این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Class FooterSection

عنصری که بخش پاورقی را نشان می دهد. یک Document معمولاً حاوی حداکثر یک Footer Section است. Footer Section ممکن است شامل List Item ، Paragraph و عناصر Table باشد. برای اطلاعات بیشتر در مورد ساختار سند، راهنمای گسترش Google Docs را ببینید.

روش ها

روش	نوع برگشت	شرح مختصر
`append Horizontal Rule()`	`Horizontal Rule`	یک `Horizontal Rule` جدید ایجاد و اضافه می کند.
`append Image(image)`	`Inline Image`	یک `Inline Image` جدید از حباب تصویر مشخص شده ایجاد و اضافه می کند.
`append Image(image)`	`Inline Image`	`Inline Image` داده شده را اضافه می کند.
`append List Item(listItem)`	`List Item`	`List Item` داده شده را اضافه می کند.
`append List Item(text)`	`List Item`	یک `List Item` جدید حاوی محتوای متن مشخص شده ایجاد و اضافه می کند.
`append Paragraph(paragraph)`	`Paragraph`	`Paragraph` داده شده را ضمیمه می کند.
`append Paragraph(text)`	`Paragraph`	یک `Paragraph` جدید حاوی محتوای متن مشخص شده ایجاد و اضافه می کند.
`append Table()`	`Table`	یک `Table` جدید ایجاد و اضافه می کند.
`append Table(cells)`	`Table`	یک `Table` جدید حاوی یک `Table Cell` برای هر مقدار رشته مشخص شده اضافه می کند.
`append Table(table)`	`Table`	`Table` داده شده را ضمیمه می کند.
`clear()`	`Footer Section`	محتویات عنصر را پاک می کند.
`copy()`	`Footer Section`	یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند.
`edit As Text()`	`Text`	یک نسخه `Text` از عنصر فعلی را برای ویرایش دریافت می کند.
`find Element(elementType)`	`Range Element`	محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند.
`find Element(elementType, from)`	`Range Element`	محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند، که از `Range Element` مشخص شده شروع می شود.
`find Text(searchPattern)`	`Range Element`	با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند.
`find Text(searchPattern, from)`	`Range Element`	محتویات عنصر را برای الگوی متن مشخص شده، از یک نتیجه جستجوی معین شروع می کند.
`get Attributes()`	`Object`	ویژگی های عنصر را بازیابی می کند.
`get Child(childIndex)`	`Element`	عنصر فرزند را در نمایه فرزند مشخص شده بازیابی می کند.
`get Child Index(child)`	`Integer`	شاخص فرزند را برای عنصر فرزند مشخص شده بازیابی می کند.
`get Images()`	`Inline Image[]`	تمام `Inline Images` موجود در بخش را بازیابی می کند.
`get List Items()`	`List Item[]`	تمام `List Items` موجود در بخش را بازیابی می کند.
`get Num Children()`	`Integer`	تعداد فرزندان را بازیابی می کند.
`get Paragraphs()`	`Paragraph[]`	تمام `Paragraphs` موجود در بخش (از جمله `List Items` ) را بازیابی می کند.
`get Parent()`	`Container Element`	عنصر والد عنصر را بازیابی می کند.
`get Tables()`	`Table[]`	تمام `Tables` موجود در بخش را بازیابی می کند.
`get Text()`	`String`	محتویات عنصر را به عنوان یک رشته متنی بازیابی می کند.
`get Text Alignment()`	`Text Alignment`	تراز متن را دریافت می کند.
`get Type()`	`Element Type`	`Element Type` عنصر را بازیابی می کند.
`insert Horizontal Rule(childIndex)`	`Horizontal Rule`	یک `Horizontal Rule` جدید را در نمایه مشخص شده ایجاد و درج می کند.
`insert Image(childIndex, image)`	`Inline Image`	یک `Inline Image` از لکه تصویر مشخص شده، در نمایه مشخص شده ایجاد و درج می کند.
`insert Image(childIndex, image)`	`Inline Image`	`Inline Image` داده شده را در نمایه مشخص شده درج می کند.
`insert List Item(childIndex, listItem)`	`List Item`	`List Item` داده شده را در نمایه مشخص شده درج می کند.
`insert List Item(childIndex, text)`	`List Item`	یک `List Item` جدید را در نمایه مشخص شده ایجاد و درج می کند که حاوی محتوای متن مشخص شده است.
`insert Paragraph(childIndex, paragraph)`	`Paragraph`	`Paragraph` داده شده را در نمایه مشخص شده درج می کند.
`insert Paragraph(childIndex, text)`	`Paragraph`	یک `Paragraph` جدید را در نمایه مشخص شده ایجاد و درج می کند که حاوی محتوای متن مشخص شده است.
`insert Table(childIndex)`	`Table`	یک `Table` جدید در نمایه مشخص شده ایجاد و درج می کند.
`insert Table(childIndex, cells)`	`Table`	یک `Table` جدید حاوی سلول های مشخص شده را در نمایه مشخص شده ایجاد و درج می کند.
`insert Table(childIndex, table)`	`Table`	`Table` داده شده را در شاخص مشخص شده درج می کند.
`remove Child(child)`	`Footer Section`	عنصر فرزند مشخص شده را حذف می کند.
`remove From Parent()`	`Footer Section`	عنصر را از والد خود حذف می کند.
`replace Text(searchPattern, replacement)`	`Element`	با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین می‌کند.
`set Attributes(attributes)`	`Footer Section`	ویژگی های عنصر را تنظیم می کند.
`set Text(text)`	`Footer Section`	محتویات را به صورت متن ساده تنظیم می کند.
`set Text Alignment(textAlignment)`	`Footer Section`	تراز متن را تنظیم می کند.

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

روش	نوع برگشت	شرح مختصر
`get Footnotes()`	`Footnote[]`	تمام `Footnotes` موجود در بخش را بازیابی می کند.
`get Link Url()`	`String`	آدرس لینک را بازیابی می کند.
`get Next Sibling()`	`Element`	عنصر خواهر و برادر بعدی عنصر را بازیابی می کند.
`get Previous Sibling()`	`Element`	عنصر خواهر و برادر قبلی عنصر را بازیابی می کند.
`is At Document End()`	`Boolean`	تعیین می کند که آیا عنصر در انتهای `Document` قرار دارد یا خیر.
`set Link Url(url)`	`Footer Section`	آدرس لینک را تنظیم می کند.

مستندات دقیق

`append Horizontal Rule()`

یک Horizontal Rule جدید ایجاد و اضافه می کند.

Horizontal Rule در یک Paragraph جدید گنجانده خواهد شد.

بازگشت

Horizontal Rule - قانون افقی جدید.

مجوز

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

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

`append Image(image)`

یک Inline Image جدید از حباب تصویر مشخص شده ایجاد و اضافه می کند.

تصویر در یک Paragraph جدید قرار خواهد گرفت.

پارامترها

نام	تایپ کنید	توضیحات
`image`	`Blob Source`	داده های تصویر

بازگشت

Inline Image - تصویر ضمیمه شده.

مجوز

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

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

`append Image(image)`

Inline Image داده شده را اضافه می کند.

Inline Image در یک Paragraph جدید قرار خواهد گرفت.

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

پارامترها

نام	تایپ کنید	توضیحات
`image`	`Inline Image`	داده های تصویر

بازگشت

Inline Image - تصویر ضمیمه شده.

مجوز

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

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

`append List Item(listItem)`

List Item داده شده را اضافه می کند.

هنگام ضمیمه یک کپی از یک List Item موجود، از این نسخه از append List Item استفاده کنید.

پارامترها

نام	تایپ کنید	توضیحات
`list Item`	`List Item`	مورد فهرست برای پیوست.

بازگشت

List Item - آیتم لیست ضمیمه شده.

مجوز

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

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

`append List Item(text)`

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

موارد متوالی لیست به عنوان بخشی از همان لیست اضافه می شوند.

پارامترها

نام	تایپ کنید	توضیحات
`text`	`String`	محتوای متن مورد فهرست

بازگشت

List Item - آیتم فهرست جدید.

مجوز

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

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

`append Paragraph(paragraph)`

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

هنگام ضمیمه یک نسخه از یک Paragraph موجود، از این نسخه append 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

`append Table()`

یک Table جدید ایجاد و اضافه می کند.

این روش همچنین یک پاراگراف خالی را بعد از جدول اضافه می کند، زیرا اسناد Google Docs نمی توانند به جدول ختم شوند.

بازگشت

Table - جدول جدید.

مجوز

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

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

`append Table(cells)`

یک Table جدید حاوی یک Table Cell برای هر مقدار رشته مشخص شده اضافه می کند.

این روش همچنین یک پاراگراف خالی را بعد از جدول اضافه می کند، زیرا اسناد Google Docs نمی توانند به جدول ختم شوند.

پارامترها

نام	تایپ کنید	توضیحات
`cells`	`String[][]`	محتویات متن سلول های جدول برای اضافه کردن به جدول جدید.

بازگشت

Table - جدول پیوست.

مجوز

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

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

`append Table(table)`

Table داده شده را ضمیمه می کند.

هنگام ضمیمه کردن یک نسخه از Table موجود، از این نسخه از append Table استفاده کنید. این روش همچنین یک پاراگراف خالی را بعد از جدول اضافه می کند، زیرا اسناد Google Docs نمی توانند به جدول ختم شوند.

پارامترها

نام	تایپ کنید	توضیحات
`table`	`Table`	جدول ضمیمه

بازگشت

Table - جدول پیوست.

مجوز

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

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

`clear()`

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

بازگشت

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

`copy()`

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

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

بازگشت

Footer 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 - یک نتیجه جستجو که موقعیت عنصر جستجو را نشان می دهد.

مجوز

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

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

مجوز

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

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

`find Text(searchPattern)`

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

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

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

پارامترها

نام	تایپ کنید	توضیحات
`search Pattern`	`String`	الگوی مورد جستجو

بازگشت

Range Element - یک نتیجه جستجو که موقعیت متن جستجو را نشان می دهد، یا اگر مطابقت نداشته باشد، پوچ است

مجوز

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

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 - یک نتیجه جستجو که موقعیت بعدی متن جستجو را نشان می دهد، یا اگر مطابقت نداشته باشد، پوچ است

مجوز

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

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 Images()`

تمام Inline Images موجود در بخش را بازیابی می کند.

بازگشت

Inline Image[] - تصاویر بخش.

مجوز

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

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

`get List Items()`

تمام List Items موجود در بخش را بازیابی می کند.

بازگشت

List Item[] - موارد فهرست بخش.

مجوز

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

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[] - پاراگراف های بخش.

مجوز

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

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

`get Parent()`

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

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

بازگشت

Container Element - عنصر والد.

مجوز

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

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

`get Tables()`

تمام Tables موجود در بخش را بازیابی می کند.

بازگشت

Table[] - جداول بخش.

مجوز

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

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

مجوز

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

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 Horizontal Rule(childIndex)`

یک Horizontal Rule جدید را در نمایه مشخص شده ایجاد و درج می کند.

Horizontal Rule در یک Paragraph جدید گنجانده خواهد شد.

پارامترها

نام	تایپ کنید	توضیحات
`child Index`	`Integer`	شاخصی که در آن عنصر درج می شود.

بازگشت

Horizontal Rule - قانون افقی جدید.

مجوز

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

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

`insert Image(childIndex, image)`

یک Inline Image از لکه تصویر مشخص شده، در نمایه مشخص شده ایجاد و درج می کند.

پارامترها

نام	تایپ کنید	توضیحات
`child Index`	`Integer`	شاخصی که در آن عنصر درج می شود.
`image`	`Blob Source`	داده های تصویر

بازگشت

Inline Image - تصویر درون خطی درج شده.

مجوز

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

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

`insert Image(childIndex, image)`

Inline Image داده شده را در نمایه مشخص شده درج می کند.

تصویر در یک Paragraph جدید قرار خواهد گرفت.

پارامترها

نام	تایپ کنید	توضیحات
`child Index`	`Integer`	شاخصی که در آن عنصر درج می شود.
`image`	`Inline Image`	تصویر برای درج

بازگشت

Inline Image - تصویر درون خطی درج شده.

مجوز

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

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

`insert List Item(childIndex, listItem)`

List Item داده شده را در نمایه مشخص شده درج می کند.

پارامترها

نام	تایپ کنید	توضیحات
`child Index`	`Integer`	شاخصی که در آن درج شود.
`list Item`	`List Item`	مورد لیست برای درج.

بازگشت

List Item - آیتم فهرست درج شده.

مجوز

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

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

`insert List Item(childIndex, text)`

یک List Item جدید را در نمایه مشخص شده ایجاد و درج می کند که حاوی محتوای متن مشخص شده است.

پارامترها

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

بازگشت

List Item - آیتم فهرست جدید.

مجوز

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

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

`insert Table(childIndex)`

یک Table جدید در نمایه مشخص شده ایجاد و درج می کند.

پارامترها

نام	تایپ کنید	توضیحات
`child Index`	`Integer`	شاخصی که در آن درج شود.

بازگشت

Table - جدول جدید.

مجوز

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

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

`insert Table(childIndex, cells)`

یک Table جدید حاوی سلول های مشخص شده را در نمایه مشخص شده ایجاد و درج می کند.

پارامترها

نام	تایپ کنید	توضیحات
`child Index`	`Integer`	شاخصی که در آن درج شود.
`cells`	`String[][]`	محتویات متن سلول های جدول برای اضافه کردن به جدول جدید.

بازگشت

Table - جدول جدید.

مجوز

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

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

`insert Table(childIndex, table)`

Table داده شده را در شاخص مشخص شده درج می کند.

پارامترها

نام	تایپ کنید	توضیحات
`child Index`	`Integer`	شاخصی که در آن درج شود.
`table`	`Table`	جدول برای درج.

بازگشت

Table - جدول درج شده.

مجوز

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

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

`remove Child(child)`

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

پارامترها

نام	تایپ کنید	توضیحات
`child`	`Element`	عنصر فرزند برای حذف.

بازگشت

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

بازگشت

Footer Section - عنصر حذف شده.

مجوز

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

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

`replace Text(searchPattern, replacement)`

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

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

این روش از کتابخانه عبارات منظم 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`	ویژگی های عنصر

بازگشت

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

مجوز

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

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

`set Text(text)`

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

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

پارامترها

نام	تایپ کنید	توضیحات
`text`	`String`	مطالب متن جدید

بازگشت

Footer 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`	نوع تراز متنی که باید اعمال شود

بازگشت

Footer Section - عنصر فعلی

مجوز

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

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

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

`get Footnotes()`

منسوخ شده است. این عنصر نمی تواند حاوی Footnote باشد.

تمام Footnotes موجود در بخش را بازیابی می کند.

بازگشت

Footnote[] - پاورقی بخش.

مجوز

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

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

`get Link Url()`

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

آدرس لینک را بازیابی می کند.

بازگشت

String - URL پیوند یا اگر عنصر حاوی مقادیر متعددی برای این ویژگی باشد، null است

مجوز

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

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 Previous Sibling()`

منسوخ شده است. این عنصر هیچ خواهر و برادری ندارد.

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

خواهر و برادر قبلی والد مشابهی دارد و مقدم بر عنصر فعلی است.

بازگشت

Element - عنصر خواهر و برادر قبلی.

مجوز

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

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

`is At Document End()`

منسوخ شده است. این روش برای Header Section قابل اعتماد نیست.

تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر.

بازگشت

Boolean - اینکه آیا عنصر در انتهای برگه است.

مجوز

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

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

`set Link Url(url)`

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

آدرس لینک را تنظیم می کند.

پارامترها

نام	تایپ کنید	توضیحات
`url`	`String`	آدرس لینک

بازگشت

Footer Section - عنصر فعلی

مجوز

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

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