Class TableCell

سلول جدول

عنصری که نشان دهنده یک سلول جدول است. یک 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 محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند.
find Element(elementType, from) Range Element محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند، که از Range Element مشخص شده شروع می شود.
find Text(searchPattern) Range Element با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند.
find Text(searchPattern, from) Range Element محتویات عنصر را برای الگوی متن مشخص شده، از یک نتیجه جستجوی معین شروع می کند.
get Attributes() Object ویژگی های عنصر را بازیابی می کند.
get Background Color() String رنگ پس زمینه را بازیابی می کند.
get Child(childIndex) Element عنصر فرزند را در نمایه فرزند مشخص شده بازیابی می کند.
get Child Index(child) Integer شاخص فرزند را برای عنصر فرزند مشخص شده بازیابی می کند.
get Col Span() Integer دهانه ستون را بازیابی می‌کند، که تعداد ستون‌های سلول‌های جدول این سلول است.
get Link Url() String آدرس لینک را بازیابی می کند.
get Next Sibling() Element عنصر خواهر و برادر بعدی عنصر را بازیابی می کند.
get Num Children() Integer تعداد فرزندان را بازیابی می کند.
get Padding Bottom() Number بالشتک پایین را به صورت امتیاز بازیابی می کند.
get Padding Left() Number لایه سمت چپ را در نقاط بازیابی می کند.
get Padding Right() Number بالشتک مناسب را در نقاط بازیابی می کند.
get Padding Top() Number بالشتک بالا را به صورت امتیاز بازیابی می کند.
get Parent() Container Element عنصر والد عنصر را بازیابی می کند.
get Parent Row() Table Row Table Row حاوی Table Cell فعلی را بازیابی می کند.
get Parent Table() Table Table حاوی Table Cell فعلی را بازیابی می کند.
get Previous Sibling() Element عنصر خواهر و برادر قبلی عنصر را بازیابی می کند.
get Row Span() Integer پهنای ردیف را بازیابی می‌کند، که تعداد ردیف‌های سلول‌های جدولی است که این سلول در آن قرار دارد.
get Text() String محتویات عنصر را به عنوان یک رشته متنی بازیابی می کند.
get Text Alignment() Text Alignment تراز متن را دریافت می کند.
get Type() Element Type Element Type عنصر را بازیابی می کند.
get Vertical Alignment() Vertical Alignment Vertical Alignment را بازیابی می کند.
get Width() Number عرض ستون حاوی سلول را در نقاط بازیابی می کند.
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 عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند.
remove Child(child) Table Cell عنصر فرزند مشخص شده را حذف می کند.
remove From Parent() Table Cell عنصر را از والد خود حذف می کند.
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 بالشتک پایین را بر حسب نقاط تنظیم می کند.
set Padding Left(paddingLeft) Table Cell بالشتک سمت چپ را در نقاط تنظیم می کند.
set Padding Right(paddingRight) Table Cell بالشتک مناسب را در نقاط تنظیم می کند.
set Padding Top(paddingTop) Table Cell بالشتک بالا را در نقاط تنظیم می کند.
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()

یک Table جدید ایجاد و اضافه می کند.

بازگشت

Table - جدول جدید

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

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()

محتویات عنصر را پاک می کند.

بازگشت

Table Cell - عنصر فعلی.

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 - یک نتیجه جستجو که موقعیت عنصر جستجو را نشان می دهد.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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 Background Color()

رنگ پس زمینه را بازیابی می کند.

بازگشت

String - رنگ پس زمینه، فرمت شده در نماد 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()

دهانه ستون را بازیابی می‌کند، که تعداد ستون‌های سلول‌های جدول این سلول است. سلول‌های غیر ادغام‌شده دارای بازه 1 است.

بازگشت

Integer - دهانه ستون یا 0 برای سلولی که توسط سلول دیگری ادغام شده است

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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 Padding Bottom()

بالشتک پایین را به صورت امتیاز بازیابی می کند.

بازگشت

Number - بالشتک پایین، بر حسب امتیاز

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Padding Left()

لایه سمت چپ را در نقاط بازیابی می کند.

بازگشت

Number - بالشتک سمت چپ، بر حسب امتیاز

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Padding Right()

بالشتک مناسب را در نقاط بازیابی می کند.

بازگشت

Number - بالشتک سمت راست، بر حسب امتیاز

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Padding Top()

بالشتک بالا را به صورت امتیاز بازیابی می کند.

بازگشت

Number - لایه بالایی، بر حسب امتیاز

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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 Parent Row()

Table Row حاوی Table Cell فعلی را بازیابی می کند.

بازگشت

Table Row - ردیف جدول حاوی سلول فعلی

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Parent Table()

Table حاوی Table Cell فعلی را بازیابی می کند.

بازگشت

Table - جدول حاوی سلول فعلی

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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 Span()

پهنای ردیف را بازیابی می‌کند، که تعداد ردیف‌های سلول‌های جدولی است که این سلول در آن قرار دارد. سلول های ادغام نشده دارای یک ردیف 1 هستند.

بازگشت

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

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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 - تراز عمودی

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

get Width()

عرض ستون حاوی سلول را در نقاط بازیابی می کند.

بازگشت

Number - عرض ستون، بر حسب نقطه

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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 - عنصر ادغام شده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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 - عنصر حذف شده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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 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 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 Right Number بالشتک سمت راست، در نقاط.

بازگشت

Table Cell - عنصر فعلی.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

set Padding Top(paddingTop)

بالشتک بالا را در نقاط تنظیم می کند.

پارامترها

نام تایپ کنید توضیحات
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