Class FootnoteSection

حاشية سفلية

عنصر يمثّل قسمًا للحاشية السفلية يحتوي FootnoteSection على النص المتوافق مع Footnote. قد تتضمن FootnoteSection العناصر ListItem أو Paragraph. لمزيد من المعلومات حول بنية المستند، يُرجى الاطّلاع على دليل توسيع نطاق "مستندات Google".

الطُرق

الطريقةنوع الإرجاعوصف قصير
appendParagraph(paragraph)Paragraphلإلحاق Paragraph المُقدَّم.
appendParagraph(text)Paragraphإنشاء Paragraph جديدة وإلحاقها بمحتوى النص المحدّد.
clear()FootnoteSectionمحو محتوى العنصر.
copy()FootnoteSectionعرض نسخة منفصلة من العنصر الحالي بشكل منفصل.
editAsText()Textللحصول على نسخة Text من العنصر الحالي للتعديل.
findElement(elementType)RangeElementيبحث في محتوى العنصر الفرعي عن النوع المحدّد.
findElement(elementType, from)RangeElementيبحث في محتوى العنصر الفرعي من النوع المحدّد، بدءًا من RangeElement المحدّد.
findText(searchPattern)RangeElementيبحث في محتوى العنصر عن نمط النص المحدّد باستخدام التعبيرات العادية.
findText(searchPattern, from)RangeElementيبحث في محتوى العنصر عن نمط النص المحدَّد، بدءًا من نتيجة بحث معيّنة.
getAttributes()Objectلاسترداد سمات العنصر\u39s.
getChild(childIndex)Elementلاسترداد العنصر الفرعي في الفهرس الفرعي المحدد.
getChildIndex(child)Integerلاسترداد الفهرس الفرعي للعنصر الفرعي المحدد.
getNextSibling()Elementلاسترداد العنصر التالي.
getNumChildren()Integerلاسترداد عدد العناصر الثانوية
getParagraphs()Paragraph[]لاسترداد كل Paragraphs المضمنة في القسم (بما في ذلك ListItems).
getParent()ContainerElementلاسترداد العنصر الرئيسي للعنصر.
getPreviousSibling()Elementلاسترجاع العنصر السابق الذي يشبه العنصر نفسه.
getText()Stringلاسترداد محتوى العنصر كسلسلة نصية.
getTextAlignment()TextAlignmentلمحاذاة النص.
getType()ElementTypeلاسترداد العنصر ElementType's.
insertParagraph(childIndex, paragraph)Paragraphإدراج Paragraph المحددة في الفهرس المحدد.
insertParagraph(childIndex, text)Paragraphلإنشاء Paragraph جديدة وإدراجها في الفهرس المحدّد، مع تضمين محتوى النص المحدّد.
removeChild(child)FootnoteSectionإزالة العنصر الفرعي المحدد.
removeFromParent()FootnoteSectionإزالة العنصر من العنصر الرئيسي.
replaceText(searchPattern, replacement)Elementاستبدال جميع تكرارات نمط نص معين بسلسلة استبدال محددة، باستخدام التعبيرات العادية.
setAttributes(attributes)FootnoteSectionتحدد سمات العنصر\u39;s.
setText(text)FootnoteSectionلضبط المحتوى كنص عادي
setTextAlignment(textAlignment)FootnoteSectionلضبط محاذاة النص.

المستندات التفصيلية

appendParagraph(paragraph)

لإلحاق Paragraph المُقدَّم.

يمكنك استخدام هذا الإصدار من appendParagraph عند إلحاق نسخة من Paragraph حالية.

المعلّمات

الاسمالنوعالوصف
paragraphParagraphالفقرة المطلوب إلحاقها

تذكرة ذهاب وعودة

Paragraph — الفقرة الملحقة

التفويض

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

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

appendParagraph(text)

إنشاء Paragraph جديدة وإلحاقها بمحتوى النص المحدّد.

المعلّمات

الاسمالنوعالوصف
textStringمحتوى النص في الفقرة

تذكرة ذهاب وعودة

Paragraph - الفقرة الجديدة

التفويض

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

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

clear()

محو محتوى العنصر.

تذكرة ذهاب وعودة

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

copy()

عرض نسخة منفصلة من العنصر الحالي بشكل منفصل.

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

تذكرة ذهاب وعودة

FootnoteSection — النسخة الجديدة:

التفويض

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

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

editAsText()

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

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

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

var body = DocumentApp.getActiveDocument().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)

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

المعلّمات

الاسمالنوعالوصف
elementTypeElementTypeنوع العنصر المطلوب البحث عنه

تذكرة ذهاب وعودة

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

التفويض

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

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

findElement(elementType, from)

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

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().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;
  }
}

المعلّمات

الاسمالنوعالوصف
elementTypeElementTypeنوع العنصر المطلوب البحث عنه
fromRangeElementنتيجة البحث للبحث من

تذكرة ذهاب وعودة

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

التفويض

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

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

findText(searchPattern)

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

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

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

المعلّمات

الاسمالنوعالوصف
searchPatternStringالنمط المطلوب البحث عنه

تذكرة ذهاب وعودة

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

التفويض

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

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

findText(searchPattern, from)

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

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

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

المعلّمات

الاسمالنوعالوصف
searchPatternStringالنمط المطلوب البحث عنه
fromRangeElementنتيجة البحث للبحث من

تذكرة ذهاب وعودة

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

التفويض

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

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

getAttributes()

لاسترداد سمات العنصر\u39s.

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

var body = DocumentApp.getActiveDocument().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)

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

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

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

المعلّمات

الاسمالنوعالوصف
childIndexIntegerفهرس العنصر الفرعي لاسترداده

تذكرة ذهاب وعودة

Element — العنصر الفرعي في الفهرس المحدد

التفويض

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

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

getChildIndex(child)

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

المعلّمات

الاسمالنوعالوصف
childElementالعنصر الفرعي الذي سيتم استرداد الفهرس له

تذكرة ذهاب وعودة

Integer — الفهرس الفرعي

التفويض

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

  • 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()

لاسترداد عدد العناصر الثانوية 

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Log the number of elements in the document.
Logger.log("There are " + body.getNumChildren() +
    " elements in the document body.");

تذكرة ذهاب وعودة

Integer — عدد الأطفال

التفويض

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

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

getParagraphs()

لاسترداد كل Paragraphs المضمنة في القسم (بما في ذلك ListItems).

تذكرة ذهاب وعودة

Paragraph[] — فقرات القسم

التفويض

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

  • 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's.

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

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

// Obtain the first element in the document 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

insertParagraph(childIndex, paragraph)

إدراج Paragraph المحددة في الفهرس المحدد.

المعلّمات

الاسمالنوعالوصف
childIndexIntegerالفهرس الذي سيتم إدراجه
paragraphParagraphالفقرة المطلوب إدراجها

تذكرة ذهاب وعودة

Paragraph — الفقرة المُدرَجة

التفويض

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

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

insertParagraph(childIndex, text)

لإنشاء Paragraph جديدة وإدراجها في الفهرس المحدّد، مع تضمين محتوى النص المحدّد.

المعلّمات

الاسمالنوعالوصف
childIndexIntegerالفهرس الذي سيتم إدراجه
textStringمحتوى النص في الفقرة

تذكرة ذهاب وعودة

Paragraph - الفقرة الجديدة

التفويض

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

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

removeChild(child)

إزالة العنصر الفرعي المحدد.

المعلّمات

الاسمالنوعالوصف
childElementالعنصر الفرعي المطلوب إزالته

تذكرة ذهاب وعودة

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

التفويض

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

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

removeFromParent()

إزالة العنصر من العنصر الرئيسي. 

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

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

تذكرة ذهاب وعودة

FootnoteSection - العنصر الذي تمت إزالته

التفويض

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

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

replaceText(searchPattern, replacement)

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

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

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

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

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

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

المعلّمات

الاسمالنوعالوصف
searchPatternStringنمط التعبير العادي للبحث عن
replacementStringالنص المطلوب استخدامه كبديل

تذكرة ذهاب وعودة

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

التفويض

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

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

setAttributes(attributes)

تحدد سمات العنصر\u39;s.

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

var body = DocumentApp.getActiveDocument().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);

المعلّمات

الاسمالنوعالوصف
attributesObjectسمات العنصر\39;s.

تذكرة ذهاب وعودة

FootnoteSection — العنصر الحالي.

التفويض

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

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

setText(text)

لضبط المحتوى كنص عادي

ملاحظة: يتم محو المحتوى الحالي.

المعلّمات

الاسمالنوعالوصف
textStringالمحتوى النصي الجديد

تذكرة ذهاب وعودة

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

المعلّمات

الاسمالنوعالوصف
textAlignmentTextAlignmentنوع محاذاة النص المراد تطبيقه

تذكرة ذهاب وعودة

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

التفويض

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

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

الطرق التي تم إيقافها نهائيًا