Class FootnoteSection

بخش پاورقی

عنصری که نشان‌دهنده‌ی یک بخش پاورقی است. Footnote Section شامل متنی است که با یک Footnote مطابقت دارد. Footnote Section ممکن است شامل عناصر List Item یا Paragraph باشد. برای اطلاعات بیشتر در مورد ساختار سند، به راهنمای توسعه‌ی Google Docs مراجعه کنید.

روش‌ها

روش نوع بازگشتی شرح مختصر
append Paragraph(paragraph) Paragraph Paragraph داده شده را اضافه می‌کند.
append Paragraph(text) Paragraph یک Paragraph جدید حاوی محتوای متن مشخص شده ایجاد و اضافه می‌کند.
clear() Footnote Section محتویات عنصر را پاک می‌کند.
copy() Footnote Section یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
edit As Text() Text یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می‌کند.
find Element(elementType) Range Element |null محتویات عنصر را برای یافتن نسلی از نوع مشخص شده جستجو می‌کند.
find Element(elementType, from) Range Element |null محتویات عنصر را برای یافتن نسلی از نوع مشخص شده، با شروع از Range Element مشخص شده، جستجو می‌کند.
find Text(searchPattern) Range Element |null با استفاده از عبارات منظم، محتوای عنصر را برای الگوی متنی مشخص شده جستجو می‌کند.
find Text(searchPattern, from) Range Element |null با شروع از یک نتیجه جستجوی داده شده، محتویات عنصر را برای الگوی متنی مشخص شده جستجو می‌کند.
get Attributes() Object ویژگی‌های عنصر را بازیابی می‌کند.
get Child(childIndex) Element عنصر فرزند را در اندیس فرزند مشخص شده بازیابی می‌کند.
get Child Index(child) Integer اندیس فرزند را برای عنصر فرزند مشخص شده بازیابی می‌کند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Num Children() Integer تعداد فرزندان را بازیابی می‌کند.
get Paragraphs() Paragraph[] |null تمام Paragraphs موجود در بخش (شامل List Items ) را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Text() String محتوای عنصر را به صورت یک رشته متنی بازیابی می‌کند.
get Text Alignment() Text Alignment |null ترازبندی متن را دریافت می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
insert Paragraph(childIndex, paragraph) Paragraph Paragraph داده شده را در اندیس مشخص شده درج می‌کند.
insert Paragraph(childIndex, text) Paragraph یک Paragraph جدید ایجاد و در فهرست مشخص شده درج می‌کند که حاوی محتوای متن مشخص شده است.
remove Child(child) Footnote Section عنصر فرزند مشخص شده را حذف می‌کند.
remove From Parent() Footnote Section |null عنصر را از والدش حذف می‌کند.
replace Text(searchPattern, replacement) Element با استفاده از عبارات منظم، تمام موارد تکرار یک الگوی متنی مشخص را با یک رشته جایگزین مشخص جایگزین می‌کند.
set Attributes(attributes) Footnote Section ویژگی‌های عنصر را تنظیم می‌کند.
set Text(text) Footnote Section محتوا را به صورت متن ساده تنظیم می‌کند.
set Text Alignment(textAlignment) Footnote Section ترازبندی متن را تنظیم می‌کند.

مستندات دقیق

append Paragraph(paragraph)

Paragraph داده شده را اضافه می‌کند.

از این نسخه از append Paragraph هنگام اضافه کردن یک کپی از یک Paragraph موجود استفاده کنید.

پارامترها

نام نوع توضیحات
paragraph Paragraph پاراگرافی که باید اضافه شود.

بازگشت

Paragraph - پاراگراف ضمیمه شده.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

append Paragraph(text)

یک Paragraph جدید حاوی محتوای متن مشخص شده ایجاد و اضافه می‌کند.

پارامترها

نام نوع توضیحات
text String محتوای متن پاراگراف.

بازگشت

