Document Service

سند

این سرویس به اسکریپت‌ها اجازه می‌دهد تا فایل‌های Google Docs را ایجاد، به آنها دسترسی پیدا کرده و آنها را تغییر دهند.

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID');

// Create and open a document.
doc = DocumentApp.create('Document Name');

کلاس‌ها

نام شرح مختصر
Attribute شمارشی از ویژگی‌های عنصر.
Body محتوای یک برگه در یک سند Google Docs.
Bookmark یک شیء که نشان دهنده یک نشانه گذاری (bookmark) است.
Container Element یک عنصر عمومی که ممکن است شامل عناصر دیگری باشد.
Date عنصری که تاریخ قالب‌بندی شده را نشان می‌دهد
Document سندی که شامل یک یا چند شیء Tab است که هر کدام شامل متن غنی و عناصری مانند جداول و لیست‌ها هستند.
Document App سرویس سند، Documents ایجاد و باز می‌کند که قابل ویرایش هستند.
Document Tab یک برگه سند، حاوی متن غنی و عناصری مانند جداول و لیست‌ها.
Element یک عنصر عمومی.
Element Type شمارشی از تمام انواع عناصر.
Equation عنصری که یک عبارت ریاضی را نشان می‌دهد.
Equation Function عنصری که نشان دهنده یک تابع در یک Equation ریاضی است.
Equation Function Argument Separator عنصری که جداکننده تابع را در یک Equation ریاضی نشان می‌دهد.
Equation Symbol عنصری که نمایانگر یک نماد در یک Equation ریاضی است.
Font Family فهرستی از فونت‌های پشتیبانی‌شده
Footer Section عنصری که نشان‌دهنده‌ی بخش پاورقی است.
Footnote عنصری که نشان‌دهنده‌ی یک پاورقی است.
Footnote Section عنصری که نشان‌دهنده‌ی یک بخش پاورقی است.
Glyph Type فهرستی از انواع گلیف‌های پشتیبانی‌شده.
Header Section عنصری که نشان‌دهنده‌ی یک بخش هدر است.
Horizontal Alignment فهرستی از انواع ترازبندی افقی پشتیبانی شده.
Horizontal Rule عنصری که نشان دهنده یک خط افقی است.
Inline Drawing عنصری که نمایانگر یک نقاشی جاسازی‌شده است.
Inline Image عنصری که نشان دهنده یک تصویر جاسازی شده است.
List Item عنصری که یک آیتم لیست را نشان می‌دهد.
Named Range Range که دارای نام و شناسه است تا امکان بازیابی بعدی فراهم شود.
Page Break عنصری که نشان‌دهنده‌ی یک شکست صفحه است.
Paragraph عنصری که نمایانگر یک پاراگراف است.
Paragraph Heading فهرستی از سرتیترهای استاندارد پاراگراف.
Person عنصری که نشان‌دهنده‌ی پیوندی به یک شخص است.
Position ارجاع به مکانی در تب سند، نسبت به یک عنصر خاص.
Positioned Image تصویر با موقعیت ثابت که به یک Paragraph متصل شده است.
Positioned Layout یک نوع شمارش که نحوه چیدمان یک Positioned Image نسبت به متن اطراف مشخص می‌کند.
Range طیف وسیعی از عناصر در یک سند.
Range Builder سازنده‌ای که برای ساخت اشیاء Range از عناصر سند استفاده می‌شود.
Range Element یک پوشش (wrapper) دور یک Element با امکان تغییر فاصله شروع و پایان.
Rich Link عنصری که نشان‌دهنده‌ی پیوندی به یک منبع گوگل، مانند یک فایل درایو یا یک ویدیوی یوتیوب است.
Tab یک برگه در یک سند Google Docs.
Tab Type فهرستی از تمام انواع تب‌ها.
Table عنصری که نشان دهنده یک جدول است.
Table Cell عنصری که نشان‌دهنده‌ی یک سلول جدول است.
Table Of Contents عنصری که شامل فهرست مطالب است.
Table Row عنصری که نشان دهنده یک ردیف جدول است.
Text عنصری که نشان‌دهنده‌ی یک ناحیه‌ی متنی غنی است.
Text Alignment شمارشی از انواع ترازبندی متن.
Unsupported Element عنصری که نشان‌دهنده‌ی ناحیه‌ای است که ناشناخته است یا نمی‌تواند تحت تأثیر یک اسکریپت قرار گیرد، مانند شماره صفحه.
Vertical Alignment فهرستی از انواع ترازبندی عمودی پشتیبانی شده.

Attribute

خواص

ملک نوع توضیحات
BACKGROUND_COLOR Enum رنگ پس‌زمینه یک عنصر (پاراگراف، جدول و غیره) یا سند.
BOLD Enum تنظیم ضخامت فونت، برای متن غنی.
BORDER_COLOR Enum رنگ حاشیه، برای عناصر جدول.
BORDER_WIDTH Enum عرض حاشیه بر حسب نقطه، برای عناصر جدول.
CODE Enum محتویات کد، برای عناصر معادله.
FONT_FAMILY Enum تنظیمات خانواده فونت، برای متن غنی.
FONT_SIZE Enum تنظیم اندازه فونت بر حسب نقطه، برای متن غنی.
FOREGROUND_COLOR Enum تنظیم رنگ پیش‌زمینه، برای متن غنی.
HEADING Enum نوع عنوان، برای عناصر پاراگراف (برای مثال، Document App.ParagraphHeading.HEADING1 ).
HEIGHT Enum تنظیم ارتفاع، برای عناصر تصویر.
HORIZONTAL_ALIGNMENT Enum تراز افقی، برای عناصر پاراگراف (برای مثال، Document App.HorizontalAlignment.CENTER ).
INDENT_END Enum تنظیم تورفتگی انتهای عناصر پاراگراف بر حسب نقطه.
INDENT_FIRST_LINE Enum تنظیم تورفتگی خط اول بر حسب نقطه، برای عناصر پاراگراف.
INDENT_START Enum تنظیم شروع تورفتگی بر حسب نقطه، برای عناصر پاراگراف.
ITALIC Enum تنظیم سبک فونت، برای متن غنی.
GLYPH_TYPE Enum نوع glyph، برای عناصر آیتم لیست.
LEFT_TO_RIGHT Enum تنظیم جهت متن، برای متن غنی.
LINE_SPACING Enum تنظیم فاصله خطوط به عنوان ضریب، برای عناصر پاراگراف.
LINK_URL Enum آدرس لینک، برای متن غنی.
LIST_ID Enum شناسه‌ی لیست فراگیر، برای عناصر آیتم لیست.
MARGIN_BOTTOM Enum تنظیم حاشیه پایین بر حسب نقطه، برای عناصر پاراگراف.
MARGIN_LEFT Enum تنظیم حاشیه چپ بر حسب نقطه، برای عناصر پاراگراف.
MARGIN_RIGHT Enum تنظیم حاشیه سمت راست بر حسب نقطه، برای عناصر پاراگراف.
MARGIN_TOP Enum تنظیم حاشیه بالا بر حسب نقطه، برای عناصر پاراگراف.
NESTING_LEVEL Enum سطح تودرتوسازی آیتم، برای عناصر آیتم لیست.
MINIMUM_HEIGHT Enum تنظیم حداقل ارتفاع بر حسب نقطه، برای عناصر ردیف جدول.
PADDING_BOTTOM Enum تنظیم padding پایین بر حسب نقطه، برای عناصر سلول جدول.
PADDING_LEFT Enum تنظیم فاصله‌ی چپ (left padding) بر حسب نقطه، برای عناصر خانه‌ی جدول.
PADDING_RIGHT Enum تنظیم صحیح فاصله‌گذاری (padding) بر حسب نقطه، برای عناصر سلول جدول.
PADDING_TOP Enum تنظیم فاصله‌ی بین عناصر جدول بر حسب نقطه.
PAGE_HEIGHT Enum تنظیم ارتفاع صفحه بر حسب نقطه، برای اسناد.
PAGE_WIDTH Enum تنظیم عرض صفحه بر حسب نقطه، برای اسناد.
SPACING_AFTER Enum تنظیم فاصله پایین بر حسب نقطه، برای عناصر پاراگراف.
SPACING_BEFORE Enum تنظیم فاصله بالا بر حسب نقطه، برای عناصر پاراگراف.
STRIKETHROUGH Enum تنظیم خط خورده، برای متن غنی.
UNDERLINE Enum تنظیمات زیرخط، برای متن غنی.
VERTICAL_ALIGNMENT Enum تنظیم تراز عمودی، برای عناصر سلول جدول.
WIDTH Enum تنظیم عرض، برای سلول‌های جدول و عناصر تصویر.

Body

روش‌ها

روش نوع بازگشتی شرح مختصر
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 Page Break() Page Break یک Page Break جدید ایجاد و اضافه می‌کند.
append Page Break(pageBreak) Page Break Page Break داده شده را اضافه می‌کند.
append Paragraph(paragraph) Paragraph Paragraph داده شده را اضافه می‌کند.
append Paragraph(text) Paragraph یک Paragraph جدید حاوی محتوای متن مشخص شده ایجاد و اضافه می‌کند.
append Table() Table یک Table جدید ایجاد و اضافه می‌کند.
append Table(cells) Table یک Table جدید شامل یک Table Cell برای هر مقدار رشته‌ای مشخص شده اضافه می‌کند.
append Table(table) Table Table داده شده را ضمیمه می‌کند.
clear() Body محتویات عنصر را پاک می‌کند.
copy() Body یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
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 Child(childIndex) Element عنصر فرزند را در اندیس فرزند مشخص شده بازیابی می‌کند.
get Child Index(child) Integer اندیس فرزند را برای عنصر فرزند مشخص شده بازیابی می‌کند.
get Heading Attributes(paragraphHeading) Object مجموعه ویژگی‌های Paragraph Heading ارائه شده را بازیابی می‌کند.
get Images() Inline Image[] |null تمام Inline Images موجود در بخش را بازیابی می‌کند.
get List Items() List Item[] |null تمام List Items موجود در بخش را بازیابی می‌کند.
get Margin Bottom() Number|null حاشیه پایین را بر حسب نقطه بازیابی می‌کند.
get Margin Left() Number|null حاشیه سمت چپ را بر حسب نقطه بازیابی می‌کند.
get Margin Right() Number|null حاشیه سمت راست را بازیابی می‌کند.
get Margin Top() Number|null حاشیه بالایی را بازیابی می‌کند.
get Num Children() Integer تعداد فرزندان را بازیابی می‌کند.
get Page Height() Number|null ارتفاع صفحه را بر حسب نقطه برمی‌گرداند.
get Page Width() Number|null عرض صفحه را بر حسب نقطه برمی‌گرداند.
get Paragraphs() Paragraph[] |null تمام Paragraphs موجود در بخش (شامل List Items ) را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Tables() Table[] |null تمام Tables موجود در بخش را بازیابی می‌کند.
get Text() String محتوای عنصر را به صورت یک رشته متنی بازیابی می‌کند.
get Text Alignment() Text Alignment |null ترازبندی متن را دریافت می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
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 Page Break(childIndex) Page Break یک Page Break جدید در اندیس مشخص شده ایجاد و درج می‌کند.
insert Page Break(childIndex, pageBreak) Page Break Page Break داده شده را در فهرست مشخص شده وارد می‌کند.
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 داده شده را در اندیس مشخص شده درج می‌کند.
remove Child(child) Body عنصر فرزند مشخص شده را حذف می‌کند.
replace Text(searchPattern, replacement) Element با استفاده از عبارات منظم، تمام موارد تکرار یک الگوی متنی مشخص را با یک رشته جایگزین مشخص جایگزین می‌کند.
set Attributes(attributes) Body ویژگی‌های عنصر را تنظیم می‌کند.
set Heading Attributes(paragraphHeading, attributes) Body ویژگی‌های Paragraph Heading ارائه شده را تنظیم می‌کند.
set Margin Bottom(marginBottom) Body حاشیه پایین را بر حسب نقطه تنظیم می‌کند.
set Margin Left(marginLeft) Body حاشیه سمت چپ را بر حسب نقطه تنظیم می‌کند.
set Margin Right(marginRight) Body حاشیه سمت راست را بر حسب نقطه تنظیم می‌کند.
set Margin Top(marginTop) Body حاشیه بالا را تنظیم می‌کند.
set Page Height(pageHeight) Body ارتفاع صفحه را بر حسب نقطه تنظیم می‌کند.
set Page Width(pageWidth) Body عرض صفحه را بر حسب نقطه تنظیم می‌کند.
set Text(text) Body محتوا را به صورت متن ساده تنظیم می‌کند.
set Text Alignment(textAlignment) Body ترازبندی متن را تنظیم می‌کند.

Bookmark

روش‌ها

روش نوع بازگشتی شرح مختصر
get Id() String شناسه‌ی Bookmark را دریافت می‌کند.
get Position() Position Position Bookmark را در Document Tab دریافت می‌کند.
remove() void Bookmark را حذف می‌کند.

Container Element

روش‌ها

روش نوع بازگشتی شرح مختصر
as Body() Body عنصر فعلی را به عنوان یک Body برمی‌گرداند.
as Equation() Equation عنصر فعلی را به عنوان یک Equation برمی‌گرداند.
as Footer Section() Footer Section عنصر فعلی را به عنوان یک Footer Section برمی‌گرداند.
as Footnote Section() Footnote Section عنصر فعلی را به عنوان یک Footnote Section برمی‌گرداند.
as Header Section() Header Section عنصر فعلی را به عنوان یک Header Section برمی‌گرداند.
as List Item() List Item عنصر فعلی را به عنوان یک List Item برمی‌گرداند.
as Paragraph() Paragraph عنصر فعلی را به عنوان یک Paragraph برمی‌گرداند.
as Table() Table عنصر فعلی را به عنوان یک Table برمی‌گرداند.
as Table Cell() Table Cell عنصر فعلی را به عنوان یک Table Cell برمی‌گرداند.
as Table Of Contents() Table Of Contents عنصر فعلی را به عنوان یک Table Of Contents برمی‌گرداند.
as Table Row() Table Row عنصر فعلی را به عنوان یک Table Row برمی‌گرداند.
clear() Container Element محتویات عنصر را پاک می‌کند.
copy() Container Element یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
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 Child(childIndex) Element عنصر فرزند را در اندیس فرزند مشخص شده بازیابی می‌کند.
get Child Index(child) Integer اندیس فرزند را برای عنصر فرزند مشخص شده بازیابی می‌کند.
get Link Url() String|null آدرس لینک را بازیابی می‌کند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Num Children() Integer تعداد فرزندان را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Text() String محتوای عنصر را به صورت یک رشته متنی بازیابی می‌کند.
get Text Alignment() Text Alignment |null ترازبندی متن را دریافت می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
is At Document End() Boolean تعیین می‌کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
merge() Container Element |null عنصر را با عنصر خواهر یا برادر قبلی از همان نوع ادغام می‌کند.
remove From Parent() Container Element |null عنصر را از والدش حذف می‌کند.
replace Text(searchPattern, replacement) Element با استفاده از عبارات منظم، تمام موارد تکرار یک الگوی متنی مشخص را با یک رشته جایگزین مشخص جایگزین می‌کند.
set Attributes(attributes) Container Element ویژگی‌های عنصر را تنظیم می‌کند.
set Link Url(url) Container Element آدرس لینک را تنظیم می‌کند.
set Text Alignment(textAlignment) Container Element ترازبندی متن را تنظیم می‌کند.

Date

روش‌ها

روش نوع بازگشتی شرح مختصر
copy() Date یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
get Attributes() Object ویژگی‌های عنصر را بازیابی می‌کند.
get Display Text() String مقدار نمایشی که در سند رندر شده است را برمی‌گرداند.
get Locale() String محلی که برای نمایش مقدار تاریخ استفاده شده است را برمی‌گرداند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Timestamp() Date مهر زمانی مرتبط با تاریخ را برمی‌گرداند.
get Type() Element Type Element Type را بازیابی می‌کند.
is At Document End() Boolean تعیین می‌کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
merge() Date |null عنصر را با عنصر خواهر یا برادر قبلی از همان نوع ادغام می‌کند.
remove From Parent() Date |null عنصر را از والدش حذف می‌کند.
set Attributes(attributes) Date ویژگی‌های عنصر را تنظیم می‌کند.

Document

روش‌ها

روش نوع بازگشتی شرح مختصر
add Bookmark(position) Bookmark یک Bookmark در Position داده شده به اولین تب یا برای اسکریپت‌هایی که به یک سند متصل هستند، به تب فعال اضافه می‌کند.
add Editor(emailAddress) Document کاربر داده شده را به لیست ویرایشگران Document اضافه می‌کند.
add Editor(user) Document کاربر داده شده را به لیست ویرایشگران Document اضافه می‌کند.
add Editors(emailAddresses) Document آرایه‌ی داده شده از کاربران را به لیست ویرایشگران Document اضافه می‌کند.
add Footer() Footer Section اگر بخشی در پاورقی وجود نداشته باشد، آن را به اولین تب یا برای اسکریپت‌هایی که به یک سند متصل هستند، به تب فعال اضافه می‌کند.
add Header() Header Section اگر بخش سربرگ وجود نداشته باشد، آن را به اولین تب یا برای اسکریپت‌هایی که به یک سند متصل هستند، به تب فعال اضافه می‌کند.
add Named Range(name, range) Named Range یک Named Range اضافه می‌کند، که Range است که دارای نام و شناسه برای استفاده در بازیابی‌های بعدی، در اولین تب یا برای اسکریپت‌هایی که به یک سند متصل هستند، در تب فعال، می‌باشد.
add Viewer(emailAddress) Document کاربر داده شده را به لیست بینندگان Document اضافه می‌کند.
add Viewer(user) Document کاربر داده شده را به لیست بینندگان Document اضافه می‌کند.
add Viewers(emailAddresses) Document آرایه‌ی داده شده از کاربران را به لیست بینندگان Document اضافه می‌کند.
get Active Tab() Tab Tab فعال فعلی کاربر در سند را برمی‌گرداند.
get As(contentType) Blob محتویات Document فعلی را به صورت یک blob از نوع مشخص شده بازیابی می‌کند.
get Blob() Blob محتوای Document فعلی را به صورت یک حباب (blob) بازیابی می‌کند.
get Body() Body Body اولین تب یا، برای اسکریپت‌هایی که به یک سند متصل هستند، Document Body Section تب فعال را بازیابی می‌کند.
get Bookmark(id) Bookmark |null Bookmark با شناسه‌ی داده شده در اولین تب یا برای اسکریپت‌هایی که به یک سند متصل هستند، در تب فعال دریافت می‌کند.
get Bookmarks() Bookmark[] تمام اشیاء Bookmark را در اولین تب یا برای اسکریپت‌هایی که به یک سند متصل هستند، در تب فعال دریافت می‌کند.
get Cursor() Position |null مکان‌نمای کاربر را در تب فعال دریافت می‌کند.
get Editors() User[] لیست ویرایشگران این Document را دریافت می‌کند.
get Footer() Footer Section |null بخش پاورقی اولین تب یا، برای اسکریپت‌هایی که به یک سند متصل هستند، بخش پاورقی تب فعال را بازیابی می‌کند.
get Footnotes() Footnote[] |null تمام عناصر Footnote را در بدنه‌ی اولین تب یا برای اسکریپت‌هایی که به یک سند متصل هستند، در بدنه‌ی تب فعال بازیابی می‌کند.
get Header() Header Section |null بخش سربرگ اولین تب یا، برای اسکریپت‌هایی که به یک سند متصل هستند، بخش سربرگ تب فعال را بازیابی می‌کند.
get Id() String شناسه منحصر به فرد سند را بازیابی می‌کند.
get Language() String کد زبان سند را دریافت می‌کند.
get Name() String عنوان سند را بازیابی می‌کند.
get Named Range By Id(id) Named Range |null Named Range با شناسه داده شده در اولین تب یا برای اسکریپت‌هایی که به یک سند متصل هستند، در تب فعال را دریافت می‌کند.
get Named Ranges() Named Range[] تمام اشیاء Named Range را در اولین تب یا برای اسکریپت‌هایی که به یک سند متصل هستند، در تب فعال دریافت می‌کند.
get Named Ranges(name) Named Range[] تمام اشیاء Named Range را با نام داده شده در اولین تب یا برای اسکریپت‌هایی که به یک سند متصل هستند، در تب فعال دریافت می‌کند.
get Selection() Range |null انتخاب کاربر را در تب فعال دریافت می‌کند.
get Supported Language Codes() String[] تمام کدهای زبانی که در فایل‌های Google Docs پشتیبانی می‌شوند را دریافت می‌کند.
get Tab(tabId) Tab Tab با شناسه (ID) مشخص شده را دریافت می‌کند.
get Tabs() Tab[] تمام Tab غیر تو در تو که بخشی از سند هستند را دریافت می‌کند.
get Url() String آدرس اینترنتی (URL) را برای دسترسی به سند فعلی بازیابی می‌کند.
get Viewers() User[] لیست بینندگان و نظردهندگان این Document را دریافت می‌کند.
new Position(element, offset) Position یک Position جدید ایجاد می‌کند که ارجاعی به مکانی در تب، نسبت به یک عنصر خاص در تب اول یا برای اسکریپت‌هایی که به یک سند متصل هستند، نسبت به تب فعال است.
new Range() Range Builder یک سازنده ایجاد می‌کند که برای ساخت اشیاء Range از عناصر tab در اولین tab یا برای اسکریپت‌هایی که به یک سند متصل هستند، از tab فعال استفاده می‌شود.
remove Editor(emailAddress) Document کاربر داده شده را از لیست ویرایشگران Document حذف می‌کند.
remove Editor(user) Document کاربر داده شده را از لیست ویرایشگران Document حذف می‌کند.
remove Viewer(emailAddress) Document کاربر داده شده را از لیست بینندگان و نظردهندگان Document حذف می‌کند.
remove Viewer(user) Document کاربر داده شده را از لیست بینندگان و نظردهندگان Document حذف می‌کند.
save And Close() void Document فعلی را ذخیره می‌کند.
set Active Tab(tabId) void Tab انتخاب شده توسط کاربر در سند فعلی را به تبی با شناسه مشخص شده تنظیم می‌کند.
set Cursor(position) Document مکان‌نمای کاربر را با توجه به Position تنظیم می‌کند.
set Language(languageCode) Document کد زبان سند را تنظیم می‌کند.
set Name(name) Document عنوان سند را تنظیم می‌کند.
set Selection(range) Document با توجه به Range ، انتخاب کاربر را در تب فعال تنظیم می‌کند.

