Class ContainerElement

ContainerElement

یک عنصر عمومی که ممکن است حاوی عناصر دیگری باشد. همه عناصری که ممکن است حاوی عناصر فرزند باشند، مانند Paragraph ، از ContainerElement به ارث می‌برند.

روش ها

روش نوع برگشت شرح مختصر
asBody() Body عنصر فعلی را به عنوان Body برمی‌گرداند.
asEquation() Equation عنصر جاری را به صورت Equation برمی‌گرداند.
asFooterSection() FooterSection عنصر فعلی را به صورت FooterSection برمی‌گرداند.
asFootnoteSection() FootnoteSection عنصر فعلی را به عنوان FootnoteSection برمی گرداند.
asHeaderSection() HeaderSection عنصر فعلی را به عنوان HeaderSection برمی‌گرداند.
asListItem() ListItem عنصر فعلی را به عنوان ListItem برمی گرداند.
asParagraph() Paragraph عنصر فعلی را به عنوان یک Paragraph برمی گرداند.
asTable() Table عنصر فعلی را به صورت Table برمی گرداند.
asTableCell() TableCell عنصر فعلی را به عنوان TableCell برمی‌گرداند.
asTableOfContents() TableOfContents عنصر فعلی را به عنوان TableOfContents برمی گرداند.
asTableRow() TableRow عنصر فعلی را به عنوان TableRow برمی‌گرداند.
clear() ContainerElement محتویات عنصر را پاک می کند.
copy() ContainerElement یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند.
editAsText() Text یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می کند.
findElement(elementType) RangeElement محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند.
findElement(elementType, from) RangeElement محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند، که از RangeElement مشخص شده شروع می شود.
findText(searchPattern) RangeElement با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند.
findText(searchPattern, from) RangeElement محتویات عنصر را برای الگوی متن مشخص شده، از یک نتیجه جستجوی معین شروع می کند.
getAttributes() Object ویژگی های عنصر را بازیابی می کند.
getChild(childIndex) Element عنصر فرزند را در نمایه فرزند مشخص شده بازیابی می کند.
getChildIndex(child) Integer شاخص فرزند را برای عنصر فرزند مشخص شده بازیابی می کند.
getLinkUrl() String آدرس لینک را بازیابی می کند.
getNextSibling() Element عنصر خواهر و برادر بعدی عنصر را بازیابی می کند.
getNumChildren() Integer تعداد فرزندان را بازیابی می کند.
getParent() ContainerElement عنصر والد عنصر را بازیابی می کند.
getPreviousSibling() Element عنصر خواهر و برادر قبلی عنصر را بازیابی می کند.
getText() String محتویات عنصر را به عنوان یک رشته متنی بازیابی می کند.
getTextAlignment() TextAlignment تراز متن را دریافت می کند.
getType() ElementType ElementType عنصر را بازیابی می کند.
isAtDocumentEnd() Boolean تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
merge() ContainerElement عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند.
removeFromParent() ContainerElement عنصر را از والد خود حذف می کند.
replaceText(searchPattern, replacement) Element با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین می‌کند.
setAttributes(attributes) ContainerElement ویژگی های عنصر را تنظیم می کند.
setLinkUrl(url) ContainerElement آدرس لینک را تنظیم می کند.
setTextAlignment(textAlignment) ContainerElement تراز متن را تنظیم می کند.

مستندات دقیق

asBody()

عنصر فعلی را به عنوان Body برمی‌گرداند.

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

بازگشت

Body - عنصر فعلی.

مجوز

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

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

asEquation()

عنصر جاری را به صورت Equation برمی‌گرداند.

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

بازگشت

Equation - عنصر فعلی.

مجوز

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

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

asFooterSection()

عنصر فعلی را به صورت FooterSection برمی‌گرداند.

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

بازگشت

FooterSection - عنصر فعلی.

مجوز

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

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

asFootnoteSection()

عنصر فعلی را به عنوان FootnoteSection برمی گرداند.

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

بازگشت

FootnoteSection - عنصر فعلی.

مجوز

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

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

asHeaderSection()

عنصر فعلی را به عنوان HeaderSection برمی‌گرداند.

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

بازگشت

HeaderSection - عنصر فعلی.

مجوز

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

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

asListItem()

عنصر فعلی را به عنوان ListItem برمی گرداند.

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

بازگشت

ListItem - عنصر فعلی.

مجوز

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

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

asParagraph()

عنصر فعلی را به عنوان یک Paragraph برمی گرداند.

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

بازگشت

Paragraph - عنصر فعلی.

مجوز

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

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

asTable()

عنصر فعلی را به صورت Table برمی گرداند.

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

بازگشت

Table - عنصر فعلی.

مجوز

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

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

asTableCell()

عنصر فعلی را به عنوان TableCell برمی‌گرداند.

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

بازگشت

TableCell - عنصر فعلی.

مجوز

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

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

asTableOfContents()

عنصر فعلی را به عنوان TableOfContents برمی گرداند.

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

بازگشت

TableOfContents - عنصر فعلی.

مجوز

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

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

asTableRow()

عنصر فعلی را به عنوان TableRow برمی‌گرداند.

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

بازگشت

TableRow - عنصر فعلی.

مجوز

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

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

clear()

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

بازگشت

ContainerElement - عنصر فعلی.


copy()

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

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

بازگشت

ContainerElement - کپی جدید.

مجوز

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

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

editAsText()

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

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

عناصر فرزند به طور کامل در محدوده متن حذف شده از عنصر حذف می شوند.

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

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, "An editAsText sample.");
body.insertHorizontalRule(0);
body.insertParagraph(0, "An example.");

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

بازگشت

Text - نسخه متنی عنصر فعلی


findElement(elementType)

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

پارامترها

نام تایپ کنید توضیحات
elementType ElementType نوع عنصر مورد جستجو

بازگشت

RangeElement - یک نتیجه جستجو که موقعیت عنصر جستجو را نشان می دهد.

مجوز

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

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

findElement(elementType, from)

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

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

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

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

پارامترها

نام تایپ کنید توضیحات
elementType ElementType نوع عنصر مورد جستجو
from RangeElement نتیجه جستجو برای جستجو از.

بازگشت

RangeElement - یک نتیجه جستجو که موقعیت بعدی عنصر جستجو را نشان می دهد.

مجوز

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

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

findText(searchPattern)

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

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

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

پارامترها

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

بازگشت

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

مجوز

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

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

findText(searchPattern, from)

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

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

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

پارامترها

نام تایپ کنید توضیحات
searchPattern String الگوی مورد جستجو
from RangeElement نتیجه جستجو برای جستجو از

بازگشت

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

مجوز

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

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

getAttributes()

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

نتیجه یک شی حاوی یک ویژگی برای هر ویژگی عنصر معتبر است که در آن نام هر ویژگی با یک مورد در شمارش DocumentApp.Attribute مطابقت دارد.

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

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

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

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

بازگشت

Object - ویژگی های عنصر.

مجوز

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

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

getChild(childIndex)

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

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

// Obtain the first element in the tab.
var firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText("This is the first paragraph.");
}

پارامترها

نام تایپ کنید توضیحات
childIndex Integer شاخص عنصر فرزند برای بازیابی.

بازگشت

Element - عنصر فرزند در شاخص مشخص شده.

مجوز

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

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

getChildIndex(child)

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

پارامترها

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

بازگشت

Integer - شاخص فرزند.

مجوز

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

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

getLinkUrl()

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

بازگشت

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

مجوز

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

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

getNextSibling()

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

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

بازگشت

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

مجوز

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

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

getNumChildren()

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

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

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

بازگشت

Integer - تعداد فرزندان.

مجوز

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

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

getParent()

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

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

بازگشت

ContainerElement - عنصر والد.

مجوز

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

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

getPreviousSibling()

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

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

بازگشت

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

مجوز

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

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

getText()

محتویات عنصر را به عنوان یک رشته متنی بازیابی می کند.

بازگشت

String - محتویات عنصر به عنوان رشته متن

مجوز

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

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

getTextAlignment()

تراز متن را دریافت می کند. انواع موجود ترازها DocumentApp.TextAlignment.NORMAL ، DocumentApp.TextAlignment.SUBSCRIPT و DocumentApp.TextAlignment.SUPERSCRIPT هستند.

بازگشت

TextAlignment - نوع هم‌ترازی متن، یا اگر متن حاوی چندین نوع هم‌ترازی متن باشد یا اگر تراز متن هرگز تنظیم نشده باشد، null

مجوز

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

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

getType()

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

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

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

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

var firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

بازگشت

ElementType - نوع عنصر.

مجوز

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

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

isAtDocumentEnd()

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

بازگشت

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

مجوز

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

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

merge()

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

فقط عناصر همان ElementType را می توان ادغام کرد. هر عنصر فرزند موجود در عنصر فعلی به عنصر خواهر و برادر قبلی منتقل می شود.

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

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
var par1 = body.appendParagraph('Paragraph 1.');
var par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
var cells = [
['Row 1, Cell 1', 'Row 1, Cell 2'],
['Row 2, Cell 1', 'Row 2, Cell 2']
];
// Build a table from the array.
var table = body.appendTable(cells);
// Get the first row in the table.
 var row = table.getRow(0);
// Get the two cells in this row.
var cell1 = row.getCell(0);
var cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
var merged = cell2.merge();

بازگشت

ContainerElement - عنصر ادغام شده.

مجوز

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

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

removeFromParent()

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

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

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

بازگشت

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

مجوز

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

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

replaceText(searchPattern, replacement)

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

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

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

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

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

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

پارامترها

نام تایپ کنید توضیحات
searchPattern String الگوی regex برای جستجو
replacement String متن برای استفاده به عنوان جایگزین

بازگشت

Element - عنصر فعلی

مجوز

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

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

setAttributes(attributes)

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

پارامتر مشخصه مشخص شده باید یک شی باشد که در آن نام هر ویژگی یک مورد در شمارش DocumentApp.Attribute باشد و هر مقدار ویژگی مقدار جدیدی است که باید اعمال شود.

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

// Define a custom paragraph style.
var style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
var par = body.appendParagraph('A paragraph with custom style.');

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

پارامترها

نام تایپ کنید توضیحات
attributes Object ویژگی های عنصر

بازگشت

ContainerElement - عنصر فعلی.

مجوز

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

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

setLinkUrl(url)

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

پارامترها

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

بازگشت

ContainerElement - عنصر فعلی

مجوز

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

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

setTextAlignment(textAlignment)

تراز متن را تنظیم می کند. انواع موجود ترازها DocumentApp.TextAlignment.NORMAL ، DocumentApp.TextAlignment.SUBSCRIPT و DocumentApp.TextAlignment.SUPERSCRIPT هستند.

// Make the entire first paragraph in the active tab be superscript.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

پارامترها

نام تایپ کنید توضیحات
textAlignment TextAlignment نوع تراز متنی که باید اعمال شود

بازگشت

ContainerElement - عنصر فعلی

مجوز

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

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