Paragraph - پاراگراف جدید.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

clear()

محتویات عنصر را پاک می‌کند.

بازگشت

Footnote Section - عنصر فعلی.

copy()

یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.

هر عنصر فرزندی که در عنصر وجود داشته باشد نیز کپی می‌شود. عنصر جدید والد ندارد.

بازگشت

Footnote Section - نسخه جدید.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

edit As Text()

یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می‌کند.

edit As Text برای دستکاری محتوای عناصر به عنوان متن غنی استفاده کنید. حالت edit As Text عناصر غیر متنی (مانند Inline Image و Horizontal Rule ) را نادیده می‌گیرد.

عناصر فرزندی که کاملاً در محدوده متن حذف شده قرار دارند، از عنصر حذف می‌شوند.

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 Type Element Type نوع عنصری که باید جستجو شود.

بازگشت

Range Element |null — نتیجه جستجو که موقعیت عنصر جستجو را نشان می‌دهد.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

find Element(elementType, from)

محتویات عنصر را برای یافتن نسلی از نوع مشخص شده، با شروع از Range Element مشخص شده، جستجو می‌کند.

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 Type Element Type نوع عنصری که باید جستجو شود.
from Range Element نتیجه جستجو برای جستجو از.

بازگشت

Range Element |null — نتیجه جستجو که موقعیت بعدی عنصر جستجو را نشان می‌دهد.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

find Text(searchPattern)

با استفاده از عبارات منظم، محتوای عنصر را برای الگوی متنی مشخص شده جستجو می‌کند.

زیرمجموعه‌ای از ویژگی‌های عبارات منظم جاوا اسکریپت به طور کامل پشتیبانی نمی‌شوند، مانند گروه‌های ضبط و اصلاح‌کننده‌های حالت.

الگوی عبارت منظم ارائه شده به طور مستقل با هر بلوک متنی موجود در عنصر فعلی مطابقت داده می‌شود.

پارامترها

نام نوع توضیحات
search Pattern String الگویی که باید جستجو شود

بازگشت

Range Element |null — نتیجه جستجو که موقعیت متن جستجو را نشان می‌دهد، یا در صورت عدم تطابق، null

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

find Text(searchPattern, from)

با شروع از یک نتیجه جستجوی داده شده، محتویات عنصر را برای الگوی متنی مشخص شده جستجو می‌کند.

زیرمجموعه‌ای از ویژگی‌های عبارات منظم جاوا اسکریپت به طور کامل پشتیبانی نمی‌شوند، مانند گروه‌های ضبط و اصلاح‌کننده‌های حالت.

الگوی عبارت منظم ارائه شده به طور مستقل با هر بلوک متنی موجود در عنصر فعلی مطابقت داده می‌شود.

پارامترها

نام نوع توضیحات
search Pattern String الگویی که باید جستجو شود
from Range Element نتیجه جستجو برای جستجو از

بازگشت

Range Element |null — نتیجه جستجو که موقعیت بعدی متن جستجو را نشان می‌دهد، یا در صورت عدم تطابق، null است.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

get Attributes()

ویژگی‌های عنصر را بازیابی می‌کند.

نتیجه، یک شیء حاوی یک ویژگی برای هر ویژگی عنصر معتبر است که در آن هر نام ویژگی با یک آیتم در شمارش Document App.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

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 Index 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 Next Sibling()

عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.

خواهر یا برادر بعدی، والد یکسانی دارد و عنصر فعلی را دنبال می‌کند.

بازگشت

Element |null — عنصر خواهر یا برادر بعدی.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

تمام Paragraphs موجود در بخش (شامل List Items ) را بازیابی می‌کند.

بازگشت

Paragraph[] |null — پاراگراف‌های بخش.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

get Parent()

عنصر والد عنصر را بازیابی می‌کند.

عنصر والد شامل عنصر فعلی است.

بازگشت

Container Element |null — عنصر والد.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

get Previous Sibling()

عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.

عنصر خواهر یا برادر قبلی، والد یکسانی دارد و قبل از عنصر فعلی قرار می‌گیرد.

بازگشت

Element |null — عنصر خواهر یا برادر قبلی.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • 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 App.TextAlignment.NORMAL ، Document App.TextAlignment.SUBSCRIPT و Document App.TextAlignment.SUPERSCRIPT .

بازگشت

Text Alignment |null — نوع ترازبندی متن، یا اگر متن شامل چندین نوع ترازبندی متن باشد یا ترازبندی متن هرگز تنظیم نشده باشد، null

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

get Type()

Element Type را بازیابی می‌کند.

برای تعیین نوع دقیق یک عنصر داده شده، get Type() استفاده کنید.

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 Type - نوع عنصر.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

insert Paragraph(childIndex, paragraph)

Paragraph داده شده را در اندیس مشخص شده درج می‌کند.

پارامترها

نام نوع توضیحات
child Index Integer شاخصی که باید در آن درج شود.
paragraph Paragraph پاراگرافی که باید درج شود.

بازگشت

Paragraph — پاراگراف درج شده.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

insert Paragraph(childIndex, text)

یک Paragraph جدید ایجاد و در فهرست مشخص شده درج می‌کند که حاوی محتوای متن مشخص شده است.

پارامترها

نام نوع توضیحات
child Index Integer شاخصی که باید در آن درج شود.
text String محتوای متن پاراگراف.

بازگشت

Paragraph - پاراگراف جدید.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

remove Child(child)

عنصر فرزند مشخص شده را حذف می‌کند.

پارامترها

نام نوع توضیحات
child Element عنصر فرزندی که قرار است حذف شود.

بازگشت

Footnote Section - عنصر فعلی.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

بازگشت

Footnote Section |null — عنصر حذف شده.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

replace Text(searchPattern, replacement)

با استفاده از عبارات منظم، تمام موارد تکرار یک الگوی متنی مشخص را با یک رشته جایگزین مشخص جایگزین می‌کند.

الگوی جستجو به صورت یک رشته ارسال می‌شود، نه یک شیء عبارت منظم جاوا اسکریپت. به همین دلیل، باید هرگونه بک‌اسلش را در الگو escape کنید.

این روش از کتابخانه عبارات منظم RE2 گوگل استفاده می‌کند که سینتکس‌های پشتیبانی‌شده را محدود می‌کند.

الگوی عبارت منظم ارائه شده به طور مستقل با هر بلوک متنی موجود در عنصر فعلی مطابقت داده می‌شود.

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

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

پارامترها

نام نوع توضیحات
search Pattern String الگوی regex برای جستجو
replacement String متنی که قرار است به عنوان جایگزین استفاده شود

بازگشت

Element - عنصر فعلی

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

set Attributes(attributes)

ویژگی‌های عنصر را تنظیم می‌کند.

پارامتر ویژگی‌های مشخص‌شده باید یک شیء باشد که در آن نام هر ویژگی، یک آیتم در شمارش Document App.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 ویژگی‌های عنصر.

بازگشت

Footnote Section - عنصر فعلی.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

set Text(text)

محتوا را به صورت متن ساده تنظیم می‌کند.

توجه: محتویات موجود پاک می‌شوند.

پارامترها

نام نوع توضیحات
text String محتوای متن جدید.

بازگشت

Footnote Section - عنصر فعلی.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

set Text Alignment(textAlignment)

ترازبندی متن را تنظیم می‌کند. انواع ترازبندی موجود عبارتند از Document App.TextAlignment.NORMAL ، Document App.TextAlignment.SUBSCRIPT و Document App.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 Alignment Text Alignment نوع ترازبندی متن که باید اعمال شود

بازگشت

Footnote Section - عنصر فعلی

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

متدهای منسوخ شده