عنصری که نشاندهندهی یک سلول جدول است. یک Table Cell همیشه درون یک Table Row قرار دارد و ممکن است شامل عناصر List Item ، Paragraph یا Table باشد. برای اطلاعات بیشتر در مورد ساختار سند، به راهنمای توسعهی Google Docs مراجعه کنید.
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
append Horizontal Rule() | Horizontal Rule | یک Horizontal Rule جدید ایجاد و اضافه میکند. |
append Image(image) | Inline Image | یک Inline Image جدید از بلوک تصویر مشخصشده ایجاد و اضافه میکند. |
append Image(image) | Inline Image | Inline Image داده شده را اضافه میکند. |
append List Item(listItem) | List Item | List Item داده شده را اضافه میکند. |
append List Item(text) | List Item | یک List Item جدید ایجاد و اضافه میکند. |
append Paragraph(paragraph) | Paragraph | Paragraph داده شده را اضافه میکند. |
append Paragraph(text) | Paragraph | یک Paragraph جدید ایجاد و اضافه میکند. |
append Table() | Table | یک Table جدید ایجاد و اضافه میکند. |
append Table(cells) | Table | یک Table جدید حاوی سلولهای مشخص شده اضافه میکند. |
append Table(table) | Table | Table داده شده را ضمیمه میکند. |
clear() | Table Cell | محتویات عنصر را پاک میکند. |
copy() | Table Cell | یک کپی جدا و عمیق از عنصر فعلی را برمیگرداند. |
edit As Text() | Text | یک نسخه Text از عنصر فعلی را برای ویرایش دریافت میکند. |
find Element(elementType) | Range Element |null | محتویات عنصر را برای یافتن نسلی از نوع مشخص شده جستجو میکند. |
find Element(elementType, from) | Range Element |null | محتویات عنصر را برای یافتن نسلی از نوع مشخص شده، با شروع از Range Element مشخص شده، جستجو میکند. |
find Text(searchPattern) | Range Element |null | با استفاده از عبارات منظم، محتوای عنصر را برای الگوی متنی مشخص شده جستجو میکند. |
find Text(searchPattern, from) | Range Element |null | با شروع از یک نتیجه جستجوی داده شده، محتویات عنصر را برای الگوی متنی مشخص شده جستجو میکند. |
get Attributes() | Object | ویژگیهای عنصر را بازیابی میکند. |
get Background Color() | String|null | رنگ پس زمینه را بازیابی میکند. |
get Child(childIndex) | Element | عنصر فرزند را در اندیس فرزند مشخص شده بازیابی میکند. |
get Child Index(child) | Integer | اندیس فرزند را برای عنصر فرزند مشخص شده بازیابی میکند. |
get Col Span() | Integer | طول ستون را بازیابی میکند، که تعداد ستونهای سلولهای جدولی است که این سلول در بر میگیرد. |
get Link Url() | String|null | آدرس لینک را بازیابی میکند. |
get Next Sibling() | Element |null | عنصر خواهر یا برادر بعدی عنصر را بازیابی میکند. |
get Num Children() | Integer | تعداد فرزندان را بازیابی میکند. |
get Padding Bottom() | Number|null | فاصلهی بین عناصر (padding) پایین را بر حسب نقطه بازیابی میکند. |
get Padding Left() | Number|null | فاصلهی بین عناصر سمت چپ (padding) را بر حسب نقطه بازیابی میکند. |
get Padding Right() | Number|null | فاصلهگذاری صحیح را بر حسب نقطه بازیابی میکند. |
get Padding Top() | Number|null | فاصلهی بین عناصر (padding) بالا را بر حسب نقطه بازیابی میکند. |
get Parent() | Container Element |null | عنصر والد عنصر را بازیابی میکند. |
get Parent Row() | Table Row |null | Table Row حاوی Table Cell فعلی را بازیابی میکند. |
get Parent Table() | Table |null | Table که شامل Table Cell فعلی است را بازیابی میکند. |
get Previous Sibling() | Element |null | عنصر خواهر و برادر قبلی عنصر را بازیابی میکند. |
get Row Span() | Integer | طول ردیف را بازیابی میکند، که تعداد ردیفهای سلولهای جدولی است که این سلول در بر میگیرد. |
get Text() | String | محتوای عنصر را به صورت یک رشته متنی بازیابی میکند. |
get Text Alignment() | Text Alignment |null | ترازبندی متن را دریافت میکند. |
get Type() | Element Type | Element Type را بازیابی میکند. |
get Vertical Alignment() | Vertical Alignment |null | Vertical Alignment بازیابی میکند. |
get Width() | Number|null | عرض ستون حاوی سلول را بر حسب نقطه برمیگرداند. |
insert Horizontal Rule(childIndex) | Horizontal Rule | یک Horizontal Rule جدید در اندیس مشخص شده ایجاد و درج میکند. |
insert Image(childIndex, image) | Inline Image | یک Inline Image از بلوک تصویر مشخصشده، در اندیس مشخصشده ایجاد و درج میکند. |
insert Image(childIndex, image) | Inline Image | Inline Image داده شده را در اندیس مشخص شده درج میکند. |
insert List Item(childIndex, listItem) | List Item | List Item داده شده را در اندیس مشخص شده درج میکند. |
insert List Item(childIndex, text) | List Item | یک List Item جدید را در اندیس مشخص شده ایجاد و درج میکند. |
insert Paragraph(childIndex, paragraph) | Paragraph | Paragraph داده شده را در اندیس مشخص شده درج میکند. |
insert Paragraph(childIndex, text) | Paragraph | یک Paragraph جدید در اندیس مشخص شده ایجاد و درج میکند. |
insert Table(childIndex) | Table | یک Table جدید در اندیس مشخص شده ایجاد و درج میکند. |
insert Table(childIndex, cells) | Table | یک Table جدید حاوی سلولهای مشخص شده، در اندیس مشخص شده ایجاد و درج میکند. |
insert Table(childIndex, table) | Table | Table داده شده را در اندیس مشخص شده درج میکند. |
is At Document End() | Boolean | تعیین میکند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
merge() | Table Cell |null | عنصر را با عنصر خواهر یا برادر قبلی از همان نوع ادغام میکند. |
remove Child(child) | Table Cell | عنصر فرزند مشخص شده را حذف میکند. |
remove From Parent() | Table Cell |null | عنصر را از والدش حذف میکند. |
replace Text(searchPattern, replacement) | Element | با استفاده از عبارات منظم، تمام موارد تکرار یک الگوی متنی مشخص را با یک رشته جایگزین مشخص جایگزین میکند. |
set Attributes(attributes) | Table Cell | ویژگیهای عنصر را تنظیم میکند. |
set Background Color(color) | Table Cell | رنگ پس زمینه را تنظیم میکند. |
set Link Url(url) | Table Cell | آدرس لینک را تنظیم میکند. |
set Padding Bottom(paddingBottom) | Table Cell | فاصلهی بین عناصر پایین (padding) را بر حسب نقطه تنظیم میکند. |
set Padding Left(paddingLeft) | Table Cell | فاصلهی بین عناصر سمت چپ (چپ) را بر حسب نقطه تنظیم میکند. |
set Padding Right(paddingRight) | Table Cell | فاصلهی مناسب (padding) را بر حسب نقطه تنظیم میکند. |
set Padding Top(paddingTop) | Table Cell | فاصلهی بین عناصر بالایی (padding) را بر حسب نقطه تنظیم میکند. |
set Text(text) | Table Cell | محتوا را به صورت متن ساده تنظیم میکند. |
set Text Alignment(textAlignment) | Table Cell | ترازبندی متن را تنظیم میکند. |
set Vertical Alignment(alignment) | Table Cell | تراز عمودی را تنظیم میکند. |
set Width(width) | Table Cell | عرض ستون حاوی سلول فعلی را بر حسب نقطه تنظیم میکند. |
مستندات دقیق
append Horizontal Rule()
یک Horizontal Rule جدید ایجاد و اضافه میکند.
Horizontal Rule در یک Paragraph جدید قرار خواهد گرفت.
بازگشت
Horizontal Rule - خطکش افقی جدید
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Image(image)
یک Inline Image جدید از بلوک تصویر مشخصشده ایجاد و اضافه میکند.
Inline Image در یک Paragraph جدید قرار خواهد گرفت.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
image | Blob Source | دادههای تصویر |
بازگشت
Inline Image - تصویر جدید
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Image(image)
Inline Image داده شده را اضافه میکند.
Inline Image در یک Paragraph جدید قرار خواهد گرفت.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
image | Inline Image | دادههای تصویر |
بازگشت
Inline Image - تصویر پیوستشده
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append List Item(listItem)
List Item داده شده را اضافه میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
list Item | List Item | مورد لیست برای اضافه کردن |
بازگشت
List Item - مورد لیست اضافه شده
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append List Item(text)
یک List Item جدید ایجاد و اضافه میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
text | String | محتوای متن |
بازگشت
List Item - مورد لیست جدید
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Paragraph(paragraph)
Paragraph داده شده را اضافه میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
paragraph | Paragraph | پاراگرافی که باید اضافه شود |
بازگشت
Paragraph - پاراگراف ضمیمه شده
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Paragraph(text)
یک Paragraph جدید ایجاد و اضافه میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
text | String | محتوای متن |
بازگشت
Paragraph - پاراگراف جدید
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Table()
append Table(cells)
یک Table جدید حاوی سلولهای مشخص شده اضافه میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
cells | String[][] | محتوای متنی سلولهای جدول برای اضافه شدن به جدول جدید |
بازگشت
Table - جدول پیوست شده
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Table(table)
Table داده شده را ضمیمه میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
table | Table | جدولی که باید اضافه شود |
بازگشت
Table - جدول پیوست شده
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
clear()
copy()
یک کپی جدا و عمیق از عنصر فعلی را برمیگرداند.
هر عنصر فرزندی که در عنصر وجود داشته باشد نیز کپی میشود. عنصر جدید والد ندارد.
بازگشت
Table Cell - نسخه جدید.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
edit As Text()
یک نسخه Text از عنصر فعلی را برای ویرایش دریافت میکند.
edit As Text برای دستکاری محتوای عناصر به عنوان متن غنی استفاده کنید. حالت edit As Text عناصر غیر متنی (مانند Inline Image و Horizontal Rule ) را نادیده میگیرد.
عناصر فرزندی که کاملاً در محدوده متن حذف شده قرار دارند، از عنصر حذف میشوند.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, 'An editAsText sample.'); body.insertHorizontalRule(0); body.insertParagraph(0, 'An example.'); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
بازگشت
Text - نسخه متنی عنصر فعلی
find Element(elementType)
محتویات عنصر را برای یافتن نسلی از نوع مشخص شده جستجو میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
element Type | Element Type | نوع عنصری که باید جستجو شود. |
بازگشت
Range Element |null — نتیجه جستجو که موقعیت عنصر جستجو را نشان میدهد.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
find Element(elementType, from)
محتویات عنصر را برای یافتن نسلی از نوع مشخص شده، با شروع از Range Element مشخص شده، جستجو میکند.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Define the search parameters. let searchResult = null; // Search until the paragraph is found. while ( (searchResult = body.findElement( DocumentApp.ElementType.PARAGRAPH, searchResult, ))) { const par = searchResult.getElement().asParagraph(); if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) { // Found one, update and stop. par.setText('This is the first header.'); break; } }
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
element Type | Element Type | نوع عنصری که باید جستجو شود. |
from | Range Element | نتیجه جستجو برای جستجو از. |
بازگشت
Range Element |null — نتیجه جستجو که موقعیت بعدی عنصر جستجو را نشان میدهد.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
find Text(searchPattern)
با استفاده از عبارات منظم، محتوای عنصر را برای الگوی متنی مشخص شده جستجو میکند.
زیرمجموعهای از ویژگیهای عبارات منظم جاوا اسکریپت به طور کامل پشتیبانی نمیشوند، مانند گروههای ضبط و اصلاحکنندههای حالت.
الگوی عبارت منظم ارائه شده به طور مستقل با هر بلوک متنی موجود در عنصر فعلی مطابقت داده میشود.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
search Pattern | String | الگویی که باید جستجو شود |
بازگشت
Range Element |null — نتیجه جستجو که موقعیت متن جستجو را نشان میدهد، یا در صورت عدم تطابق، null
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
find Text(searchPattern, from)
با شروع از یک نتیجه جستجوی داده شده، محتویات عنصر را برای الگوی متنی مشخص شده جستجو میکند.
زیرمجموعهای از ویژگیهای عبارات منظم جاوا اسکریپت به طور کامل پشتیبانی نمیشوند، مانند گروههای ضبط و اصلاحکنندههای حالت.
الگوی عبارت منظم ارائه شده به طور مستقل با هر بلوک متنی موجود در عنصر فعلی مطابقت داده میشود.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
search Pattern | String | الگویی که باید جستجو شود |
from | Range Element | نتیجه جستجو برای جستجو از |
بازگشت
Range Element |null — نتیجه جستجو که موقعیت بعدی متن جستجو را نشان میدهد، یا در صورت عدم تطابق، null است.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Attributes()
ویژگیهای عنصر را بازیابی میکند.
نتیجه، یک شیء حاوی یک ویژگی برای هر ویژگی عنصر معتبر است که در آن هر نام ویژگی با یک آیتم در شمارش Document App.Attribute مطابقت دارد.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Append a styled paragraph. const par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. const atts = par.getAttributes(); // Log the paragraph attributes. for (const att in atts) { Logger.log(`${att}:${atts[att]}`); }
بازگشت
Object - ویژگیهای عنصر.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Background Color()
رنگ پس زمینه را بازیابی میکند.
بازگشت
String|null — رنگ پسزمینه، که با نمادگذاری CSS قالببندی شده است (مانند '#ffffff' )
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Child(childIndex)
عنصر فرزند را در اندیس فرزند مشخص شده بازیابی میکند.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. const firstChild = body.getChild(0); // If it's a paragraph, set its contents. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { firstChild.asParagraph().setText('This is the first paragraph.'); }
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
child Index | Integer | اندیس عنصر فرزندی که قرار است بازیابی شود. |
بازگشت
Element - عنصر فرزند در اندیس مشخص شده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Child Index(child)
اندیس فرزند را برای عنصر فرزند مشخص شده بازیابی میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
child | Element | عنصر فرزندی که اندیس آن بازیابی میشود. |
بازگشت
Integer - اندیس فرزند.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Col Span()
طول ستون را بازیابی میکند، که تعداد ستونهای سلولهای جدولی است که این سلول در بر میگیرد. سلولهای ادغام نشده دارای طول ستون ۱ هستند.
بازگشت
Integer - طول ستون یا 0 برای سلولی که توسط سلول دیگری ادغام شده است
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Link Url()
آدرس لینک را بازیابی میکند.
بازگشت
String|null — آدرس اینترنتی لینک، یا اگر عنصر شامل چندین مقدار برای این ویژگی باشد، null.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Next Sibling()
عنصر خواهر یا برادر بعدی عنصر را بازیابی میکند.
خواهر یا برادر بعدی، والد یکسانی دارد و عنصر فعلی را دنبال میکند.
بازگشت
Element |null — عنصر خواهر یا برادر بعدی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Num Children()
تعداد فرزندان را بازیابی میکند.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Log the number of elements in the tab. Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);
بازگشت
Integer - تعداد فرزندان.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Padding Bottom()
فاصلهی بین عناصر (padding) پایین را بر حسب نقطه بازیابی میکند.
بازگشت
Number|null — فاصلهگذاری پایین، بر حسب نقطه
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Padding Left()
فاصلهی بین عناصر سمت چپ (padding) را بر حسب نقطه بازیابی میکند.
بازگشت
Number|null — فاصلهگذاری چپ، بر حسب نقطه
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Padding Right()
فاصلهگذاری صحیح را بر حسب نقطه بازیابی میکند.
بازگشت
Number|null — فاصلهگذاری سمت راست، بر حسب نقطه
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Padding Top()
فاصلهی بین عناصر (padding) بالا را بر حسب نقطه بازیابی میکند.
بازگشت
Number|null — فاصلهگذاری بالا، بر حسب نقطه
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Parent()
عنصر والد عنصر را بازیابی میکند.
عنصر والد شامل عنصر فعلی است.
بازگشت
Container Element |null — عنصر والد.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Parent Row()
Table Row حاوی Table Cell فعلی را بازیابی میکند.
بازگشت
Table Row |null — ردیف جدول حاوی سلول فعلی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Parent Table()
Table که شامل Table Cell فعلی است را بازیابی میکند.
بازگشت
Table |null — جدولی که سلول فعلی در آن قرار دارد
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Previous Sibling()
عنصر خواهر و برادر قبلی عنصر را بازیابی میکند.
عنصر خواهر یا برادر قبلی، والد یکسانی دارد و قبل از عنصر فعلی قرار میگیرد.
بازگشت
Element |null — عنصر خواهر یا برادر قبلی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Row Span()
طول سطر را بازیابی میکند، که تعداد سطرهای سلولهای جدولی است که این سلول در بر میگیرد. سلولهای ادغام نشده دارای طول سطر ۱ هستند.
بازگشت
Integer - طول ردیف یا 0 برای سلولی که توسط سلول دیگری ادغام شده است
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Text()
محتوای عنصر را به صورت یک رشته متنی بازیابی میکند.
بازگشت
String - محتویات عنصر به صورت رشته متنی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Text Alignment()
ترازبندی متن را دریافت میکند. انواع ترازبندی موجود عبارتند از Document App.TextAlignment.NORMAL ، Document App.TextAlignment.SUBSCRIPT و Document App.TextAlignment.SUPERSCRIPT .
بازگشت
Text Alignment |null — نوع ترازبندی متن، یا اگر متن شامل چندین نوع ترازبندی متن باشد یا ترازبندی متن هرگز تنظیم نشده باشد، null
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Type()
Element Type را بازیابی میکند.
برای تعیین نوع دقیق یک عنصر داده شده، get Type() استفاده کنید.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Obtain the first element in the active tab's body. const firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
بازگشت
Element Type - نوع عنصر.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Vertical Alignment()
Vertical Alignment بازیابی میکند.
بازگشت
Vertical Alignment |null — ترازبندی عمودی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Width()
عرض ستون حاوی سلول را بر حسب نقطه برمیگرداند.
بازگشت
Number|null — عرض ستون، بر حسب نقطه
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Horizontal Rule(childIndex)
یک Horizontal Rule جدید در اندیس مشخص شده ایجاد و درج میکند.
خط افقی در یک Paragraph جدید قرار خواهد گرفت.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
child Index | Integer | اندیسی که عنصر در آن قرار میگیرد |
بازگشت
Horizontal Rule - خطکش افقی جدید
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Image(childIndex, image)
یک Inline Image از بلوک تصویر مشخصشده، در اندیس مشخصشده ایجاد و درج میکند.
تصویر در یک Paragraph جدید قرار خواهد گرفت.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
child Index | Integer | اندیسی که عنصر در آن قرار میگیرد |
image | Blob Source | دادههای تصویر |
بازگشت
Inline Image - تصویر درونخطی درجشده
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Image(childIndex, image)
Inline Image داده شده را در اندیس مشخص شده درج میکند.
تصویر در یک Paragraph جدید قرار خواهد گرفت.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
child Index | Integer | اندیسی که عنصر در آن قرار میگیرد |
image | Inline Image | تصویر برای درج |
بازگشت
Inline Image - تصویر درونخطی درجشده
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert List Item(childIndex, listItem)
List Item داده شده را در اندیس مشخص شده درج میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
child Index | Integer | اندیسی که عنصر در آن قرار میگیرد |
list Item | List Item | مورد لیست برای درج |
بازگشت
List Item - مورد لیست جدید اضافه شد
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert List Item(childIndex, text)
یک List Item جدید را در اندیس مشخص شده ایجاد و درج میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
child Index | Integer | اندیسی که عنصر در آن قرار میگیرد |
text | String | محتوای متن |
بازگشت
List Item - مورد لیست جدید
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Paragraph(childIndex, paragraph)
Paragraph داده شده را در اندیس مشخص شده درج میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
child Index | Integer | اندیسی که عنصر در آن قرار میگیرد |
paragraph | Paragraph | پاراگرافی که باید درج شود |
بازگشت
Paragraph - پاراگراف درج شده
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Paragraph(childIndex, text)
یک Paragraph جدید در اندیس مشخص شده ایجاد و درج میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
child Index | Integer | اندیسی که عنصر در آن قرار میگیرد |
text | String | محتوای متن |
بازگشت
Paragraph - پاراگراف جدید
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Table(childIndex)
یک Table جدید در اندیس مشخص شده ایجاد و درج میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
child Index | Integer | اندیسی که عنصر در آن قرار میگیرد |
بازگشت
Table — میز جدید
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Table(childIndex, cells)
یک Table جدید حاوی سلولهای مشخص شده، در اندیس مشخص شده ایجاد و درج میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
child Index | Integer | شاخصی که باید در آن درج شود |
cells | String[][] | محتوای متنی سلولهای جدول برای اضافه شدن به جدول جدید |
بازگشت
Table — میز جدید
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Table(childIndex, table)
Table داده شده را در اندیس مشخص شده درج میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
child Index | Integer | اندیسی که عنصر در آن قرار میگیرد |
table | Table | جدولی که باید درج شود |
بازگشت
Table - جدول درج شده
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
is At Document End()
تعیین میکند که آیا عنصر در انتهای Document قرار دارد یا خیر.
بازگشت
Boolean - اینکه آیا عنصر در انتهای تب قرار دارد یا خیر.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
merge()
عنصر را با عنصر خواهر یا برادر قبلی از همان نوع ادغام میکند.
فقط عناصری که از Element Type یکسانی هستند میتوانند ادغام شوند. هر عنصر فرزندی که در عنصر فعلی قرار داشته باشد، به عنصر خواهر و برادر قبلی منتقل میشود.
عنصر فعلی از سند حذف میشود.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document's active tab. const par1 = body.appendParagraph('Paragraph 1.'); const par2 = body.appendParagraph('Paragraph 2.'); // Merge the newly added paragraphs into a single paragraph. par2.merge(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's cell contents. const cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'], ]; // Build a table from the array. const table = body.appendTable(cells); // Get the first row in the table. const row = table.getRow(0); // Get the two cells in this row. const cell1 = row.getCell(0); const cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. const merged = cell2.merge();
بازگشت
Table Cell |null — عنصر ادغام شده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
remove Child(child)
عنصر فرزند مشخص شده را حذف میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
child | Element | عنصر فرزندی که قرار است حذف شود |
بازگشت
Table Cell - عنصر فعلی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
remove From Parent()
عنصر را از والدش حذف میکند.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Remove all images in the active tab's body. const imgs = body.getImages(); for (let i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
بازگشت
Table Cell |null — عنصر حذف شده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
replace Text(searchPattern, replacement)
با استفاده از عبارات منظم، تمام موارد تکرار یک الگوی متنی مشخص را با یک رشته جایگزین مشخص جایگزین میکند.
الگوی جستجو به صورت یک رشته ارسال میشود، نه یک شیء عبارت منظم جاوا اسکریپت. به همین دلیل، باید هرگونه بکاسلش را در الگو escape کنید.
این روش از کتابخانه عبارات منظم RE2 گوگل استفاده میکند که سینتکسهای پشتیبانیشده را محدود میکند.
الگوی عبارت منظم ارائه شده به طور مستقل با هر بلوک متنی موجود در عنصر فعلی مطابقت داده میشود.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText('^.*Apps ?Script.*$', 'Apps Script');
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
search Pattern | String | الگوی regex برای جستجو |
replacement | String | متنی که قرار است به عنوان جایگزین استفاده شود |
بازگشت
Element - عنصر فعلی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Attributes(attributes)
ویژگیهای عنصر را تنظیم میکند.
پارامتر ویژگیهای مشخصشده باید یک شیء باشد که در آن نام هر ویژگی، یک آیتم در شمارش Document App.Attribute است و مقدار هر ویژگی، مقدار جدیدی است که باید اعمال شود.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Define a custom paragraph style. const style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. const par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
attributes | Object | ویژگیهای عنصر. |
بازگشت
Table Cell - عنصر فعلی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Background Color(color)
رنگ پس زمینه را تنظیم میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
color | String | رنگ پسزمینه، که با نمادگذاری CSS قالببندی شده است (مانند '#ffffff' ) |
بازگشت
Table Cell - عنصر فعلی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Link Url(url)
آدرس لینک را تنظیم میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
url | String | آدرس لینک |
بازگشت
Table Cell - عنصر فعلی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Padding Bottom(paddingBottom)
فاصلهی بین عناصر پایین (padding) را بر حسب نقطه تنظیم میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
padding Bottom | Number | لایه گذاری پایین، بر حسب نقطه |
بازگشت
Table Cell - عنصر فعلی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Padding Left(paddingLeft)
فاصلهی بین عناصر سمت چپ (چپ) را بر حسب نقطه تنظیم میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
padding Left | Number | فاصلهگذاری چپ، بر حسب نقطه |
بازگشت
Table Cell - عنصر فعلی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Padding Right(paddingRight)
فاصلهی مناسب (padding) را بر حسب نقطه تنظیم میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
padding Right | Number | فاصلهگذاری مناسب، بر حسب نقطه. |
بازگشت
Table Cell - عنصر فعلی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Padding Top(paddingTop)
فاصلهی بین عناصر بالایی (padding) را بر حسب نقطه تنظیم میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
padding Top | Number | لایه بالایی، بر حسب نقطه |
بازگشت
Table Cell - عنصر فعلی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Text(text)
محتوا را به صورت متن ساده تنظیم میکند.
توجه: محتویات موجود پاک میشوند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
text | String | محتوای متن جدید |
بازگشت
Table Cell - عنصر فعلی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Text Alignment(textAlignment)
ترازبندی متن را تنظیم میکند. انواع ترازبندی موجود عبارتند از Document App.TextAlignment.NORMAL ، Document App.TextAlignment.SUBSCRIPT و Document App.TextAlignment.SUPERSCRIPT .
// Make the entire first paragraph in the active tab be superscript. const documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); const text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
text Alignment | Text Alignment | نوع ترازبندی متن که باید اعمال شود |
بازگشت
Table Cell - عنصر فعلی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Vertical Alignment(alignment)
تراز عمودی را تنظیم میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
alignment | Vertical Alignment | تراز عمودی |
بازگشت
Table Cell - عنصر فعلی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Width(width)
عرض ستون حاوی سلول فعلی را بر حسب نقطه تنظیم میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
width | Number | عرض ستون، بر حسب نقطه |
بازگشت
Table Cell - عنصر فعلی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents