عنصر يمثّل عنصر قائمة List
هو Paragraph
مرتبط
برقم تعريف قائمة. يمكن أن يحتوي عنصر List
على عناصر Equation
وFootnote
وHorizontal
وInline
وInline
وPage
وText
. لمزيد من المعلومات عن بنية المستند، يُرجى الاطّلاع على دليل توسيع نطاق "مستندات Google".
لا يمكن أن يحتوي List
على أحرف سطر جديد. يتم تحويل أحرف سطر جديد ("\n")
إلى أحرف فاصل سطر ("\r").
إنّ List
التي تحمل معرّف القائمة نفسه تنتمي إلى القائمة نفسها ويتم ترقيمها وفقًا لذلك.
ليس من الضروري أن تكون علامات List
لقائمة معيّنة متجاورة في علامة التبويب أو أن تتضمّن
العنصر الرئيسي نفسه. يمكن أن يكون هناك عنصران ينتميان إلى القائمة نفسها في أي مكان في علامة التبويب مع
الحفاظ على التسلسل، كما يوضّح المثال التالي:
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Append a new list item to the body. const item1 = body.appendListItem('Item 1'); // Log the new list item's list ID. Logger.log(item1.getListId()); // Append a table after the list item. body.appendTable([['Cell 1', 'Cell 2']]); // Append a second list item with the same list ID. The two items are treated as // the same list, despite not being consecutive. const item2 = body.appendListItem('Item 2'); item2.setListId(item1);
الطُرق
الطريقة | نوع القيمة التي يتم عرضها | وصف قصير |
---|---|---|
add | Positioned | لإنشاء Positioned جديد وإدراجه من قطعة البيانات المحدّدة للصورة |
append | Horizontal | لإنشاء Horizontal جديد وإضافته |
append | Inline | لإنشاء Inline جديد وإضافته من قطعة الصورة المحدّدة |
append | Inline | إلحاق Inline المحدَّد |
append | Page | لإنشاء Page جديد وإضافته |
append | Page | إلحاق Page المحدَّد |
append | Text | لإنشاء عنصر Text جديد وإضافته مع المحتوى المحدّد |
append | Text | إلحاق عنصر Text المحدّد |
clear() | List | تمحو محتويات العنصر. |
copy() | List | تعرِض نسخة مفصَّلة ومُفصَّلة من العنصر الحالي. |
edit | Text | الحصول على نسخة Text من العنصر الحالي لتعديلها |
find | Range | تبحث في محتوى العنصر عن سلف من النوع المحدّد. |
find | Range | تبحث في محتويات العنصر عن عنصر فرعي من النوع المحدّد، بدءًا منRange المحدّد. |
find | Range | تبحث في محتوى العنصر عن النمط النصي المحدّد باستخدام التعبيرات العادية. |
find | Range | البحث في محتوى العنصر عن نمط النص المحدّد، بدءًا من نتيجة بحث معيّنة |
get | Horizontal | استرجاع Horizontal |
get | Object | يسترجع سمات العنصر. |
get | Element | يسترجع العنصر الفرعي في فهرس العنصر الفرعي المحدّد. |
get | Integer | يسترجع فهرس العنصر الفرعي للعنصر الفرعي المحدّد. |
get | Glyph | يستردّ Glyph لعنصر القائمة. |
get | Paragraph | استرجاع Paragraph |
get | Number | يسترجع المسافة البادئة للنهاية، بالنقاط. |
get | Number | استرداد مسافة بادئة السطر الأول، بالنقاط |
get | Number | يسترجع المسافة البادئة للبدء. |
get | Number | يسترجع تباعد الأسطر، بالنقاط. |
get | String | يستردّ عنوان URL للرابط. |
get | String | استرداد معرّف القائمة |
get | Integer | يسترجع مستوى دمج عنصر القائمة. |
get | Element | يسترجع العنصر الشقيق التالي للعنصر. |
get | Integer | يسترجع عدد الأطفال. |
get | Container | يسترجع العنصر الرئيسي للعنصر. |
get | Positioned | الحصول على Positioned حسب معرّف الصورة |
get | Positioned | الحصول على جميع عناصر Positioned المرتبطة بالفقرة |
get | Element | يسترجع العنصر الشقيق السابق للعنصر. |
get | Number | يسترجع التباعد بعد العنصر، بالنقاط. |
get | Number | يسترجع المسافة قبل العنصر، بوحدة النقاط. |
get | String | يسترجع محتوى العنصر كسلسلة نصية. |
get | Text | الحصول على محاذاة النص |
get | Element | يسترجع Element للعنصر. |
insert | Horizontal | تُنشئ هذه الدالة رمز Horizontal وتُدرجه في الفهرس المحدّد. |
insert | Inline | تُنشئ هذه الدالة Inline جديدة وتُدرجها من قطعة البيانات المحدّدة للصورة، في الترتيب المحدد. |
insert | Inline | تُدرج Inline المحدّدة في الفهرس المحدّد. |
insert | Page | لإنشاء Page جديدة وإدراجها في الفهرس المحدّد |
insert | Page | تُدرج Page المحدّدة في الفهرس المحدّد. |
insert | Text | لإنشاء عنصر نصي جديد وإدراجه في الفهرس المحدّد |
insert | Text | تُدرِج هذه الدالة عنصر Text المحدَّد في الفهرس المحدَّد، مع محتوى النص المُحدَّد. |
is | Boolean | لتحديد ما إذا كان العنصر في نهاية Document |
is | Boolean | يسترجع الإعداد من اليمين إلى اليسار. |
merge() | List | دمج العنصر مع العنصر الشقيق السابق من النوع نفسه |
remove | List | تزيل العنصر الفرعي المحدّد. |
remove | List | تزيل العنصر من العنصر الرئيسي. |
remove | Boolean | تزيل Positioned حسب رقم تعريف الصورة. |
replace | Element | لاستبدال جميع مظاهر نمط نصي معيّن بسلسلة بديل معيّنة، باستخدام تعبيرات عادية. |
set | List | لضبط Horizontal |
set | List | تُستخدَم لضبط سمات العنصر. |
set | List | لضبط Glyph لعنصر القائمة |
set | List | لضبط Paragraph |
set | List | لضبط المسافة البادئة للنهاية، بالنقاط |
set | List | تُستخدَم لضبط المسافة البادئة للسطر الأول، بوحدة النقاط. |
set | List | تُستخدَم لضبط المسافة البادئة للفقرة، بوحدة النقاط. |
set | List | لضبط الإعداد من اليمين إلى اليسار |
set | List | لضبط تباعد الأسطر، ككمية تشير إلى عدد الأسطر التي سيتم استخدامها للتباعد |
set | List | لضبط عنوان URL للرابط |
set | List | لضبط معرّف القائمة. |
set | List | لضبط مستوى دمج عنصر القائمة |
set | List | لضبط التباعد بعد العنصر، بوحدة النقاط |
set | List | لضبط المسافة قبل العنصر، بالنقاط |
set | void | لضبط محتوى عنصر القائمة على أنّه نص |
set | List | لضبط محاذاة النص |
مستندات تفصيلية
add Positioned Image(image)
لإنشاء Positioned
جديد وإدراجه من قطعة البيانات المحدّدة للصورة
المعلمات
الاسم | النوع | الوصف |
---|---|---|
image | Blob | بيانات الصورة |
الإرجاع
Positioned
: الصورة الجديدة التي تمّ وضعها
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Horizontal Rule()
لإنشاء Horizontal
جديد وإضافته
الإرجاع
Horizontal
- الخط الأفقي الجديد
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Inline Image(image)
لإنشاء Inline
جديد وإضافته من قطعة الصورة المحدّدة
المعلمات
الاسم | النوع | الوصف |
---|---|---|
image | Blob | بيانات الصورة |
الإرجاع
Inline
: الصورة المُرفَقة
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Inline Image(image)
إلحاق Inline
المحدَّد
المعلمات
الاسم | النوع | الوصف |
---|---|---|
image | Inline | بيانات الصورة |
الإرجاع
Inline
: الصورة المُرفَقة
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Page Break()
لإنشاء Page
جديد وإضافته
ملاحظة: قد لا يكون Page
مضمّنًا في Table
.
إذا كان العنصر الحالي مضمّنًا في خلية جدول، سيتم طرح استثناء.
الإرجاع
Page
- عنصر فاصل الصفحة الجديد
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Page Break(pageBreak)
إلحاق Page
المحدَّد
ملاحظة: قد لا يكون Page
مضمّنًا في Table
.
إذا كان العنصر الحالي مضمّنًا في خلية جدول، سيتم طرح استثناء.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
page | Page | فاصل الصفحة المطلوب إلحاقه |
الإرجاع
Page
- عنصر فاصل الصفحة المُلحَق
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Text(text)
لإنشاء عنصر Text
جديد وإضافته مع المحتوى المحدّد
المعلمات
الاسم | النوع | الوصف |
---|---|---|
text | String | محتوى النص |
الإرجاع
Text
: عنصر النص الجديد
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Text(text)
إلحاق عنصر Text
المحدّد
المعلمات
الاسم | النوع | الوصف |
---|---|---|
text | Text | عنصر النص المطلوب إلحاقه |
الإرجاع
Text
- عنصر النص المُرفَق
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
copy()
تعرِض نسخة مفصَّلة ومُفصَّلة من العنصر الحالي.
ويتم أيضًا نسخ أي عناصر فرعية متوفّرة في العنصر. لا يحتوي العنصر الجديد على عنصر رئيسي.
الإرجاع
List
: النسخة الجديدة
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
edit As Text()
الحصول على نسخة Text
من العنصر الحالي لتعديلها
استخدِم edit
لتعديل محتوى العناصر كنص منسق. يتجاهل وضع edit
العناصر غير النصية (مثل Inline
وHorizontal
).
تتم إزالة العناصر الفرعية المضمّنة بالكامل ضمن نطاق نص تم حذفه من العنصر.
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
: نسخة نصية للعنصر الحالي
find Element(elementType)
تبحث في محتوى العنصر عن سلف من النوع المحدّد.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
element | Element | نوع العنصر المطلوب البحث عنه |
الإرجاع
Range
- نتيجة بحث تشير إلى موضع عنصر البحث
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
find Element(elementType, from)
تبحث في محتويات العنصر عن عنصر فرعي من النوع المحدّد، بدءًا منRange
المحدّد.
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 | نتيجة البحث التي تريد البحث منها |
الإرجاع
Range
: نتيجة بحث تشير إلى الموضع التالي لعنصر البحث
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
find Text(searchPattern)
تبحث في محتوى العنصر عن النمط النصي المحدّد باستخدام التعبيرات العادية.
لا تتوفّر مجموعة فرعية من ميزات التعبير العادي في JavaScript بالكامل، مثل مجموعات الالتقاط وعوامل تعديل الوضع.
تتم مطابقة نمط التعبير العادي المقدَّم بشكل مستقل مع كلّ كتلة نص مضمّنة في العنصر الحالي.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
search | String | النمط المطلوب البحث عنه |
الإرجاع
Range
: نتيجة بحث تشير إلى موضع نص البحث، أو قيمة فارغة في حال عدم توفّر
مطابقة
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
find Text(searchPattern, from)
البحث في محتوى العنصر عن نمط النص المحدّد، بدءًا من نتيجة بحث معيّنة
لا تتوفّر مجموعة فرعية من ميزات التعبير العادي في JavaScript بالكامل، مثل مجموعات الالتقاط وعوامل تعديل الوضع.
تتم مطابقة نمط التعبير العادي المقدَّم بشكل مستقل مع كلّ كتلة نص مضمّنة في العنصر الحالي.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
search | String | النمط المطلوب البحث عنه |
from | Range | نتيجة البحث التي تريد البحث منها |
الإرجاع
Range
: نتيجة بحث تشير إلى الموضع التالي لنص البحث، أو قيمة فارغة في حال عدم توفّر مطابقة
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Alignment()
استرجاع Horizontal
الإرجاع
Horizontal
- المحاذاة
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
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 Child(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
get Child Index(child)
يسترجع فهرس العنصر الفرعي للعنصر الفرعي المحدّد.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
child | Element | العنصر الفرعي الذي يتم استرداد الفهرس له. |
الإرجاع
Integer
- فهرس الطفل
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Glyph Type()
get Heading()
استرجاع Paragraph
الإرجاع
Paragraph
: العنوان
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Indent End()
يسترجع المسافة البادئة للنهاية، بالنقاط.
الإرجاع
Number
- المسافة البادئة للنهاية، بالنقاط
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Indent First Line()
استرداد مسافة بادئة السطر الأول، بالنقاط
الإرجاع
Number
: المسافة البادئة للسطر الأول، بالنقاط
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Indent Start()
يسترجع المسافة البادئة للبدء.
الإرجاع
Number
- المسافة البادئة الأولى
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Line Spacing()
يسترجع تباعد الأسطر، بالنقاط.
الإرجاع
Number
: تباعد الأسطر، بالنقاط
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Link Url()
يستردّ عنوان URL للرابط.
الإرجاع
String
: عنوان URL للرابط، أو قيمة فارغة إذا كان العنصر يحتوي على قيم متعددة لهذه السمة
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get List Id()
استرداد معرّف القائمة
الإرجاع
String
- رقم تعريف القائمة
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Nesting Level()
يسترجع مستوى دمج عنصر القائمة.
يكون مستوى دمج عناصر القائمة تلقائيًا صفرًا. يحدِّد مستوى التداخل الرمز المميّز الذي يستخدمه عنصر القائمة.
الإرجاع
Integer
- مستوى التداخل
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Next Sibling()
يسترجع العنصر الشقيق التالي للعنصر.
يتضمّن الشقيق التالي العنصر الرئيسي نفسه ويتبع العنصر الحالي.
الإرجاع
Element
: العنصر الشقيق التالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Num Children()
يسترجع عدد الأطفال.
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
get Parent()
يسترجع العنصر الرئيسي للعنصر.
يحتوي العنصر الرئيسي على العنصر الحالي.
الإرجاع
Container
: العنصر الرئيسي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Positioned Image(id)
الحصول على Positioned
حسب معرّف الصورة
المعلمات
الاسم | النوع | الوصف |
---|---|---|
id | String | معرّف الصورة |
الإرجاع
Positioned
: الصورة المُعدّة
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Positioned Images()
الحصول على جميع عناصر Positioned
المرتبطة بالفقرة
الإرجاع
Positioned
: قائمة بالصور التي تم تحديد مواضعها
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Previous Sibling()
يسترجع العنصر الشقيق السابق للعنصر.
يتضمّن العنصر الشقيق السابق العنصر الرئيسي نفسه ويسبق العنصر الحالي.
الإرجاع
Element
: العنصر الشقيق السابق
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Spacing After()
يسترجع التباعد بعد العنصر، بالنقاط.
الإرجاع
Number
- التباعد بعد العنصر، بالنقاط
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Spacing Before()
يسترجع المسافة قبل العنصر، بوحدة النقاط.
الإرجاع
Number
: التباعد قبل العنصر، بالنقاط
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Text()
يسترجع محتوى العنصر كسلسلة نصية.
الإرجاع
String
: محتوى العنصر بتنسيق سلسلة نصية
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Text Alignment()
الحصول على محاذاة النص الأنواع المتاحة للمحاذاة هي Document
وDocument
وDocument
.
الإرجاع
Text
: نوع محاذاة النص، أو 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
insert Horizontal Rule(childIndex)
تُنشئ هذه الدالة رمز Horizontal
وتُدرجه في الفهرس المحدّد.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
child | Integer | الفهرس الذي سيتم إدراج العنصر فيه |
الإرجاع
Horizontal
- عنصر الخط الأفقي الجديد
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Inline Image(childIndex, image)
تُنشئ هذه الدالة Inline
جديدة وتُدرجها من قطعة البيانات المحدّدة للصورة، في الترتيب المحدد.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
child | Integer | الفهرس الذي سيتم إدراج العنصر فيه |
image | Blob | بيانات الصورة |
الإرجاع
Inline
: عنصر الصورة المضمّنة المُدرَج
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Inline Image(childIndex, image)
تُدرج Inline
المحدّدة في الفهرس المحدّد.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
child | Integer | الفهرس الذي سيتم إدراج العنصر فيه |
image | Inline | بيانات الصورة |
الإرجاع
Inline
: عنصر الصورة المضمّنة المُدرَج
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Page Break(childIndex)
لإنشاء Page
جديدة وإدراجها في الفهرس المحدّد
ملاحظة: قد لا يكون Page
مضمّنًا في Table
.
إذا كان العنصر الحالي مضمّنًا في خلية جدول، سيتم طرح استثناء.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
child | Integer | الفهرس الذي سيتم إدراج العنصر فيه |
الإرجاع
Page
- عنصر فاصل الصفحة الجديد
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Page Break(childIndex, pageBreak)
تُدرج Page
المحدّدة في الفهرس المحدّد.
ملاحظة: قد لا يكون Page
مضمّنًا في Table
.
إذا كان العنصر الحالي مضمّنًا في خلية جدول، سيتم طرح استثناء.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
child | Integer | الفهرس الذي سيتم إدراج العنصر فيه |
page | Page | فاصل الصفحة المطلوب إدراجه |
الإرجاع
Page
- عنصر فاصل الصفحة المُدرَج
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Text(childIndex, text)
لإنشاء عنصر نصي جديد وإدراجه في الفهرس المحدّد
المعلمات
الاسم | النوع | الوصف |
---|---|---|
child | Integer | الفهرس الذي سيتم إدراج العنصر فيه |
text | String | محتوى النص |
الإرجاع
Text
: عنصر النص الجديد
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Text(childIndex, text)
تُدرِج هذه الدالة عنصر Text
المحدَّد في الفهرس المحدَّد، مع محتوى النص المُحدَّد.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
child | Integer | الفهرس الذي سيتم إدراج العنصر فيه |
text | Text | عنصر النص المطلوب إدراجه |
الإرجاع
Text
: عنصر النص المُدرج
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
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
is Left To Right()
يسترجع الإعداد من اليمين إلى اليسار.
الإرجاع
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();
الإرجاع
List
: العنصر المدمج
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
remove Child(child)
تزيل العنصر الفرعي المحدّد.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
child | Element | العنصر الفرعي المطلوب إزالته |
الإرجاع
List
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
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(); }
الإرجاع
List
: العنصر الذي تمّت إزالته
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
remove Positioned Image(id)
تزيل Positioned
حسب رقم تعريف الصورة.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
id | String |
الإرجاع
Boolean
- ما إذا تمت إزالة الصورة المحدّدة أم لا
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replace Text(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
set Alignment(alignment)
لضبط Horizontal
المعلمات
الاسم | النوع | الوصف |
---|---|---|
alignment | Horizontal | المحاذاة الأفقية |
الإرجاع
List
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
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 | سمات العنصر |
الإرجاع
List
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Glyph Type(glyphType)
لضبط Glyph
لعنصر القائمة
المعلمات
الاسم | النوع | الوصف |
---|---|---|
glyph | Glyph | نوع الحرف الرسومي |
الإرجاع
List
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Heading(heading)
لضبط Paragraph
المعلمات
الاسم | النوع | الوصف |
---|---|---|
heading | Paragraph | العنوان |
الإرجاع
List
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Indent End(indentEnd)
لضبط المسافة البادئة للنهاية، بالنقاط
المعلمات
الاسم | النوع | الوصف |
---|---|---|
indent | Number | المسافة البادئة للنهاية، بالنقاط |
الإرجاع
List
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Indent First Line(indentFirstLine)
تُستخدَم لضبط المسافة البادئة للسطر الأول، بوحدة النقاط.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
indent | Number | المسافة البادئة للسطر الأول، بالنقاط |
الإرجاع
List
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Indent Start(indentStart)
تُستخدَم لضبط المسافة البادئة للفقرة، بوحدة النقاط.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
indent | Number | المسافة البادئة الأولى، بالنقاط |
الإرجاع
List
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Left To Right(leftToRight)
لضبط الإعداد من اليمين إلى اليسار
المعلمات
الاسم | النوع | الوصف |
---|---|---|
left | Boolean | إعداد "من اليسار إلى اليمين" |
الإرجاع
List
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Line Spacing(multiplier)
لضبط تباعد الأسطر، ككمية تشير إلى عدد الأسطر التي سيتم استخدامها للتباعد
المعلمات
الاسم | النوع | الوصف |
---|---|---|
multiplier | Number | عدد الأسطر |
الإرجاع
List
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Link Url(url)
لضبط عنوان URL للرابط
المعلمات
الاسم | النوع | الوصف |
---|---|---|
url | String | عنوان URL للرابط |
الإرجاع
List
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set List Id(listItem)
لضبط معرّف القائمة.
يتم ضبط رقم تعريف القائمة على القيمة نفسها List
المحدّدة. سيتم التعامل مع List
على أنّهما عضوان في القائمة نفسها.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
list | List | عنصر القائمة الذي يجب استخدام رقم تعريفه |
الإرجاع
List
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Nesting Level(nestingLevel)
لضبط مستوى دمج عنصر القائمة
يكون مستوى دمج عناصر القائمة تلقائيًا صفرًا. يحدِّد مستوى التداخل الرمز المميّز الذي يستخدمه عنصر القائمة.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
nesting | Integer | مستوى التداخل |
الإرجاع
List
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Spacing After(spacingAfter)
لضبط التباعد بعد العنصر، بوحدة النقاط
المعلمات
الاسم | النوع | الوصف |
---|---|---|
spacing | Number | التباعد بعد العنصر، بالنقاط |
الإرجاع
List
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Spacing Before(spacingBefore)
لضبط المسافة قبل العنصر، بالنقاط
المعلمات
الاسم | النوع | الوصف |
---|---|---|
spacing | Number | المسافة قبل العنصر، بالنقاط |
الإرجاع
List
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Text(text)
لضبط محتوى عنصر القائمة على أنّه نص
ملاحظة: يتم محو المحتوى الحالي.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
text | String | محتوى النصوص الجديدة |
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Text Alignment(textAlignment)
لضبط محاذاة النص الأنواع المتاحة للمحاذاة هي Document
وDocument
وDocument
.
// 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 | نوع محاذاة النص المطلوب تطبيقها |
الإرجاع
List
: العنصر الحالي
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents