Class FooterSection

بخش پاورقی

عنصری که نشان‌دهنده‌ی بخش پاورقی است. یک Document معمولاً حداکثر شامل یک FooterSection است. FooterSection ممکن است شامل عناصر ListItem ، 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 |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 Images() Inline Image[] |null تمام Inline Images موجود در بخش را بازیابی می‌کند.
get List Items() List Item[] |null تمام List Items موجود در بخش را بازیابی می‌کند.
get Num Children() Integer تعداد فرزندان را بازیابی می‌کند.
get Paragraphs() Paragraph[] |null تمام Paragraphs موجود در بخش (شامل List Items ) را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Tables() Table[] |null تمام Tables موجود در بخش را بازیابی می‌کند.
get Text() String محتوای عنصر را به صورت یک رشته متنی بازیابی می‌کند.
get Text Alignment() Text Alignment |null ترازبندی متن را دریافت می‌کند.
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 |null عنصر را از والدش حذف می‌کند.
replace Text(searchPattern, replacement) Element با استفاده از عبارات منظم، تمام موارد تکرار یک الگوی متنی مشخص را با یک رشته جایگزین مشخص جایگزین می‌کند.
set Attributes(attributes) Footer Section ویژگی‌های عنصر را تنظیم می‌کند.
set Text(text) Footer Section محتوا را به صورت متن ساده تنظیم می‌کند.
set Text Alignment(textAlignment) Footer Section ترازبندی متن را تنظیم می‌کند.

مستندات دقیق

appendHorizontalRule()

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

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

بازگشت

HorizontalRule — قانون افقی جدید.

مجوز

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

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

appendImage(image)

یک InlineImage جدید از تصویر مشخص شده ایجاد و به آن اضافه می‌کند.

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

پارامترها

نام نوع توضیحات
image Blob Source داده‌های تصویر.

بازگشت

InlineImage - تصویر پیوست شده.

مجوز

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

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

appendImage(image)

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

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

از این نسخه appendImage هنگام افزودن یک کپی از یک InlineImage موجود استفاده کنید.

پارامترها

نام نوع توضیحات
image Inline Image داده‌های تصویر.

بازگشت

InlineImage - تصویر پیوست شده.

مجوز

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

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

appendListItem(listItem)

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

از این نسخه از appendListItem هنگام افزودن یک کپی از ListItem موجود استفاده کنید.

پارامترها

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

بازگشت

ListItem — آیتم لیست اضافه شده.

مجوز

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

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

appendListItem(text)

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

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

پارامترها

نام نوع توضیحات
text String محتوای متنی آیتم لیست.

بازگشت

ListItem — آیتم جدید لیست.

مجوز

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

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

appendParagraph(paragraph)

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

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

پارامترها

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

بازگشت

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

مجوز

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

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

appendParagraph(text)

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

پارامترها

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

بازگشت

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

مجوز

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

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

appendTable()

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

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

بازگشت

Table - میز جدید.

مجوز

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

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

appendTable(cells)

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

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

پارامترها

نام نوع توضیحات
cells String[][] محتوای متنی سلول‌های جدول که قرار است به جدول جدید اضافه شوند.

بازگشت

Table — جدول پیوست شده.

مجوز

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

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

appendTable(table)

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

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

پارامترها

نام نوع توضیحات
table Table جدولی که باید پیوست شود.

بازگشت

Table — جدول پیوست شده.

مجوز

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

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

clear()

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

بازگشت

FooterSection - عنصر فعلی.

copy()

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

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

بازگشت

FooterSection - نسخه جدید.

مجوز

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

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

editAsText()

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

editAsText برای دستکاری محتوای عناصر به عنوان متن غنی استفاده کنید. حالت editAsText عناصر غیر متنی (مانند InlineImage و HorizontalRule ) را نادیده می‌گیرد.

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

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 - نسخه متنی عنصر فعلی

findElement(elementType)

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

پارامترها

نام نوع توضیحات
element Type Element Type نوع عنصری که باید جستجو شود.

بازگشت

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

مجوز

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

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

findElement(elementType, from)

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

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 نتیجه جستجو برای جستجو از.

بازگشت

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

مجوز

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

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

findText(searchPattern)

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

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

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

پارامترها

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

بازگشت

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

مجوز

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

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

findText(searchPattern, from)

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

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

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

پارامترها

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

بازگشت

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

مجوز

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

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

getAttributes()

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

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

getChild(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

getChildIndex(child)

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

پارامترها

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

بازگشت

Integer - اندیس فرزند.

مجوز

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

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

getImages()

تمام تصاویر InlineImages موجود در بخش را بازیابی می‌کند.

بازگشت

InlineImage[] |null — تصاویر بخش.

مجوز

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

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

getListItems()

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

بازگشت

ListItem[] |null — آیتم‌های لیست بخش.

مجوز

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

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

getNumChildren()

تعداد فرزندان را بازیابی می‌کند.

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

getParagraphs()

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

بازگشت

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

مجوز

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

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

getParent()

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

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

بازگشت

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

مجوز

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

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

getTables()

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

بازگشت

Table[] |null — جداول بخش.

مجوز

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

  • 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 — نوع ترازبندی متن، یا اگر متن شامل چندین نوع ترازبندی متن باشد یا ترازبندی متن هرگز تنظیم نشده باشد، null

مجوز

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

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

getType()

ElementType را بازیابی می‌کند.

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

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.');
}

بازگشت

ElementType - نوع عنصر.

مجوز

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

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

insertHorizontalRule(childIndex)

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

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

پارامترها

نام نوع توضیحات
child Index Integer اندیسی که عنصر در آن قرار می‌گیرد.

بازگشت

HorizontalRule — قانون افقی جدید.

مجوز

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

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

insertImage(childIndex, image)

یک InlineImage از blob تصویر مشخص شده، در اندیس مشخص شده ایجاد و درج می‌کند.

پارامترها

نام نوع توضیحات
child Index Integer اندیسی که عنصر در آن قرار می‌گیرد.
image Blob Source داده‌های تصویر.

بازگشت

InlineImage - تصویر درون‌خطی درج شده.

مجوز

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

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

insertImage(childIndex, image)

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

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

پارامترها

نام نوع توضیحات
child Index Integer اندیسی که عنصر در آن قرار می‌گیرد.
image Inline Image تصویری که قرار است درج شود.

بازگشت

InlineImage - تصویر درون‌خطی درج شده.

مجوز

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

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

insertListItem(childIndex, listItem)

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

پارامترها

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

بازگشت

ListItem — آیتم لیست درج شده.

مجوز

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

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

insertListItem(childIndex, text)

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

پارامترها

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

بازگشت

ListItem — آیتم جدید لیست.

مجوز

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

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

insertParagraph(childIndex, paragraph)

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

پارامترها

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

بازگشت

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

مجوز

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

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

insertParagraph(childIndex, text)

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

پارامترها

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

بازگشت

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

مجوز

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

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

insertTable(childIndex)

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

پارامترها

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

بازگشت

Table - میز جدید.

مجوز

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

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

insertTable(childIndex, cells)

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

پارامترها

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

بازگشت

Table - میز جدید.

مجوز

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

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

insertTable(childIndex, table)

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

پارامترها

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

بازگشت

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

مجوز

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

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

removeChild(child)

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

پارامترها

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

بازگشت

FooterSection - عنصر فعلی.

مجوز

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

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

removeFromParent()

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

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

بازگشت

FooterSection |null — The removed element.

مجوز

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

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

replaceText(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

setAttributes(attributes)

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

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

بازگشت

FooterSection - عنصر فعلی.

مجوز

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

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

setText(text)

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

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

پارامترها

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

بازگشت

FooterSection - عنصر فعلی.

مجوز

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

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

پارامترها

نام نوع توضیحات
text Alignment Text Alignment نوع ترازبندی متن که باید اعمال شود

بازگشت

FooterSection - عنصر فعلی

مجوز

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

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

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