تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

Class TableOfContents

عنصر يحتوي على جدول محتويات. قد يحتوي TableOfContents على العناصر ListItem وParagraph وTable، على الرغم من أنّ محتوى TableOfContents يتم إنشاؤه تلقائيًا عادةً بواسطة "مستندات Google". لمزيد من المعلومات حول بنية المستند، فراجع دليل "مستندات Google"

الطُرق

الطريقة	نوع الإرجاع	وصف قصير
`clear()`	`TableOfContents`	يؤدي إلى محو محتوى العنصر.
`copy()`	`TableOfContents`	لعرض نسخة منفصلة عميقة من العنصر الحالي.
`editAsText()`	`Text`	الحصول على نسخة `Text` من العنصر الحالي للتعديل.
`findElement(elementType)`	`RangeElement`	يبحث في محتوى العنصر عن تابع من النوع المحدد.
`findElement(elementType, from)`	`RangeElement`	يبحث في محتوى العنصر عن تابع من النوع المحدد، بدءًا من تم تحديد `RangeElement`.
`findText(searchPattern)`	`RangeElement`	للبحث في محتويات العنصر عن نمط النص المحدد باستخدام التعبيرات العادية.
`findText(searchPattern, from)`	`RangeElement`	يبحث في محتويات العنصر عن نمط النص المحدد، بدءًا من عنصر نتيجة البحث.
`getAttributes()`	`Object`	يسترد سمات العنصر.
`getChild(childIndex)`	`Element`	استرداد العنصر الفرعي في الفهرس الفرعي المحدد.
`getChildIndex(child)`	`Integer`	استرداد الفهرس الفرعي للعنصر الفرعي المحدد.
`getLinkUrl()`	`String`	يسترد عنوان URL للرابط.
`getNextSibling()`	`Element`	لاسترداد العنصر الشقيق التالي للعنصر.
`getNumChildren()`	`Integer`	لاسترداد عدد الأطفال.
`getParent()`	`ContainerElement`	استرداد العنصر الأصلي للعنصر.
`getPreviousSibling()`	`Element`	لاسترداد العنصر الشقيق السابق للعنصر.
`getText()`	`String`	لاسترداد محتوى العنصر كسلسلة نصية.
`getTextAlignment()`	`TextAlignment`	الحصول على محاذاة النص
`getType()`	`ElementType`	لاسترداد `ElementType` للعنصر.
`isAtDocumentEnd()`	`Boolean`	وتحدِّد ما إذا كان العنصر في نهاية `Document`.
`removeFromParent()`	`TableOfContents`	إزالة العنصر من عنصره الأساسي
`replaceText(searchPattern, replacement)`	`Element`	لاستبدال جميع ورود نمط نص معين بسلسلة استبدال معينة، باستخدام والتعبيرات.
`setAttributes(attributes)`	`TableOfContents`	يعيّن سمات العنصر.
`setLinkUrl(url)`	`TableOfContents`	لضبط عنوان URL للرابط.
`setTextAlignment(textAlignment)`	`TableOfContents`	لضبط محاذاة النص.

الوثائق التفصيلية

`clear()`

يؤدي إلى محو محتوى العنصر.

الإرجاع

TableOfContents — العنصر الحالي

`copy()`

لعرض نسخة منفصلة عميقة من العنصر الحالي.

ويتم أيضًا نسخ أي عناصر فرعية موجودة في العنصر. لا يحتوي العنصر الجديد على أحد الوالدين.

الإرجاع

TableOfContents: النسخة الجديدة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`editAsText()`

الحصول على نسخة Text من العنصر الحالي للتعديل.

استخدام editAsText لمعالجة محتوى العناصر كنص منسق. يتجاهل وضع editAsText العناصر غير النصية (مثل InlineImage وHorizontalRule).

تتم إزالة العناصر الثانوية الموجودة بالكامل داخل نطاق نص محذوف من العنصر.

var 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)`

يبحث في محتوى العنصر عن تابع من النوع المحدد.

المعلمات

الاسم	النوع	الوصف
`elementType`	`ElementType`	نوع العنصر المطلوب البحث عنه.

الإرجاع

RangeElement: نتيجة بحث تشير إلى موضع عنصر البحث

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`findElement(elementType, from)`

يبحث في محتوى العنصر عن تابع من النوع المحدد، بدءًا من تم تحديد RangeElement.

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

المعلمات

الاسم	النوع	الوصف
`elementType`	`ElementType`	نوع العنصر المطلوب البحث عنه.
`from`	`RangeElement`	نتيجة البحث المطلوب البحث منها.

الإرجاع

RangeElement - نتيجة بحث تشير إلى الموضع التالي لعنصر البحث.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`findText(searchPattern)`

للبحث في محتويات العنصر عن نمط النص المحدد باستخدام التعبيرات العادية.

هناك مجموعة فرعية من ميزات التعبير العادي في JavaScript غير متوافقة بالكامل، مثل التقاط المجموعات ومعدِّلات الأوضاع.

تتم مطابقة نمط التعبير العادي المقدَّم بشكل مستقل مع كل جزء نصي الموجودة في العنصر الحالي.

المعلمات

الاسم	النوع	الوصف
`searchPattern`	`String`	النمط للبحث عن

الإرجاع

RangeElement — نتيجة بحث تشير إلى موضع نص البحث أو "فارغ" إذا لم يكن هناك مطابقة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`findText(searchPattern, from)`

يبحث في محتويات العنصر عن نمط النص المحدد، بدءًا من عنصر نتيجة البحث.

تتم مطابقة نمط التعبير العادي المقدَّم بشكل مستقل مع كل جزء نصي الموجودة في العنصر الحالي.

المعلمات

الاسم	النوع	الوصف
`searchPattern`	`String`	النمط للبحث عن
`from`	`RangeElement`	نتيجة البحث للبحث منها

الإرجاع

RangeElement - نتيجة بحث تشير إلى الموضع التالي من نص البحث، أو "فارغة" إذا لم يكن هناك مطابقة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getAttributes()`

يسترد سمات العنصر.

والنتيجة هي كائن يحتوي على خاصية لكل سمة عنصر صالح حيث تكون يتجاوب اسم السمة مع عنصر في التعداد DocumentApp.Attribute.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Append a styled paragraph.
var par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
var atts = par.getAttributes();

// Log the paragraph attributes.
for (var att in atts) {
  Logger.log(att + ":" + atts[att]);
}

الإرجاع

Object — سمات العنصر

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getChild(childIndex)`

استرداد العنصر الفرعي في الفهرس الفرعي المحدد.

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Obtain the first element in the tab.
var 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.");
}

المعلمات

الاسم	النوع	الوصف
`childIndex`	`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

`getLinkUrl()`

يسترد عنوان URL للرابط.

الإرجاع

String: عنوان URL للرابط أو قيمة فارغة إذا كان العنصر يحتوي على قيم متعددة لهذه السمة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getNextSibling()`

لاسترداد العنصر الشقيق التالي للعنصر.

عنصر الشقيق التالي له نفس الأصل ويتبع العنصر الحالي.

الإرجاع

Element — العنصر الشقيق التالي

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getNumChildren()`

لاسترداد عدد الأطفال.

var 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

`getParent()`

استرداد العنصر الأصلي للعنصر.

يحتوي العنصر الأصلي على العنصر الحالي.

الإرجاع

ContainerElement: العنصر الرئيسي

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getPreviousSibling()`

لاسترداد العنصر الشقيق السابق للعنصر.

العنصر الشقيق السابق له نفس العنصر الرئيسي ويسبق العنصر الحالي.

الإرجاع

Element — العنصر الشقيق السابق

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`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 إذا كان النص يحتوي على أنواع متعددة من النص المحاذاة أو إذا لم يتم تعيين محاذاة النص

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getType()`

لاسترداد ElementType للعنصر.

استخدِم getType() لتحديد نوع عنصر معيَّن بالضبط.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Obtain the first element in the active tab's body.

var 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

`isAtDocumentEnd()`

وتحدِّد ما إذا كان العنصر في نهاية Document.

الإرجاع

Boolean: ما إذا كان العنصر في نهاية علامة التبويب.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`removeFromParent()`

إزالة العنصر من عنصره الأساسي

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab()
var body = documentTab.getBody();

// Remove all images in the active tab's body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

الإرجاع

TableOfContents — العنصر الذي تمت إزالته

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`replaceText(searchPattern, replacement)`

لاستبدال جميع ورود نمط نص معين بسلسلة استبدال معينة، باستخدام والتعبيرات.

ويتم تمرير نمط البحث كسلسلة، وليس ككائن تعبير عادي في JavaScript. لهذا السبب، ستحتاج إلى تجنب أي شرطات مائلة للخلف في النمط.

تستخدم هذه الطرق طريقة RE2 العادية من Google. مكتبة التعبيرات، التي تحدّ من البنية المتوافقة.

تتم مطابقة نمط التعبير العادي المقدَّم بشكل مستقل مع كل جزء نصي الموجودة في العنصر الحالي.

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText("^.*Apps ?Script.*$", "Apps Script");

المعلمات

الاسم	النوع	الوصف
`searchPattern`	`String`	نمط التعبير العادي للبحث عن
`replacement`	`String`	النص المطلوب استخدامه كبديل

الإرجاع

Element — العنصر الحالي

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setAttributes(attributes)`

يعيّن سمات العنصر.

يجب أن تكون معلَمة السمات المحدّدة كائنًا يكون فيه كل اسم سمة عنصرًا في عدد DocumentApp.Attribute وكل قيمة خاصية هي القيمة الجديدة التي يجب المنهجية.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Define a custom paragraph style.
var 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.
var par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

المعلمات

الاسم	النوع	الوصف
`attributes`	`Object`	سمات العنصر.

الإرجاع

TableOfContents — العنصر الحالي

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setLinkUrl(url)`

لضبط عنوان URL للرابط.

المعلمات

الاسم	النوع	الوصف
`url`	`String`	عنوان URL للرابط

الإرجاع

TableOfContents — العنصر الحالي

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:

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.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

المعلمات

الاسم	النوع	الوصف
`textAlignment`	`TextAlignment`	نوع محاذاة النص لتطبيقه

الإرجاع

TableOfContents — العنصر الحالي

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents