Class ListItem

مورد فهرست

عنصری که یک آیتم لیست را نشان می دهد. List Item Paragraph است که با شناسه لیست مرتبط است. یک List Item ممکن است شامل Equation ، Footnote ، Horizontal Rule ، Inline Drawing ، Inline Image ، Page Break و عناصر Text باشد. برای اطلاعات بیشتر در مورد ساختار سند، راهنمای گسترش Google Docs را ببینید.

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

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

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 محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند.
find Element(elementType, from) Range Element محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند، که از Range Element مشخص شده شروع می شود.
find Text(searchPattern) Range Element با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند.
find Text(searchPattern, from) Range Element محتویات عنصر را برای الگوی متن مشخص شده، از یک نتیجه جستجوی معین شروع می کند.
get Alignment() Horizontal Alignment Horizontal Alignment را بازیابی می کند.
get Attributes() Object ویژگی های عنصر را بازیابی می کند.
get Child(childIndex) Element عنصر فرزند را در نمایه فرزند مشخص شده بازیابی می کند.
get Child Index(child) Integer شاخص فرزند را برای عنصر فرزند مشخص شده بازیابی می کند.
get Glyph Type() Glyph Type Glyph Type فهرست مورد را بازیابی می کند.
get Heading() Paragraph Heading Paragraph Heading را بازیابی می کند.
get Indent End() Number تورفتگی انتهایی را در نقاط بازیابی می کند.
get Indent First Line() Number تورفتگی خط اول را در نقاط بازیابی می کند.
get Indent Start() Number تورفتگی شروع را بازیابی می کند.
get Line Spacing() Number فاصله خطوط را در نقاط بازیابی می کند.
get Link Url() String آدرس لینک را بازیابی می کند.
get List Id() String شناسه لیست را بازیابی می کند.
get Nesting Level() Integer سطح تودرتوی مورد فهرست را بازیابی می کند.
get Next Sibling() Element عنصر خواهر و برادر بعدی عنصر را بازیابی می کند.
get Num Children() Integer تعداد فرزندان را بازیابی می کند.
get Parent() Container Element عنصر والد عنصر را بازیابی می کند.
get Positioned Image(id) Positioned Image یک Positioned Image با شناسه تصویر دریافت می‌کند.
get Positioned Images() Positioned Image[] همه اشیاء Positioned Image را به پاراگراف متصل می‌کند.
get Previous Sibling() Element عنصر خواهر و برادر قبلی عنصر را بازیابی می کند.
get Spacing After() Number فاصله بعد از عنصر را در نقاط بازیابی می کند.
get Spacing Before() Number فاصله قبل از عنصر، در نقاط را بازیابی می کند.
get Text() String محتویات عنصر را به عنوان یک رشته متنی بازیابی می کند.
get Text Alignment() Text Alignment تراز متن را دریافت می کند.
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 تنظیمات چپ به راست را بازیابی می کند.
merge() List Item عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند.
remove Child(child) List Item عنصر فرزند مشخص شده را حذف می کند.
remove From Parent() List Item عنصر را از والد خود حذف می کند.
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 تراز متن را تنظیم می کند.

مستندات دقیق

add Positioned Image(image)

یک Positioned Image جدید از حباب تصویر مشخص شده ایجاد و درج می‌کند.

پارامترها

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

بازگشت

Positioned Image - تصویر موقعیت‌یافته جدید

مجوز

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

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

append Horizontal Rule()

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

بازگشت

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

مجوز

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

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

append Inline Image(image)

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

پارامترها

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

بازگشت

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

مجوز

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

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

append Inline Image(image)

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

پارامترها

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

بازگشت

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

مجوز

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

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

append Page Break()

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

توجه: Page Breaks ممکن است در Table Cells وجود نداشته باشد. اگر عنصر فعلی در یک سلول جدول وجود داشته باشد، یک استثنا ایجاد می شود.

بازگشت

Page Break - عنصر جدید شکستن صفحه

مجوز

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

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

append Page Break(pageBreak)

Page Break داده شده را اضافه می کند.

توجه: Page Breaks ممکن است در Table Cells وجود نداشته باشد. اگر عنصر فعلی در یک سلول جدول وجود داشته باشد، یک استثنا ایجاد می شود.

پارامترها

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

بازگشت

Page Break - عنصر شکست صفحه الحاق شده

مجوز

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

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

append Text(text)

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

پارامترها

نام تایپ کنید توضیحات
text String محتویات متن

بازگشت

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

مجوز

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

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

append Text(text)

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

پارامترها

نام تایپ کنید توضیحات
text Text عنصر متن برای اضافه کردن

بازگشت

Text - عنصر متن ضمیمه شده

مجوز

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

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

clear()

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

بازگشت

List Item - عنصر فعلی.

copy()

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

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

بازگشت

List Item - کپی جدید.

مجوز

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

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

Horizontal Alignment را بازیابی می کند.

بازگشت

Horizontal Alignment - هم ترازی

مجوز

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

  • 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 Glyph Type()

Glyph Type فهرست مورد را بازیابی می کند.

بازگشت

Glyph Type - نوع گلیف

مجوز

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

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

get Heading()

Paragraph Heading را بازیابی می کند.

بازگشت

Paragraph Heading - عنوان

مجوز

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

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

get Indent End()

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

بازگشت

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

مجوز

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

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

get Indent First Line()

تورفتگی خط اول را در نقاط بازیابی می کند.

بازگشت

Number - تورفتگی خط اول، در نقاط

مجوز

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

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

get Indent Start()

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

بازگشت

Number - تورفتگی شروع

مجوز

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

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

get Line Spacing()

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

بازگشت

Number - فاصله خطوط، در نقاط

مجوز

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

  • 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 List Id()

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

بازگشت

String - شناسه لیست

مجوز

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

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

get Nesting Level()

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

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

بازگشت

Integer - سطح تودرتو

مجوز

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

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

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

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

بازگشت

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

مجوز

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

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

get Positioned Image(id)

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

پارامترها

نام تایپ کنید توضیحات
id String شناسه تصویر

بازگشت

Positioned Image - تصویر موقعیت‌یافته

مجوز

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

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

get Positioned Images()

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

بازگشت

Positioned Image[] - فهرستی از تصاویر موقعیت‌یافته

مجوز

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

  • 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

get Spacing After()

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

بازگشت

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

مجوز

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

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

get Spacing Before()

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

بازگشت

Number - فاصله قبل از عنصر، در نقاط

مجوز

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

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

پارامترها

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

بازگشت

Horizontal Rule - عنصر قانون افقی جدید

مجوز

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

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

insert Inline 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 Inline Image(childIndex, image)

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

پارامترها

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

بازگشت

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

مجوز

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

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

insert Page Break(childIndex)

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

توجه: Page Breaks ممکن است در Table Cells وجود نداشته باشد. اگر عنصر فعلی در یک سلول جدول وجود داشته باشد، یک استثنا ایجاد می شود.

پارامترها

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

بازگشت

Page Break - عنصر جدید شکستن صفحه

مجوز

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

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

insert Page Break(childIndex, pageBreak)

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

توجه: Page Breaks ممکن است در Table Cells وجود نداشته باشد. اگر عنصر فعلی در یک سلول جدول وجود داشته باشد، یک استثنا ایجاد می شود.

پارامترها

نام تایپ کنید توضیحات
child Index Integer شاخصی که در آن عنصر درج می شود
page Break Page Break p[age break برای درج

بازگشت

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

مجوز

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

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

insert Text(childIndex, text)

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

پارامترها

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

بازگشت

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

مجوز

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

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

insert Text(childIndex, text)

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

پارامترها

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

بازگشت

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

مجوز

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

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

is At Document End()

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

بازگشت

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

مجوز

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

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

is Left To Right()

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

بازگشت

Boolean - تنظیم چپ به راست

مجوز

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

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

merge()

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

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

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

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

بازگشت

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

مجوز

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

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

remove Child(child)

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

پارامترها

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

بازگشت

List Item - عنصر فعلی

مجوز

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

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

بازگشت

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

مجوز

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

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

remove Positioned Image(id)

یک Positioned Image توسط شناسه تصویر را حذف می کند.

پارامترها

نام تایپ کنید توضیحات
id String

بازگشت

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

مجوز

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

  • 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 Alignment(alignment)

Horizontal Alignment را تنظیم می کند.

پارامترها

نام تایپ کنید توضیحات
alignment Horizontal Alignment تراز افقی

بازگشت

List Item - عنصر فعلی

مجوز

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

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

بازگشت

List Item - عنصر فعلی.

مجوز

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

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

set Glyph Type(glyphType)

Glyph Type مورد لیست را تنظیم می کند.

پارامترها

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

بازگشت

List Item - عنصر فعلی

مجوز

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

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

set Heading(heading)

Paragraph Heading تنظیم می کند.

پارامترها

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

بازگشت

List Item - عنصر فعلی

مجوز

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

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

set Indent End(indentEnd)

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

پارامترها

نام تایپ کنید توضیحات
indent End Number تورفتگی انتهایی، در نقاط

بازگشت

List Item - عنصر فعلی

مجوز

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

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

set Indent First Line(indentFirstLine)

تورفتگی خط اول را در نقاط تنظیم می کند.

پارامترها

نام تایپ کنید توضیحات
indent First Line Number تورفتگی خط اول، در نقاط

بازگشت

List Item - عنصر فعلی

مجوز

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

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

set Indent Start(indentStart)

تورفتگی شروع را در نقاط تنظیم می کند.

پارامترها

نام تایپ کنید توضیحات
indent Start Number تورفتگی شروع، در نقاط

بازگشت

List Item - عنصر فعلی

مجوز

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

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

set Left To Right(leftToRight)

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

پارامترها

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

بازگشت

List Item - عنصر فعلی

مجوز

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

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

set Line Spacing(multiplier)

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

پارامترها

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

بازگشت

List Item - عنصر فعلی

مجوز

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

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

set Link Url(url)

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

پارامترها

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

بازگشت

List Item - عنصر فعلی

مجوز

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

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

set List Id(listItem)

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

شناسه لیست برای List Item مشخص شده روی همان مقدار تنظیم شده است. دو List Items به عنوان اعضای یک لیست تلقی خواهند شد.

پارامترها

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

بازگشت

List Item - عنصر فعلی

مجوز

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

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

set Nesting Level(nestingLevel)

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

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

پارامترها

نام تایپ کنید توضیحات
nesting Level Integer سطح تودرتو

بازگشت

List Item - عنصر فعلی

مجوز

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

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

set Spacing After(spacingAfter)

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

پارامترها

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

بازگشت

List Item - عنصر فعلی

مجوز

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

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

set Spacing Before(spacingBefore)

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

پارامترها

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

بازگشت

List Item - عنصر فعلی

مجوز

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

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

set Text(text)

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

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

پارامترها

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

مجوز

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

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

بازگشت

List Item - عنصر فعلی

مجوز

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

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