Document App

خواص

ملک نوع توضیحات
Attribute Attribute شمارش Attribute .
Element Type Element Type شمارش Element Type .
Font Family Font Family شمارش Font Family .
Glyph Type Glyph Type شمارش Glyph Type .
Horizontal Alignment Horizontal Alignment شمارش Horizontal Alignment .
Paragraph Heading Paragraph Heading شمارش Paragraph Heading .
Positioned Layout Positioned Layout شمارش Positioned Layout .
Text Alignment Text Alignment شمارش Text Alignment .
Vertical Alignment Vertical Alignment شمارش Vertical Alignment .

روش‌ها

روش نوع بازگشتی شرح مختصر
create(name) Document یک سند جدید ایجاد و برمی‌گرداند.
get Active Document() Document سندی را که اسکریپت به آن متصل است، برمی‌گرداند.
get Ui() Ui نمونه‌ای از محیط رابط کاربری سند را برمی‌گرداند که به اسکریپت اجازه می‌دهد ویژگی‌هایی مانند منوها، کادرهای محاوره‌ای و نوارهای کناری را اضافه کند.
open By Id(id) Document سند را با شناسه مشخص شده برمی‌گرداند.
open By Url(url) Document سند را با URL مشخص شده باز کرده و برمی‌گرداند.

Document Tab

روش‌ها

روش نوع بازگشتی شرح مختصر
add Bookmark(position) Bookmark یک Bookmark در Position داده شده اضافه می‌کند.
add Footer() Footer Section اگر بخشی در پاورقی برگه وجود نداشته باشد، آن را اضافه می‌کند.
add Header() Header Section اگر بخشی برای سربرگ تب وجود نداشته باشد، آن را اضافه می‌کند.
add Named Range(name, range) Named Range یک Named Range اضافه می‌کند، که Range است که دارای نام و شناسه برای استفاده در بازیابی‌های بعدی است.
get Body() Body Body تب را بازیابی می‌کند.
get Bookmark(id) Bookmark |null Bookmark با شناسه‌ی داده شده دریافت می‌کند.
get Bookmarks() Bookmark[] تمام اشیاء Bookmark در تب را دریافت می‌کند.
get Footer() Footer Section |null در صورت وجود، بخش پاورقی برگه را بازیابی می‌کند.
get Footnotes() Footnote[] |null تمام عناصر Footnote را در بدنه تب بازیابی می‌کند.
get Header() Header Section |null در صورت وجود، بخش سربرگ تب را بازیابی می‌کند.
get Named Range By Id(id) Named Range |null Named Range با شناسه‌ی داده شده را دریافت می‌کند.
get Named Ranges() Named Range[] تمام اشیاء Named Range را در برگه دریافت می‌کند.
get Named Ranges(name) Named Range[] تمام اشیاء Named Range را در تب با نام داده شده دریافت می‌کند.
new Position(element, offset) Position یک Position جدید ایجاد می‌کند که ارجاعی به مکانی در تب، نسبت به یک عنصر خاص است.
new Range() Range Builder یک سازنده ایجاد می‌کند که برای ساخت اشیاء Range از عناصر tab استفاده می‌شود.

Element

روش‌ها

روش نوع بازگشتی شرح مختصر
as Body() Body عنصر فعلی را به عنوان یک Body برمی‌گرداند.
as Date() Date عنصر فعلی را به عنوان یک Date برمی‌گرداند.
as Equation() Equation عنصر فعلی را به عنوان یک Equation برمی‌گرداند.
as Equation Function() Equation Function عنصر فعلی را به عنوان یک Equation Function برمی‌گرداند.
as Equation Function Argument Separator() Equation Function Argument Separator عنصر فعلی را به عنوان Equation Function Argument Separator برمی‌گرداند.
as Equation Symbol() Equation Symbol عنصر فعلی را به عنوان Equation Symbol برمی‌گرداند.
as Footer Section() Footer Section عنصر فعلی را به عنوان یک Footer Section برمی‌گرداند.
as Footnote() Footnote عنصر فعلی را به عنوان یک Footnote برمی‌گرداند.
as Footnote Section() Footnote Section عنصر فعلی را به عنوان یک Footnote Section برمی‌گرداند.
as Header Section() Header Section عنصر فعلی را به عنوان یک Header Section برمی‌گرداند.
as Horizontal Rule() Horizontal Rule عنصر فعلی را به عنوان یک Horizontal Rule برمی‌گرداند.
as Inline Drawing() Inline Drawing عنصر فعلی را به عنوان یک Inline Drawing برمی‌گرداند.
as Inline Image() Inline Image عنصر فعلی را به عنوان یک Inline Image برمی‌گرداند.
as List Item() List Item عنصر فعلی را به عنوان یک List Item برمی‌گرداند.
as Page Break() Page Break عنصر فعلی را به عنوان یک Page Break برمی‌گرداند.
as Paragraph() Paragraph عنصر فعلی را به عنوان یک Paragraph برمی‌گرداند.
as Person() Person عنصر فعلی را به عنوان یک Person برمی‌گرداند.
as Rich Link() Rich Link عنصر فعلی را به عنوان یک Rich Link )، برای مثال، پیوندی به یک فایل Google Sheets، برمی‌گرداند.
as Table() Table عنصر فعلی را به عنوان یک Table برمی‌گرداند.
as Table Cell() Table Cell عنصر فعلی را به عنوان یک Table Cell برمی‌گرداند.
as Table Of Contents() Table Of Contents عنصر فعلی را به عنوان یک Table Of Contents برمی‌گرداند.
as Table Row() Table Row عنصر فعلی را به عنوان یک Table Row برمی‌گرداند.
as Text() Text عنصر فعلی را به عنوان یک Text برمی‌گرداند.
copy() Element یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
get Attributes() Object ویژگی‌های عنصر را بازیابی می‌کند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
is At Document End() Boolean تعیین می‌کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
merge() Element |null عنصر را با عنصر خواهر یا برادر قبلی از همان نوع ادغام می‌کند.
remove From Parent() Element |null عنصر را از والدش حذف می‌کند.
set Attributes(attributes) Element ویژگی‌های عنصر را تنظیم می‌کند.

Element Type

خواص

ملک نوع توضیحات
BODY_SECTION Enum نوع مربوط به عنصر Body .
COMMENT_SECTION Enum نوع مربوط به عنصر Comment Section .
DATE Enum نوع مربوط به عنصر Date .
EQUATION Enum نوع مربوط به عنصر Equation .
EQUATION_FUNCTION Enum نوع مربوط به عنصر Equation Function .
EQUATION_FUNCTION_ARGUMENT_SEPARATOR Enum نوع مربوط به عنصر Equation Function Argument Separator .
EQUATION_SYMBOL Enum نوع مربوط به عنصر Equation Symbol .
RICH_LINK Enum نوع مربوط به عنصر Rich Link .
FOOTER_SECTION Enum نوع مربوط به عنصر Footer Section .
FOOTNOTE Enum نوع مربوط به عنصر Footnote .
FOOTNOTE_SECTION Enum نوع مربوط به عنصر Footnote Section .
HEADER_SECTION Enum نوع مربوط به عنصر Header Section .
HORIZONTAL_RULE Enum نوع مربوط به عنصر Horizontal Rule .
INLINE_DRAWING Enum نوع مربوط به عنصر Inline Drawing .
INLINE_IMAGE Enum نوع مربوط به عنصر Inline Image .
LIST_ITEM Enum نوع مربوط به عنصر List Item .
PAGE_BREAK Enum نوع مربوط به عنصر Page Break .
PARAGRAPH Enum نوع مربوط به عنصر Paragraph .
PERSON Enum نوع مربوط به عنصر Person .
TABLE Enum نوع مربوط به عنصر Table .
TABLE_CELL Enum نوع مربوط به عنصر Table Cell .
TABLE_OF_CONTENTS Enum نوع مربوط به عنصر Table Of Contents .
TABLE_ROW Enum نوع مربوط به عنصر Table Row .
TEXT Enum نوع مربوط به عنصر Text .
UNSUPPORTED Enum نوع مربوط به Unsupported Element .

Equation

روش‌ها

روش نوع بازگشتی شرح مختصر
clear() Equation محتویات عنصر را پاک می‌کند.
copy() Equation یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
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 Child(childIndex) Element عنصر فرزند را در اندیس فرزند مشخص شده بازیابی می‌کند.
get Child Index(child) Integer اندیس فرزند را برای عنصر فرزند مشخص شده بازیابی می‌کند.
get Link Url() String|null آدرس لینک را بازیابی می‌کند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Num Children() Integer تعداد فرزندان را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Text() String محتوای عنصر را به صورت یک رشته متنی بازیابی می‌کند.
get Text Alignment() Text Alignment |null ترازبندی متن را دریافت می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
is At Document End() Boolean تعیین می‌کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
merge() Equation |null عنصر را با عنصر خواهر یا برادر قبلی از همان نوع ادغام می‌کند.
remove From Parent() Equation |null عنصر را از والدش حذف می‌کند.
replace Text(searchPattern, replacement) Element با استفاده از عبارات منظم، تمام موارد تکرار یک الگوی متنی مشخص را با یک رشته جایگزین مشخص جایگزین می‌کند.
set Attributes(attributes) Equation ویژگی‌های عنصر را تنظیم می‌کند.
set Link Url(url) Equation آدرس لینک را تنظیم می‌کند.
set Text Alignment(textAlignment) Equation ترازبندی متن را تنظیم می‌کند.

Equation Function

روش‌ها

روش نوع بازگشتی شرح مختصر
clear() Equation Function محتویات عنصر را پاک می‌کند.
copy() Equation Function یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
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 Child(childIndex) Element عنصر فرزند را در اندیس فرزند مشخص شده بازیابی می‌کند.
get Child Index(child) Integer اندیس فرزند را برای عنصر فرزند مشخص شده بازیابی می‌کند.
get Code() String کد مربوط به تابع معادله را بازیابی می‌کند.
get Link Url() String|null آدرس لینک را بازیابی می‌کند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Num Children() Integer تعداد فرزندان را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Text() String محتوای عنصر را به صورت یک رشته متنی بازیابی می‌کند.
get Text Alignment() Text Alignment |null ترازبندی متن را دریافت می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
is At Document End() Boolean تعیین می‌کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
merge() Equation Function |null عنصر را با عنصر خواهر یا برادر قبلی از همان نوع ادغام می‌کند.
remove From Parent() Equation Function |null عنصر را از والدش حذف می‌کند.
replace Text(searchPattern, replacement) Element با استفاده از عبارات منظم، تمام موارد تکرار یک الگوی متنی مشخص را با یک رشته جایگزین مشخص جایگزین می‌کند.
set Attributes(attributes) Equation Function ویژگی‌های عنصر را تنظیم می‌کند.
set Link Url(url) Equation Function آدرس لینک را تنظیم می‌کند.
set Text Alignment(textAlignment) Equation Function ترازبندی متن را تنظیم می‌کند.

Equation Function Argument Separator

روش‌ها

روش نوع بازگشتی شرح مختصر
copy() Equation Function Argument Separator یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
get Attributes() Object ویژگی‌های عنصر را بازیابی می‌کند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
is At Document End() Boolean تعیین می‌کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
merge() Equation Function Argument Separator |null عنصر را با عنصر خواهر یا برادر قبلی از همان نوع ادغام می‌کند.
remove From Parent() Equation Function Argument Separator |null عنصر را از والدش حذف می‌کند.
set Attributes(attributes) Equation Function Argument Separator ویژگی‌های عنصر را تنظیم می‌کند.

Equation Symbol

روش‌ها

روش نوع بازگشتی شرح مختصر
copy() Equation Symbol یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
get Attributes() Object ویژگی‌های عنصر را بازیابی می‌کند.
get Code() String کد مربوط به نماد معادله را بازیابی می‌کند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
is At Document End() Boolean تعیین می‌کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
merge() Equation Symbol |null عنصر را با عنصر خواهر یا برادر قبلی از همان نوع ادغام می‌کند.
remove From Parent() Equation Symbol |null عنصر را از والدش حذف می‌کند.
set Attributes(attributes) Equation Symbol ویژگی‌های عنصر را تنظیم می‌کند.

Font Family

Footer Section

روش‌ها

روش نوع بازگشتی شرح مختصر
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 جدید شامل یک Table Cell برای هر مقدار رشته‌ای مشخص شده اضافه می‌کند.
append Table(table) Table Table داده شده را ضمیمه می‌کند.
clear() Footer Section محتویات عنصر را پاک می‌کند.
copy() Footer Section یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
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 Child(childIndex) Element عنصر فرزند را در اندیس فرزند مشخص شده بازیابی می‌کند.
get Child Index(child) Integer اندیس فرزند را برای عنصر فرزند مشخص شده بازیابی می‌کند.
get Images() Inline Image[] |null تمام Inline Images موجود در بخش را بازیابی می‌کند.
get List Items() List Item[] |null تمام List Items موجود در بخش را بازیابی می‌کند.
get Num Children() Integer تعداد فرزندان را بازیابی می‌کند.
get Paragraphs() Paragraph[] |null تمام Paragraphs موجود در بخش (شامل List Items ) را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Tables() Table[] |null تمام Tables موجود در بخش را بازیابی می‌کند.
get Text() String محتوای عنصر را به صورت یک رشته متنی بازیابی می‌کند.
get Text Alignment() Text Alignment |null ترازبندی متن را دریافت می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
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 داده شده را در اندیس مشخص شده درج می‌کند.
remove Child(child) Footer Section عنصر فرزند مشخص شده را حذف می‌کند.
remove From Parent() Footer Section |null عنصر را از والدش حذف می‌کند.
replace Text(searchPattern, replacement) Element با استفاده از عبارات منظم، تمام موارد تکرار یک الگوی متنی مشخص را با یک رشته جایگزین مشخص جایگزین می‌کند.
set Attributes(attributes) Footer Section ویژگی‌های عنصر را تنظیم می‌کند.
set Text(text) Footer Section محتوا را به صورت متن ساده تنظیم می‌کند.
set Text Alignment(textAlignment) Footer Section ترازبندی متن را تنظیم می‌کند.

Footnote

روش‌ها

روش نوع بازگشتی شرح مختصر
copy() Footnote یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
get Attributes() Object ویژگی‌های عنصر را بازیابی می‌کند.
get Footnote Contents() Footnote Section |null محتویات عنصر پاورقی را بازیابی می‌کند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
is At Document End() Boolean تعیین می‌کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
remove From Parent() Footnote |null عنصر را از والدش حذف می‌کند.
set Attributes(attributes) Footnote ویژگی‌های عنصر را تنظیم می‌کند.

Footnote Section

روش‌ها

روش نوع بازگشتی شرح مختصر
append Paragraph(paragraph) Paragraph Paragraph داده شده را اضافه می‌کند.
append Paragraph(text) Paragraph یک Paragraph جدید حاوی محتوای متن مشخص شده ایجاد و اضافه می‌کند.
clear() Footnote Section محتویات عنصر را پاک می‌کند.
copy() Footnote Section یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
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 Child(childIndex) Element عنصر فرزند را در اندیس فرزند مشخص شده بازیابی می‌کند.
get Child Index(child) Integer اندیس فرزند را برای عنصر فرزند مشخص شده بازیابی می‌کند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Num Children() Integer تعداد فرزندان را بازیابی می‌کند.
get Paragraphs() Paragraph[] |null تمام Paragraphs موجود در بخش (شامل List Items ) را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Text() String محتوای عنصر را به صورت یک رشته متنی بازیابی می‌کند.
get Text Alignment() Text Alignment |null ترازبندی متن را دریافت می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
insert Paragraph(childIndex, paragraph) Paragraph Paragraph داده شده را در اندیس مشخص شده درج می‌کند.
insert Paragraph(childIndex, text) Paragraph یک Paragraph جدید ایجاد و در فهرست مشخص شده درج می‌کند که حاوی محتوای متن مشخص شده است.
remove Child(child) Footnote Section عنصر فرزند مشخص شده را حذف می‌کند.
remove From Parent() Footnote Section |null عنصر را از والدش حذف می‌کند.
replace Text(searchPattern, replacement) Element با استفاده از عبارات منظم، تمام موارد تکرار یک الگوی متنی مشخص را با یک رشته جایگزین مشخص جایگزین می‌کند.
set Attributes(attributes) Footnote Section ویژگی‌های عنصر را تنظیم می‌کند.
set Text(text) Footnote Section محتوا را به صورت متن ساده تنظیم می‌کند.
set Text Alignment(textAlignment) Footnote Section ترازبندی متن را تنظیم می‌کند.

Glyph Type

خواص

ملک نوع توضیحات
BULLET Enum گلوله پیش‌فرض، دایره‌ای و توپر.
HOLLOW_BULLET Enum یک گلوله توخالی.
SQUARE_BULLET Enum یک گلوله مربعی.
NUMBER Enum یک بولت مبتنی بر عدد.
LATIN_UPPER Enum یک علامت با حروف بزرگ لاتین.
LATIN_LOWER Enum یک گلوله لاتین با حروف کوچک.
ROMAN_UPPER Enum یک عدد رومی، گلوله با حروف بزرگ.
ROMAN_LOWER Enum یک عدد رومی، گلوله با حروف کوچک.

Header Section

روش‌ها

روش نوع بازگشتی شرح مختصر
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 جدید شامل یک Table Cell برای هر مقدار رشته‌ای مشخص شده اضافه می‌کند.
append Table(table) Table Table داده شده را ضمیمه می‌کند.
clear() Header Section محتویات عنصر را پاک می‌کند.
copy() Header Section یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
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 Child(childIndex) Element عنصر فرزند را در اندیس فرزند مشخص شده بازیابی می‌کند.
get Child Index(child) Integer اندیس فرزند را برای عنصر فرزند مشخص شده بازیابی می‌کند.
get Images() Inline Image[] |null تمام Inline Images موجود در بخش را بازیابی می‌کند.
get List Items() List Item[] |null تمام List Items موجود در بخش را بازیابی می‌کند.
get Num Children() Integer تعداد فرزندان را بازیابی می‌کند.
get Paragraphs() Paragraph[] |null تمام Paragraphs موجود در بخش (شامل List Items ) را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Tables() Table[] |null تمام Tables موجود در بخش را بازیابی می‌کند.
get Text() String محتوای عنصر را به صورت یک رشته متنی بازیابی می‌کند.
get Text Alignment() Text Alignment |null ترازبندی متن را دریافت می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
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 داده شده را در اندیس مشخص شده درج می‌کند.
remove Child(child) Header Section عنصر فرزند مشخص شده را حذف می‌کند.
remove From Parent() Header Section |null عنصر را از والدش حذف می‌کند.
replace Text(searchPattern, replacement) Element با استفاده از عبارات منظم، تمام موارد تکرار یک الگوی متنی مشخص را با یک رشته جایگزین مشخص جایگزین می‌کند.
set Attributes(attributes) Header Section ویژگی‌های عنصر را تنظیم می‌کند.
set Text(text) Header Section محتوا را به صورت متن ساده تنظیم می‌کند.
set Text Alignment(textAlignment) Header Section ترازبندی متن را تنظیم می‌کند.

Horizontal Alignment

خواص

ملک نوع توضیحات
LEFT Enum گزینه ترازبندی چپ.
CENTER Enum گزینه ترازبندی در مرکز.
RIGHT Enum گزینه ترازبندی از راست.
JUSTIFY Enum گزینه ترازبندی توجیهی.

Horizontal Rule

روش‌ها

روش نوع بازگشتی شرح مختصر
copy() Horizontal Rule یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
get Attributes() Object ویژگی‌های عنصر را بازیابی می‌کند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
is At Document End() Boolean تعیین می‌کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
remove From Parent() Horizontal Rule |null عنصر را از والدش حذف می‌کند.
set Attributes(attributes) Horizontal Rule ویژگی‌های عنصر را تنظیم می‌کند.

Inline Drawing

روش‌ها

روش نوع بازگشتی شرح مختصر
copy() Inline Drawing یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
get Alt Description() String|null توضیحات جایگزین نقاشی را برمی‌گرداند.
get Alt Title() String|null عنوان جایگزین نقاشی را برمی‌گرداند.
get Attributes() Object ویژگی‌های عنصر را بازیابی می‌کند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
is At Document End() Boolean تعیین می‌کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
merge() Inline Drawing |null عنصر را با عنصر خواهر یا برادر قبلی از همان نوع ادغام می‌کند.
remove From Parent() Inline Drawing |null عنصر را از والدش حذف می‌کند.
set Alt Description(description) Inline Drawing توضیحات جایگزین نقاشی را تنظیم می‌کند.
set Alt Title(title) Inline Drawing عنوان جایگزین نقاشی را تنظیم می‌کند.
set Attributes(attributes) Inline Drawing ویژگی‌های عنصر را تنظیم می‌کند.

Inline Image

روش‌ها

روش نوع بازگشتی شرح مختصر
copy() Inline Image یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
get Alt Description() String|null توضیحات جایگزین تصویر را برمی‌گرداند.
get Alt Title() String|null عنوان جایگزین تصویر را برمی‌گرداند.
get As(contentType) Blob داده‌های درون این شیء را به صورت یک blob تبدیل‌شده به نوع محتوای مشخص‌شده، برمی‌گرداند.
get Attributes() Object ویژگی‌های عنصر را بازیابی می‌کند.
get Blob() Blob داده‌های درون این شیء را به صورت یک blob برمی‌گرداند.
get Height() Integer ارتفاع تصویر را بر حسب پیکسل بازیابی می‌کند.
get Link Url() String|null آدرس لینک را بازیابی می‌کند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
get Width() Integer عرض تصویر را بر حسب پیکسل بازیابی می‌کند.
is At Document End() Boolean تعیین می‌کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
merge() Inline Image |null عنصر را با عنصر خواهر یا برادر قبلی از همان نوع ادغام می‌کند.
remove From Parent() Inline Image |null عنصر را از والدش حذف می‌کند.
set Alt Description(description) Inline Image توضیحات جایگزین تصویر را تنظیم می‌کند.
set Alt Title(title) Inline Image عنوان جایگزین تصویر را تنظیم می‌کند.
set Attributes(attributes) Inline Image ویژگی‌های عنصر را تنظیم می‌کند.
set Height(height) Inline Image ارتفاع تصویر را بر حسب پیکسل تنظیم می‌کند.
set Link Url(url) Inline Image آدرس لینک را تنظیم می‌کند.
set Width(width) Inline Image عرض تصویر را بر حسب پیکسل تنظیم می‌کند.

List Item

روش‌ها

روش نوع بازگشتی شرح مختصر
add Positioned Image(image) Positioned Image یک Positioned Image جدید از بلوک تصویر مشخص‌شده ایجاد و درج می‌کند.
append Horizontal Rule() Horizontal Rule یک Horizontal Rule جدید ایجاد و اضافه می‌کند.
append Inline Image(image) Inline Image یک Inline Image جدید از بلوک تصویر مشخص‌شده ایجاد و اضافه می‌کند.
append Inline Image(image) Inline Image Inline Image داده شده را اضافه می‌کند.
append Page Break() Page Break یک Page Break جدید ایجاد و اضافه می‌کند.
append Page Break(pageBreak) Page Break Page Break داده شده را اضافه می‌کند.
append Text(text) Text یک عنصر Text جدید با محتوای مشخص شده ایجاد و اضافه می‌کند.
append Text(text) Text عنصر Text داده شده را اضافه می‌کند.
clear() List Item محتویات عنصر را پاک می‌کند.
copy() List Item یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
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 Alignment() Horizontal Alignment |null Horizontal Alignment بازیابی می‌کند.
get Attributes() Object ویژگی‌های عنصر را بازیابی می‌کند.
get Child(childIndex) Element عنصر فرزند را در اندیس فرزند مشخص شده بازیابی می‌کند.
get Child Index(child) Integer اندیس فرزند را برای عنصر فرزند مشخص شده بازیابی می‌کند.
get Glyph Type() Glyph Type |null Glyph Type آیتم لیست را بازیابی می‌کند.
get Heading() Paragraph Heading |null Paragraph Heading بازیابی می‌کند.
get Indent End() Number|null تورفتگی انتهایی را بر حسب نقطه بازیابی می‌کند.
get Indent First Line() Number|null میزان تورفتگی خط اول را بر حسب نقطه برمی‌گرداند.
get Indent Start() Number|null تورفتگی شروع را بازیابی می‌کند.
get Line Spacing() Number|null فاصله بین خطوط را بر حسب نقطه بازیابی می‌کند.
get Link Url() String|null آدرس لینک را بازیابی می‌کند.
get List Id() String|null شناسه لیست را بازیابی می‌کند.
get Nesting Level() Integer سطح تودرتوی آیتم لیست را بازیابی می‌کند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Num Children() Integer تعداد فرزندان را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Positioned Image(id) Positioned Image یک Positioned Image بر اساس شناسه تصویر دریافت می‌کند.
get Positioned Images() Positioned Image[] تمام اشیاء Positioned Image که به پاراگراف متصل شده‌اند، دریافت می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Spacing After() Number|null فاصله بعد از عنصر را بر حسب نقطه بازیابی می‌کند.
get Spacing Before() Number|null فاصله قبل از عنصر را بر حسب نقطه بازیابی می‌کند.
get Text() String محتوای عنصر را به صورت یک رشته متنی بازیابی می‌کند.
get Text Alignment() Text Alignment |null ترازبندی متن را دریافت می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
insert Horizontal Rule(childIndex) Horizontal Rule یک Horizontal Rule در اندیس مشخص شده ایجاد و درج می‌کند.
insert Inline Image(childIndex, image) Inline Image یک Inline Image جدید را از بلوک تصویر مشخص‌شده، در اندیس مشخص‌شده ایجاد و درج می‌کند.
insert Inline Image(childIndex, image) Inline Image Inline Image داده شده را در اندیس مشخص شده درج می‌کند.
insert Page Break(childIndex) Page Break یک Page Break جدید در اندیس مشخص شده ایجاد و درج می‌کند.
insert Page Break(childIndex, pageBreak) Page Break Page Break داده شده را در فهرست مشخص شده وارد می‌کند.
insert Text(childIndex, text) Text یک عنصر متنی جدید را در اندیس مشخص شده ایجاد و درج می‌کند.
insert Text(childIndex, text) Text عنصر Text داده شده را در اندیس مشخص شده، با محتوای متن مشخص شده، درج می‌کند.
is At Document End() Boolean تعیین می‌کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
is Left To Right() Boolean|null تنظیمات چپ به راست را بازیابی می‌کند.
merge() List Item |null عنصر را با عنصر خواهر یا برادر قبلی از همان نوع ادغام می‌کند.
remove Child(child) List Item عنصر فرزند مشخص شده را حذف می‌کند.
remove From Parent() List Item |null عنصر را از والدش حذف می‌کند.
remove Positioned Image(id) Boolean یک Positioned Image بر اساس شناسه تصویر حذف می‌کند.
replace Text(searchPattern, replacement) Element با استفاده از عبارات منظم، تمام موارد تکرار یک الگوی متنی مشخص را با یک رشته جایگزین مشخص جایگزین می‌کند.
set Alignment(alignment) List Item Horizontal Alignment را تنظیم می‌کند.
set Attributes(attributes) List Item ویژگی‌های عنصر را تنظیم می‌کند.
set Glyph Type(glyphType) List Item Glyph Type آیتم لیست را تنظیم می‌کند.
set Heading(heading) List Item Paragraph Heading تنظیم می‌کند.
set Indent End(indentEnd) List Item تورفتگی انتهایی را بر حسب نقطه تنظیم می‌کند.
set Indent First Line(indentFirstLine) List Item میزان تورفتگی خط اول را بر حسب نقطه تنظیم می‌کند.
set Indent Start(indentStart) List Item تورفتگی شروع را بر حسب نقطه تنظیم می‌کند.
set Left To Right(leftToRight) List Item تنظیم چپ به راست را تنظیم می‌کند.
set Line Spacing(multiplier) List Item فاصله خطوط را به عنوان کمیتی که تعداد خطوط مورد استفاده برای فاصله‌گذاری را نشان می‌دهد، تنظیم می‌کند.
set Link Url(url) List Item آدرس لینک را تنظیم می‌کند.
set List Id(listItem) List Item شناسه لیست را تنظیم می‌کند.
set Nesting Level(nestingLevel) List Item سطح تودرتو بودن آیتم لیست را تنظیم می‌کند.
set Spacing After(spacingAfter) List Item فاصله بعد از عنصر را بر حسب نقطه تنظیم می‌کند.
set Spacing Before(spacingBefore) List Item فاصله قبل از عنصر را بر حسب نقطه تنظیم می‌کند.
set Text(text) void محتوای آیتم لیست را به صورت متن تنظیم می‌کند.
set Text Alignment(textAlignment) List Item ترازبندی متن را تنظیم می‌کند.

Named Range

روش‌ها

روش نوع بازگشتی شرح مختصر
get Id() String شناسه (ID) این Named Range را دریافت می‌کند.
get Name() String نام این Named Range را دریافت می‌کند.
get Range() Range محدوده عناصر مرتبط با این Named Range را دریافت می‌کند.
remove() void این Named Range از برگه حذف می‌کند.

Page Break

روش‌ها

روش نوع بازگشتی شرح مختصر
copy() Page Break یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
get Attributes() Object ویژگی‌های عنصر را بازیابی می‌کند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
is At Document End() Boolean تعیین می‌کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
remove From Parent() Page Break |null عنصر را از والدش حذف می‌کند.
set Attributes(attributes) Page Break ویژگی‌های عنصر را تنظیم می‌کند.

Paragraph

روش‌ها

روش نوع بازگشتی شرح مختصر
add Positioned Image(image) Positioned Image یک Positioned Image جدید از بلوک تصویر مشخص‌شده ایجاد و درج می‌کند.
append Horizontal Rule() Horizontal Rule یک Horizontal Rule جدید ایجاد و اضافه می‌کند.
append Inline Image(image) Inline Image یک Inline Image جدید از بلوک تصویر مشخص‌شده ایجاد و اضافه می‌کند.
append Inline Image(image) Inline Image Inline Image داده شده را اضافه می‌کند.
append Page Break() Page Break یک Page Break جدید ایجاد و اضافه می‌کند.
append Page Break(pageBreak) Page Break Page Break داده شده را اضافه می‌کند.
append Text(text) Text یک عنصر Text جدید با محتوای مشخص شده ایجاد و اضافه می‌کند.
append Text(text) Text عنصر Text داده شده را اضافه می‌کند.
clear() Paragraph محتویات عنصر را پاک می‌کند.
copy() Paragraph یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
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 Alignment() Horizontal Alignment |null Horizontal Alignment بازیابی می‌کند.
get Attributes() Object ویژگی‌های عنصر را بازیابی می‌کند.
get Child(childIndex) Element عنصر فرزند را در اندیس فرزند مشخص شده بازیابی می‌کند.
get Child Index(child) Integer اندیس فرزند را برای عنصر فرزند مشخص شده بازیابی می‌کند.
get Heading() Paragraph Heading |null Paragraph Heading بازیابی می‌کند.
get Indent End() Number|null تورفتگی انتهایی را بر حسب نقطه بازیابی می‌کند.
get Indent First Line() Number|null میزان تورفتگی خط اول را بر حسب نقطه برمی‌گرداند.
get Indent Start() Number|null تورفتگی شروع را بازیابی می‌کند.
get Line Spacing() Number|null فاصله بین خطوط را بر حسب نقطه بازیابی می‌کند.
get Link Url() String|null آدرس لینک را بازیابی می‌کند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Num Children() Integer تعداد فرزندان را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Positioned Image(id) Positioned Image یک Positioned Image بر اساس شناسه تصویر دریافت می‌کند.
get Positioned Images() Positioned Image[] تمام اشیاء Positioned Image که به پاراگراف متصل شده‌اند، دریافت می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Spacing After() Number|null فاصله بعد از عنصر را بر حسب نقطه بازیابی می‌کند.
get Spacing Before() Number|null فاصله قبل از عنصر را بر حسب نقطه بازیابی می‌کند.
get Text() String محتوای عنصر را به صورت یک رشته متنی بازیابی می‌کند.
get Text Alignment() Text Alignment |null ترازبندی متن را دریافت می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
insert Horizontal Rule(childIndex) Horizontal Rule یک Horizontal Rule در اندیس مشخص شده ایجاد و درج می‌کند.
insert Inline Image(childIndex, image) Inline Image یک Inline Image جدید را از بلوک تصویر مشخص‌شده، در اندیس مشخص‌شده ایجاد و درج می‌کند.
insert Inline Image(childIndex, image) Inline Image Inline Image داده شده را در اندیس مشخص شده درج می‌کند.
insert Page Break(childIndex) Page Break یک Page Break جدید در اندیس مشخص شده ایجاد و درج می‌کند.
insert Page Break(childIndex, pageBreak) Page Break Page Break داده شده را در فهرست مشخص شده وارد می‌کند.
insert Text(childIndex, text) Text یک عنصر متنی جدید را در اندیس مشخص شده ایجاد و درج می‌کند.
insert Text(childIndex, text) Text عنصر Text داده شده را در اندیس مشخص شده، با محتوای متن مشخص شده، درج می‌کند.
is At Document End() Boolean تعیین می‌کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
is Left To Right() Boolean|null تنظیمات چپ به راست را بازیابی می‌کند.
merge() Paragraph |null عنصر را با عنصر خواهر یا برادر قبلی از همان نوع ادغام می‌کند.
remove Child(child) Paragraph عنصر فرزند مشخص شده را حذف می‌کند.
remove From Parent() Paragraph |null عنصر را از والدش حذف می‌کند.
remove Positioned Image(id) Boolean یک Positioned Image بر اساس شناسه تصویر حذف می‌کند.
replace Text(searchPattern, replacement) Element با استفاده از عبارات منظم، تمام موارد تکرار یک الگوی متنی مشخص را با یک رشته جایگزین مشخص جایگزین می‌کند.
set Alignment(alignment) Paragraph Horizontal Alignment را تنظیم می‌کند.
set Attributes(attributes) Paragraph ویژگی‌های عنصر را تنظیم می‌کند.
set Heading(heading) Paragraph Paragraph Heading تنظیم می‌کند.
set Indent End(indentEnd) Paragraph تورفتگی انتهایی را بر حسب نقطه تنظیم می‌کند.
set Indent First Line(indentFirstLine) Paragraph میزان تورفتگی خط اول را بر حسب نقطه تنظیم می‌کند.
set Indent Start(indentStart) Paragraph تورفتگی شروع را بر حسب نقطه تنظیم می‌کند.
set Left To Right(leftToRight) Paragraph تنظیم چپ به راست را تنظیم می‌کند.
set Line Spacing(multiplier) Paragraph فاصله خطوط را به عنوان کمیتی که تعداد خطوط مورد استفاده برای فاصله‌گذاری را نشان می‌دهد، تنظیم می‌کند.
set Link Url(url) Paragraph آدرس لینک را تنظیم می‌کند.
set Spacing After(spacingAfter) Paragraph فاصله بعد از عنصر را بر حسب نقطه تنظیم می‌کند.
set Spacing Before(spacingBefore) Paragraph فاصله قبل از عنصر را بر حسب نقطه تنظیم می‌کند.
set Text(text) void محتوای پاراگراف را به عنوان متن تنظیم می‌کند.
set Text Alignment(textAlignment) Paragraph ترازبندی متن را تنظیم می‌کند.

Paragraph Heading

خواص

ملک نوع توضیحات
NORMAL Enum گزینه عنوان برای متن معمولی.
HEADING1 Enum بالاترین گزینه عنوان.
HEADING2 Enum گزینه عنوان دوم.
HEADING3 Enum گزینه عنوان سوم
HEADING4 Enum گزینه عنوان چهارم.
HEADING5 Enum گزینه عنوان پنجم.
HEADING6 Enum پایین‌ترین گزینه عنوان.
TITLE Enum گزینه عنوان.
SUBTITLE Enum گزینه عنوان زیرنویس.

Person

روش‌ها

روش نوع بازگشتی شرح مختصر
copy() Person یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
get Attributes() Object ویژگی‌های عنصر را بازیابی می‌کند.
get Email() String آدرس ایمیل شخص را برمی‌گرداند.
get Name() String|null در صورت تنظیم، نام نمایشی شخص را برمی‌گرداند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
is At Document End() Boolean تعیین می‌کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
merge() Person |null عنصر را با عنصر خواهر یا برادر قبلی از همان نوع ادغام می‌کند.
remove From Parent() Person |null عنصر را از والدش حذف می‌کند.
set Attributes(attributes) Person ویژگی‌های عنصر را تنظیم می‌کند.

Position

روش‌ها

روش نوع بازگشتی شرح مختصر
get Element() Element عنصری را که شامل این Position است، برمی‌گرداند.
get Offset() Integer مکان نسبی این Position را درون عنصری که شامل آن است، برمی‌گرداند.
get Surrounding Text() Text یک عنصر Text مصنوعی ایجاد می‌کند که متن و قالب‌بندی Paragraph یا List Item را که شامل Position است، به طور مستقیم یا از طریق زنجیره‌ای از عناصر فرزند، نشان می‌دهد.
get Surrounding Text Offset() Integer مقدار انحراف این Position (Position) را درون عنصر Text ) که توسط get Surrounding Text() برگردانده می‌شود، برمی‌گرداند.
insert Bookmark() Bookmark یک Bookmark جدید ایجاد و در این Position درج می‌کند.
insert Inline Image(image) Inline Image |null یک Inline Image جدید را در این Position از حباب تصویر مشخص‌شده ایجاد و درج می‌کند.
insert Text(text) Text |null متن مشخص شده را در این Position وارد می‌کند.

Positioned Image

روش‌ها

روش نوع بازگشتی شرح مختصر
get As(contentType) Blob داده‌های درون این شیء را به صورت یک blob تبدیل‌شده به نوع محتوای مشخص‌شده، برمی‌گرداند.
get Blob() Blob داده‌های درون این شیء را به صورت یک blob برمی‌گرداند.
get Height() Integer ارتفاع تصویر را بر حسب پیکسل بازیابی می‌کند.
get Id() String شناسه تصویر را دریافت می‌کند.
get Layout() Positioned Layout یک مقدار شمارشی (enum) دریافت می‌کند که نشان دهنده نحوه چیدمان تصویر است.
get Left Offset() Number میزان انحراف تصویر از سمت چپ پاراگراف را بر حسب نقطه برمی‌گرداند.
get Paragraph() Paragraph Paragraph را که تصویر به آن متصل شده است، دریافت می‌کند.
get Top Offset() Number میزان انحراف تصویر از بالای پاراگراف را بر حسب نقطه برمی‌گرداند.
get Width() Integer عرض تصویر را بر حسب پیکسل بازیابی می‌کند.
set Height(height) Positioned Image ارتفاع تصویر را بر حسب پیکسل تنظیم می‌کند.
set Layout(layout) Positioned Image تعریف نحوه چیدمان تصویر را تعیین می‌کند.
set Left Offset(offset) Positioned Image میزان انحراف تصویر از سمت چپ پاراگراف را بر حسب نقطه تنظیم می‌کند.
set Top Offset(offset) Positioned Image میزان انحراف تصویر از بالای پاراگراف را بر حسب نقطه تنظیم می‌کند.
set Width(width) Positioned Image عرض تصویر را بر حسب پیکسل تنظیم می‌کند.

Positioned Layout

خواص

ملک نوع توضیحات
ABOVE_TEXT Enum تصویر در بالای متن قرار می‌گیرد.
BREAK_BOTH Enum تصویر، متن را در سمت چپ و راست می‌شکند.
BREAK_LEFT Enum تصویر، متن سمت چپ را می‌شکند.
BREAK_RIGHT Enum تصویر، متن سمت راست را می‌شکند.
WRAP_TEXT Enum تصویر توسط متن احاطه شده است.

Range

روش‌ها

روش نوع بازگشتی شرح مختصر
get Range Elements() Range Element[] تمام عناصر موجود در این Range ، شامل هر عنصر Text جزئی (برای مثال، در مورد انتخابی که فقط بخشی از یک عنصر Text را شامل می‌شود) را برمی‌گرداند.

Range Builder

روش‌ها

روش نوع بازگشتی شرح مختصر
add Element(element) Range Builder یک Element کامل را به این Range Builder اضافه می‌کند.
add Element(textElement, startOffset, endOffsetInclusive) Range Builder یک عنصر Text جزئی به این Range Builder اضافه می‌کند.
add Elements Between(startElement, endElementInclusive) Range Builder دو عنصر کامل و تمام عناصر بین آنها را به این Range Builder اضافه می‌کند.
add Elements Between(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) Range Builder دو عنصر Text ناقص و تمام عناصر بین آنها را به Range Builder اضافه می‌کند.
add Range(range) Range Builder محتویات یک Range دیگر را به این Range Builder اضافه می‌کند.
build() Range یک Range از تنظیمات اعمال شده به سازنده می‌سازد.
get Range Elements() Range Element[] تمام عناصر موجود در این Range ، شامل هر عنصر Text جزئی (برای مثال، در مورد انتخابی که فقط بخشی از یک عنصر Text را شامل می‌شود) را برمی‌گرداند.

Range Element

روش‌ها

روش نوع بازگشتی شرح مختصر
get Element() Element Element را که با این Range Element مطابقت دارد، برمی‌گرداند.
get End Offset Inclusive() Integer موقعیت انتهای یک محدوده جزئی را در عنصر محدوده دریافت می‌کند.
get Start Offset() Integer موقعیت شروع یک محدوده جزئی را در عنصر محدوده دریافت می‌کند.
is Partial() Boolean تعیین می‌کند که آیا این عنصر محدوده، کل عنصر را پوشش می‌دهد یا بخشی از کاراکترهای عنصر را انتخاب می‌کند.

روش‌ها

روش نوع بازگشتی شرح مختصر
copy() Rich Link یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
get Attributes() Object ویژگی‌های عنصر را بازیابی می‌کند.
get Mime Type() String|null نوع MIME لینک را برمی‌گرداند، که وقتی آیتم، لینکی به یک فایل Drive است، در دسترس است و در غیر این صورت null .
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Title() String عنوان نمایش داده شده لینک را برمی‌گرداند.
get Type() Element Type Element Type را بازیابی می‌کند.
get Url() String آدرس اینترنتی منبع را برمی‌گرداند.
is At Document End() Boolean تعیین می‌کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
merge() Rich Link |null عنصر را با عنصر خواهر یا برادر قبلی از همان نوع ادغام می‌کند.
remove From Parent() Rich Link |null عنصر را از والدش حذف می‌کند.
set Attributes(attributes) Rich Link ویژگی‌های عنصر را تنظیم می‌کند.

Tab

روش‌ها

روش نوع بازگشتی شرح مختصر
as Document Tab() Document Tab محتوای تب را به عنوان یک Document Tab بازیابی می‌کند.
get Child Tabs() Tab[] تب‌های فرزندِ تودرتو درون این تب را بازیابی می‌کند.
get Id() String شناسه (ID) برگه (tab) را بازیابی می‌کند.
get Index() Integer ایندکس مبتنی بر ۰ تب درون والد را بازیابی می‌کند.
get Title() String عنوان برگه را بازیابی می‌کند.
get Type() Tab Type نوع تب را بازیابی می‌کند.

Tab Type

خواص

ملک نوع توضیحات
DOCUMENT_TAB Enum نوع مربوط به Document Tab .

Table

روش‌ها

روش نوع بازگشتی شرح مختصر
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 |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 Border Color() String|null رنگ حاشیه را بازیابی می‌کند.
get Border Width() Number|null عرض حاشیه را بر حسب نقطه برمی‌گرداند.
get Cell(rowIndex, cellIndex) Table Cell |null Table Cell در ردیف و شاخص‌های سلول مشخص شده بازیابی می‌کند.
get Child(childIndex) Element عنصر فرزند را در اندیس فرزند مشخص شده بازیابی می‌کند.
get Child Index(child) Integer اندیس فرزند را برای عنصر فرزند مشخص شده بازیابی می‌کند.
get Column Width(columnIndex) Number|null عرض ستون جدول مشخص شده را بر حسب نقطه برمی‌گرداند.
get Link Url() String|null آدرس لینک را بازیابی می‌کند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Num Children() Integer تعداد فرزندان را بازیابی می‌کند.
get Num Rows() Integer تعداد Table Rows را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Row(rowIndex) Table Row |null Table Row را در اندیس سطر مشخص شده بازیابی می‌کند.
get Text() String محتوای عنصر را به صورت یک رشته متنی بازیابی می‌کند.
get Text Alignment() Text Alignment |null ترازبندی متن را دریافت می‌کند.
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 |null عنصر را از والدش حذف می‌کند.
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 ترازبندی متن را تنظیم می‌کند.

Table Cell

روش‌ها

روش نوع بازگشتی شرح مختصر
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 عرض ستون حاوی سلول فعلی را بر حسب نقطه تنظیم می‌کند.

Table Of Contents

روش‌ها

روش نوع بازگشتی شرح مختصر
clear() Table Of Contents محتویات عنصر را پاک می‌کند.
copy() Table Of Contents یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
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 Child(childIndex) Element عنصر فرزند را در اندیس فرزند مشخص شده بازیابی می‌کند.
get Child Index(child) Integer اندیس فرزند را برای عنصر فرزند مشخص شده بازیابی می‌کند.
get Link Url() String|null آدرس لینک را بازیابی می‌کند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Num Children() Integer تعداد فرزندان را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Text() String محتوای عنصر را به صورت یک رشته متنی بازیابی می‌کند.
get Text Alignment() Text Alignment |null ترازبندی متن را دریافت می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
is At Document End() Boolean تعیین می‌کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
remove From Parent() Table Of Contents |null عنصر را از والدش حذف می‌کند.
replace Text(searchPattern, replacement) Element با استفاده از عبارات منظم، تمام موارد تکرار یک الگوی متنی مشخص را با یک رشته جایگزین مشخص جایگزین می‌کند.
set Attributes(attributes) Table Of Contents ویژگی‌های عنصر را تنظیم می‌کند.
set Link Url(url) Table Of Contents آدرس لینک را تنظیم می‌کند.
set Text Alignment(textAlignment) Table Of Contents ترازبندی متن را تنظیم می‌کند.

Table Row

روش‌ها

روش نوع بازگشتی شرح مختصر
append Table Cell() Table Cell یک Table Cell جدید ایجاد و اضافه می‌کند.
append Table Cell(textContents) Table Cell Table Cell داده شده حاوی متن مشخص شده را اضافه می‌کند.
append Table Cell(tableCell) Table Cell Table Cell داده شده را اضافه می‌کند.
clear() Table Row محتویات عنصر را پاک می‌کند.
copy() Table Row یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
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 Cell(cellIndex) Table Cell |null Table Cell در اندیس سلول مشخص شده بازیابی می‌کند.
get Child(childIndex) Element عنصر فرزند را در اندیس فرزند مشخص شده بازیابی می‌کند.
get Child Index(child) Integer اندیس فرزند را برای عنصر فرزند مشخص شده بازیابی می‌کند.
get Link Url() String|null آدرس لینک را بازیابی می‌کند.
get Minimum Height() Number|null حداقل ارتفاع را بر حسب نقطه برمی‌گرداند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Num Cells() Integer تعداد سلول‌های موجود در ردیف را برمی‌گرداند.
get Num Children() Integer تعداد فرزندان را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Parent Table() Table |null Table حاوی ردیف فعلی را بازیابی می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Text() String محتوای عنصر را به صورت یک رشته متنی بازیابی می‌کند.
get Text Alignment() Text Alignment |null ترازبندی متن را دریافت می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
insert Table Cell(childIndex) Table Cell یک Table Cell جدید را در اندیس مشخص شده ایجاد و درج می‌کند.
insert Table Cell(childIndex, textContents) Table Cell Table Cell داده شده را در فهرست مشخص شده، که حاوی متن داده شده است، درج می‌کند.
insert Table Cell(childIndex, tableCell) Table Cell Table Cell داده شده را در اندیس مشخص شده درج می‌کند.
is At Document End() Boolean تعیین می‌کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
merge() Table Row |null عنصر را با عنصر خواهر یا برادر قبلی از همان نوع ادغام می‌کند.
remove Cell(cellIndex) Table Cell Table Cell در اندیس سلول مشخص شده حذف می‌کند.
remove Child(child) Table Row عنصر فرزند مشخص شده را حذف می‌کند.
remove From Parent() Table Row |null عنصر را از والدش حذف می‌کند.
replace Text(searchPattern, replacement) Element با استفاده از عبارات منظم، تمام موارد تکرار یک الگوی متنی مشخص را با یک رشته جایگزین مشخص جایگزین می‌کند.
set Attributes(attributes) Table Row ویژگی‌های عنصر را تنظیم می‌کند.
set Link Url(url) Table Row آدرس لینک را تنظیم می‌کند.
set Minimum Height(minHeight) Table Row حداقل ارتفاع را بر حسب نقطه تنظیم می‌کند.
set Text Alignment(textAlignment) Table Row ترازبندی متن را تنظیم می‌کند.

Text

روش‌ها

روش نوع بازگشتی شرح مختصر
append Text(text) Text متن مشخص شده را به انتهای این ناحیه متنی اضافه می‌کند.
copy() Text یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
delete Text(startOffset, endOffsetInclusive) Text محدوده‌ای از متن را حذف می‌کند.
edit As Text() Text یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می‌کند.
find Text(searchPattern) Range Element |null با استفاده از عبارات منظم، محتوای عنصر را برای الگوی متنی مشخص شده جستجو می‌کند.
find Text(searchPattern, from) Range Element |null با شروع از یک نتیجه جستجوی داده شده، محتویات عنصر را برای الگوی متنی مشخص شده جستجو می‌کند.
get Attributes() Object ویژگی‌های عنصر را بازیابی می‌کند.
get Attributes(offset) Object ویژگی‌ها را در فاصله‌ی کاراکتری مشخص‌شده بازیابی می‌کند.
get Background Color() String|null تنظیمات رنگ پس‌زمینه را بازیابی می‌کند.
get Background Color(offset) String|null رنگ پس‌زمینه را در فاصله‌ی کاراکتری مشخص‌شده بازیابی می‌کند.
get Font Family() String|null تنظیمات خانواده فونت را بازیابی می‌کند.
get Font Family(offset) String|null خانواده فونت را در فاصله‌ی کاراکتری مشخص شده بازیابی می‌کند.
get Font Size() Number|null تنظیم اندازه فونت را بازیابی می‌کند.
get Font Size(offset) Number|null اندازه فونت را در فاصله کاراکتری مشخص شده بازیابی می‌کند.
get Foreground Color() String|null تنظیمات رنگ پیش‌زمینه را بازیابی می‌کند.
get Foreground Color(offset) String|null رنگ پیش‌زمینه را در فاصله‌ی کاراکتری مشخص‌شده بازیابی می‌کند.
get Link Url() String|null آدرس لینک را بازیابی می‌کند.
get Link Url(offset) String|null آدرس اینترنتی (URL) لینک را در فاصله‌ی کاراکتری مشخص شده بازیابی می‌کند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Text() String محتوای عنصر را به صورت یک رشته متنی بازیابی می‌کند.
get Text Alignment() Text Alignment |null ترازبندی متن را دریافت می‌کند.
get Text Alignment(offset) Text Alignment |null ترازبندی متن را برای یک کاراکتر واحد دریافت می‌کند.
get Text Attribute Indices() Integer[] مجموعه‌ای از اندیس‌های متن را که مربوط به شروع اجرای قالب‌بندی متن متمایز هستند، بازیابی می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
insert Text(offset, text) Text متن مشخص شده را در فاصله‌ی کاراکتری داده شده درج می‌کند.
is At Document End() Boolean تعیین می‌کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
is Bold() Boolean|null تنظیمات پررنگ را بازیابی می‌کند.
is Bold(offset) Boolean|null تنظیمات پررنگ را در فاصله‌ی کاراکتر مشخص‌شده بازیابی می‌کند.
is Italic() Boolean|null تنظیمات ایتالیک را بازیابی می‌کند.
is Italic(offset) Boolean|null تنظیمات ایتالیک را در فاصله‌ی کاراکتری مشخص‌شده بازیابی می‌کند.
is Strikethrough() Boolean|null تنظیمات خط خورده را بازیابی می‌کند.
is Strikethrough(offset) Boolean|null تنظیمات خط‌خوردگی را در فاصله‌ی کاراکتری مشخص‌شده بازیابی می‌کند.
is Underline() Boolean|null تنظیمات زیرخط را بازیابی می‌کند.
is Underline(offset) Boolean|null تنظیمات زیرخط را در فاصله‌ی کاراکتری مشخص‌شده بازیابی می‌کند.
merge() Text |null عنصر را با عنصر خواهر یا برادر قبلی از همان نوع ادغام می‌کند.
remove From Parent() Text |null عنصر را از والدش حذف می‌کند.
replace Text(searchPattern, replacement) Element با استفاده از عبارات منظم، تمام موارد تکرار یک الگوی متنی مشخص را با یک رشته جایگزین مشخص جایگزین می‌کند.
set Attributes(startOffset, endOffsetInclusive, attributes) Text ویژگی‌های مشخص‌شده را به محدوده کاراکتر داده‌شده اعمال می‌کند.
set Attributes(attributes) Text ویژگی‌های عنصر را تنظیم می‌کند.
set Background Color(startOffset, endOffsetInclusive, color) Text رنگ پس‌زمینه را برای محدوده کاراکتر مشخص شده تنظیم می‌کند.
set Background Color(color) Text رنگ پس زمینه را تنظیم می‌کند.
set Bold(bold) Text تنظیمات پررنگ را تنظیم می‌کند.
set Bold(startOffset, endOffsetInclusive, bold) Text تنظیمات پررنگ بودن را برای محدوده کاراکتر مشخص شده تنظیم می‌کند.
set Font Family(startOffset, endOffsetInclusive, fontFamilyName) Text خانواده فونت را برای محدوده کاراکتر مشخص شده تنظیم می‌کند.
set Font Family(fontFamilyName) Text خانواده فونت را تنظیم می‌کند.
set Font Size(startOffset, endOffsetInclusive, size) Text اندازه فونت را برای محدوده کاراکتر مشخص شده تنظیم می‌کند.
set Font Size(size) Text اندازه فونت را تنظیم می‌کند.
set Foreground Color(startOffset, endOffsetInclusive, color) Text رنگ پیش‌زمینه را برای محدوده کاراکتر مشخص شده تنظیم می‌کند.
set Foreground Color(color) Text رنگ پیش‌زمینه را تنظیم می‌کند.
set Italic(italic) Text حالت ایتالیک را تنظیم می‌کند.
set Italic(startOffset, endOffsetInclusive, italic) Text تنظیمات ایتالیک را برای محدوده کاراکتر مشخص شده تنظیم می‌کند.
set Link Url(startOffset, endOffsetInclusive, url) Text آدرس اینترنتی (URL) لینک را برای محدوده کاراکتری مشخص شده تنظیم می‌کند.
set Link Url(url) Text آدرس لینک را تنظیم می‌کند.
set Strikethrough(strikethrough) Text تنظیمات خط خورده را تنظیم می‌کند.
set Strikethrough(startOffset, endOffsetInclusive, strikethrough) Text تنظیمات خط‌خوردگی را برای محدوده کاراکتر مشخص‌شده تنظیم می‌کند.
set Text(text) Text محتوای متن را تنظیم می‌کند.
set Text Alignment(startOffset, endOffsetInclusive, textAlignment) Text ترازبندی متن را برای یک محدوده کاراکتری مشخص تنظیم می‌کند.
set Text Alignment(textAlignment) Text ترازبندی متن را تنظیم می‌کند.
set Underline(underline) Text تنظیمات زیرخط را تنظیم می‌کند.
set Underline(startOffset, endOffsetInclusive, underline) Text تنظیمات زیرخط را برای محدوده کاراکتر مشخص شده تنظیم می‌کند.

Text Alignment

خواص

ملک نوع توضیحات
NORMAL Enum ترازبندی متن معمولی.
SUPERSCRIPT Enum ترازبندی متن بالانویس.
SUBSCRIPT Enum ترازبندی متن زیرنویس.

Unsupported Element

روش‌ها

روش نوع بازگشتی شرح مختصر
copy() Unsupported Element یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
get Attributes() Object ویژگی‌های عنصر را بازیابی می‌کند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
is At Document End() Boolean تعیین می‌کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
merge() Unsupported Element |null عنصر را با عنصر خواهر یا برادر قبلی از همان نوع ادغام می‌کند.
remove From Parent() Unsupported Element |null عنصر را از والدش حذف می‌کند.
set Attributes(attributes) Unsupported Element ویژگی‌های عنصر را تنظیم می‌کند.

Vertical Alignment

خواص

ملک نوع توضیحات
BOTTOM Enum گزینه ترازبندی از پایین.
CENTER Enum گزینه ترازبندی در مرکز.
TOP Enum گزینه ترازبندی از بالا.