عنصری که نشان دهنده یک سلول جدول است. یک TableCell
همیشه در یک TableRow
قرار دارد و ممکن است حاوی 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 جدید حاوی سلول های مشخص شده اضافه می کند. |
appendTable(table) | Table | Table داده شده را ضمیمه می کند. |
clear() | TableCell | محتویات عنصر را پاک می کند. |
copy() | TableCell | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
editAsText() | Text | یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می کند. |
findElement(elementType) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند. |
findElement(elementType, from) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند، که از RangeElement مشخص شده شروع می شود. |
findText(searchPattern) | RangeElement | با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند. |
findText(searchPattern, from) | RangeElement | محتویات عنصر را برای الگوی متن مشخص شده، از یک نتیجه جستجوی معین شروع می کند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getBackgroundColor() | String | رنگ پس زمینه را بازیابی می کند. |
getChild(childIndex) | Element | عنصر فرزند را در نمایه فرزند مشخص شده بازیابی می کند. |
getChildIndex(child) | Integer | شاخص فرزند را برای عنصر فرزند مشخص شده بازیابی می کند. |
getColSpan() | Integer | دهانه ستون را بازیابی میکند، که تعداد ستونهای سلولهای جدول این سلول است. |
getLinkUrl() | String | آدرس لینک را بازیابی می کند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getNumChildren() | Integer | تعداد فرزندان را بازیابی می کند. |
getPaddingBottom() | Number | بالشتک پایین را به صورت امتیاز بازیابی می کند. |
getPaddingLeft() | Number | لایه سمت چپ را در نقاط بازیابی می کند. |
getPaddingRight() | Number | بالشتک مناسب را در نقاط بازیابی می کند. |
getPaddingTop() | Number | لایه بالایی را بر حسب امتیاز بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getParentRow() | TableRow | TableRow حاوی TableCell فعلی را بازیابی می کند. |
getParentTable() | Table | Table حاوی TableCell فعلی را بازیابی می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getRowSpan() | Integer | پهنای ردیف را بازیابی میکند، که تعداد ردیفهای سلولهای جدولی است که این سلول در آن قرار دارد. |
getText() | String | محتویات عنصر را به عنوان یک رشته متنی بازیابی می کند. |
getTextAlignment() | TextAlignment | تراز متن را دریافت می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
getVerticalAlignment() | VerticalAlignment | VerticalAlignment بازیابی می کند. |
getWidth() | Number | عرض ستون حاوی سلول را در نقاط بازیابی می کند. |
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 داده شده را در شاخص مشخص شده درج می کند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
merge() | TableCell | عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند. |
removeChild(child) | TableCell | عنصر فرزند مشخص شده را حذف می کند. |
removeFromParent() | TableCell | عنصر را از والد خود حذف می کند. |
replaceText(searchPattern, replacement) | Element | با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین میکند. |
setAttributes(attributes) | TableCell | ویژگی های عنصر را تنظیم می کند. |
setBackgroundColor(color) | TableCell | رنگ پس زمینه را تنظیم می کند. |
setLinkUrl(url) | TableCell | آدرس لینک را تنظیم می کند. |
setPaddingBottom(paddingBottom) | TableCell | بالشتک پایین را بر حسب نقاط تنظیم می کند. |
setPaddingLeft(paddingLeft) | TableCell | بالشتک سمت چپ را در نقاط تنظیم می کند. |
setPaddingRight(paddingRight) | TableCell | بالشتک مناسب را در نقاط تنظیم می کند. |
setPaddingTop(paddingTop) | TableCell | لایه بالایی را بر حسب امتیاز تنظیم می کند. |
setText(text) | TableCell | محتویات را به صورت متن ساده تنظیم می کند. |
setTextAlignment(textAlignment) | TableCell | تراز متن را تنظیم می کند. |
setVerticalAlignment(alignment) | TableCell | تراز عمودی را تنظیم می کند. |
setWidth(width) | TableCell | عرض ستون حاوی سلول فعلی را بر حسب نقطه تنظیم می کند. |
appendHorizontalRule()
یک HorizontalRule
جدید ایجاد و اضافه می کند.
HorizontalRule
در یک Paragraph
جدید گنجانده خواهد شد.
HorizontalRule
- قانون افقی جدید
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
یک InlineImage
جدید از حباب تصویر مشخص شده ایجاد و اضافه می کند.
InlineImage
در یک Paragraph
جدید قرار خواهد گرفت.
نام | تایپ کنید | شرح |
---|---|---|
image | BlobSource | داده های تصویر |
InlineImage
- تصویر جدید
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
InlineImage
داده شده را اضافه می کند.
InlineImage
در یک Paragraph
جدید قرار خواهد گرفت.
نام | تایپ کنید | شرح |
---|---|---|
image | InlineImage | داده های تصویر |
InlineImage
- تصویر ضمیمه شده
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendListItem(listItem)
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
داده شده را ضمیمه می کند.
نام | تایپ کنید | شرح |
---|---|---|
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()
appendTable(cells)
یک Table
جدید حاوی سلول های مشخص شده اضافه می کند.
نام | تایپ کنید | شرح |
---|---|---|
cells | String[][] | محتویات متن سلول های جدول برای اضافه کردن به جدول جدید |
Table
- جدول پیوست
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendTable(table)
Table
داده شده را ضمیمه می کند.
نام | تایپ کنید | شرح |
---|---|---|
table | Table | جدول برای پیوست |
Table
- جدول پیوست
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
محتویات عنصر را پاک می کند.
TableCell
- عنصر فعلی
copy()
یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند.
هر عنصر فرزند موجود در عنصر نیز کپی می شود. عنصر جدید والد ندارد.
TableCell
- کپی جدید.
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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
getBackgroundColor()
رنگ پس زمینه را بازیابی می کند.
String
- رنگ پس زمینه، فرمت شده در نماد CSS (مانند '#ffffff'
)
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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
getColSpan()
دهانه ستون را بازیابی میکند، که تعداد ستونهای سلولهای جدول این سلول است. سلولهای غیر ادغامشده دارای بازه 1 است.
Integer
- دهانه ستون یا 0 برای سلولی که توسط سلول دیگری ادغام شده است
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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
getNextSibling()
عنصر خواهر و برادر بعدی عنصر را بازیابی می کند.
خواهر و برادر بعدی همان والد را دارد و از عنصر فعلی پیروی می کند.
Element
- عنصر خواهر و برادر بعدی.
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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
getPaddingBottom()
بالشتک پایین را به صورت امتیاز بازیابی می کند.
Number
- بالشتک پایین، بر حسب امتیاز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPaddingLeft()
لایه سمت چپ را در نقاط بازیابی می کند.
Number
- بالشتک سمت چپ، بر حسب امتیاز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPaddingRight()
بالشتک مناسب را در نقاط بازیابی می کند.
Number
- بالشتک سمت راست، بر حسب امتیاز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPaddingTop()
بالشتک بالا را به صورت امتیاز بازیابی می کند.
Number
- لایه بالایی، بر حسب امتیاز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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
getParentRow()
getParentTable()
getPreviousSibling()
عنصر خواهر و برادر قبلی عنصر را بازیابی می کند.
خواهر و برادر قبلی والد مشابهی دارد و مقدم بر عنصر فعلی است.
Element
- عنصر خواهر و برادر قبلی.
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getRowSpan()
پهنای ردیف را بازیابی میکند، که تعداد ردیفهای سلولهای جدولی است که این سلول در آن قرار دارد. سلول های ادغام نشده دارای یک ردیف 1 هستند.
Integer
- دهانه ردیف یا 0 برای سلولی که توسط سلول دیگری ادغام شده است
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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 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
getVerticalAlignment()
VerticalAlignment
بازیابی می کند.
VerticalAlignment
- تراز عمودی
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getWidth()
عرض ستون حاوی سلول را در نقاط بازیابی می کند.
Number
- عرض ستون، بر حسب نقطه
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertHorizontalRule(childIndex)
یک HorizontalRule
جدید در نمایه مشخص شده ایجاد و درج می کند.
قانون افقی در یک Paragraph
جدید گنجانده خواهد شد.
نام | تایپ کنید | شرح |
---|---|---|
childIndex | Integer | شاخصی که در آن عنصر درج می شود |
HorizontalRule
- قانون افقی جدید
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
یک InlineImage
از حباب تصویر مشخص شده، در نمایه مشخص شده ایجاد و درج می کند.
تصویر در یک Paragraph
جدید قرار خواهد گرفت.
نام | تایپ کنید | شرح |
---|---|---|
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
isAtDocumentEnd()
تعیین می کند که آیا عنصر در انتهای Document
قرار دارد یا خیر.
Boolean
- اینکه آیا عنصر در انتهای سند است.
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
merge()
عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند.
فقط عناصر همان ElementType
را می توان ادغام کرد. هر عنصر فرزند موجود در عنصر فعلی به عنصر خواهر و برادر قبلی منتقل می شود.
عنصر فعلی از سند حذف می شود.
var body = DocumentApp.getActiveDocument().getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document. 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();
TableCell
- عنصر ادغام شده.
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeChild(child)
عنصر فرزند مشخص شده را حذف می کند.
نام | تایپ کنید | شرح |
---|---|---|
child | Element | عنصر فرزند برای حذف |
TableCell
- عنصر فعلی
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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(); }
TableCell
- عنصر حذف شده.
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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 | ویژگی های عنصر |
TableCell
- عنصر فعلی.
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setBackgroundColor(color)
رنگ پس زمینه را تنظیم می کند.
نام | تایپ کنید | شرح |
---|---|---|
color | String | رنگ پس زمینه، فرمت شده در نماد CSS (مانند '#ffffff' ) |
TableCell
- عنصر فعلی
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLinkUrl(url)
آدرس لینک را تنظیم می کند.
نام | تایپ کنید | شرح |
---|---|---|
url | String | آدرس لینک |
TableCell
- عنصر فعلی
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setPaddingBottom(paddingBottom)
بالشتک پایین را بر حسب نقاط تنظیم می کند.
نام | تایپ کنید | شرح |
---|---|---|
paddingBottom | Number | بالشتک پایین، در نقاط |
TableCell
- عنصر فعلی
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setPaddingLeft(paddingLeft)
بالشتک سمت چپ را در نقاط تنظیم می کند.
نام | تایپ کنید | شرح |
---|---|---|
paddingLeft | Number | لایه سمت چپ، در نقاط |
TableCell
- عنصر فعلی
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setPaddingRight(paddingRight)
بالشتک مناسب را در نقاط تنظیم می کند.
نام | تایپ کنید | شرح |
---|---|---|
paddingRight | Number | بالشتک سمت راست، در نقاط. |
TableCell
- عنصر فعلی.
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setPaddingTop(paddingTop)
لایه بالایی را بر حسب امتیاز تنظیم می کند.
نام | تایپ کنید | شرح |
---|---|---|
paddingTop | Number | بالشتک بالا، در نقاط |
TableCell
- عنصر فعلی
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setText(text)
محتویات را به صورت متن ساده تنظیم می کند.
توجه: محتویات موجود پاک شده است.
نام | تایپ کنید | شرح |
---|---|---|
text | String | مطالب متن جدید |
TableCell
- عنصر فعلی
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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 | نوع تراز متنی که باید اعمال شود |
TableCell
- عنصر فعلی
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setVerticalAlignment(alignment)
تراز عمودی را تنظیم می کند.
نام | تایپ کنید | شرح |
---|---|---|
alignment | VerticalAlignment | تراز عمودی |
TableCell
- عنصر فعلی
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setWidth(width)
عرض ستون حاوی سلول فعلی را بر حسب نقطه تنظیم می کند.
نام | تایپ کنید | شرح |
---|---|---|
width | Number | عرض ستون، در نقاط |
TableCell
- عنصر فعلی
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents