عنصری که یک جدول را نشان می دهد. یک Table
ممکن است فقط حاوی عناصر Table Row
باشد. برای اطلاعات بیشتر در مورد ساختار سند، راهنمای گسترش Google Docs را ببینید.
هنگام ایجاد Table
که حاوی تعداد زیادی ردیف یا سلول است، همانطور که در مثال زیر نشان داده شده است، آن را از یک آرایه رشته ای بسازید.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Create a two-dimensional array containing the 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. body.appendTable(cells);
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
append Table Row() | Table Row | یک Table Row جدید ایجاد و اضافه می کند. |
append Table Row(tableRow) | Table Row | Table Row داده شده را اضافه می کند. |
clear() | Table | محتویات عنصر را پاک می کند. |
copy() | Table | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
edit As Text() | Text | یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می کند. |
find Element(elementType) | Range Element | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند. |
find Element(elementType, from) | Range Element | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند، که از Range Element مشخص شده شروع می شود. |
find Text(searchPattern) | Range Element | با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند. |
find Text(searchPattern, from) | Range Element | محتویات عنصر را برای الگوی متن مشخص شده، از یک نتیجه جستجوی معین شروع می کند. |
get Attributes() | Object | ویژگی های عنصر را بازیابی می کند. |
get Border Color() | String | رنگ حاشیه را بازیابی می کند. |
get Border Width() | Number | عرض حاشیه را بر حسب نقطه بازیابی می کند. |
get Cell(rowIndex, cellIndex) | Table Cell | Table Cell را در ردیف و شاخص های سلول مشخص شده بازیابی می کند. |
get Child(childIndex) | Element | عنصر فرزند را در نمایه فرزند مشخص شده بازیابی می کند. |
get Child Index(child) | Integer | شاخص فرزند را برای عنصر فرزند مشخص شده بازیابی می کند. |
get Column Width(columnIndex) | Number | عرض ستون جدول مشخص شده را در نقاط بازیابی می کند. |
get Link Url() | String | آدرس لینک را بازیابی می کند. |
get Next Sibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
get Num Children() | Integer | تعداد فرزندان را بازیابی می کند. |
get Num Rows() | Integer | تعداد Table Rows را بازیابی می کند. |
get Parent() | Container Element | عنصر والد عنصر را بازیابی می کند. |
get Previous Sibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
get Row(rowIndex) | Table Row | Table Row در شاخص ردیف مشخص شده بازیابی می کند. |
get Text() | String | محتویات عنصر را به عنوان یک رشته متنی بازیابی می کند. |
get Text Alignment() | Text Alignment | تراز متن را دریافت می کند. |
get Type() | Element Type | Element Type عنصر را بازیابی می کند. |
insert Table Row(childIndex) | Table Row | یک Table Row جدید را در نمایه مشخص شده ایجاد و درج می کند. |
insert Table Row(childIndex, tableRow) | Table Row | Table Row داده شده را در شاخص مشخص شده درج می کند. |
is At Document End() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
remove Child(child) | Table | عنصر فرزند مشخص شده را حذف می کند. |
remove From Parent() | Table | عنصر را از والد خود حذف می کند. |
remove Row(rowIndex) | Table Row | Table Row در شاخص ردیف مشخص شده حذف می کند. |
replace Text(searchPattern, replacement) | Element | با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین میکند. |
set Attributes(attributes) | Table | ویژگی های عنصر را تنظیم می کند. |
set Border Color(color) | Table | رنگ حاشیه را تنظیم می کند. |
set Border Width(width) | Table | عرض حاشیه را بر حسب نقطه تنظیم می کند. |
set Column Width(columnIndex, width) | Table | عرض ستون مشخص شده را بر حسب نقطه تنظیم می کند. |
set Link Url(url) | Table | آدرس لینک را تنظیم می کند. |
set Text Alignment(textAlignment) | Table | تراز متن را تنظیم می کند. |
مستندات دقیق
append Table Row()
یک Table Row
جدید ایجاد و اضافه می کند.
بازگشت
Table Row
- عنصر ردیف جدول جدید
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Table Row(tableRow)
Table Row
داده شده را اضافه می کند.
// Opens the Docs file by its ID. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the first table in the tab and copies the second row. const table = body.getTables()[0]; const row = table.getChild(1).copy(); // Adds the copied row to the bottom of the table. const tableRow = table.appendTableRow(row);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
table Row | Table Row | ردیف جدول برای پیوست. |
بازگشت
Table Row
- عنصر ردیف جدول ضمیمه شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
copy()
یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند.
هر عنصر فرزند موجود در عنصر نیز کپی می شود. عنصر جدید والد ندارد.
بازگشت
Table
- نسخه جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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
- یک نتیجه جستجو که موقعیت عنصر جستجو را نشان می دهد.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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
- یک نتیجه جستجو که موقعیت بعدی عنصر جستجو را نشان می دهد.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
find Text(searchPattern)
با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند.
زیرمجموعه ای از ویژگی های عبارت منظم جاوا اسکریپت به طور کامل پشتیبانی نمی شود، مانند گروه های ضبط و اصلاح کننده های حالت.
الگوی عبارت منظم ارائه شده به طور مستقل با هر بلوک متن موجود در عنصر فعلی مطابقت دارد.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
search Pattern | String | الگوی جستجو |
بازگشت
Range Element
- یک نتیجه جستجو که موقعیت متن جستجو را نشان می دهد، یا اگر مطابقت نداشته باشد، پوچ است
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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
- یک نتیجه جستجو که موقعیت بعدی متن جستجو را نشان می دهد، یا اگر مطابقت نداشته باشد، پوچ است
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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 Border Color()
رنگ حاشیه را بازیابی می کند.
// Opens the Docs file by its ID. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the first table. const table = body.getTables()[0]; // Sets the border color of the first table. table.setBorderColor('#00FF00'); // Logs the border color of the first table to the console. console.log(table.getBorderColor());
بازگشت
String
- رنگ حاشیه، فرمت شده در نماد CSS (مانند '#ffffff'
).
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Border Width()
عرض حاشیه را بر حسب نقطه بازیابی می کند.
// Opens the Docs file by its ID. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the first table. const table = body.getTables()[0]; // Sets the border width of the first table. table.setBorderWidth(20); // Logs the border width of the first table. console.log(table.getBorderWidth());
بازگشت
Number
- عرض حاشیه، بر حسب نقطه.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Cell(rowIndex, cellIndex)
Table Cell
را در ردیف و شاخص های سلول مشخص شده بازیابی می کند.
// Opens the Docs file by its ID. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the first table. const table = body.getTables()[0]; // Gets the cell of the table's third row and second column. const cell = table.getCell(2, 1); // Logs the cell text to the console. console.log(cell.getText());
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
row Index | Integer | نمایه سطر حاوی سلول برای بازیابی. |
cell Index | Integer | شاخص سلولی که باید بازیابی شود. |
بازگشت
Table Cell
- سلول جدول.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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 Column Width(columnIndex)
عرض ستون جدول مشخص شده را در نقاط بازیابی می کند.
// Opens the Docs file by its ID. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the first table. const table = body.getTables()[0]; // Sets the width of the second column to 100 points. const columnWidth = table.setColumnWidth(1, 100); // Gets the width of the second column and logs it to the console. console.log(columnWidth.getColumnWidth(1));
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
column Index | Integer | شاخص ستون. |
بازگشت
Number
- عرض ستون، بر حسب نقطه.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Link Url()
آدرس لینک را بازیابی می کند.
بازگشت
String
- URL پیوند یا اگر عنصر حاوی مقادیر متعددی برای این ویژگی باشد، null است
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Next Sibling()
عنصر خواهر و برادر بعدی عنصر را بازیابی می کند.
خواهر و برادر بعدی همان والد را دارد و از عنصر فعلی پیروی می کند.
بازگشت
Element
- عنصر خواهر و برادر بعدی.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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 Num Rows()
تعداد Table Rows
را بازیابی می کند.
// Opens the Docs file by its ID. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the first table. const table = body.getTables()[0]; // Logs the number of rows of the first table to the console. console.log(table.getNumRows());
بازگشت
Integer
- تعداد ردیف های جدول.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Parent()
عنصر والد عنصر را بازیابی می کند.
عنصر والد حاوی عنصر فعلی است.
بازگشت
Container Element
- عنصر والد.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Previous Sibling()
عنصر خواهر و برادر قبلی عنصر را بازیابی می کند.
خواهر و برادر قبلی والد مشابهی دارد و مقدم بر عنصر فعلی است.
بازگشت
Element
- عنصر خواهر و برادر قبلی.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Row(rowIndex)
Table Row
در شاخص ردیف مشخص شده بازیابی می کند.
// Opens the Docs file by its ID. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the first table and logs the text of first row to the console. const table = body.getTables()[0]; console.log(table.getRow(0).getText());
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
row Index | Integer | نمایه سطر برای بازیابی. |
بازگشت
Table Row
- ردیف جدول.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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
insert Table Row(childIndex)
یک Table Row
جدید را در نمایه مشخص شده ایجاد و درج می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
child Index | Integer | شاخصی که در آن عنصر درج می شود |
بازگشت
Table Row
- عنصر فعلی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Table Row(childIndex, tableRow)
Table Row
داده شده را در شاخص مشخص شده درج می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
child Index | Integer | شاخصی که در آن عنصر درج می شود |
table Row | Table Row | ردیف جدول برای درج |
بازگشت
Table Row
- عنصر ردیف جدول درج شده
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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
remove Child(child)
عنصر فرزند مشخص شده را حذف می کند.
// Opens the Docs file by its ID. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the first table. const table = body.getTables()[0]; // Finds the first table row and removes it. const element = table.findElement(DocumentApp.ElementType.TABLE_ROW); table.removeChild(element.getElement());
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
child | Element | عنصر فرزند برای حذف. |
بازگشت
Table
- عنصر فعلی.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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
- عنصر حذف شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
remove Row(rowIndex)
Table Row
در شاخص ردیف مشخص شده حذف می کند.
// Opens the Docs file by its ID. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the first table and removes its second row. const table = body.getTables()[0]; table.removeRow(1);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
row Index | Integer | شاخص ردیف برای حذف. |
بازگشت
Table Row
- ردیف حذف شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replace Text(searchPattern, replacement)
با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین میکند.
الگوی جستجو به عنوان یک رشته ارسال می شود، نه یک شیء عبارت منظم جاوا اسکریپت. به همین دلیل شما باید از هر گونه بک اسلش در الگو فرار کنید.
این روش از کتابخانه عبارات منظم 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
- عنصر فعلی.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Border Color(color)
رنگ حاشیه را تنظیم می کند.
// Opens the Docs file by its ID. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the first table. const table = body.getTables()[0]; // Sets the border color of the table to green. table.setBorderColor('#00FF00');
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
color | String | رنگ حاشیه، فرمت شده در نماد CSS (مانند '#ffffff' ). |
بازگشت
Table
- عنصر فعلی.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Border Width(width)
عرض حاشیه را بر حسب نقطه تنظیم می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
width | Number | عرض حاشیه، در نقاط |
بازگشت
Table
- عنصر فعلی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Column Width(columnIndex, width)
عرض ستون مشخص شده را بر حسب نقطه تنظیم می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
column Index | Integer | شاخص ستون |
width | Number | عرض حاشیه، در نقاط |
بازگشت
Table
- عنصر فعلی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Link Url(url)
آدرس لینک را تنظیم می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
url | String | آدرس لینک |
بازگشت
Table
- عنصر فعلی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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
- عنصر فعلی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents