Class ListItem

List Item

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

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

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

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

// Append a new list item to the body.
var 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.
var item2 = body.appendListItem('Item 2');
item2.setListId(item1);

روش ها

روش نوع برگشت شرح مختصر
addPositionedImage(image) PositionedImage یک PositionedImage جدید از حباب تصویر مشخص شده ایجاد و درج می کند.
appendHorizontalRule() HorizontalRule یک HorizontalRule جدید ایجاد و اضافه می کند.
appendInlineImage(image) InlineImage یک InlineImage جدید از حباب تصویر مشخص شده ایجاد و اضافه می کند.
appendInlineImage(image) InlineImage InlineImage داده شده را اضافه می کند.
appendPageBreak() PageBreak یک PageBreak جدید ایجاد و اضافه می کند.
appendPageBreak(pageBreak) PageBreak PageBreak داده شده را اضافه می کند.
appendText(text) Text یک عنصر Text جدید با محتوای مشخص شده ایجاد و اضافه می کند.
appendText(text) Text عنصر Text داده شده را اضافه می کند.
clear() ListItem محتویات عنصر را پاک می کند.
copy() ListItem یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند.
editAsText() Text یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می کند.
findElement(elementType) RangeElement محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند.
findElement(elementType, from) RangeElement محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند، که از RangeElement مشخص شده شروع می شود.
findText(searchPattern) RangeElement با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند.
findText(searchPattern, from) RangeElement محتویات عنصر را برای الگوی متن مشخص شده، از یک نتیجه جستجوی معین شروع می کند.
getAlignment() HorizontalAlignment HorizontalAlignment را بازیابی می کند.
getAttributes() Object ویژگی های عنصر را بازیابی می کند.
getChild(childIndex) Element عنصر فرزند را در نمایه فرزند مشخص شده بازیابی می کند.
getChildIndex(child) Integer شاخص فرزند را برای عنصر فرزند مشخص شده بازیابی می کند.
getGlyphType() GlyphType GlyphType مورد فهرست را بازیابی می کند.
getHeading() ParagraphHeading ParagraphHeading را بازیابی می کند.
getIndentEnd() Number تورفتگی انتهایی را در نقاط بازیابی می کند.
getIndentFirstLine() Number تورفتگی خط اول را در نقاط بازیابی می کند.
getIndentStart() Number تورفتگی شروع را بازیابی می کند.
getLineSpacing() Number فاصله خطوط را در نقاط بازیابی می کند.
getLinkUrl() String آدرس لینک را بازیابی می کند.
getListId() String شناسه لیست را بازیابی می کند.
getNestingLevel() Integer سطح تودرتوی مورد فهرست را بازیابی می کند.
getNextSibling() Element عنصر خواهر و برادر بعدی عنصر را بازیابی می کند.
getNumChildren() Integer تعداد فرزندان را بازیابی می کند.
getParent() ContainerElement عنصر والد عنصر را بازیابی می کند.
getPositionedImage(id) PositionedImage با شناسه تصویر یک PositionedImage دریافت می کند.
getPositionedImages() PositionedImage[] تمام اشیاء PositionedImage متصل به پاراگراف را دریافت می کند.
getPreviousSibling() Element عنصر خواهر و برادر قبلی عنصر را بازیابی می کند.
getSpacingAfter() Number فاصله بعد از عنصر را در نقاط بازیابی می کند.
getSpacingBefore() Number فاصله قبل از عنصر، در نقاط را بازیابی می کند.
getText() String محتویات عنصر را به عنوان یک رشته متنی بازیابی می کند.
getTextAlignment() TextAlignment تراز متن را دریافت می کند.
getType() ElementType ElementType عنصر را بازیابی می کند.
insertHorizontalRule(childIndex) HorizontalRule یک HorizontalRule در نمایه مشخص شده ایجاد و درج می کند.
insertInlineImage(childIndex, image) InlineImage یک InlineImage جدید از حباب تصویر مشخص شده، در نمایه مشخص شده ایجاد و درج می کند.
insertInlineImage(childIndex, image) InlineImage InlineImage داده شده را در نمایه مشخص شده درج می کند.
insertPageBreak(childIndex) PageBreak یک PageBreak جدید در ایندکس مشخص شده ایجاد و درج می کند.
insertPageBreak(childIndex, pageBreak) PageBreak PageBreak داده شده را در ایندکس مشخص شده درج می کند.
insertText(childIndex, text) Text یک عنصر متنی جدید را در نمایه مشخص شده ایجاد و درج می کند.
insertText(childIndex, text) Text عنصر Text داده شده را با محتوای متن مشخص شده در فهرست مشخص شده درج می کند.
isAtDocumentEnd() Boolean تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
isLeftToRight() Boolean تنظیمات چپ به راست را بازیابی می کند.
merge() ListItem عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند.
removeChild(child) ListItem عنصر فرزند مشخص شده را حذف می کند.
removeFromParent() ListItem عنصر را از والد خود حذف می کند.
removePositionedImage(id) Boolean یک PositionedImage با شناسه تصویر حذف می کند.
replaceText(searchPattern, replacement) Element با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین می‌کند.
setAlignment(alignment) ListItem HorizontalAlignment را تنظیم می کند.
setAttributes(attributes) ListItem ویژگی های عنصر را تنظیم می کند.
setGlyphType(glyphType) ListItem GlyphType مورد لیست را تنظیم می کند.
setHeading(heading) ListItem ParagraphHeading را تنظیم می کند.
setIndentEnd(indentEnd) ListItem تورفتگی انتهایی را در نقاط تنظیم می کند.
setIndentFirstLine(indentFirstLine) ListItem تورفتگی خط اول را در نقاط تنظیم می کند.
setIndentStart(indentStart) ListItem تورفتگی شروع را در نقاط تنظیم می کند.
setLeftToRight(leftToRight) ListItem تنظیمات چپ به راست را تنظیم می کند.
setLineSpacing(multiplier) ListItem فاصله خطوط را به عنوان کمیتی تنظیم می کند که نشان دهنده تعداد خطوطی است که برای فاصله گذاری استفاده می شود.
setLinkUrl(url) ListItem آدرس لینک را تنظیم می کند.
setListId(listItem) ListItem شناسه لیست را تنظیم می کند.
setNestingLevel(nestingLevel) ListItem سطح تودرتوی مورد فهرست را تنظیم می کند.
setSpacingAfter(spacingAfter) ListItem فاصله بعد از عنصر را بر حسب نقطه تنظیم می کند.
setSpacingBefore(spacingBefore) ListItem فاصله قبل از عنصر را بر حسب نقطه تنظیم می کند.
setText(text) void محتویات آیتم لیست را به عنوان متن تنظیم می کند.
setTextAlignment(textAlignment) ListItem تراز متن را تنظیم می کند.

مستندات دقیق

addPositionedImage(image)

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

پارامترها

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

بازگشت

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 BlobSource داده های تصویر

بازگشت

InlineImage - تصویر ضمیمه شده

مجوز

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

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

appendInlineImage(image)

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

پارامترها

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

بازگشت

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

پارامترها

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

بازگشت

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 ) را نادیده می گیرد.

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

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

getAlignment()

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

بازگشت

HorizontalAlignment - تراز

مجوز

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

  • 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

getGlyphType()

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

بازگشت

GlyphType - نوع گلیف

مجوز

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

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

getHeading()

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

بازگشت

ParagraphHeading - عنوان

مجوز

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

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

getIndentEnd()

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

بازگشت

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

مجوز

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

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

getIndentFirstLine()

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

بازگشت

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

مجوز

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

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

getIndentStart()

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

بازگشت

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

مجوز

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

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

getLineSpacing()

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

بازگشت

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

مجوز

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

  • 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

getListId()

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

بازگشت

String - شناسه لیست

مجوز

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

  • 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 - عنصر خواهر و برادر بعدی.

مجوز

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

  • 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

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 - عنصر خواهر و برادر قبلی.

مجوز

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

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

getSpacingAfter()

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

بازگشت

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

مجوز

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

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

getSpacingBefore()

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

بازگشت

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

مجوز

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

  • 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

insertHorizontalRule(childIndex)

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

پارامترها

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

بازگشت

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

مجوز

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

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

insertInlineImage(childIndex, image)

یک InlineImage جدید از حباب تصویر مشخص شده، در نمایه مشخص شده ایجاد و درج می کند.

پارامترها

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

بازگشت

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

مجوز

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

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

insertInlineImage(childIndex, image)

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

پارامترها

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

بازگشت

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

مجوز

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

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

insertPageBreak(childIndex)

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

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

پارامترها

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

بازگشت

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

مجوز

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

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

insertPageBreak(childIndex, pageBreak)

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

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

پارامترها

نام تایپ کنید توضیحات
childIndex Integer شاخصی که در آن عنصر درج می شود
pageBreak PageBreak p[age break برای درج

بازگشت

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

مجوز

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

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

insertText(childIndex, text)

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

پارامترها

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

بازگشت

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

مجوز

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

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

insertText(childIndex, text)

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

پارامترها

نام تایپ کنید توضیحات
childIndex 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 - تنظیم چپ به راست

مجوز

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

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

بازگشت

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

مجوز

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

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

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

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

بازگشت

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

مجوز

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

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

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

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

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

setAlignment(alignment)

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

پارامترها

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

بازگشت

ListItem - عنصر فعلی

مجوز

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

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

بازگشت

ListItem - عنصر فعلی.

مجوز

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

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

setGlyphType(glyphType)

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

پارامترها

نام تایپ کنید توضیحات
glyphType GlyphType نوع گلیف

بازگشت

ListItem - عنصر فعلی

مجوز

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

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

setHeading(heading)

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

پارامترها

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

بازگشت

ListItem - عنصر فعلی

مجوز

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

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

setIndentEnd(indentEnd)

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

پارامترها

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

بازگشت

ListItem - عنصر فعلی

مجوز

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

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

setIndentFirstLine(indentFirstLine)

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

پارامترها

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

بازگشت

ListItem - عنصر فعلی

مجوز

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

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

setIndentStart(indentStart)

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

پارامترها

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

بازگشت

ListItem - عنصر فعلی

مجوز

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

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

setLeftToRight(leftToRight)

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

پارامترها

نام تایپ کنید توضیحات
leftToRight 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 به عنوان اعضای یک لیست در نظر گرفته می شوند.

پارامترها

نام تایپ کنید توضیحات
listItem ListItem آیتم فهرستی که شناسه فهرست آن برای استفاده

بازگشت

ListItem - عنصر فعلی

مجوز

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

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

setNestingLevel(nestingLevel)

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

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

پارامترها

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

بازگشت

ListItem - عنصر فعلی

مجوز

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

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

setSpacingAfter(spacingAfter)

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

پارامترها

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

بازگشت

ListItem - عنصر فعلی

مجوز

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

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

setSpacingBefore(spacingBefore)

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

پارامترها

نام تایپ کنید توضیحات
spacingBefore 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.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

پارامترها

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

بازگشت

ListItem - عنصر فعلی

مجوز

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

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