عنصری که بخش پاورقی را نشان می دهد. یک Document
معمولاً حاوی حداکثر یک FooterSection
است. FooterSection
ممکن است حاوی عناصر ListItem
، Paragraph
و Table
باشد. برای اطلاعات بیشتر در مورد ساختار سند، راهنمای گسترش Google Docs را ببینید.
مواد و روش ها
روش | نوع برگشت | توضیح مختصر |
---|---|---|
appendHorizontalRule() | HorizontalRule | یک HorizontalRule جدید ایجاد و اضافه می کند. |
appendImage(image) | InlineImage | یک InlineImage جدید از حباب تصویر مشخص شده ایجاد و اضافه می کند. |
appendImage(image) | InlineImage | InlineImage داده شده را اضافه می کند. |
appendListItem(listItem) | ListItem | ListItem داده شده را اضافه می کند. |
appendListItem(text) | ListItem | یک ListItem جدید حاوی محتوای متن مشخص شده ایجاد و اضافه می کند. |
appendParagraph(paragraph) | Paragraph | Paragraph داده شده را ضمیمه می کند. |
appendParagraph(text) | Paragraph | یک Paragraph جدید حاوی محتوای متن مشخص شده ایجاد و اضافه می کند. |
appendTable() | Table | یک Table جدید ایجاد و اضافه می کند. |
appendTable(cells) | Table | یک Table جدید حاوی TableCell برای هر مقدار رشته مشخص شده اضافه می کند. |
appendTable(table) | Table | Table داده شده را ضمیمه می کند. |
clear() | FooterSection | محتویات عنصر را پاک می کند. |
copy() | FooterSection | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
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 | شاخص فرزند را برای عنصر فرزند مشخص شده بازیابی می کند. |
getImages() | InlineImage[] | همه InlineImages موجود در بخش را بازیابی می کند. |
getListItems() | ListItem[] | همه ListItems موجود در بخش را بازیابی می کند. |
getNumChildren() | Integer | تعداد فرزندان را بازیابی می کند. |
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 جدید را در نمایه مشخص شده ایجاد و درج می کند که حاوی محتوای متن مشخص شده است. |
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) | FooterSection | عنصر فرزند مشخص شده را حذف می کند. |
removeFromParent() | FooterSection | عنصر را از والد خود حذف می کند. |
replaceText(searchPattern, replacement) | Element | با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین میکند. |
setAttributes(attributes) | FooterSection | ویژگی های عنصر را تنظیم می کند. |
setText(text) | FooterSection | محتویات را به صورت متن ساده تنظیم می کند. |
setTextAlignment(textAlignment) | FooterSection | تراز متن را تنظیم می کند. |
مستندات دقیق
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
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()
یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند.
هر عنصر فرزند موجود در عنصر نیز کپی می شود. عنصر جدید والد ندارد.
برگشت
FooterSection
- نسخه جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
editAsText()
یک نسخه Text
از عنصر فعلی را برای ویرایش دریافت می کند.
از editAsText
برای دستکاری محتویات عناصر به عنوان متن غنی استفاده کنید. حالت editAsText
عناصر غیر متنی (مانند InlineImage
و HorizontalRule
) را نادیده می گیرد.
عناصر فرزند به طور کامل در محدوده متن حذف شده از عنصر حذف می شوند.
var body = DocumentApp.getActiveDocument().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
مشخص شده شروع می شود.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().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 body = DocumentApp.getActiveDocument().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)
عنصر فرزند را در نمایه فرزند مشخص شده بازیابی می کند.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document. 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
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
getNumChildren()
تعداد فرزندان را بازیابی می کند.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Log the number of elements in the document. Logger.log("There are " + body.getNumChildren() + " elements in the document body.");
برگشت
Integer
- تعداد فرزندان
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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 body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document 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
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 | عنصر فرزند برای حذف |
برگشت
FooterSection
- عنصر فعلی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeFromParent()
عنصر را از والد خود حذف می کند.
var body = DocumentApp.getActiveDocument().getBody(); // Remove all images in the document body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
برگشت
FooterSection
- عنصر حذف شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replaceText(searchPattern, replacement)
با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین میکند.
الگوی جستجو به عنوان یک رشته ارسال می شود، نه یک شیء عبارت منظم جاوا اسکریپت. به همین دلیل شما باید از هر گونه بک اسلش در الگو فرار کنید.
این روش از کتابخانه عبارات منظم RE2 گوگل استفاده می کند که نحو پشتیبانی شده را محدود می کند.
الگوی عبارت منظم ارائه شده به طور مستقل با هر بلوک متن موجود در عنصر فعلی مطابقت دارد.
var body = DocumentApp.getActiveDocument().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 body = DocumentApp.getActiveDocument().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 | ویژگی های عنصر |
برگشت
FooterSection
- عنصر فعلی.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setText(text)
محتویات را به صورت متن ساده تنظیم می کند.
توجه: محتویات موجود پاک شده است.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
text | String | مطالب متن جدید |
برگشت
FooterSection
- عنصر فعلی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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 be superscript. var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
textAlignment | TextAlignment | نوع تراز متنی که باید اعمال شود |
برگشت
FooterSection
- عنصر فعلی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents