عنصر عام يتم تمثيل محتويات Document
كعناصر. على سبيل المثال، List
وParagraph
وTable
هي
عناصر وتكتسب جميع الطرق التي حدّدها Element
، مثل get
.
تنفيذ الصفوف
الاسم | وصف قصير |
---|---|
Body | محتوى علامة تبويب في مستند "مستندات Google" |
Container | عنصر عام قد يحتوي على عناصر أخرى |
Date | عنصر يمثّل تاريخًا منسَّقًا |
Equation | عنصر يمثّل تعبيرًا حسابيًا |
Equation | عنصر يمثّل دالة في Equation رياضية |
Equation | عنصر يمثّل فاصل دالة في Equation رياضية |
Equation | عنصر يمثّل رمزًا في Equation رياضي |
Footer | عنصر يمثّل قسم تذييل |
Footnote | عنصر يمثّل حاشية سفلية. |
Footnote | عنصر يمثّل قسم الهامش السفلي |
Header | عنصر يمثّل قسم عنوان |
Horizontal | عنصر يمثّل خطًا أفقيًا |
Inline | عنصر يمثّل رسمًا مضمّنًا |
Inline | عنصر يمثّل صورة مضمّنة |
List | عنصر يمثّل عنصر قائمة |
Page | عنصر يمثّل فاصل صفحة |
Paragraph | عنصر يمثّل فقرة |
Person | عنصر يمثّل رابطًا يؤدي إلى شخص |
Rich | عنصر يمثّل رابطًا يؤدي إلى مورد على Google، مثل ملف على Drive أو فيديو على YouTube |
Table | عنصر يمثّل جدولاً |
Table | عنصر يمثّل خلية جدول |
Table | عنصر يحتوي على جدول محتويات |
Table | عنصر يمثّل صف جدول |
Text | عنصر يمثّل منطقة نص منسق |
Unsupported | عنصر يمثّل منطقة غير معروفة أو لا يمكن أن تتأثر بنص برمجي، مثل رقم الصفحة |
الطُرق
مستندات تفصيلية
asBody()
لعرض العنصر الحالي كBody
.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.
الإرجاع
Body
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asDate()
لعرض العنصر الحالي كDate
.
عندما تعرف أنّ العنصر هو Date
، استخدِم هذه الطريقة لضبط نوعه على Date
. يؤدي ذلك إلى السماح للميزة "الإكمال التلقائي" في محرِّر Apps Script بعرض الطرق التي يمكنك استخدامها
مع Date
.
الإرجاع
Date
: العنصر الحالي الذي تم ضبط نوعه على Date
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asEquation()
لعرض العنصر الحالي كEquation
.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.
الإرجاع
Equation
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asEquationFunction()
لعرض العنصر الحالي كEquation
.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.
الإرجاع
Equation
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asEquationFunctionArgumentSeparator()
لعرض العنصر الحالي كEquation
.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.
الإرجاع
Equation
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asEquationSymbol()
لعرض العنصر الحالي كEquation
.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.
الإرجاع
Equation
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asFootnote()
لعرض العنصر الحالي كFootnote
.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.
الإرجاع
Footnote
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asFootnoteSection()
لعرض العنصر الحالي كFootnote
.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.
الإرجاع
Footnote
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asHeaderSection()
لعرض العنصر الحالي كHeader
.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.
الإرجاع
Header
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asHorizontalRule()
لعرض العنصر الحالي كHorizontal
.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.
الإرجاع
Horizontal
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asInlineDrawing()
لعرض العنصر الحالي كInline
.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.
الإرجاع
Inline
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asInlineImage()
لعرض العنصر الحالي كInline
.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.
الإرجاع
Inline
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asListItem()
لعرض العنصر الحالي كList
.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.
الإرجاع
List
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asPageBreak()
لعرض العنصر الحالي كPage
.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.
الإرجاع
Page
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asParagraph()
لعرض العنصر الحالي كParagraph
.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.
الإرجاع
Paragraph
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asPerson()
لعرض العنصر الحالي كPerson
.
عندما تعرف أنّ العنصر هو Person
، استخدِم هذه الطريقة لضبط نوعه على أنّه شخص.
يؤدي ذلك إلى السماح للإكمال التلقائي في محرِّر Apps Script بعرض الطرق التي يمكنك استخدامها مع عنصر
شخص.
الإرجاع
Person
: العنصر الحالي الذي تم ضبط نوعه على Person
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asRichLink()
لعرض العنصر الحالي كعنصر Rich
، على سبيل المثال، رابط إلى ملف "جداول بيانات Google".
عندما تعرف أنّ العنصر هو Rich
، استخدِم هذه الطريقة لضبط نوعه على Rich
. يتيح لك ذلك استخدام ميزة الإكمال التلقائي في محرِّر Apps Script لعرض الطرق التي يمكنك
استخدامها مع Rich
.
الإرجاع
Rich
: العنصر الحالي الذي تم ضبط نوعه على Rich
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asTable()
لعرض العنصر الحالي كTable
.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.
الإرجاع
Table
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asTableCell()
لعرض العنصر الحالي كTable
.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.
الإرجاع
Table
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asTableOfContents()
لعرض العنصر الحالي كTable
.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.
الإرجاع
Table
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asTableRow()
لعرض العنصر الحالي كTable
.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.
الإرجاع
Table
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asText()
لعرض العنصر الحالي كText
.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.
الإرجاع
Text
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
copy()
تعرِض نسخة مفصَّلة ومُفصَّلة من العنصر الحالي.
ويتم أيضًا نسخ أي عناصر فرعية متوفّرة في العنصر. لا يحتوي العنصر الجديد على عنصر رئيسي.
الإرجاع
Element
: النسخة الجديدة
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAttributes()
يسترجع سمات العنصر.
والنتيجة هي عنصر يحتوي على سمة لكل سمة عنصر صالحة، حيث يتوافق كل اسم
سمة مع عنصر في التعداد Document
.
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
getNextSibling()
يسترجع العنصر الشقيق التالي للعنصر.
يتضمّن الشقيق التالي العنصر الرئيسي نفسه ويتبع العنصر الحالي.
الإرجاع
Element
: العنصر الشقيق التالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
يسترجع العنصر الرئيسي للعنصر.
يحتوي العنصر الرئيسي على العنصر الحالي.
الإرجاع
Container
: العنصر الرئيسي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
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()
يسترجع Element
للعنصر.
استخدِم get
لتحديد النوع الدقيق لعنصر معيّن.
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.'); }
الإرجاع
Element
: نوع العنصر
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
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()
دمج العنصر مع العنصر الشقيق السابق من النوع نفسه
لا يمكن دمج سوى عناصر Element
نفسها. يتم نقل أي عناصر فرعية مضمّنة في
العنصر الحالي إلى العنصر الشقيق السابق.
تتم إزالة العنصر الحالي من المستند.
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();
الإرجاع
Element
: العنصر المدمج
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
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(); }
الإرجاع
Element
: العنصر الذي تمّت إزالته
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
تُستخدَم لضبط سمات العنصر.
يجب أن تكون مَعلمة السمات المحدّدة عنصرًا يكون فيه كل اسم خاصية عنصرًا في التعداد Document
وتكون كل قيمة خاصية هي القيمة الجديدة التي سيتم تطبيقها.
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 | سمات العنصر |
الإرجاع
Element
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents