Class ListItem

آیتم لیست

عنصری که نشان‌دهنده‌ی یک آیتم لیست است. یک ListItem یک Paragraph است که با یک شناسه‌ی لیست مرتبط شده است. یک ListItem ممکن است شامل عناصر Equation ، Footnote ، HorizontalRule ، InlineDrawing ، InlineImage ، PageBreak و Text باشد. برای اطلاعات بیشتر در مورد ساختار سند، به راهنمای توسعه‌ی Google Docs مراجعه کنید.

ListItems نمی‌تواند شامل کاراکترهای خط جدید باشد. کاراکترهای خط جدید ("\n") به کاراکترهای خط جدید ("\r") تبدیل می‌شوند.

ListItems با شناسه لیست یکسان، متعلق به یک لیست هستند و بر این اساس شماره‌گذاری می‌شوند. ListItems برای یک لیست مشخص، نیازی نیست که در تب مجاور باشند یا حتی عنصر والد یکسانی داشته باشند. دو آیتم متعلق به یک لیست یکسان می‌توانند در هر جایی از تب وجود داشته باشند، در حالی که شماره‌گذاری متوالی آنها حفظ می‌شود، همانطور که در مثال زیر نشان داده شده است:

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

// Append a new list item to the body.
const item1 = body.appendListItem('Item 1');

// Log the new list item's list ID.
Logger.log(item1.getListId());

// Append a table after the list item.
body.appendTable([['Cell 1', 'Cell 2']]);

// Append a second list item with the same list ID. The two items are treated as
// the same list, despite not being consecutive.
const item2 = body.appendListItem('Item 2');
item2.setListId(item1);

روش‌ها

روش نوع بازگشتی شرح مختصر
add Positioned Image(image) Positioned Image یک Positioned Image جدید از بلوک تصویر مشخص‌شده ایجاد و درج می‌کند.
append Horizontal Rule() Horizontal Rule یک Horizontal Rule جدید ایجاد و اضافه می‌کند.
append Inline Image(image) Inline Image یک Inline Image جدید از بلوک تصویر مشخص‌شده ایجاد و اضافه می‌کند.
append Inline Image(image) Inline Image Inline Image داده شده را اضافه می‌کند.
append Page Break() Page Break یک Page Break جدید ایجاد و اضافه می‌کند.
append Page Break(pageBreak) Page Break Page Break داده شده را اضافه می‌کند.
append Text(text) Text یک عنصر Text جدید با محتوای مشخص شده ایجاد و اضافه می‌کند.
append Text(text) Text عنصر Text داده شده را اضافه می‌کند.
clear() List Item محتویات عنصر را پاک می‌کند.
copy() List Item یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
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 Alignment() Horizontal Alignment |null Horizontal Alignment بازیابی می‌کند.
get Attributes() Object ویژگی‌های عنصر را بازیابی می‌کند.
get Child(childIndex) Element عنصر فرزند را در اندیس فرزند مشخص شده بازیابی می‌کند.
get Child Index(child) Integer اندیس فرزند را برای عنصر فرزند مشخص شده بازیابی می‌کند.
get Glyph Type() Glyph Type |null Glyph Type آیتم لیست را بازیابی می‌کند.
get Heading() Paragraph Heading |null Paragraph Heading بازیابی می‌کند.
get Indent End() Number|null تورفتگی انتهایی را بر حسب نقطه بازیابی می‌کند.
get Indent First Line() Number|null میزان تورفتگی خط اول را بر حسب نقطه برمی‌گرداند.
get Indent Start() Number|null تورفتگی شروع را بازیابی می‌کند.
get Line Spacing() Number|null فاصله بین خطوط را بر حسب نقطه بازیابی می‌کند.
get Link Url() String|null آدرس لینک را بازیابی می‌کند.
get List Id() String|null شناسه لیست را بازیابی می‌کند.
get Nesting Level() Integer سطح تودرتوی آیتم لیست را بازیابی می‌کند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Num Children() Integer تعداد فرزندان را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Positioned Image(id) Positioned Image یک Positioned Image بر اساس شناسه تصویر دریافت می‌کند.
get Positioned Images() Positioned Image[] تمام اشیاء Positioned Image که به پاراگراف متصل شده‌اند، دریافت می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Spacing After() Number|null فاصله بعد از عنصر را بر حسب نقطه بازیابی می‌کند.
get Spacing Before() Number|null فاصله قبل از عنصر را بر حسب نقطه بازیابی می‌کند.
get Text() String محتوای عنصر را به صورت یک رشته متنی بازیابی می‌کند.
get Text Alignment() Text Alignment |null ترازبندی متن را دریافت می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
insert Horizontal Rule(childIndex) Horizontal Rule یک Horizontal Rule در اندیس مشخص شده ایجاد و درج می‌کند.
insert Inline Image(childIndex, image) Inline Image یک Inline Image جدید را از بلوک تصویر مشخص‌شده، در اندیس مشخص‌شده ایجاد و درج می‌کند.
insert Inline Image(childIndex, image) Inline Image Inline Image داده شده را در اندیس مشخص شده درج می‌کند.
insert Page Break(childIndex) Page Break یک Page Break جدید در اندیس مشخص شده ایجاد و درج می‌کند.
insert Page Break(childIndex, pageBreak) Page Break Page Break داده شده را در فهرست مشخص شده وارد می‌کند.
insert Text(childIndex, text) Text یک عنصر متنی جدید را در اندیس مشخص شده ایجاد و درج می‌کند.
insert Text(childIndex, text) Text عنصر Text داده شده را در اندیس مشخص شده، با محتوای متن مشخص شده، درج می‌کند.
is At Document End() Boolean تعیین می‌کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
is Left To Right() Boolean|null تنظیمات چپ به راست را بازیابی می‌کند.
merge() List Item |null عنصر را با عنصر خواهر یا برادر قبلی از همان نوع ادغام می‌کند.
remove Child(child) List Item عنصر فرزند مشخص شده را حذف می‌کند.
remove From Parent() List Item |null عنصر را از والدش حذف می‌کند.
remove Positioned Image(id) Boolean یک Positioned Image بر اساس شناسه تصویر حذف می‌کند.
replace Text(searchPattern, replacement) Element با استفاده از عبارات منظم، تمام موارد تکرار یک الگوی متنی مشخص را با یک رشته جایگزین مشخص جایگزین می‌کند.
set Alignment(alignment) List Item Horizontal Alignment را تنظیم می‌کند.
set Attributes(attributes) List Item ویژگی‌های عنصر را تنظیم می‌کند.
set Glyph Type(glyphType) List Item Glyph Type آیتم لیست را تنظیم می‌کند.
set Heading(heading) List Item Paragraph Heading تنظیم می‌کند.
set Indent End(indentEnd) List Item تورفتگی انتهایی را بر حسب نقطه تنظیم می‌کند.
set Indent First Line(indentFirstLine) List Item میزان تورفتگی خط اول را بر حسب نقطه تنظیم می‌کند.
set Indent Start(indentStart) List Item تورفتگی شروع را بر حسب نقطه تنظیم می‌کند.
set Left To Right(leftToRight) List Item تنظیم چپ به راست را تنظیم می‌کند.
set Line Spacing(multiplier) List Item فاصله خطوط را به عنوان کمیتی که تعداد خطوط مورد استفاده برای فاصله‌گذاری را نشان می‌دهد، تنظیم می‌کند.
set Link Url(url) List Item آدرس لینک را تنظیم می‌کند.
set List Id(listItem) List Item شناسه لیست را تنظیم می‌کند.
set Nesting Level(nestingLevel) List Item سطح تودرتو بودن آیتم لیست را تنظیم می‌کند.
set Spacing After(spacingAfter) List Item فاصله بعد از عنصر را بر حسب نقطه تنظیم می‌کند.
set Spacing Before(spacingBefore) List Item فاصله قبل از عنصر را بر حسب نقطه تنظیم می‌کند.
set Text(text) void محتوای آیتم لیست را به صورت متن تنظیم می‌کند.
set Text Alignment(textAlignment) List Item ترازبندی متن را تنظیم می‌کند.

مستندات دقیق

addPositionedImage(image)

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

پارامترها

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

بازگشت

PositionedImage — تصویر جدید موقعیت‌یابی‌شده

مجوز

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

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

appendHorizontalRule()

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

بازگشت

HorizontalRule - قانون افقی جدید

مجوز

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

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

appendInlineImage(image)

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

پارامترها

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

بازگشت

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

مجوز

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

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

appendInlineImage(image)

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

پارامترها

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

بازگشت

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

مجوز

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

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

appendPageBreak()

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

نکته: PageBreaks نمی‌توانند درون TableCells قرار بگیرند. اگر عنصر فعلی درون یک سلول جدول قرار داشته باشد، یک استثنا ایجاد می‌شود.

بازگشت

PageBreak — عنصر جدید شکستن صفحه

مجوز

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

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

appendPageBreak(pageBreak)

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

نکته: PageBreaks نمی‌توانند درون TableCells قرار بگیرند. اگر عنصر فعلی درون یک سلول جدول قرار داشته باشد، یک استثنا ایجاد می‌شود.

پارامترها

نام نوع توضیحات
page Break Page Break شکستن صفحه برای اضافه کردن

بازگشت

PageBreak - عنصر شکست صفحه اضافه شده

مجوز

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

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

appendText(text)

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

پارامترها

نام نوع توضیحات
text String محتوای متن

بازگشت

Text - عنصر متن جدید

مجوز

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

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

appendText(text)

عنصر Text داده شده را اضافه می‌کند.

پارامترها

نام نوع توضیحات
text Text عنصر متنی که قرار است اضافه شود

بازگشت

Text - عنصر متن پیوست شده

مجوز

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

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

clear()

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

بازگشت

ListItem - عنصر فعلی.

copy()

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

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

بازگشت

ListItem — نسخه جدید.

مجوز

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

  • 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

getAlignment()

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

بازگشت

HorizontalAlignment |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

getGlyphType()

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

بازگشت

GlyphType |null — نوع glyph

مجوز

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

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

getHeading()

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

بازگشت

ParagraphHeading |null — عنوان

مجوز

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

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

getIndentEnd()

تورفتگی انتهایی را بر حسب نقطه بازیابی می‌کند.

بازگشت

Number|null — تورفتگی انتهایی، بر حسب نقطه

مجوز

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

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

getIndentFirstLine()

میزان تورفتگی خط اول را بر حسب نقطه برمی‌گرداند.

بازگشت

Number|null — میزان تورفتگی خط اول، بر حسب نقطه

مجوز

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

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

getIndentStart()

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

بازگشت

Number|null — شروع تورفتگی

مجوز

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

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

getLineSpacing()

فاصله بین خطوط را بر حسب نقطه بازیابی می‌کند.

بازگشت

Number|null — فاصله خطوط، بر حسب نقطه

مجوز

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

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

getLinkUrl()

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

بازگشت

String|null — آدرس اینترنتی لینک، یا اگر عنصر شامل چندین مقدار برای این ویژگی باشد، null.

مجوز

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

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

getListId()

شناسه لیست را بازیابی می‌کند.

بازگشت

String|null — شناسه لیست

مجوز

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

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

getNestingLevel()

سطح تودرتوی آیتم لیست را بازیابی می‌کند.

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

بازگشت

Integer - سطح تودرتو

مجوز

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

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

getNextSibling()

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

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

بازگشت

Element |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

getParent()

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

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

بازگشت

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

مجوز

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

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

getPositionedImage(id)

یک PositionedImage را بر اساس شناسه تصویر دریافت می‌کند.

پارامترها

نام نوع توضیحات
id String شناسه تصویر

بازگشت

تصویر PositionedImage - تصویر موقعیت‌یابی‌شده

مجوز

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

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

getPositionedImages()

تمام اشیاء PositionedImage که به پاراگراف متصل شده‌اند را دریافت می‌کند.

بازگشت

PositionedImage[] — فهرستی از تصاویر موقعیت‌یابی‌شده

مجوز

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

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

getPreviousSibling()

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

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

بازگشت

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

مجوز

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

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

getSpacingAfter()

فاصله بعد از عنصر را بر حسب نقطه بازیابی می‌کند.

بازگشت

Number|null — فاصله بعد از عنصر، بر حسب نقطه

مجوز

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

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

getSpacingBefore()

فاصله قبل از عنصر را بر حسب نقطه بازیابی می‌کند.

بازگشت

Number|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 را در اندیس مشخص شده ایجاد و درج می‌کند.

پارامترها

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

بازگشت

HorizontalRule — عنصر جدید خط افقی

مجوز

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

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

insertInlineImage(childIndex, image)

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

پارامترها

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

بازگشت

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

مجوز

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

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

insertInlineImage(childIndex, image)

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

پارامترها

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

بازگشت

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

مجوز

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

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

insertPageBreak(childIndex)

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

نکته: PageBreaks نمی‌توانند درون TableCells قرار بگیرند. اگر عنصر فعلی درون یک سلول جدول قرار داشته باشد، یک استثنا ایجاد می‌شود.

پارامترها

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

بازگشت

PageBreak — عنصر جدید شکستن صفحه

مجوز

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

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

insertPageBreak(childIndex, pageBreak)

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

نکته: PageBreaks نمی‌توانند درون TableCells قرار بگیرند. اگر عنصر فعلی درون یک سلول جدول قرار داشته باشد، یک استثنا ایجاد می‌شود.

پارامترها

نام نوع توضیحات
child Index Integer اندیسی که عنصر در آن قرار می‌گیرد
page Break Page Break صفحه[page break برای درج

بازگشت

PageBreak - عنصر شکست صفحه درج شده

مجوز

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

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

insertText(childIndex, text)

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

پارامترها

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

بازگشت

Text - عنصر متن جدید

مجوز

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

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

insertText(childIndex, text)

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

پارامترها

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

بازگشت

Text - عنصر متن درج شده

مجوز

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

  • 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

isLeftToRight()

تنظیمات چپ به راست را بازیابی می‌کند.

بازگشت

Boolean|null — تنظیم از چپ به راست

مجوز

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

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

merge()

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

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

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

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const 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.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

بازگشت

ListItem |null — عنصر ادغام‌شده.

مجوز

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

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

removeChild(child)

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

پارامترها

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

بازگشت

ListItem - عنصر فعلی

مجوز

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

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

بازگشت

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

مجوز

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

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

removePositionedImage(id)

یک PositionedImage بر اساس شناسه تصویر حذف می‌کند.

پارامترها

نام نوع توضیحات
id String

بازگشت

Boolean - آیا تصویر مشخص شده حذف شده است یا خیر

مجوز

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

  • 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

setAlignment(alignment)

HorizontalAlignment را تنظیم می‌کند.

پارامترها

نام نوع توضیحات
alignment Horizontal Alignment تراز افقی

بازگشت

ListItem - عنصر فعلی

مجوز

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

  • 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 ویژگی‌های عنصر.

بازگشت

ListItem - عنصر فعلی.

مجوز

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

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

setGlyphType(glyphType)

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

پارامترها

نام نوع توضیحات
glyph Type Glyph Type نوع گلیف

بازگشت

ListItem - عنصر فعلی

مجوز

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

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

setHeading(heading)

ParagraphHeading را تنظیم می‌کند.

پارامترها

نام نوع توضیحات
heading Paragraph Heading عنوان

بازگشت

ListItem - عنصر فعلی

مجوز

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

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

setIndentEnd(indentEnd)

تورفتگی انتهایی را بر حسب نقطه تنظیم می‌کند.

پارامترها

نام نوع توضیحات
indent End Number فرورفتگی انتهایی، بر حسب نقطه

بازگشت

ListItem - عنصر فعلی

مجوز

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

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

setIndentFirstLine(indentFirstLine)

میزان تورفتگی خط اول را بر حسب نقطه تنظیم می‌کند.

پارامترها

نام نوع توضیحات
indent First Line Number تورفتگی خط اول، بر حسب نقطه

بازگشت

ListItem - عنصر فعلی

مجوز

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

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

setIndentStart(indentStart)

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

پارامترها

نام نوع توضیحات
indent Start Number تورفتگی شروع، بر حسب نقطه

بازگشت

ListItem - عنصر فعلی

مجوز

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

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

setLeftToRight(leftToRight)

تنظیم چپ به راست را تنظیم می‌کند.

پارامترها

نام نوع توضیحات
left To Right Boolean تنظیم چپ به راست

بازگشت

ListItem - عنصر فعلی

مجوز

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

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

setLineSpacing(multiplier)

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

پارامترها

نام نوع توضیحات
multiplier Number تعداد خطوط

بازگشت

ListItem - عنصر فعلی

مجوز

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

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

setLinkUrl(url)

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

پارامترها

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

بازگشت

ListItem - عنصر فعلی

مجوز

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

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

setListId(listItem)

شناسه لیست را تنظیم می‌کند.

شناسه لیست برای ListItem مشخص شده روی مقدار یکسانی تنظیم شده است. دو ListItems به عنوان اعضای یک لیست در نظر گرفته می‌شوند.

پارامترها

نام نوع توضیحات
list Item List Item آیتم لیستی که شناسه لیست آن قرار است استفاده شود

بازگشت

ListItem - عنصر فعلی

مجوز

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

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

setNestingLevel(nestingLevel)

سطح تودرتو بودن آیتم لیست را تنظیم می‌کند.

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

پارامترها

نام نوع توضیحات
nesting Level Integer سطح لانه سازی

بازگشت

ListItem - عنصر فعلی

مجوز

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

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

setSpacingAfter(spacingAfter)

فاصله بعد از عنصر را بر حسب نقطه تنظیم می‌کند.

پارامترها

نام نوع توضیحات
spacing After Number فاصله بعد از عنصر، بر حسب نقطه

بازگشت

ListItem - عنصر فعلی

مجوز

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

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

setSpacingBefore(spacingBefore)

فاصله قبل از عنصر را بر حسب نقطه تنظیم می‌کند.

پارامترها

نام نوع توضیحات
spacing Before Number فاصله قبل از عنصر، بر حسب نقطه

بازگشت

ListItem - عنصر فعلی

مجوز

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

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

setText(text)

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

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

پارامترها

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

مجوز

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

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

بازگشت

ListItem - عنصر فعلی

مجوز

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

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