محتوای یک برگه در سند Google Docs. Body
ممکن است حاوی عناصر ListItem
، Paragraph
، Table
و TableOfContents
باشد. برای اطلاعات بیشتر در مورد ساختار سند، راهنمای گسترش Google Docs را ببینید.
Body
معمولاً شامل محتویات برگه کامل به جز HeaderSection
، FooterSection
و هر عنصر FootnoteSection
است.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Append a paragraph and a page break to the tab's body section directly. body.appendParagraph("A paragraph."); body.appendPageBreak();
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
appendHorizontalRule() | HorizontalRule | یک HorizontalRule جدید ایجاد و اضافه می کند. |
appendImage(image) | InlineImage | یک InlineImage جدید از حباب تصویر مشخص شده ایجاد و اضافه می کند. |
appendImage(image) | InlineImage | InlineImage داده شده را اضافه می کند. |
appendListItem(listItem) | ListItem | ListItem داده شده را اضافه می کند. |
appendListItem(text) | ListItem | یک ListItem جدید حاوی محتوای متن مشخص شده ایجاد و اضافه می کند. |
appendPageBreak() | PageBreak | یک PageBreak جدید ایجاد و اضافه می کند. |
appendPageBreak(pageBreak) | PageBreak | PageBreak داده شده را اضافه می کند. |
appendParagraph(paragraph) | Paragraph | Paragraph داده شده را ضمیمه می کند. |
appendParagraph(text) | Paragraph | یک Paragraph جدید حاوی محتوای متن مشخص شده ایجاد و اضافه می کند. |
appendTable() | Table | یک Table جدید ایجاد و اضافه می کند. |
appendTable(cells) | Table | یک Table جدید حاوی TableCell برای هر مقدار رشته مشخص شده اضافه می کند. |
appendTable(table) | Table | Table داده شده را ضمیمه می کند. |
clear() | Body | محتویات عنصر را پاک می کند. |
copy() | Body | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
editAsText() | Text | یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می کند. |
findElement(elementType) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند. |
findElement(elementType, from) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند، که از RangeElement مشخص شده شروع می شود. |
findText(searchPattern) | RangeElement | با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند. |
findText(searchPattern, from) | RangeElement | محتویات عنصر را برای الگوی متن مشخص شده، از یک نتیجه جستجوی معین شروع می کند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getChild(childIndex) | Element | عنصر فرزند را در نمایه فرزند مشخص شده بازیابی می کند. |
getChildIndex(child) | Integer | شاخص فرزند را برای عنصر فرزند مشخص شده بازیابی می کند. |
getHeadingAttributes(paragraphHeading) | Object | مجموعه ای از ویژگی ها را برای ParagraphHeading ارائه شده بازیابی می کند. |
getImages() | InlineImage[] | همه InlineImages موجود در بخش را بازیابی می کند. |
getListItems() | ListItem[] | همه ListItems موجود در بخش را بازیابی می کند. |
getMarginBottom() | Number | حاشیه پایین را به صورت امتیاز بازیابی می کند. |
getMarginLeft() | Number | حاشیه سمت چپ را بر حسب امتیاز بازیابی می کند. |
getMarginRight() | Number | حاشیه سمت راست را بازیابی می کند. |
getMarginTop() | Number | حاشیه بالایی را بازیابی می کند. |
getNumChildren() | Integer | تعداد فرزندان را بازیابی می کند. |
getPageHeight() | Number | ارتفاع صفحه را بر حسب امتیاز بازیابی می کند. |
getPageWidth() | Number | عرض صفحه را بر حسب نقطه بازیابی می کند. |
getParagraphs() | Paragraph[] | تمام Paragraphs موجود در بخش (از جمله ListItems ) را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getTables() | Table[] | تمام Tables موجود در بخش را بازیابی می کند. |
getText() | String | محتویات عنصر را به عنوان یک رشته متنی بازیابی می کند. |
getTextAlignment() | TextAlignment | تراز متن را دریافت می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
insertHorizontalRule(childIndex) | HorizontalRule | یک HorizontalRule جدید در نمایه مشخص شده ایجاد و درج می کند. |
insertImage(childIndex, image) | InlineImage | یک InlineImage از حباب تصویر مشخص شده، در نمایه مشخص شده ایجاد و درج می کند. |
insertImage(childIndex, image) | InlineImage | InlineImage داده شده را در نمایه مشخص شده درج می کند. |
insertListItem(childIndex, listItem) | ListItem | ListItem داده شده را در نمایه مشخص شده درج می کند. |
insertListItem(childIndex, text) | ListItem | یک ListItem جدید را در نمایه مشخص شده ایجاد و درج می کند که حاوی محتوای متن مشخص شده است. |
insertPageBreak(childIndex) | PageBreak | یک PageBreak جدید در ایندکس مشخص شده ایجاد و درج می کند. |
insertPageBreak(childIndex, pageBreak) | PageBreak | PageBreak داده شده را در ایندکس مشخص شده درج می کند. |
insertParagraph(childIndex, paragraph) | Paragraph | Paragraph داده شده را در نمایه مشخص شده درج می کند. |
insertParagraph(childIndex, text) | Paragraph | یک Paragraph جدید را در نمایه مشخص شده ایجاد و درج می کند که حاوی محتوای متن مشخص شده است. |
insertTable(childIndex) | Table | یک Table جدید در نمایه مشخص شده ایجاد و درج می کند. |
insertTable(childIndex, cells) | Table | یک Table جدید حاوی سلول های مشخص شده را در نمایه مشخص شده ایجاد و درج می کند. |
insertTable(childIndex, table) | Table | Table داده شده را در نمایه مشخص شده درج می کند. |
removeChild(child) | Body | عنصر فرزند مشخص شده را حذف می کند. |
replaceText(searchPattern, replacement) | Element | با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین میکند. |
setAttributes(attributes) | Body | ویژگی های عنصر را تنظیم می کند. |
setHeadingAttributes(paragraphHeading, attributes) | Body | ویژگی ها را برای ParagraphHeading ارائه شده تنظیم می کند. |
setMarginBottom(marginBottom) | Body | حاشیه پایین را بر حسب امتیاز تنظیم می کند. |
setMarginLeft(marginLeft) | Body | حاشیه سمت چپ را بر حسب امتیاز تنظیم می کند. |
setMarginRight(marginRight) | Body | حاشیه سمت راست را بر حسب امتیاز تنظیم می کند. |
setMarginTop(marginTop) | Body | حاشیه بالایی را تنظیم می کند. |
setPageHeight(pageHeight) | Body | ارتفاع صفحه را بر حسب نقطه تنظیم می کند. |
setPageWidth(pageWidth) | Body | عرض صفحه را بر حسب نقطه تنظیم می کند. |
setText(text) | Body | محتویات را به صورت متن ساده تنظیم می کند. |
setTextAlignment(textAlignment) | Body | تراز متن را تنظیم می کند. |
مستندات دقیق
appendHorizontalRule()
یک HorizontalRule
جدید ایجاد و اضافه می کند.
HorizontalRule
در یک Paragraph
جدید گنجانده خواهد شد.
بازگشت
HorizontalRule
- قانون افقی جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
یک InlineImage
جدید از حباب تصویر مشخص شده ایجاد و اضافه می کند.
تصویر در یک Paragraph
جدید قرار خواهد گرفت.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
image | BlobSource | داده های تصویر |
بازگشت
InlineImage
- تصویر ضمیمه شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
InlineImage
داده شده را اضافه می کند.
InlineImage
در یک Paragraph
جدید قرار خواهد گرفت.
از این نسخه از appendImage
هنگام ضمیمه یک کپی از InlineImage
موجود استفاده کنید.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
image | InlineImage | داده های تصویر |
بازگشت
InlineImage
- تصویر ضمیمه شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendListItem(listItem)
ListItem
داده شده را اضافه می کند.
از این نسخه appendListItem
هنگام ضمیمه یک کپی از ListItem
موجود استفاده کنید.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
listItem | ListItem | مورد فهرست برای پیوست. |
بازگشت
ListItem
- مورد لیست ضمیمه شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendListItem(text)
یک ListItem
جدید حاوی محتوای متن مشخص شده ایجاد و اضافه می کند.
موارد متوالی لیست به عنوان بخشی از همان لیست اضافه می شوند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
text | String | محتوای متن مورد فهرست |
بازگشت
ListItem
- مورد جدید لیست.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendPageBreak()
یک PageBreak
جدید ایجاد و اضافه می کند.
PageBreak
در یک Paragraph
جدید گنجانده خواهد شد.
بازگشت
PageBreak
- شکستن صفحه جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendPageBreak(pageBreak)
PageBreak
داده شده را اضافه می کند.
PageBreak
در یک Paragraph
جدید گنجانده خواهد شد.
از این نسخه appendPageBreak
هنگام ضمیمه یک کپی از PageBreak
موجود استفاده کنید.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
pageBreak | PageBreak | صفحه شکسته برای افزودن. |
بازگشت
PageBreak
- شکست صفحه اضافه شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendParagraph(paragraph)
Paragraph
داده شده را ضمیمه می کند.
از این نسخه appendParagraph
هنگام ضمیمه یک نسخه از یک Paragraph
موجود استفاده کنید.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
paragraph | Paragraph | پاراگراف برای الحاق |
بازگشت
Paragraph
- پاراگراف الحاقی.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendParagraph(text)
یک Paragraph
جدید حاوی محتوای متن مشخص شده ایجاد و اضافه می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
text | String | محتوای متن پاراگراف |
بازگشت
Paragraph
- پاراگراف جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendTable()
یک Table
جدید ایجاد و اضافه می کند.
این روش همچنین یک پاراگراف خالی را بعد از جدول اضافه می کند، زیرا اسناد Google Docs نمی توانند به جدول ختم شوند.
بازگشت
Table
- جدول جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendTable(cells)
یک Table
جدید حاوی TableCell
برای هر مقدار رشته مشخص شده اضافه می کند.
این روش همچنین یک پاراگراف خالی را بعد از جدول اضافه می کند، زیرا اسناد Google Docs نمی توانند به جدول ختم شوند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
cells | String[][] | محتویات متن سلول های جدول برای اضافه کردن به جدول جدید. |
بازگشت
Table
- جدول پیوست.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendTable(table)
Table
داده شده را ضمیمه می کند.
از این نسخه از appendTable
هنگام ضمیمه کردن یک کپی از Table
موجود استفاده کنید. این روش همچنین یک پاراگراف خالی را بعد از جدول اضافه می کند، زیرا اسناد Google Docs نمی توانند به جدول ختم شوند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
table | Table | جدول ضمیمه |
بازگشت
Table
- جدول پیوست.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
copy()
یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند.
هر عنصر فرزند موجود در عنصر نیز کپی می شود. عنصر جدید والد ندارد.
بازگشت
Body
- نسخه جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
editAsText()
یک نسخه Text
از عنصر فعلی را برای ویرایش دریافت می کند.
از editAsText
برای دستکاری محتویات عناصر به عنوان متن غنی استفاده کنید. حالت editAsText
عناصر غیر متنی (مانند InlineImage
و HorizontalRule
) را نادیده می گیرد.
عناصر فرزند به طور کامل در محدوده متن حذف شده از عنصر حذف می شوند.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, "An editAsText sample."); body.insertHorizontalRule(0); body.insertParagraph(0, "An example."); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
بازگشت
Text
- نسخه متنی عنصر فعلی
findElement(elementType)
محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
elementType | ElementType | نوع عنصر مورد جستجو |
بازگشت
RangeElement
- یک نتیجه جستجو که موقعیت عنصر جستجو را نشان می دهد.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findElement(elementType, from)
محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند، که از RangeElement
مشخص شده شروع می شود.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Define the search parameters. var searchType = DocumentApp.ElementType.PARAGRAPH; var searchHeading = DocumentApp.ParagraphHeading.HEADING1; var searchResult = null; // Search until the paragraph is found. while (searchResult = body.findElement(searchType, searchResult)) { var par = searchResult.getElement().asParagraph(); if (par.getHeading() == searchHeading) { // Found one, update and stop. par.setText('This is the first header.'); return; } }
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
elementType | ElementType | نوع عنصر مورد جستجو |
from | RangeElement | نتیجه جستجو برای جستجو از. |
بازگشت
RangeElement
- یک نتیجه جستجو که موقعیت بعدی عنصر جستجو را نشان می دهد.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern)
با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند.
زیرمجموعه ای از ویژگی های عبارت منظم جاوا اسکریپت به طور کامل پشتیبانی نمی شود، مانند گروه های ضبط و اصلاح کننده های حالت.
الگوی عبارت منظم ارائه شده به طور مستقل با هر بلوک متن موجود در عنصر فعلی مطابقت دارد.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
searchPattern | String | الگوی مورد جستجو |
بازگشت
RangeElement
- یک نتیجه جستجو که موقعیت متن جستجو را نشان می دهد، یا اگر مطابقت نداشته باشد، پوچ است
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
محتویات عنصر را برای الگوی متن مشخص شده، از یک نتیجه جستجوی معین شروع می کند.
زیرمجموعه ای از ویژگی های عبارت منظم جاوا اسکریپت به طور کامل پشتیبانی نمی شود، مانند گروه های ضبط و اصلاح کننده های حالت.
الگوی عبارت منظم ارائه شده به طور مستقل با هر بلوک متن موجود در عنصر فعلی مطابقت دارد.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
searchPattern | String | الگوی مورد جستجو |
from | RangeElement | نتیجه جستجو برای جستجو از |
بازگشت
RangeElement
- یک نتیجه جستجو که موقعیت بعدی متن جستجو را نشان می دهد، یا اگر مطابقت نداشته باشد، پوچ است
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAttributes()
ویژگی های عنصر را بازیابی می کند.
نتیجه یک شی حاوی یک ویژگی برای هر ویژگی عنصر معتبر است که در آن نام هر ویژگی با یک مورد در شمارش DocumentApp.Attribute
مطابقت دارد.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Append a styled paragraph. var par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. var atts = par.getAttributes(); // Log the paragraph attributes. for (var att in atts) { Logger.log(att + ":" + atts[att]); }
بازگشت
Object
- ویژگی های عنصر.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChild(childIndex)
عنصر فرزند را در نمایه فرزند مشخص شده بازیابی می کند.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. var firstChild = body.getChild(0); // If it's a paragraph, set its contents. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { firstChild.asParagraph().setText("This is the first paragraph."); }
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
childIndex | Integer | شاخص عنصر فرزند برای بازیابی. |
بازگشت
Element
- عنصر فرزند در شاخص مشخص شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChildIndex(child)
شاخص فرزند را برای عنصر فرزند مشخص شده بازیابی می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
child | Element | عنصر فرزند که برای بازیابی ایندکس. |
بازگشت
Integer
- شاخص فرزند.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getHeadingAttributes(paragraphHeading)
مجموعه ای از ویژگی ها را برای ParagraphHeading
ارائه شده بازیابی می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
paragraphHeading | ParagraphHeading | عنوانی که ویژگی های آن باید بازیابی شوند. |
بازگشت
Object
- نقشه ای از ویژگی ها و مقادیر فعلی آنها.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getImages()
همه InlineImages
موجود در بخش را بازیابی می کند.
بازگشت
InlineImage[]
- تصاویر بخش.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getListItems()
همه ListItems
موجود در بخش را بازیابی می کند.
بازگشت
ListItem[]
- موارد فهرست بخش.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getMarginBottom()
حاشیه پایین را به صورت امتیاز بازیابی می کند.
بازگشت
Number
- حاشیه پایین، بر حسب امتیاز.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getMarginLeft()
حاشیه سمت چپ را بر حسب امتیاز بازیابی می کند.
بازگشت
Number
- حاشیه سمت چپ، بر حسب امتیاز.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getMarginRight()
حاشیه سمت راست را بازیابی می کند.
بازگشت
Number
- حاشیه سمت راست، بر حسب امتیاز.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getMarginTop()
حاشیه بالایی را بازیابی می کند.
بازگشت
Number
- حاشیه بالا، بر حسب امتیاز.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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
getPageHeight()
ارتفاع صفحه را بر حسب امتیاز بازیابی می کند.
بازگشت
Number
- ارتفاع صفحه، بر حسب امتیاز.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPageWidth()
عرض صفحه را بر حسب نقطه بازیابی می کند.
بازگشت
Number
- عرض صفحه، بر حسب امتیاز.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParagraphs()
تمام Paragraphs
موجود در بخش (از جمله ListItems
) را بازیابی می کند.
بازگشت
Paragraph[]
- پاراگراف های بخش.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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
getTables()
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
جدید در نمایه مشخص شده ایجاد و درج می کند.
HorizontalRule
در یک Paragraph
جدید گنجانده خواهد شد.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
childIndex | Integer | شاخصی که در آن عنصر درج می شود. |
بازگشت
HorizontalRule
- قانون افقی جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
یک InlineImage
از حباب تصویر مشخص شده، در نمایه مشخص شده ایجاد و درج می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
childIndex | Integer | شاخصی که در آن عنصر درج می شود. |
image | BlobSource | داده های تصویر |
بازگشت
InlineImage
- تصویر درون خطی درج شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
InlineImage
داده شده را در نمایه مشخص شده درج می کند.
تصویر در یک Paragraph
جدید قرار خواهد گرفت.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
childIndex | Integer | شاخصی که در آن عنصر درج می شود. |
image | InlineImage | تصویر برای درج |
بازگشت
InlineImage
- تصویر درون خطی درج شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertListItem(childIndex, listItem)
ListItem
داده شده را در نمایه مشخص شده درج می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
childIndex | Integer | شاخصی که در آن درج شود. |
listItem | ListItem | مورد لیست برای درج. |
بازگشت
ListItem
- آیتم فهرست درج شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertListItem(childIndex, text)
یک ListItem
جدید را در نمایه مشخص شده ایجاد و درج می کند که حاوی محتوای متن مشخص شده است.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
childIndex | Integer | شاخصی که در آن درج شود. |
text | String | محتوای متن مورد فهرست |
بازگشت
ListItem
- مورد جدید لیست.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex)
یک PageBreak
جدید در ایندکس مشخص شده ایجاد و درج می کند.
PageBreak
در یک Paragraph
جدید گنجانده خواهد شد.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
childIndex | Integer | شاخصی که در آن عنصر درج می شود. |
بازگشت
PageBreak
- شکستن صفحه جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex, pageBreak)
PageBreak
داده شده را در ایندکس مشخص شده درج می کند.
PageBreak
در یک Paragraph
جدید گنجانده خواهد شد.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
childIndex | Integer | شاخصی که در آن عنصر درج می شود. |
pageBreak | PageBreak | شکستن صفحه برای درج. |
بازگشت
PageBreak
- شکست صفحه درج شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, paragraph)
Paragraph
داده شده را در نمایه مشخص شده درج می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
childIndex | Integer | شاخصی که در آن درج شود. |
paragraph | Paragraph | پاراگراف برای درج |
بازگشت
Paragraph
- پاراگراف درج شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, text)
یک Paragraph
جدید را در نمایه مشخص شده ایجاد و درج می کند که حاوی محتوای متن مشخص شده است.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
childIndex | Integer | شاخصی که در آن درج شود. |
text | String | محتوای متن پاراگراف |
بازگشت
Paragraph
- پاراگراف جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex)
یک Table
جدید در نمایه مشخص شده ایجاد و درج می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
childIndex | Integer | شاخصی که در آن درج شود. |
بازگشت
Table
- جدول جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex, cells)
یک Table
جدید حاوی سلول های مشخص شده را در نمایه مشخص شده ایجاد و درج می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
childIndex | Integer | شاخصی که در آن درج شود. |
cells | String[][] | محتویات متن سلول های جدول برای اضافه کردن به جدول جدید. |
بازگشت
Table
- جدول جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex, table)
Table
داده شده را در نمایه مشخص شده درج می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
childIndex | Integer | شاخصی که در آن درج شود. |
table | Table | جدول برای درج. |
بازگشت
Table
- جدول درج شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeChild(child)
عنصر فرزند مشخص شده را حذف می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
child | Element | عنصر فرزند برای حذف. |
بازگشت
Body
- عنصر فعلی.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replaceText(searchPattern, replacement)
با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین میکند.
الگوی جستجو به عنوان یک رشته ارسال می شود، نه یک شیء عبارت منظم جاوا اسکریپت. به همین دلیل شما باید از هر گونه بک اسلش در الگو فرار کنید.
این روش از کتابخانه عبارات منظم RE2 گوگل استفاده می کند که نحو پشتیبانی شده را محدود می کند.
الگوی عبارت منظم ارائه شده به طور مستقل با هر بلوک متن موجود در عنصر فعلی مطابقت دارد.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText("^.*Apps ?Script.*$", "Apps Script");
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
searchPattern | String | الگوی regex برای جستجو |
replacement | String | متن برای استفاده به عنوان جایگزین |
بازگشت
Element
- عنصر فعلی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
ویژگی های عنصر را تنظیم می کند.
پارامتر مشخصه مشخص شده باید یک شی باشد که در آن نام هر ویژگی یک مورد در شمارش DocumentApp.Attribute
باشد و هر مقدار ویژگی مقدار جدیدی است که باید اعمال شود.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Define a custom paragraph style. var style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. var par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
attributes | Object | ویژگی های عنصر |
بازگشت
Body
- عنصر فعلی.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setHeadingAttributes(paragraphHeading, attributes)
ویژگی ها را برای ParagraphHeading
ارائه شده تنظیم می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
paragraphHeading | ParagraphHeading | عنوانی که ویژگی های آن باید تنظیم شود. |
attributes | Object | نقشه ای از ویژگی ها و مقادیری که باید آنها را تنظیم کنید. |
بازگشت
Body
- عنصر فعلی.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setMarginBottom(marginBottom)
حاشیه پایین را بر حسب امتیاز تنظیم می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
marginBottom | Number | حاشیه پایین، بر حسب امتیاز. |
بازگشت
Body
- عنصر فعلی.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setMarginLeft(marginLeft)
حاشیه سمت چپ را بر حسب امتیاز تنظیم می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
marginLeft | Number | حاشیه سمت چپ، در نقاط. |
بازگشت
Body
- عنصر فعلی.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setMarginRight(marginRight)
حاشیه سمت راست را بر حسب امتیاز تنظیم می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
marginRight | Number | حاشیه سمت راست. |
بازگشت
Body
- عنصر فعلی.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setMarginTop(marginTop)
حاشیه بالایی را تنظیم می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
marginTop | Number | حاشیه بالا، در امتیاز. |
بازگشت
Body
- عنصر فعلی.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setPageHeight(pageHeight)
ارتفاع صفحه را بر حسب نقطه تنظیم می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
pageHeight | Number | ارتفاع صفحه بر حسب امتیاز |
بازگشت
Body
- عنصر فعلی.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setPageWidth(pageWidth)
عرض صفحه را بر حسب نقطه تنظیم می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
pageWidth | Number | عرض صفحه، بر حسب امتیاز |
بازگشت
Body
- عنصر فعلی.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setText(text)
محتویات را به صورت متن ساده تنظیم می کند.
توجه: محتویات موجود پاک شده است.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
text | String | مطالب متن جدید |
بازگشت
Body
- عنصر فعلی.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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 | نوع تراز متنی که باید اعمال شود |
بازگشت
Body
- عنصر فعلی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents