محتوى علامة تبويب في مستند "مستندات Google" قد يحتوي Body على عناصر ListItem وParagraph وTable وTableOfContents. لمزيد من المعلومات حول بنية المستند، راجِع دليل توسيع نطاق "مستندات Google".
تحتوي Body عادةً على المحتوى الكامل للعلامة باستثناء HeaderSection وFooterSection وأي عناصر FootnoteSection.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Append a paragraph and a page break to the tab's body section directly. body.appendParagraph('A paragraph.'); body.appendPageBreak();
الطُرق
| الطريقة | نوع القيمة التي تم إرجاعها | وصف قصير |
|---|---|---|
append | Horizontal | تنشئ هذه السمة Horizontal جديدة وتلحقها. |
append | Inline | تنشئ هذه الطريقة Inline جديدًا وتضيفه من كائن ثنائي كبير الحجم للصورة المحدّدة. |
append | Inline | تُلحق هذه الطريقة Inline المحدّدة. |
append | List | تُلحق هذه الطريقة List المحدّدة. |
append | List | تنشئ هذه الطريقة عنصر List جديدًا وتضيفه إلى نهاية المستند، ويحتوي هذا العنصر على محتوى النص المحدّد. |
append | Page | تنشئ هذه السمة Page جديدة وتلحقها. |
append | Page | تُلحق هذه الطريقة Page المحدّدة. |
append | Paragraph | تُلحق هذه الطريقة Paragraph المحدّدة. |
append | Paragraph | تنشئ هذه الطريقة عنصر Paragraph جديدًا وتضيفه إلى نهاية المستند، ويحتوي هذا العنصر على محتوى النص المحدّد. |
append | Table | تنشئ هذه السمة Table جديدة وتلحقها. |
append | Table | تُلحق هذه السمة Table جديدة تحتوي على Table لكل قيمة سلسلة محددة. |
append | Table | تُلحق هذه الطريقة Table المحدّدة. |
clear() | Body | يمحو محتوى العنصر. |
copy() | Body | تعرض نسخة منفصلة وعميقة من العنصر الحالي. |
edit | Text | يحصل على نسخة Text من العنصر الحالي لتعديلها. |
find | Range | يبحث في محتوى العنصر عن عنصر فرعي من النوع المحدّد. |
find | Range | يبحث في محتويات العنصر عن عنصر فرعي من النوع المحدّد، بدءًا من Range المحدّد. |
find | Range | يبحث في محتوى العنصر عن نمط النص المحدّد باستخدام التعبيرات العادية. |
find | Range | يبحث في محتوى العنصر عن نمط النص المحدّد، بدءًا من نتيجة بحث معيّنة. |
get | Object | يتم استرداد سمات العنصر. |
get | Element | يستردّ العنصر الفرعي في فهرس العنصر الفرعي المحدّد. |
get | Integer | يستردّ هذا الإجراء فهرس العنصر الفرعي للعنصر الفرعي المحدّد. |
get | Object | تعرض هذه الطريقة مجموعة السمات الخاصة بـ Paragraph المقدَّم. |
get | Inline | يستردّ هذا الإجراء جميع Inline الواردة في القسم. |
get | List | يستردّ هذا الإجراء جميع List الواردة في القسم. |
get | Number|null | تعرض هذه السمة الهامش السفلي بالنقاط. |
get | Number|null | تعرض هذه السمة الهامش الأيسر بالنقاط. |
get | Number|null | تعرض هذه السمة الهامش الأيمن. |
get | Number|null | تعرض هذه السمة الهامش العلوي. |
get | Integer | تعرض هذه السمة عدد الأطفال. |
get | Number|null | تعرض هذه السمة ارتفاع الصفحة بالنقاط. |
get | Number|null | تعرض هذه السمة عرض الصفحة بالنقاط. |
get | Paragraph[]|null | تعرض هذه السمة جميع Paragraphs الواردة في القسم (بما في ذلك List). |
get | Container | تعرض هذه السمة العنصر الرئيسي للعنصر الحالي. |
get | Table[]|null | يستردّ هذا الإجراء جميع Tables الواردة في القسم. |
get | String | تعرض محتوى العنصر كسلسلة نصية. |
get | Text | تعرض هذه السمة محاذاة النص. |
get | Element | يستردّ Element الخاص بالعنصر. |
insert | Horizontal | تنشئ هذه الطريقة Horizontal جديدًا وتُدرجه في الفهرس المحدّد. |
insert | Inline | تنشئ هذه الدالة عنصر Inline وتُدرجه من كائن ثنائي كبير الحجم للصورة المحدّدة، وذلك في الفهرس المحدّد. |
insert | Inline | تُدرِج هذه الدالة Inline المحدّدة في الفهرس المحدّد. |
insert | List | تُدرِج هذه الدالة List المحدّدة في الفهرس المحدّد. |
insert | List | تنشئ هذه الطريقة عنصر List جديدًا وتدرجه في الفهرس المحدّد، على أن يتضمّن محتوى النص المحدّد. |
insert | Page | تنشئ هذه الطريقة Page جديدًا وتُدرجه في الفهرس المحدّد. |
insert | Page | تُدرِج هذه الدالة Page المحدّدة في الفهرس المحدّد. |
insert | Paragraph | تُدرِج هذه الدالة Paragraph المحدّدة في الفهرس المحدّد. |
insert | Paragraph | تنشئ هذه الطريقة عنصر Paragraph جديدًا وتدرجه في الفهرس المحدّد، على أن يتضمّن محتوى النص المحدّد. |
insert | Table | تنشئ هذه الطريقة Table جديدًا وتُدرجه في الفهرس المحدّد. |
insert | Table | تنشئ هذه الدالة Table جديدًا يحتوي على الخلايا المحدّدة وتُدرجه في الفهرس المحدّد. |
insert | Table | تُدرِج هذه الدالة Table المحدّدة في الفهرس المحدّد. |
remove | Body | يزيل العنصر الفرعي المحدّد. |
replace | Element | لاستبدال جميع تكرارات نمط نصي معيّن بسلسلة استبدال معيّنة، باستخدام التعبيرات العادية. |
set | Body | تضبط هذه السمة سمات العنصر. |
set | Body | تضبط هذه الطريقة سمات Paragraph المقدَّمة. |
set | Body | تضبط هذه السمة الهامش السفلي بالنقاط. |
set | Body | تضبط هذه السمة الهامش الأيسر بالنقاط. |
set | Body | تضبط هذه السمة الهامش الأيمن بالنقاط. |
set | Body | تضبط هذه السمة الهامش العلوي. |
set | Body | تضبط هذه السمة ارتفاع الصفحة بالنقاط. |
set | Body | تضبط هذه السمة عرض الصفحة بالنقاط. |
set | Body | يضبط المحتوى كنص عادي. |
set | Body | تضبط هذه السمة محاذاة النص. |
مستندات تفصيلية
appendHorizontalRule()
تنشئ هذه السمة HorizontalRule جديدة وتلحقها.
سيتم تضمين HorizontalRule في Paragraph جديد.
الإرجاع
HorizontalRule: الخط الأفقي الجديد
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendImage(image)
تنشئ هذه الطريقة InlineImage جديدًا وتضيفه من كائن ثنائي كبير الحجم للصورة المحدّدة.
سيتم تضمين الصورة في Paragraph جديد.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
image | Blob | بيانات الصورة |
الإرجاع
InlineImage: الصورة الملحقة
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendImage(image)
تُلحق هذه الطريقة InlineImage المحدّدة.
سيتم تضمين InlineImage في Paragraph جديد.
استخدِم هذا الإصدار من appendImage عند إلحاق نسخة من InlineImage حالي.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
image | Inline | بيانات الصورة |
الإرجاع
InlineImage: الصورة الملحقة
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendListItem(listItem)
تُلحق هذه الطريقة ListItem المحدّدة.
استخدِم هذا الإصدار من appendListItem عند إلحاق نسخة من ListItem حالي.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
list | List | عنصر القائمة المطلوب إلحاقه |
الإرجاع
ListItem: عنصر القائمة الملحق
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendListItem(text)
تنشئ هذه الطريقة عنصر ListItem جديدًا وتضيفه إلى نهاية المستند، ويحتوي هذا العنصر على محتوى النص المحدّد.
تتم إضافة عناصر القائمة المتتالية كجزء من القائمة نفسها.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
text | String | محتوى النص الخاص بعنصر القائمة |
الإرجاع
ListItem: عنصر القائمة الجديد
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendPageBreak()
تنشئ هذه السمة PageBreak جديدة وتلحقها.
سيتم تضمين PageBreak في Paragraph جديد.
الإرجاع
PageBreak: فاصل الصفحات الجديد
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendPageBreak(pageBreak)
تُلحق هذه الطريقة PageBreak المحدّدة.
سيتم تضمين PageBreak في Paragraph جديد.
استخدِم هذا الإصدار من appendPageBreak عند إلحاق نسخة من PageBreak حالي.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
page | Page | تمثّل هذه السمة فاصل الصفحة المطلوب إلحاقه. |
الإرجاع
PageBreak: فاصل الصفحة الملحق
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
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
appendTable()
تنشئ هذه السمة Table جديدة وتلحقها.
ستؤدي هذه الطريقة أيضًا إلى إضافة فقرة فارغة بعد الجدول، لأنّ مستندات "مستندات Google" لا يمكن أن تنتهي بجدول.
الإرجاع
Table: الجدول الجديد
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendTable(cells)
تُلحق هذه السمة Table جديدة تحتوي على TableCell لكل قيمة سلسلة محددة.
ستؤدي هذه الطريقة أيضًا إلى إضافة فقرة فارغة بعد الجدول، لأنّ مستندات "مستندات Google" لا يمكن أن تنتهي بجدول.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
cells | String[][] | محتوى النص في خلايا الجدول الذي سيتم إضافته إلى الجدول الجديد |
الإرجاع
Table: الجدول الملحق
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendTable(table)
تُلحق هذه الطريقة Table المحدّدة.
استخدِم هذا الإصدار من appendTable عند إلحاق نسخة من Table حالي.
ستؤدي هذه الطريقة أيضًا إلى إضافة فقرة فارغة بعد الجدول، لأنّ مستندات "مستندات Google" لا يمكن أن تنتهي بجدول.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
table | Table | الجدول الذي سيتم إلحاقه |
الإرجاع
Table: الجدول الملحق
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
clear()
copy()
تعرض نسخة منفصلة وعميقة من العنصر الحالي.
يتم أيضًا نسخ أي عناصر فرعية مضمّنة في العنصر. لا يحتوي العنصر الجديد على عنصر رئيسي.
الإرجاع
Body: النسخة الجديدة
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
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
getHeadingAttributes(paragraphHeading)
تعرض هذه الطريقة مجموعة السمات الخاصة بـ ParagraphHeading المقدَّم.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
paragraph | Paragraph | العنوان المطلوب استرداد سماته. |
الإرجاع
Object: خريطة للسمات وقيمها الحالية.
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getImages()
يستردّ هذا الإجراء جميع InlineImages الواردة في القسم.
الإرجاع
InlineImage[]|null: صور الأقسام
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getListItems()
يستردّ هذا الإجراء جميع ListItems الواردة في القسم.
الإرجاع
ListItem[]|null: عناصر قائمة الأقسام
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getMarginBottom()
تعرض هذه السمة الهامش السفلي بالنقاط.
الإرجاع
Number|null: الهامش السفلي، بالنقاط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getMarginLeft()
تعرض هذه السمة الهامش الأيسر بالنقاط.
الإرجاع
Number|null: الهامش الأيسر، بالنقاط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getMarginRight()
تعرض هذه السمة الهامش الأيمن.
الإرجاع
Number|null: الهامش الأيمن، بالنقاط
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getMarginTop()
تعرض هذه السمة الهامش العلوي.
الإرجاع
Number|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
getPageHeight()
تعرض هذه السمة ارتفاع الصفحة بالنقاط.
الإرجاع
Number|null: تمثّل ارتفاع الصفحة بالنقاط.
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getPageWidth()
تعرض هذه السمة عرض الصفحة بالنقاط.
الإرجاع
استبدِل Number|null بعرض الصفحة بالنقاط.
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
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
getTables()
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
insertHorizontalRule(childIndex)
تنشئ هذه الطريقة HorizontalRule جديدًا وتُدرجه في الفهرس المحدّد.
سيتم تضمين HorizontalRule في Paragraph جديد.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
child | Integer | الفهرس الذي سيتم إدراج العنصر فيه. |
الإرجاع
HorizontalRule: الخط الأفقي الجديد
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
تنشئ هذه الدالة عنصر InlineImage وتُدرجه من كائن ثنائي كبير الحجم للصورة المحدّدة، وذلك في الفهرس المحدّد.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
child | Integer | الفهرس الذي سيتم إدراج العنصر فيه. |
image | Blob | بيانات الصورة |
الإرجاع
InlineImage: الصورة المضمّنة التي تم إدراجها
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
تُدرِج هذه الدالة InlineImage المحدّدة في الفهرس المحدّد.
سيتم تضمين الصورة في Paragraph جديد.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
child | Integer | الفهرس الذي سيتم إدراج العنصر فيه. |
image | Inline | الصورة المطلوب إدراجها |
الإرجاع
InlineImage: الصورة المضمّنة التي تم إدراجها
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertListItem(childIndex, listItem)
تُدرِج هذه الدالة ListItem المحدّدة في الفهرس المحدّد.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
child | Integer | الفهرس الذي سيتم الإدراج فيه. |
list | List | عنصر القائمة المطلوب إدراجه |
الإرجاع
ListItem: عنصر القائمة الذي تم إدراجه
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertListItem(childIndex, text)
تنشئ هذه الطريقة عنصر ListItem جديدًا وتدرجه في الفهرس المحدّد، على أن يتضمّن محتوى النص المحدّد.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
child | Integer | الفهرس الذي سيتم الإدراج فيه. |
text | String | محتوى النص الخاص بعنصر القائمة |
الإرجاع
ListItem: عنصر القائمة الجديد
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex)
تنشئ هذه الطريقة PageBreak جديدًا وتُدرجه في الفهرس المحدّد.
سيتم تضمين PageBreak في Paragraph جديد.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
child | Integer | الفهرس الذي سيتم إدراج العنصر فيه. |
الإرجاع
PageBreak: فاصل الصفحات الجديد
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex, pageBreak)
تُدرِج هذه الدالة PageBreak المحدّدة في الفهرس المحدّد.
سيتم تضمين PageBreak في Paragraph جديد.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
child | Integer | الفهرس الذي سيتم إدراج العنصر فيه. |
page | Page | تمثّل هذه السمة فاصل الصفحة المطلوب إدراجه. |
الإرجاع
PageBreak: فاصل الصفحة الذي تم إدراجه
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
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
insertTable(childIndex)
تنشئ هذه الطريقة Table جديدًا وتُدرجه في الفهرس المحدّد.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
child | Integer | الفهرس الذي سيتم الإدراج فيه. |
الإرجاع
Table: الجدول الجديد
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertTable(childIndex, cells)
تنشئ هذه الدالة Table جديدًا يحتوي على الخلايا المحدّدة وتُدرجه في الفهرس المحدّد.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
child | Integer | الفهرس الذي سيتم الإدراج فيه. |
cells | String[][] | محتوى النص في خلايا الجدول الذي سيتم إضافته إلى الجدول الجديد |
الإرجاع
Table: الجدول الجديد
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertTable(childIndex, table)
تُدرِج هذه الدالة Table المحدّدة في الفهرس المحدّد.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
child | Integer | الفهرس الذي سيتم الإدراج فيه. |
table | Table | الجدول المطلوب إدراجه |
الإرجاع
Table: الجدول الذي تم إدراجه
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
removeChild(child)
يزيل العنصر الفرعي المحدّد.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
child | Element | عنصر الطفل الذي ستتم إزالته. |
الإرجاع
Body: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
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 | سمات العنصر |
الإرجاع
Body: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setHeadingAttributes(paragraphHeading, attributes)
تضبط هذه الطريقة سمات ParagraphHeading المقدَّمة.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
paragraph | Paragraph | العنوان الذي يجب ضبط سماته |
attributes | Object | خريطة للسمات والقيم التي سيتم ضبطها عليها |
الإرجاع
Body: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setMarginBottom(marginBottom)
تضبط هذه السمة الهامش السفلي بالنقاط.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
margin | Number | الهامش السفلي، بالنقاط |
الإرجاع
Body: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setMarginLeft(marginLeft)
تضبط هذه السمة الهامش الأيسر بالنقاط.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
margin | Number | الهامش الأيسر، بالنقاط |
الإرجاع
Body: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setMarginRight(marginRight)
تضبط هذه السمة الهامش الأيمن بالنقاط.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
margin | Number | الهامش الأيمن |
الإرجاع
Body: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setMarginTop(marginTop)
تضبط هذه السمة الهامش العلوي.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
margin | Number | تمثّل هذه السمة الهامش العلوي بالنقاط. |
الإرجاع
Body: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setPageHeight(pageHeight)
تضبط هذه السمة ارتفاع الصفحة بالنقاط.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
page | Number | تمثّل هذه السمة ارتفاع الصفحة بالنقاط. |
الإرجاع
Body: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setPageWidth(pageWidth)
تضبط هذه السمة عرض الصفحة بالنقاط.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
page | Number | تمثّل هذه السمة عرض الصفحة بالنقاط. |
الإرجاع
Body: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setText(text)
يضبط المحتوى كنص عادي.
ملاحظة: يتم محو المحتوى الحالي.
المعلمات
| الاسم | النوع | الوصف |
|---|---|---|
text | String | محتوى النص الجديد |
الإرجاع
Body: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
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 | نوع محاذاة النص المطلوب تطبيقه |
الإرجاع
Body: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام نطاق واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents