تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

Class InlineImage

عنصر يمثّل صورة مضمّنة يمكن أن يكون InlineImage مضمّنًا في ListItem أو Paragraph، ما لم يكن ListItem أو Paragraph ضمن FootnoteSection. لا يمكن أن يحتوي InlineImage على أي عنصر آخر. للحصول على مزيد من المعلومات عن بنية المستند، اطّلِع على دليل توسيع نطاق "مستندات Google".

الطُرق

الطريقة	نوع القيمة التي يتم عرضها	وصف قصير
`copy()`	`InlineImage`	تعرِض نسخة مفصَّلة ومُفصَّلة من العنصر الحالي.
`getAltDescription()`	`String`	تعرِض هذه السمة الوصف البديل للصورة.
`getAltTitle()`	`String`	تعرِض هذه السمة العنوان البديل للصورة.
`getAs(contentType)`	`Blob`	عرض البيانات داخل هذا العنصر كبيانات ثنائية كبيرة تم تحويلها إلى نوع المحتوى المحدّد
`getAttributes()`	`Object`	يسترجع سمات العنصر.
`getBlob()`	`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 التي تم إنشاؤها حديثًا مؤقتًا لحدود برمجية أكثر صرامة.

المعلَمات

الاسم	النوع	الوصف
`contentType`	`String`	نوع MIME المطلوب التحويل إليه بالنسبة إلى معظم العناصر المصغّرة، يكون `'application/pdf'` هو الخيار الوحيد الصالح. بالنسبة إلى الصور بتنسيق BMP أو GIF أو JPEG أو PNG، يمكن استخدام أي من `'image/bmp'` أو `'image/gif'` أو `'image/jpeg'` أو `'image/png'` أيضًا. بالنسبة إلى مستند "مستندات Google"، يكون `'text/markdown'` صالحًا أيضًا.

الإرجاع

‫Blob: البيانات بتنسيق ملف نصي

`getAttributes()`

يسترجع سمات العنصر.

والنتيجة هي عنصر يحتوي على سمة لكل سمة عنصر صالحة، حيث يتوافق كل اسم سمة مع عنصر في التعداد DocumentApp.Attribute.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Append a styled paragraph.
const par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
const atts = par.getAttributes();

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

الإرجاع

Object: سمات العنصر

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getBlob()`

عرض البيانات داخل هذا الكائن ككتلة بيانات

الإرجاع

‫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() لتحديد النوع الدقيق لعنصر معيّن.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Obtain the first element in the active tab's body.

const 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 نفسها. يتم نقل أي عناصر فرعية مضمّنة في العنصر الحالي إلى العنصر الشقيق السابق.

تتم إزالة العنصر الحالي من المستند.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const 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.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

الإرجاع

InlineImage: العنصر المدمج

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`removeFromParent()`

تزيل العنصر من العنصر الرئيسي.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let 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، يتم ضبط الوصف على السلسلة الفارغة.

المعلَمات

الاسم	النوع	الوصف
`description`	`String`	العنوان البديل

الإرجاع

InlineImage - العنصر الحالي

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setAltTitle(title)`

لضبط العنوان البديل للصورة. إذا كان العنوان المحدَّد هو null، يتم ضبط العنوان على السلسلة الفارغة.

المعلَمات

الاسم	النوع	الوصف
`title`	`String`	العنوان البديل

الإرجاع

InlineImage - العنصر الحالي

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setAttributes(attributes)`

تُستخدَم لضبط سمات العنصر.

يجب أن تكون مَعلمة السمات المحدّدة عنصرًا يكون فيه كل اسم خاصية عنصرًا في التعداد DocumentApp.Attribute وتكون كل قيمة خاصية هي القيمة الجديدة التي سيتم تطبيقها.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Define a custom paragraph style.
const 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.
const par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

المعلَمات

الاسم	النوع	الوصف
`attributes`	`Object`	سمات العنصر

الإرجاع

InlineImage: العنصر الحالي

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setHeight(height)`

لضبط ارتفاع الصورة بالبكسل.

المعلَمات

الاسم	النوع	الوصف
`height`	`Integer`	ارتفاع الصورة بالبكسل

الإرجاع

InlineImage - العنصر الحالي

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setLinkUrl(url)`

لضبط عنوان URL للرابط إذا كان عنوان URL المحدَّد هو null أو سلسلة فارغة، ستنشئ هذه الطريقة رابطًا يتضمّن عنوان URL فارغًا قد يظهر على أنّه "رابط غير صالح" في "مستندات Google".

المعلَمات

الاسم	النوع	الوصف
`url`	`String`	عنوان URL للرابط

الإرجاع

InlineImage - العنصر الحالي

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setWidth(width)`

لضبط عرض الصورة بالبكسل.

المعلَمات

الاسم	النوع	الوصف
`width`	`Integer`	عرض الصورة بالبكسل

الإرجاع

InlineImage - العنصر الحالي

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents