عنصر يمثّل قسم الحواشي السفلية تحتوي FootnoteSection على النص الذي يتوافق مع Footnote. قد تحتوي السمة FootnoteSection على عناصر ListItem أو Paragraph. لمزيد من المعلومات حول بنية المستند، يُرجى الاطّلاع على دليل توسيع "مستندات Google".
الطُرق
| الطريقة | نوع القيمة التي تم إرجاعها | وصف قصير |
|---|---|---|
append | Paragraph | تُلحق هذه الطريقة Paragraph المحدّدة. |
append | Paragraph | تنشئ هذه الطريقة عنصر Paragraph جديدًا وتضيفه إلى نهاية المستند، ويحتوي هذا العنصر على محتوى النص المحدّد. |
clear() | Footnote | يمحو محتوى العنصر. |
copy() | Footnote | تعرض نسخة منفصلة وعميقة من العنصر الحالي. |
edit | Text | يحصل على نسخة Text من العنصر الحالي لتعديلها. |
find | Range | يبحث في محتوى العنصر عن عنصر فرعي من النوع المحدّد. |
find | Range | يبحث في محتويات العنصر عن عنصر فرعي من النوع المحدّد، بدءًا من Range المحدّد. |
find | Range | يبحث في محتوى العنصر عن نمط النص المحدّد باستخدام التعبيرات العادية. |
find | Range | يبحث في محتوى العنصر عن نمط النص المحدّد، بدءًا من نتيجة بحث معيّنة. |
get | Object | يتم استرداد سمات العنصر. |
get | Element | يستردّ العنصر الفرعي في فهرس العنصر الفرعي المحدّد. |
get | Integer | يستردّ هذا الإجراء فهرس العنصر الفرعي للعنصر الفرعي المحدّد. |
get | Element|null | يستردّ العنصر الشقيق التالي للعنصر. |
get | Integer | تعرض هذه السمة عدد الأطفال. |
get | Paragraph[]|null | تعرض هذه السمة جميع Paragraphs الواردة في القسم (بما في ذلك List). |
get | Container | تعرض هذه السمة العنصر الرئيسي للعنصر الحالي. |
get | Element|null | يتم استرداد العنصر الشقيق السابق للعنصر. |
get | String | تعرض محتوى العنصر كسلسلة نصية. |
get | Text | تعرض هذه السمة محاذاة النص. |
get | Element | يستردّ Element الخاص بالعنصر. |
insert | Paragraph | تُدرِج هذه الدالة Paragraph المحدّدة في الفهرس المحدّد. |
insert | Paragraph | تنشئ هذه الطريقة عنصر Paragraph جديدًا وتدرجه في الفهرس المحدّد، على أن يتضمّن محتوى النص المحدّد. |
remove | Footnote | يزيل العنصر الفرعي المحدّد. |
remove | Footnote | تزيل هذه الطريقة العنصر من العنصر الأصل. |
replace | Element | لاستبدال جميع تكرارات نمط نصي معيّن بسلسلة استبدال معيّنة، باستخدام التعبيرات العادية. |
set | Footnote | تضبط هذه السمة سمات العنصر. |
set | Footnote | يضبط المحتوى كنص عادي. |
set | Footnote | تضبط هذه السمة محاذاة النص. |
مستندات تفصيلية
appendParagraph(paragraph)
تُلحق هذه الطريقة Paragraph المحدّدة.
استخدِم هذا الإصدار من appendParagraph عند إلحاق نسخة من Paragraph حالي.
المَعلمات
| الاسم | النوع | الوصف |
|---|---|---|
paragraph | Paragraph | الفقرة المطلوب إلحاقها. |
الإرجاع
Paragraph: الفقرة الملحقة
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendParagraph(text)
تنشئ هذه الطريقة عنصر Paragraph جديدًا وتضيفه إلى نهاية المستند، ويحتوي هذا العنصر على محتوى النص المحدّد.
المَعلمات
| الاسم | النوع | الوصف |
|---|---|---|
text | String | محتوى النص في الفقرة |
الإرجاع
Paragraph: الفقرة الجديدة
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
clear()
copy()
تعرض نسخة منفصلة وعميقة من العنصر الحالي.
يتم أيضًا نسخ أي عناصر فرعية مضمّنة في العنصر. لا يحتوي العنصر الجديد على عنصر رئيسي.
الإرجاع
FootnoteSection: النسخة الجديدة
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
editAsText()
يحصل على نسخة Text من العنصر الحالي لتعديلها.
استخدِم editAsText لمعالجة محتوى العناصر كنص منسّق. يتجاهل الوضع editAsText العناصر غير النصية (مثل InlineImage وHorizontalRule).
تتم إزالة العناصر الفرعية التي يتم تضمينها بالكامل في نطاق نصي محذوف من العنصر.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, 'An editAsText sample.'); body.insertHorizontalRule(0); body.insertParagraph(0, 'An example.'); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
الإرجاع
Text: نسخة نصية من العنصر الحالي
findElement(elementType)
يبحث في محتوى العنصر عن عنصر فرعي من النوع المحدّد.
المَعلمات
| الاسم | النوع | الوصف |
|---|---|---|
element | Element | نوع العنصر المطلوب البحث عنه. |
الإرجاع
RangeElement|null: نتيجة بحث تشير إلى موضع عنصر البحث.
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
findElement(elementType, from)
يبحث في محتويات العنصر عن عنصر فرعي من النوع المحدّد، بدءًا من RangeElement المحدّد.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Define the search parameters. let searchResult = null; // Search until the paragraph is found. while ( (searchResult = body.findElement( DocumentApp.ElementType.PARAGRAPH, searchResult, ))) { const par = searchResult.getElement().asParagraph(); if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) { // Found one, update and stop. par.setText('This is the first header.'); break; } }
المَعلمات
| الاسم | النوع | الوصف |
|---|---|---|
element | Element | نوع العنصر المطلوب البحث عنه. |
from | Range | نتيجة البحث التي سيتم البحث منها |
الإرجاع
RangeElement|null: نتيجة بحث تشير إلى الموضع التالي لعنصر البحث.
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
findText(searchPattern)
يبحث في محتوى العنصر عن نمط النص المحدّد باستخدام التعبيرات العادية.
لا تتوافق مجموعة فرعية من ميزات التعبير العادي في JavaScript بشكل كامل، مثل مجموعات الالتقاط ومعدّلات الوضع.
تتم مطابقة نمط التعبير العادي المقدَّم بشكل مستقل مع كل كتلة نصية مضمّنة في العنصر الحالي.
المَعلمات
| الاسم | النوع | الوصف |
|---|---|---|
search | String | النمط المطلوب البحث عنه |
الإرجاع
RangeElement|null — نتيجة بحث تشير إلى موضع نص البحث، أو قيمة فارغة إذا لم تكن هناك أي مطابقة
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
يبحث في محتوى العنصر عن نمط النص المحدّد، بدءًا من نتيجة بحث معيّنة.
لا تتوافق مجموعة فرعية من ميزات التعبير العادي في JavaScript بشكل كامل، مثل مجموعات الالتقاط ومعدّلات الوضع.
تتم مطابقة نمط التعبير العادي المقدَّم بشكل مستقل مع كل كتلة نصية مضمّنة في العنصر الحالي.
المَعلمات
| الاسم | النوع | الوصف |
|---|---|---|
search | String | النمط المطلوب البحث عنه |
from | Range | نتيجة البحث التي تريد البحث منها |
الإرجاع
RangeElement|null: نتيجة بحث تشير إلى الموضع التالي لنص البحث، أو قيمة فارغة إذا لم تكن هناك أي مطابقة
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
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
getChild(childIndex)
يستردّ العنصر الفرعي في فهرس العنصر الفرعي المحدّد.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. const firstChild = body.getChild(0); // If it's a paragraph, set its contents. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { firstChild.asParagraph().setText('This is the first paragraph.'); }
المَعلمات
| الاسم | النوع | الوصف |
|---|---|---|
child | Integer | فهرس العنصر الفرعي المطلوب استرداده |
الإرجاع
Element: العنصر الفرعي في الفهرس المحدّد
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getChildIndex(child)
يستردّ هذا الإجراء فهرس العنصر الفرعي للعنصر الفرعي المحدّد.
المَعلمات
| الاسم | النوع | الوصف |
|---|---|---|
child | Element | العنصر الفرعي الذي سيتم استرداد الفهرس الخاص به. |
الإرجاع
Integer: فهرس الطفل
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getNextSibling()
يستردّ العنصر الشقيق التالي للعنصر.
العنصر الشقيق التالي له العنصر الرئيسي نفسه ويتبع العنصر الحالي.
الإرجاع
Element|null: العنصر الشقيق التالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getNumChildren()
تعرض هذه السمة عدد الأطفال.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Log the number of elements in the tab. Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);
الإرجاع
Integer: عدد الأطفال
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getParagraphs()
تعرض هذه السمة جميع Paragraphs الواردة في القسم (بما في ذلك ListItems).
الإرجاع
Paragraph[]|null: فقرات القسم
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getParent()
تعرض هذه السمة العنصر الرئيسي للعنصر الحالي.
يحتوي العنصر الرئيسي على العنصر الحالي.
الإرجاع
ContainerElement|null: العنصر الرئيسي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getPreviousSibling()
يتم استرداد العنصر الشقيق السابق للعنصر.
العنصر الشقيق السابق له العنصر الأصلي نفسه ويسبق العنصر الحالي.
الإرجاع
Element|null: العنصر الشقيق السابق
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getText()
تعرض محتوى العنصر كسلسلة نصية.
الإرجاع
String: محتوى العنصر كسلسلة نصية
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getTextAlignment()
تعرض هذه السمة محاذاة النص. تشمل أنواع المحاذاة المتاحة DocumentApp.TextAlignment.NORMAL وDocumentApp.TextAlignment.SUBSCRIPT وDocumentApp.TextAlignment.SUPERSCRIPT.
الإرجاع
TextAlignment|null: نوع محاذاة النص، أو null إذا كان النص يحتوي على أنواع متعدّدة من محاذاة النص أو إذا لم يتم ضبط محاذاة النص مطلقًا
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
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
insertParagraph(childIndex, paragraph)
تُدرِج هذه الدالة Paragraph المحدّدة في الفهرس المحدّد.
المَعلمات
| الاسم | النوع | الوصف |
|---|---|---|
child | Integer | الفهرس الذي سيتم الإدراج فيه. |
paragraph | Paragraph | الفقرة المطلوب إدراجها |
الإرجاع
Paragraph: الفقرة المُدرَجة
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, text)
تنشئ هذه الطريقة عنصر Paragraph جديدًا وتدرجه في الفهرس المحدّد، على أن يتضمّن محتوى النص المحدّد.
المَعلمات
| الاسم | النوع | الوصف |
|---|---|---|
child | Integer | الفهرس الذي سيتم الإدراج فيه. |
text | String | محتوى النص في الفقرة |
الإرجاع
Paragraph: الفقرة الجديدة
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
removeChild(child)
يزيل العنصر الفرعي المحدّد.
المَعلمات
| الاسم | النوع | الوصف |
|---|---|---|
child | Element | عنصر الطفل الذي ستتم إزالته. |
الإرجاع
FootnoteSection: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
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(); }
الإرجاع
FootnoteSection|null: العنصر الذي تمت إزالته
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
replaceText(searchPattern, replacement)
لاستبدال جميع تكرارات نمط نصي معيّن بسلسلة استبدال معيّنة، باستخدام التعبيرات العادية.
يتم تمرير نمط البحث كسلسلة، وليس ككائن تعبير عادي في JavaScript. لهذا السبب، عليك تخطّي أي شرطات مائلة عكسية في النمط.
تستخدِم هذه الطريقة مكتبة RE2 للتعبيرات العادية من Google، ما يحدّ من البنية المتوافقة.
تتم مطابقة نمط التعبير العادي المقدَّم بشكل مستقل مع كل كتلة نصية مضمّنة في العنصر الحالي.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText('^.*Apps ?Script.*$', 'Apps Script');
المَعلمات
| الاسم | النوع | الوصف |
|---|---|---|
search | String | نمط التعبير العادي المطلوب البحث عنه |
replacement | String | النص الذي سيتم استخدامه كبديل |
الإرجاع
Element: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
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 | سمات العنصر |
الإرجاع
FootnoteSection: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setText(text)
يضبط المحتوى كنص عادي.
ملاحظة: يتم محو المحتوى الحالي.
المَعلمات
| الاسم | النوع | الوصف |
|---|---|---|
text | String | محتوى النص الجديد |
الإرجاع
FootnoteSection: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setTextAlignment(textAlignment)
تضبط هذه السمة محاذاة النص. تشمل أنواع المحاذاة المتاحة DocumentApp.TextAlignment.NORMAL وDocumentApp.TextAlignment.SUBSCRIPT وDocumentApp.TextAlignment.SUPERSCRIPT.
// Make the entire first paragraph in the active tab be superscript. const documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); const text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
المَعلمات
| الاسم | النوع | الوصف |
|---|---|---|
text | Text | نوع محاذاة النص المطلوب تطبيقه |
الإرجاع
FootnoteSection: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents