عنصر يمثل صورة مضمّنة. ويمكن تضمين InlineImage
ضمن ListItem
أو Paragraph
ما لم يكن ListItem
أو Paragraph
ضمن FootnoteSection
. لا يمكن أن يحتوي InlineImage
نفسه على أي عنصر آخر. لمزيد من المعلومات حول بنية المستند، يُرجى الاطّلاع على دليل توسيع نطاق مستندات Google.
الطُرق
الطريقة | نوع القيمة التي يتم إرجاعها | وصف قصير |
---|---|---|
copy() | InlineImage | لعرض نسخة عميقة منفصلة من العنصر الحالي. |
getAltDescription() | String | لعرض الوصف البديل للصورة. |
getAltTitle() | String | لعرض العنوان البديل للصورة. |
getAs(contentType) | Blob | عرض البيانات داخل هذا الكائن على شكل كائن ثنائي كبير يتم تحويله إلى نوع المحتوى المحدّد. |
getAttributes() | Object | لاسترداد سمات العنصر. |
getBlob() | Blob | عرض البيانات داخل هذا الكائن على هيئة كائن ثنائي كبير (blob). |
getHeight() | Integer | لاسترداد ارتفاع الصورة بالبكسل. |
getLinkUrl() | String | لاسترداد عنوان URL للرابط. |
getNextSibling() | Element | لاسترداد العنصر الشقيق التالي للعنصر. |
getParent() | ContainerElement | لاسترداد العنصر الرئيسي للعنصر. |
getPreviousSibling() | Element | لاسترداد العنصر الشقيق السابق للعنصر. |
getType() | ElementType | لاسترداد ElementType للعنصر. |
getWidth() | Integer | لاسترداد عرض الصورة بالبكسل. |
isAtDocumentEnd() | Boolean | تحدِّد هذه السياسة ما إذا كان العنصر في نهاية Document . |
merge() | InlineImage | يدمج العنصر مع العنصر التابع السابق من النوع نفسه. |
removeFromParent() | InlineImage | لإزالة العنصر من الأصل. |
setAltDescription(description) | InlineImage | لضبط الوصف البديل للصورة |
setAltTitle(title) | InlineImage | لتعيين العنوان البديل للصورة. |
setAttributes(attributes) | InlineImage | تعيّن سمات العنصر. |
setHeight(height) | InlineImage | لضبط ارتفاع الصورة بالبكسل. |
setLinkUrl(url) | InlineImage | لضبط عنوان URL للرابط. |
setWidth(width) | InlineImage | لضبط عرض الصورة بالبكسل. |
الوثائق التفصيلية
copy()
لعرض نسخة عميقة منفصلة من العنصر الحالي.
يتم أيضًا نسخ أي عناصر فرعية موجودة في العنصر. العنصر الجديد ليس له أصل.
استرجاع الكرة
InlineImage
— النسخة الجديدة
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAltDescription()
لعرض الوصف البديل للصورة.
استرجاع الكرة
String
: العنوان البديل أو null
إذا لم يكن للعنصر عنوانًا بديلاً
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAltTitle()
لعرض العنوان البديل للصورة.
استرجاع الكرة
String
: العنوان البديل أو null
إذا لم يكن للعنصر عنوانًا بديلاً
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAs(contentType)
عرض البيانات داخل هذا الكائن على شكل كائن ثنائي كبير يتم تحويله إلى نوع المحتوى المحدّد. تضيف هذه الطريقة الامتداد المناسب إلى اسم الملف - على سبيل المثال، "myfile.pdf". ومع ذلك، يُفترض أن يمثّل جزء اسم الملف الذي يلي النقطة الأخيرة (إن وُجدت) إضافة حالية يجب استبدالها. وبالتالي، يصبح "ShoppingList.12.25.2014" هو "ShoppingList.12.25.pdf".
لعرض الحصص اليومية للإحالات الناجحة، راجِع حصص خدمات Google. قد تخضع نطاقات Google Workspace التي تم إنشاؤها حديثًا لحصص أكثر صرامة مؤقتًا.
المَعلمات
الاسم | Type | الوصف |
---|---|---|
contentType | String | نوع MIME المطلوب التحويل إليه. بالنسبة إلى معظم الكائنات الثنائية الكبيرة، يكون 'application/pdf' هو الخيار الصالح الوحيد. بالنسبة إلى الصور بتنسيق BMP أو GIF أو JPEG أو PNG، يكون أي من 'image/bmp' أو 'image/gif' أو 'image/jpeg' أو 'image/png' صالحًا أيضًا. |
استرجاع الكرة
Blob
— البيانات في صورة كائن ثنائي كبير (blob).
getAttributes()
لاسترداد سمات العنصر.
والنتيجة هي كائن يحتوي على سمة لكل سمة عنصر صالحة حيث يتجاوب كل اسم خاصية مع عنصر في التعداد DocumentApp.Attribute
.
var body = DocumentApp.getActiveDocument().getBody(); // Append a styled paragraph. var par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. var atts = par.getAttributes(); // Log the paragraph attributes. for (var att in atts) { Logger.log(att + ":" + atts[att]); }
استرجاع الكرة
Object
— سمات العنصر
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBlob()
عرض البيانات داخل هذا الكائن على هيئة كائن ثنائي كبير (blob).
استرجاع الكرة
Blob
— البيانات في صورة كائن ثنائي كبير (blob).
getHeight()
لاسترداد ارتفاع الصورة بالبكسل.
استرجاع الكرة
Integer
- ارتفاع الصورة بالبكسل
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLinkUrl()
لاسترداد عنوان URL للرابط.
استرجاع الكرة
String
: عنوان URL للرابط أو null
إذا كان العنصر يحتوي على قيم متعدّدة لهذه السمة.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNextSibling()
لاسترداد العنصر الشقيق التالي للعنصر.
الشقيق التالي له نفس الأصل ويتبع العنصر الحالي.
استرجاع الكرة
Element
- العنصر الشقيق التالي.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
لاسترداد العنصر الرئيسي للعنصر.
يحتوي العنصر الأصلي على العنصر الحالي.
استرجاع الكرة
ContainerElement
— العنصر الرئيسي
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPreviousSibling()
لاسترداد العنصر الشقيق السابق للعنصر.
العنصر التابع السابق له نفس الأصل ويسبق العنصر الحالي.
استرجاع الكرة
Element
- العنصر التابع السابق
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
لاسترداد ElementType
للعنصر.
يمكنك استخدام getType()
لتحديد النوع الدقيق لعنصر معيّن.
var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document body. var firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
استرجاع الكرة
ElementType
— نوع العنصر
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getWidth()
لاسترداد عرض الصورة بالبكسل.
استرجاع الكرة
Integer
- عرض الصورة بالبكسل
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
تحدِّد هذه السياسة ما إذا كان العنصر في نهاية Document
.
استرجاع الكرة
Boolean
: يشير إلى ما إذا كان العنصر في نهاية المستند.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
merge()
يدمج العنصر مع العنصر التابع السابق من النوع نفسه.
يمكن دمج العناصر من ElementType
نفسه فقط. يتم نقل أي عناصر فرعية مضمنة في العنصر الحالي إلى العنصر التابع السابق.
تتم إزالة العنصر الحالي من المستند.
var body = DocumentApp.getActiveDocument().getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document. var par1 = body.appendParagraph('Paragraph 1.'); var par2 = body.appendParagraph('Paragraph 2.'); // Merge the newly added paragraphs into a single paragraph. par2.merge(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's cell contents. var cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'] ]; // Build a table from the array. var table = body.appendTable(cells); // Get the first row in the table. var row = table.getRow(0); // Get the two cells in this row. var cell1 = row.getCell(0); var cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. var merged = cell2.merge();
استرجاع الكرة
InlineImage
— العنصر المدمج
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeFromParent()
لإزالة العنصر من الأصل.
var body = DocumentApp.getActiveDocument().getBody(); // Remove all images in the document body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
استرجاع الكرة
InlineImage
— العنصر الذي تمت إزالته
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAltDescription(description)
لضبط الوصف البديل للصورة إذا كان العنوان المحدَّد هو null
، سيتم ضبط الوصف على السلسلة الفارغة.
المَعلمات
الاسم | Type | الوصف |
---|---|---|
description | String | العنوان البديل |
استرجاع الكرة
InlineImage
- العنصر الحالي
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAltTitle(title)
لتعيين العنوان البديل للصورة. إذا كان العنوان المحدّد هو null
، سيتم ضبط العنوان على السلسلة الفارغة.
المَعلمات
الاسم | Type | الوصف |
---|---|---|
title | String | العنوان البديل |
استرجاع الكرة
InlineImage
- العنصر الحالي
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
تعيّن سمات العنصر.
يجب أن تكون معلمة السمات المحددة كائنًا يكون فيه كل اسم للخاصية عنصرًا في التعداد DocumentApp.Attribute
وتكون كل قيمة للخاصية هي القيمة الجديدة المطلوب تطبيقها.
var body = DocumentApp.getActiveDocument().getBody(); // Define a custom paragraph style. var style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. var par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
المَعلمات
الاسم | Type | الوصف |
---|---|---|
attributes | Object | تمثّل هذه السمة سمات العنصر. |
استرجاع الكرة
InlineImage
- العنصر الحالي
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setHeight(height)
لضبط ارتفاع الصورة بالبكسل.
المَعلمات
الاسم | Type | الوصف |
---|---|---|
height | Integer | ارتفاع الصورة بالبكسل |
استرجاع الكرة
InlineImage
- العنصر الحالي
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLinkUrl(url)
لضبط عنوان URL للرابط. إذا كان عنوان URL المحدّد هو null
أو سلسلة فارغة، تنشئ هذه الطريقة رابطًا بعنوان URL فارغًا قد يظهر على أنّه "رابط غير صالح" في "مستندات Google".
المَعلمات
الاسم | Type | الوصف |
---|---|---|
url | String | عنوان URL للرابط |
استرجاع الكرة
InlineImage
- العنصر الحالي
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setWidth(width)
لضبط عرض الصورة بالبكسل.
المَعلمات
الاسم | Type | الوصف |
---|---|---|
width | Integer | عرض الصورة بالبكسل |
استرجاع الكرة
InlineImage
- العنصر الحالي
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents