عنصر عام يتم تمثيل محتوى 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 | عنصر يمثّل منطقة غير معروفة أو لا يمكن أن يتأثر بنص برمجي، مثل رقم الصفحة |
الطُرق
مستندات تفصيلية
as Body()
تعرض العنصر الحالي كـ Body.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون من المعروف أنّ عنصرًا معيّنًا من نوع محدّد.
الإرجاع
Body: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
as Date()
تعرض العنصر الحالي كـ Date.
عندما تعرف أنّ العنصر هو Date، استخدِم هذه الطريقة لضبط نوعه على Date. يسمح لك ذلك بأن تعرض لك ميزة الإكمال التلقائي في محرّر Apps Script الطرق التي يمكنك استخدامها مع Date.
الإرجاع
Date: العنصر الحالي الذي تم ضبط نوعه على Date.
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
as Equation()
تعرض العنصر الحالي كـ Equation.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون من المعروف أنّ عنصرًا معيّنًا من نوع محدّد.
الإرجاع
Equation: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
as Equation Function()
تعرض العنصر الحالي كـ Equation.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون من المعروف أنّ عنصرًا معيّنًا من نوع محدّد.
الإرجاع
Equation: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
as Equation Function Argument Separator()
تعرض العنصر الحالي كـ Equation.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون من المعروف أنّ عنصرًا معيّنًا من نوع محدّد.
الإرجاع
Equation: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
as Equation Symbol()
تعرض العنصر الحالي كـ Equation.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون من المعروف أنّ عنصرًا معيّنًا من نوع محدّد.
الإرجاع
Equation: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
as Footnote()
تعرض العنصر الحالي كـ Footnote.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون من المعروف أنّ عنصرًا معيّنًا من نوع محدّد.
الإرجاع
Footnote: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
as Footnote Section()
تعرض العنصر الحالي كـ Footnote.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون من المعروف أنّ عنصرًا معيّنًا من نوع محدّد.
الإرجاع
Footnote: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
as Header Section()
تعرض العنصر الحالي كـ Header.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون من المعروف أنّ عنصرًا معيّنًا من نوع محدّد.
الإرجاع
Header: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
as Horizontal Rule()
تعرض العنصر الحالي كـ Horizontal.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون من المعروف أنّ عنصرًا معيّنًا من نوع محدّد.
الإرجاع
Horizontal: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
as Inline Drawing()
تعرض العنصر الحالي كـ Inline.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون من المعروف أنّ عنصرًا معيّنًا من نوع محدّد.
الإرجاع
Inline: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
as Inline Image()
تعرض العنصر الحالي كـ Inline.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون من المعروف أنّ عنصرًا معيّنًا من نوع محدّد.
الإرجاع
Inline: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
as List Item()
تعرض العنصر الحالي كـ List.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون من المعروف أنّ عنصرًا معيّنًا من نوع محدّد.
الإرجاع
List: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
as Page Break()
تعرض العنصر الحالي كـ Page.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون من المعروف أنّ عنصرًا معيّنًا من نوع محدّد.
الإرجاع
Page: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
as Paragraph()
تعرض العنصر الحالي كـ Paragraph.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون من المعروف أنّ عنصرًا معيّنًا من نوع محدّد.
الإرجاع
Paragraph: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
as Person()
تعرض العنصر الحالي كـ Person.
عندما تعرف أنّ العنصر هو Person، استخدِم هذه الطريقة لضبط نوعه كشخص.
يؤدي ذلك إلى السماح لميزة الإكمال التلقائي في "أداة تعديل النصوص البرمجية في Apps Script" بعرض الطرق التي يمكنك استخدامها مع عنصر
الشخص.
الإرجاع
Person: العنصر الحالي الذي تم ضبط نوعه على Person.
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
as Rich Link()
تعرض العنصر الحالي كـ Rich، مثلاً، رابط إلى ملف في "جداول بيانات Google".
عندما تعرف أنّ العنصر هو Rich، استخدِم هذه الطريقة لضبط نوعه على Rich. يسمح لك ذلك بأن تعرض لك ميزة الإكمال التلقائي في محرّر Apps Script الطرق التي يمكنك استخدامها مع Rich.
الإرجاع
Rich: العنصر الحالي الذي تم ضبط نوعه على Rich.
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
as Table()
تعرض العنصر الحالي كـ Table.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون من المعروف أنّ عنصرًا معيّنًا من نوع محدّد.
الإرجاع
Table: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
as Table Cell()
تعرض العنصر الحالي كـ Table.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون من المعروف أنّ عنصرًا معيّنًا من نوع محدّد.
الإرجاع
Table: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
as Table Of Contents()
تعرض العنصر الحالي كـ Table.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون من المعروف أنّ عنصرًا معيّنًا من نوع محدّد.
الإرجاع
Table: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
as Table Row()
تعرض العنصر الحالي كـ Table.
استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون من المعروف أنّ عنصرًا معيّنًا من نوع محدّد.
الإرجاع
Table: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
as Text()
تعرض العنصر الحالي كـ 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
get Attributes()
يستردّ سمات العنصر.
والنتيجة هي عنصر يحتوي على سمة لكل سمة عنصر صالحة، حيث يتطابق اسم كل سمة مع عنصر في التعداد 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
get Next Sibling()
يستردّ العنصر الشقيق التالي للعنصر.
العنصر الشقيق التالي له العنصر الرئيسي نفسه ويتبع العنصر الحالي.
الإرجاع
Element|null: العنصر الشقيق التالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Parent()
تعرض هذه السمة العنصر الرئيسي للعنصر الحالي.
يحتوي العنصر الرئيسي على العنصر الحالي.
الإرجاع
Container: العنصر الرئيسي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Previous Sibling()
يستردّ هذا الإجراء العنصر الشقيق السابق للعنصر.
العنصر الشقيق السابق له العنصر الرئيسي نفسه ويسبق العنصر الحالي.
الإرجاع
Element|null: العنصر الشقيق السابق
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Type()
يستردّ 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
is At Document End()
تحدّد هذه السمة ما إذا كان العنصر في نهاية 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|null: العنصر المدمج
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
remove From Parent()
يزيل العنصر من العنصر الأصل.
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|null: العنصر الذي تمت إزالته
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Attributes(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