این سرویس به اسکریپتها اجازه میدهد تا فایلهای 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 | یک شی که نشان دهنده یک نشانک است. |
ContainerElement | یک عنصر عمومی که ممکن است حاوی عناصر دیگری باشد. |
Date | عنصری که تاریخ قالب بندی شده را نشان می دهد |
Document | یک سند، حاوی یک یا چند شی Tab ، که هر کدام حاوی متن غنی و عناصری مانند جداول و لیست است. |
DocumentApp | سرویس اسناد Documents قابل ویرایش را ایجاد و باز می کند. |
DocumentTab | یک برگه سند، حاوی متن غنی و عناصری مانند جداول و لیست ها. |
Element | یک عنصر عمومی |
ElementType | شمارش تمام انواع عناصر |
Equation | عنصری که بیانگر یک عبارت ریاضی است. |
EquationFunction | عنصری که یک تابع را در یک Equation ریاضی نشان می دهد. |
EquationFunctionArgumentSeparator | عنصری که جداکننده تابع در یک Equation ریاضی را نشان می دهد. |
EquationSymbol | عنصری که نمادی را در یک Equation ریاضی نشان می دهد. |
| شمارشی از فونت های پشتیبانی شده |
FooterSection | عنصری که بخش پاورقی را نشان می دهد. |
Footnote | عنصری که نشان دهنده پاورقی است. |
FootnoteSection | عنصری که بخش پاورقی را نشان می دهد. |
GlyphType | شمارشی از انواع گلیف پشتیبانی شده. |
HeaderSection | عنصری که بخش سرصفحه را نشان می دهد. |
HorizontalAlignment | شمارشی از انواع تراز افقی پشتیبانی شده. |
HorizontalRule | عنصری که یک قانون افقی را نشان می دهد. |
InlineDrawing | عنصری که یک طراحی جاسازی شده را نشان می دهد. |
InlineImage | عنصری که یک تصویر جاسازی شده را نشان می دهد. |
ListItem | عنصری که یک آیتم لیست را نشان می دهد. |
NamedRange | Range ای که دارای نام و شناسه است تا امکان بازیابی بعدی را فراهم کند. |
PageBreak | عنصری که نمایانگر شکست صفحه است. |
Paragraph | عنصری که یک پاراگراف را نشان می دهد. |
ParagraphHeading | شمارشی از عناوین پاراگراف استاندارد. |
Person | عنصری که نشان دهنده پیوند به یک شخص است. |
Position | ارجاع به مکانی در برگه سند، نسبت به یک عنصر خاص. |
PositionedImage | تصویر موقعیت ثابت لنگر به یک Paragraph . |
PositionedLayout | شمارشی که نحوه چیدمان PositionedImage در رابطه با متن اطراف مشخص می کند. |
Range | طیف وسیعی از عناصر در یک سند. |
RangeBuilder | سازنده ای که برای ساختن اشیاء Range از عناصر سند استفاده می شود. |
RangeElement | یک لفاف در اطراف یک Element با شروع و پایان ممکن آفست. |
RichLink | عنصری که پیوندی به یک منبع Google را نشان می دهد، مانند یک فایل Drive یا یک ویدیوی YouTube. |
Tab | یک برگه در سند Google Docs. |
TabType | شمارش تمام انواع برگه ها. |
Table | عنصری که یک جدول را نشان می دهد. |
TableCell | عنصری که نشان دهنده یک سلول جدول است. |
TableOfContents | عنصری که حاوی فهرست مطالب است. |
TableRow | عنصری که یک ردیف جدول را نشان می دهد. |
Text | عنصری که یک منطقه متن غنی را نشان می دهد. |
TextAlignment | شمارشی از انواع ترازبندی متن. |
UnsupportedElement | عنصری که منطقه ای را نشان می دهد که ناشناخته است یا نمی تواند تحت تأثیر یک اسکریپت قرار گیرد، مانند شماره صفحه. |
VerticalAlignment | شمارشی از انواع تراز عمودی پشتیبانی شده. |
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 | نوع عنوان، برای عناصر پاراگراف (به عنوان مثال، DocumentApp.ParagraphHeading.HEADING1 ). |
HEIGHT | Enum | تنظیم ارتفاع، برای عناصر تصویر. |
HORIZONTAL_ALIGNMENT | Enum | تراز افقی، برای عناصر پاراگراف (به عنوان مثال، DocumentApp.HorizontalAlignment.CENTER ). |
INDENT_END | Enum | تنظیم تورفتگی انتهایی در نقاط، برای عناصر پاراگراف. |
INDENT_FIRST_LINE | Enum | تنظیم تورفتگی خط اول در نقاط، برای عناصر پاراگراف. |
INDENT_START | Enum | تنظیم تورفتگی شروع در نقاط، برای عناصر پاراگراف. |
ITALIC | Enum | تنظیم سبک فونت، برای متن غنی. |
GLYPH_TYPE | Enum | نوع علامت، برای عناصر آیتم فهرست. |
LEFT_TO_RIGHT | Enum | تنظیم جهت متن، برای متن غنی. |
LINE_SPACING | Enum | تنظیم فاصله خطوط به عنوان ضریب، برای عناصر پاراگراف. |
LINK_URL | Enum | URL پیوند، برای متن غنی. |
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_LEFT | Enum | تنظیم لایه سمت چپ در نقاط، برای عناصر سلول جدول. |
PADDING_RIGHT | Enum | تنظیم بالشتک مناسب در نقاط، برای عناصر سلول جدول. |
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
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
appendHorizontalRule() | HorizontalRule | یک HorizontalRule جدید ایجاد و اضافه می کند. |
appendImage(image) | InlineImage | یک InlineImage جدید از حباب تصویر مشخص شده ایجاد و اضافه می کند. |
appendImage(image) | InlineImage | InlineImage داده شده را اضافه می کند. |
appendListItem(listItem) | ListItem | ListItem داده شده را اضافه می کند. |
appendListItem(text) | ListItem | یک ListItem جدید حاوی محتوای متن مشخص شده ایجاد و اضافه می کند. |
appendPageBreak() | PageBreak | یک PageBreak جدید ایجاد و اضافه می کند. |
appendPageBreak(pageBreak) | PageBreak | PageBreak داده شده را اضافه می کند. |
appendParagraph(paragraph) | Paragraph | Paragraph داده شده را ضمیمه می کند. |
appendParagraph(text) | Paragraph | یک Paragraph جدید حاوی محتوای متن مشخص شده ایجاد و اضافه می کند. |
appendTable() | Table | یک Table جدید ایجاد و اضافه می کند. |
appendTable(cells) | Table | یک Table جدید حاوی TableCell برای هر مقدار رشته مشخص شده اضافه می کند. |
appendTable(table) | Table | Table داده شده را ضمیمه می کند. |
clear() | Body | محتویات عنصر را پاک می کند. |
copy() | Body | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
editAsText() | Text | یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می کند. |
findElement(elementType) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند. |
findElement(elementType, from) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند، که از RangeElement مشخص شده شروع می شود. |
findText(searchPattern) | RangeElement | با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند. |
findText(searchPattern, from) | RangeElement | محتویات عنصر را برای الگوی متن مشخص شده، از یک نتیجه جستجوی معین شروع می کند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getChild(childIndex) | Element | عنصر فرزند را در نمایه فرزند مشخص شده بازیابی می کند. |
getChildIndex(child) | Integer | شاخص فرزند را برای عنصر فرزند مشخص شده بازیابی می کند. |
getHeadingAttributes(paragraphHeading) | Object | مجموعه ای از ویژگی ها را برای ParagraphHeading ارائه شده بازیابی می کند. |
getImages() | InlineImage[] | همه InlineImages موجود در بخش را بازیابی می کند. |
getListItems() | ListItem[] | همه ListItems موجود در بخش را بازیابی می کند. |
getMarginBottom() | Number | حاشیه پایین را به صورت امتیاز بازیابی می کند. |
getMarginLeft() | Number | حاشیه سمت چپ را بر حسب امتیاز بازیابی می کند. |
getMarginRight() | Number | حاشیه سمت راست را بازیابی می کند. |
getMarginTop() | Number | حاشیه بالایی را بازیابی می کند. |
getNumChildren() | Integer | تعداد فرزندان را بازیابی می کند. |
getPageHeight() | Number | ارتفاع صفحه را بر حسب امتیاز بازیابی می کند. |
getPageWidth() | Number | عرض صفحه را بر حسب نقطه بازیابی می کند. |
getParagraphs() | Paragraph[] | تمام Paragraphs موجود در بخش (از جمله ListItems ) را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getTables() | Table[] | تمام Tables موجود در بخش را بازیابی می کند. |
getText() | String | محتویات عنصر را به عنوان یک رشته متنی بازیابی می کند. |
getTextAlignment() | TextAlignment | تراز متن را دریافت می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
insertHorizontalRule(childIndex) | HorizontalRule | یک HorizontalRule جدید در نمایه مشخص شده ایجاد و درج می کند. |
insertImage(childIndex, image) | InlineImage | یک InlineImage از حباب تصویر مشخص شده، در نمایه مشخص شده ایجاد و درج می کند. |
insertImage(childIndex, image) | InlineImage | InlineImage داده شده را در نمایه مشخص شده درج می کند. |
insertListItem(childIndex, listItem) | ListItem | ListItem داده شده را در نمایه مشخص شده درج می کند. |
insertListItem(childIndex, text) | ListItem | یک ListItem جدید را در نمایه مشخص شده ایجاد و درج می کند که حاوی محتوای متن مشخص شده است. |
insertPageBreak(childIndex) | PageBreak | یک PageBreak جدید در ایندکس مشخص شده ایجاد و درج می کند. |
insertPageBreak(childIndex, pageBreak) | PageBreak | PageBreak داده شده را در ایندکس مشخص شده درج می کند. |
insertParagraph(childIndex, paragraph) | Paragraph | Paragraph داده شده را در نمایه مشخص شده درج می کند. |
insertParagraph(childIndex, text) | Paragraph | یک Paragraph جدید را در نمایه مشخص شده ایجاد و درج می کند که حاوی محتوای متن مشخص شده است. |
insertTable(childIndex) | Table | یک Table جدید در نمایه مشخص شده ایجاد و درج می کند. |
insertTable(childIndex, cells) | Table | یک Table جدید حاوی سلول های مشخص شده را در نمایه مشخص شده ایجاد و درج می کند. |
insertTable(childIndex, table) | Table | Table داده شده را در شاخص مشخص شده درج می کند. |
removeChild(child) | Body | عنصر فرزند مشخص شده را حذف می کند. |
replaceText(searchPattern, replacement) | Element | با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین میکند. |
setAttributes(attributes) | Body | ویژگی های عنصر را تنظیم می کند. |
setHeadingAttributes(paragraphHeading, attributes) | Body | ویژگی ها را برای ParagraphHeading ارائه شده تنظیم می کند. |
setMarginBottom(marginBottom) | Body | حاشیه پایین را بر حسب امتیاز تنظیم می کند. |
setMarginLeft(marginLeft) | Body | حاشیه سمت چپ را بر حسب امتیاز تنظیم می کند. |
setMarginRight(marginRight) | Body | حاشیه سمت راست را بر حسب امتیاز تنظیم می کند. |
setMarginTop(marginTop) | Body | حاشیه بالایی را تنظیم می کند. |
setPageHeight(pageHeight) | Body | ارتفاع صفحه را بر حسب نقطه تنظیم می کند. |
setPageWidth(pageWidth) | Body | عرض صفحه را بر حسب نقطه تنظیم می کند. |
setText(text) | Body | محتویات را به صورت متن ساده تنظیم می کند. |
setTextAlignment(textAlignment) | Body | تراز متن را تنظیم می کند. |
Bookmark
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
getId() | String | شناسه Bookmark را دریافت می کند. |
getPosition() | Position | Position Bookmark را در DocumentTab دریافت می کند. |
remove() | void | Bookmark حذف می کند. |
ContainerElement
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
asBody() | Body | عنصر فعلی را به عنوان Body برمیگرداند. |
asEquation() | Equation | عنصر جاری را به صورت Equation برمیگرداند. |
asFooterSection() | FooterSection | عنصر فعلی را به صورت FooterSection برمیگرداند. |
asFootnoteSection() | FootnoteSection | عنصر فعلی را به عنوان FootnoteSection برمی گرداند. |
asHeaderSection() | HeaderSection | عنصر فعلی را به عنوان HeaderSection برمیگرداند. |
asListItem() | ListItem | عنصر فعلی را به عنوان ListItem برمی گرداند. |
asParagraph() | Paragraph | عنصر فعلی را به عنوان یک Paragraph برمی گرداند. |
asTable() | Table | عنصر فعلی را به صورت Table برمی گرداند. |
asTableCell() | TableCell | عنصر فعلی را به عنوان TableCell برمیگرداند. |
asTableOfContents() | TableOfContents | عنصر فعلی را به عنوان TableOfContents برمی گرداند. |
asTableRow() | TableRow | عنصر فعلی را به عنوان TableRow برمیگرداند. |
clear() | ContainerElement | محتویات عنصر را پاک می کند. |
copy() | ContainerElement | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
editAsText() | Text | یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می کند. |
findElement(elementType) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند. |
findElement(elementType, from) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند، که از RangeElement مشخص شده شروع می شود. |
findText(searchPattern) | RangeElement | با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند. |
findText(searchPattern, from) | RangeElement | محتویات عنصر را برای الگوی متن مشخص شده، از یک نتیجه جستجوی معین شروع می کند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getChild(childIndex) | Element | عنصر فرزند را در نمایه فرزند مشخص شده بازیابی می کند. |
getChildIndex(child) | Integer | شاخص فرزند را برای عنصر فرزند مشخص شده بازیابی می کند. |
getLinkUrl() | String | آدرس لینک را بازیابی می کند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getNumChildren() | Integer | تعداد فرزندان را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getText() | String | محتویات عنصر را به عنوان یک رشته متنی بازیابی می کند. |
getTextAlignment() | TextAlignment | تراز متن را دریافت می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
merge() | ContainerElement | عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند. |
removeFromParent() | ContainerElement | عنصر را از والد خود حذف می کند. |
replaceText(searchPattern, replacement) | Element | با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین میکند. |
setAttributes(attributes) | ContainerElement | ویژگی های عنصر را تنظیم می کند. |
setLinkUrl(url) | ContainerElement | آدرس لینک را تنظیم می کند. |
setTextAlignment(textAlignment) | ContainerElement | تراز متن را تنظیم می کند. |
Date
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
copy() | Date | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getDisplayText() | String | مقدار نمایش داده شده در سند را برمیگرداند. |
getLocale() | String | محلی تاریخ استفاده شده برای مقدار نمایش را برمی گرداند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getTimestamp() | Date | مهر زمانی مرتبط با تاریخ را برمیگرداند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
merge() | Date | عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند. |
removeFromParent() | Date | عنصر را از والد خود حذف می کند. |
setAttributes(attributes) | Date | ویژگی های عنصر را تنظیم می کند. |
Document
روشهایی در کلاس Document که مستقیماً به محتوای متن دسترسی پیدا میکنند و آنها را تغییر میدهند، بر روی برگه فعال (در اسکریپتهای متصل به یک سند خاص) یا تب اول (اگر یک برگه فعال در دسترس نباشد) عمل میکنند. اسکریپت های متکی به این روش ها (مانند Document.getBody()
) می توانند برای پشتیبانی از برگه ها به یکی از موارد زیر به روز شوند:
- از برگه اول استفاده کنید:
Document.getTabs()[0].asDocumentTab().getBody()
- از همه برگه ها استفاده کنید: با استفاده از
Document.getTabs()
وTab.getChildTabs()
درخت برگه ها را طی کنید. برای هر برگه در درخت،Tab.asDocumentTab().getBody()
را فراخوانی کنید. - از برگه انتخاب شده استفاده کنید:
Document.getTabs()[Document.getActiveTab().getId()].asDocumentTab().getBody()
- توجه: اگر برگه فعال توسط اسکریپت با استفاده از
Document.setActiveTab(tabId)
تنظیم نشده باشد، خطا می دهد. - از یک برگه خاص استفاده کنید:
Document.getTab(TAB_ID).asDocumentTab().getBody()
برای اطلاعات بیشتر در مورد ویژگی برگه ها، به کار با برگه ها مراجعه کنید.
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
addBookmark(position) | Bookmark | یک Bookmark در Position داده شده به برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، به برگه فعال اضافه می کند. |
addEditor(emailAddress) | Document | کاربر داده شده را به لیست ویرایشگرهای Document اضافه می کند. |
addEditor(user) | Document | کاربر داده شده را به لیست ویرایشگرهای Document اضافه می کند. |
addEditors(emailAddresses) | Document | آرایه داده شده از کاربران را به لیست ویرایشگرهای Document اضافه می کند. |
addFooter() | FooterSection | یک بخش پاورقی، اگر وجود نداشته باشد، به اولین برگه یا برای اسکریپت هایی که به یک سند متصل هستند، به برگه فعال اضافه می کند. |
addHeader() | HeaderSection | یک بخش سرصفحه، اگر وجود نداشته باشد، به اولین تب یا برای اسکریپت هایی که به یک سند متصل هستند، به برگه فعال اضافه می کند. |
addNamedRange(name, range) | NamedRange | NamedRange را اضافه میکند، که Range است که دارای نام و شناسهای است که برای بازیابی بعدی، در برگه اول یا برای اسکریپتهایی که به یک سند متصل شدهاند ، در برگه فعال استفاده میکند. |
addViewer(emailAddress) | Document | کاربر داده شده را به لیست بینندگان Document اضافه می کند. |
addViewer(user) | Document | کاربر داده شده را به لیست بینندگان Document اضافه می کند. |
addViewers(emailAddresses) | Document | آرایه داده شده از کاربران را به لیست بینندگان Document اضافه می کند. |
getActiveTab() | Tab | Tab فعال فعلی کاربر را در سند دریافت می کند. |
getAs(contentType) | Blob | محتویات Document فعلی را به عنوان یک حباب از نوع مشخص شده بازیابی می کند. |
getBlob() | Blob | محتویات Document فعلی را به صورت لکه ای بازیابی می کند. |
getBody() | Body | Body اولین برگه یا برای اسکریپت هایی که به یک سند متصل هستند، DocumentBodySection برگه فعال را بازیابی می کند. |
getBookmark(id) | Bookmark | Bookmark با شناسه داده شده در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند. |
getBookmarks() | Bookmark[] | همه اشیاء Bookmark در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند. |
getCursor() | Position | نشانگر کاربر را در برگه فعال دریافت می کند. |
getEditors() | User[] | لیست ویرایشگران این Document را دریافت می کند. |
getFooter() | FooterSection | بخش پاورقی برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، بخش پاورقی برگه فعال را بازیابی می کند. |
getFootnotes() | Footnote[] | تمام عناصر Footnote در بدنه اولین برگه یا برای اسکریپت هایی که به یک سند متصل هستند، بدنه برگه فعال را بازیابی می کند. |
getHeader() | HeaderSection | بخش هدر برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، بخش سربرگ برگه فعال را بازیابی می کند. |
getId() | String | شناسه منحصر به فرد سند را بازیابی می کند. |
getLanguage() | String | کد زبان سند را دریافت می کند. |
getName() | String | عنوان سند را بازیابی می کند. |
getNamedRangeById(id) | NamedRange | NamedRange با شناسه داده شده در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند. |
getNamedRanges() | NamedRange[] | تمام اشیاء NamedRange را در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند. |
getNamedRanges(name) | NamedRange[] | تمام اشیاء NamedRange را با نام داده شده در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند. |
getSelection() | Range | انتخاب کاربر را در برگه فعال دریافت می کند. |
getSupportedLanguageCodes() | String[] | همه کدهای زبانی که در فایلهای Google Docs پشتیبانی میشوند را دریافت میکند. |
getTab(tabId) | Tab | Tab با شناسه مشخص شده دریافت می کند. |
getTabs() | Tab[] | همه Tab تودرتو نشده را که بخشی از سند هستند دریافت می کند. |
getUrl() | String | URL را برای دسترسی به سند فعلی بازیابی می کند. |
getViewers() | User[] | لیست بینندگان و نظر دهندگان را برای این Document دریافت می کند. |
newPosition(element, offset) | Position | یک Position جدید ایجاد می کند، که اشاره ای به یک مکان در برگه، نسبت به یک عنصر خاص در برگه اول یا، برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال است. |
newRange() | RangeBuilder | سازنده ای ایجاد می کند که برای ساخت اشیاء Range از عناصر برگه در اولین تب یا برای اسکریپت هایی که به یک سند متصل هستند، از برگه فعال استفاده می شود. |
removeEditor(emailAddress) | Document | کاربر داده شده را از لیست ویرایشگرهای Document حذف می کند. |
removeEditor(user) | Document | کاربر داده شده را از لیست ویرایشگرهای Document حذف می کند. |
removeViewer(emailAddress) | Document | کاربر داده شده را از لیست بینندگان و نظردهندگان Document حذف می کند. |
removeViewer(user) | Document | کاربر داده شده را از لیست بینندگان و نظردهندگان Document حذف می کند. |
saveAndClose() | void | Document فعلی را ذخیره می کند. |
setActiveTab(tabId) | void | Tab انتخاب شده کاربر در سند فعلی را به برگه با شناسه مشخص شده تنظیم می کند. |
setCursor(position) | Document | مکان نما کاربر را با یک Position تعیین می کند. |
setLanguage(languageCode) | Document | کد زبان سند را تنظیم می کند. |
setName(name) | Document | عنوان سند را تنظیم می کند. |
setSelection(range) | Document | انتخاب کاربر را در برگه فعال با توجه به Range تنظیم می کند. |
DocumentApp
خواص
اموال | تایپ کنید | توضیحات |
---|---|---|
Attribute | Attribute | شمارش Attribute |
ElementType | ElementType | شمارش ElementType |
FontFamily |
| شمارش . |
GlyphType | GlyphType | شمارش GlyphType . |
HorizontalAlignment | HorizontalAlignment | شمارش HorizontalAlignment . |
ParagraphHeading | ParagraphHeading | شمارش سرفصل ParagraphHeading . |
PositionedLayout | PositionedLayout | شمارش PositionedLayout . |
TextAlignment | TextAlignment | شمارش TextAlignment . |
VerticalAlignment | VerticalAlignment | شمارش VerticalAlignment . |
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
create(name) | Document | یک سند جدید ایجاد و برمی گرداند. |
getActiveDocument() | Document | سندی را که اسکریپت به آن محدود شده است برمیگرداند. |
getUi() | Ui | نمونهای از محیط رابط کاربری سند را برمیگرداند که به اسکریپت اجازه میدهد ویژگیهایی مانند منوها، گفتگوها و نوارهای جانبی را اضافه کند. |
openById(id) | Document | سند را با شناسه مشخص شده برمی گرداند. |
openByUrl(url) | Document | سند را با URL مشخص شده باز می کند و برمی گرداند. |
DocumentTab
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
addBookmark(position) | Bookmark | یک Bookmark در Position داده شده اضافه می کند. |
addFooter() | FooterSection | یک بخش پاورقی برگه را اضافه می کند، اگر وجود نداشته باشد. |
addHeader() | HeaderSection | یک بخش سربرگ برگه را اضافه می کند، اگر وجود نداشته باشد. |
addNamedRange(name, range) | NamedRange | NamedRange اضافه میکند، که Range است که دارای نام و شناسه برای بازیابی بعدی است. |
getBody() | Body | Body برگه را بازیابی می کند. |
getBookmark(id) | Bookmark | Bookmark با شناسه داده شده دریافت می کند. |
getBookmarks() | Bookmark[] | همه اشیاء Bookmark را در برگه دریافت می کند. |
getFooter() | FooterSection | بخش پاورقی برگه را در صورت وجود بازیابی می کند. |
getFootnotes() | Footnote[] | همه عناصر Footnote را در بدنه برگه بازیابی می کند. |
getHeader() | HeaderSection | بخش سربرگ برگه را در صورت وجود بازیابی می کند. |
getNamedRangeById(id) | NamedRange | NamedRange با شناسه داده شده دریافت می کند. |
getNamedRanges() | NamedRange[] | تمام اشیاء NamedRange را در برگه دریافت می کند. |
getNamedRanges(name) | NamedRange[] | تمام اشیاء NamedRange را در برگه با نام داده شده دریافت می کند. |
newPosition(element, offset) | Position | یک Position جدید ایجاد می کند، که اشاره ای به یک مکان در برگه، نسبت به یک عنصر خاص است. |
newRange() | RangeBuilder | سازنده ای ایجاد می کند که برای ساخت اشیاء Range از عناصر برگه استفاده می شود. |
Element
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
asBody() | Body | عنصر فعلی را به عنوان Body برمیگرداند. |
asDate() | Date | عنصر فعلی را به عنوان Date برمیگرداند. |
asEquation() | Equation | عنصر جاری را به صورت Equation برمیگرداند. |
asEquationFunction() | EquationFunction | عنصر فعلی را به عنوان یک EquationFunction برمیگرداند. |
asEquationFunctionArgumentSeparator() | EquationFunctionArgumentSeparator | عنصر فعلی را به عنوان یک EquationFunctionArgumentSeparator برمی گرداند. |
asEquationSymbol() | EquationSymbol | عنصر فعلی را به عنوان EquationSymbol برمیگرداند. |
asFooterSection() | FooterSection | عنصر فعلی را به صورت FooterSection برمیگرداند. |
asFootnote() | Footnote | عنصر فعلی را به عنوان Footnote برمی گرداند. |
asFootnoteSection() | FootnoteSection | عنصر فعلی را به عنوان FootnoteSection برمی گرداند. |
asHeaderSection() | HeaderSection | عنصر فعلی را به عنوان HeaderSection برمیگرداند. |
asHorizontalRule() | HorizontalRule | عنصر فعلی را به صورت HorizontalRule برمیگرداند. |
asInlineDrawing() | InlineDrawing | عنصر فعلی را به صورت InlineDrawing برمیگرداند. |
asInlineImage() | InlineImage | عنصر فعلی را به عنوان InlineImage برمیگرداند. |
asListItem() | ListItem | عنصر فعلی را به عنوان ListItem برمی گرداند. |
asPageBreak() | PageBreak | عنصر فعلی را به عنوان یک PageBreak برمیگرداند. |
asParagraph() | Paragraph | عنصر فعلی را به عنوان یک Paragraph برمی گرداند. |
asPerson() | Person | عنصر فعلی را به عنوان یک Person برمی گرداند. |
asRichLink() | RichLink | عنصر فعلی را به عنوان یک RichLink برمیگرداند، به عنوان مثال، پیوندی به فایل کاربرگنگار Google. |
asTable() | Table | عنصر فعلی را به صورت Table برمی گرداند. |
asTableCell() | TableCell | عنصر فعلی را به عنوان TableCell برمیگرداند. |
asTableOfContents() | TableOfContents | عنصر فعلی را به عنوان TableOfContents برمی گرداند. |
asTableRow() | TableRow | عنصر فعلی را به عنوان TableRow برمیگرداند. |
asText() | Text | عنصر فعلی را به عنوان یک Text برمی گرداند. |
copy() | Element | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
merge() | Element | عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند. |
removeFromParent() | Element | عنصر را از والد خود حذف می کند. |
setAttributes(attributes) | Element | ویژگی های عنصر را تنظیم می کند. |
ElementType
خواص
اموال | تایپ کنید | توضیحات |
---|---|---|
BODY_SECTION | Enum | نوع مربوط به عنصر Body . |
COMMENT_SECTION | Enum | نوع مربوط به عنصر . |
DATE | Enum | نوع مربوط به عنصر Date . |
EQUATION | Enum | نوع مربوط به عنصر Equation . |
EQUATION_FUNCTION | Enum | نوع مربوط به عنصر EquationFunction . |
EQUATION_FUNCTION_ARGUMENT_SEPARATOR | Enum | نوع مربوط به عنصر EquationFunctionArgumentSeparator . |
EQUATION_SYMBOL | Enum | نوع مربوط به عنصر EquationSymbol . |
RICH_LINK | Enum | نوع مربوط به عنصر RichLink . |
FOOTER_SECTION | Enum | نوع مربوط به عنصر FooterSection . |
FOOTNOTE | Enum | نوع مربوط به عنصر Footnote . |
FOOTNOTE_SECTION | Enum | نوع مربوط به عنصر FootnoteSection . |
HEADER_SECTION | Enum | نوع مربوط به عنصر HeaderSection . |
HORIZONTAL_RULE | Enum | نوع مربوط به عنصر HorizontalRule . |
INLINE_DRAWING | Enum | نوع مربوط به عنصر InlineDrawing . |
INLINE_IMAGE | Enum | نوع مربوط به عنصر InlineImage . |
LIST_ITEM | Enum | نوع مربوط به عنصر ListItem . |
PAGE_BREAK | Enum | نوع مربوط به عنصر PageBreak . |
PARAGRAPH | Enum | نوع مربوط به عنصر Paragraph . |
PERSON | Enum | نوع مربوط به عنصر Person . |
TABLE | Enum | نوع مربوط به عنصر Table . |
TABLE_CELL | Enum | نوع مربوط به عنصر TableCell . |
TABLE_OF_CONTENTS | Enum | نوع مربوط به عنصر TableOfContents . |
TABLE_ROW | Enum | نوع مربوط به عنصر TableRow . |
TEXT | Enum | نوع مربوط به عنصر Text . |
UNSUPPORTED | Enum | نوع مربوط به UnsupportedElement . |
Equation
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
clear() | Equation | محتویات عنصر را پاک می کند. |
copy() | Equation | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
editAsText() | Text | یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می کند. |
findElement(elementType) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند. |
findElement(elementType, from) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند، که از RangeElement مشخص شده شروع می شود. |
findText(searchPattern) | RangeElement | با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند. |
findText(searchPattern, from) | RangeElement | محتویات عنصر را برای الگوی متن مشخص شده، از یک نتیجه جستجوی معین شروع می کند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getChild(childIndex) | Element | عنصر فرزند را در نمایه فرزند مشخص شده بازیابی می کند. |
getChildIndex(child) | Integer | شاخص فرزند را برای عنصر فرزند مشخص شده بازیابی می کند. |
getLinkUrl() | String | آدرس لینک را بازیابی می کند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getNumChildren() | Integer | تعداد فرزندان را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getText() | String | محتویات عنصر را به عنوان یک رشته متنی بازیابی می کند. |
getTextAlignment() | TextAlignment | تراز متن را دریافت می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
merge() | Equation | عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند. |
removeFromParent() | Equation | عنصر را از والد خود حذف می کند. |
replaceText(searchPattern, replacement) | Element | با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین میکند. |
setAttributes(attributes) | Equation | ویژگی های عنصر را تنظیم می کند. |
setLinkUrl(url) | Equation | آدرس لینک را تنظیم می کند. |
setTextAlignment(textAlignment) | Equation | تراز متن را تنظیم می کند. |
EquationFunction
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
clear() | EquationFunction | محتویات عنصر را پاک می کند. |
copy() | EquationFunction | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
editAsText() | Text | یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می کند. |
findElement(elementType) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند. |
findElement(elementType, from) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند، که از RangeElement مشخص شده شروع می شود. |
findText(searchPattern) | RangeElement | با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند. |
findText(searchPattern, from) | RangeElement | محتویات عنصر را برای الگوی متن مشخص شده، از یک نتیجه جستجوی معین شروع می کند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getChild(childIndex) | Element | عنصر فرزند را در نمایه فرزند مشخص شده بازیابی می کند. |
getChildIndex(child) | Integer | شاخص فرزند را برای عنصر فرزند مشخص شده بازیابی می کند. |
getCode() | String | کد مربوط به تابع معادله را بازیابی می کند. |
getLinkUrl() | String | آدرس لینک را بازیابی می کند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getNumChildren() | Integer | تعداد فرزندان را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getText() | String | محتویات عنصر را به عنوان یک رشته متنی بازیابی می کند. |
getTextAlignment() | TextAlignment | تراز متن را دریافت می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
merge() | EquationFunction | عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند. |
removeFromParent() | EquationFunction | عنصر را از والد خود حذف می کند. |
replaceText(searchPattern, replacement) | Element | با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین میکند. |
setAttributes(attributes) | EquationFunction | ویژگی های عنصر را تنظیم می کند. |
setLinkUrl(url) | EquationFunction | آدرس لینک را تنظیم می کند. |
setTextAlignment(textAlignment) | EquationFunction | تراز متن را تنظیم می کند. |
EquationFunctionArgumentSeparator
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
copy() | EquationFunctionArgumentSeparator | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
merge() | EquationFunctionArgumentSeparator | عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند. |
removeFromParent() | EquationFunctionArgumentSeparator | عنصر را از والد خود حذف می کند. |
setAttributes(attributes) | EquationFunctionArgumentSeparator | ویژگی های عنصر را تنظیم می کند. |
EquationSymbol
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
copy() | EquationSymbol | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getCode() | String | کد مربوط به نماد معادله را بازیابی می کند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
merge() | EquationSymbol | عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند. |
removeFromParent() | EquationSymbol | عنصر را از والد خود حذف می کند. |
setAttributes(attributes) | EquationSymbol | ویژگی های عنصر را تنظیم می کند. |
FontFamily
FooterSection
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
appendHorizontalRule() | HorizontalRule | یک HorizontalRule جدید ایجاد و اضافه می کند. |
appendImage(image) | InlineImage | یک InlineImage جدید از حباب تصویر مشخص شده ایجاد و اضافه می کند. |
appendImage(image) | InlineImage | InlineImage داده شده را اضافه می کند. |
appendListItem(listItem) | ListItem | ListItem داده شده را اضافه می کند. |
appendListItem(text) | ListItem | یک ListItem جدید حاوی محتوای متن مشخص شده ایجاد و اضافه می کند. |
appendParagraph(paragraph) | Paragraph | Paragraph داده شده را ضمیمه می کند. |
appendParagraph(text) | Paragraph | یک Paragraph جدید حاوی محتوای متن مشخص شده ایجاد و اضافه می کند. |
appendTable() | Table | یک Table جدید ایجاد و اضافه می کند. |
appendTable(cells) | Table | یک Table جدید حاوی TableCell برای هر مقدار رشته مشخص شده اضافه می کند. |
appendTable(table) | Table | Table داده شده را ضمیمه می کند. |
clear() | FooterSection | محتویات عنصر را پاک می کند. |
copy() | FooterSection | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
editAsText() | Text | یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می کند. |
findElement(elementType) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند. |
findElement(elementType, from) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند، که از RangeElement مشخص شده شروع می شود. |
findText(searchPattern) | RangeElement | با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند. |
findText(searchPattern, from) | RangeElement | محتویات عنصر را برای الگوی متن مشخص شده، از یک نتیجه جستجوی معین شروع می کند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getChild(childIndex) | Element | عنصر فرزند را در نمایه فرزند مشخص شده بازیابی می کند. |
getChildIndex(child) | Integer | شاخص فرزند را برای عنصر فرزند مشخص شده بازیابی می کند. |
getImages() | InlineImage[] | همه InlineImages موجود در بخش را بازیابی می کند. |
getListItems() | ListItem[] | همه ListItems موجود در بخش را بازیابی می کند. |
getNumChildren() | Integer | تعداد فرزندان را بازیابی می کند. |
getParagraphs() | Paragraph[] | تمام Paragraphs موجود در بخش (از جمله ListItems ) را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getTables() | Table[] | تمام Tables موجود در بخش را بازیابی می کند. |
getText() | String | محتویات عنصر را به عنوان یک رشته متنی بازیابی می کند. |
getTextAlignment() | TextAlignment | تراز متن را دریافت می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
insertHorizontalRule(childIndex) | HorizontalRule | یک HorizontalRule جدید در نمایه مشخص شده ایجاد و درج می کند. |
insertImage(childIndex, image) | InlineImage | یک InlineImage از حباب تصویر مشخص شده، در نمایه مشخص شده ایجاد و درج می کند. |
insertImage(childIndex, image) | InlineImage | InlineImage داده شده را در نمایه مشخص شده درج می کند. |
insertListItem(childIndex, listItem) | ListItem | ListItem داده شده را در نمایه مشخص شده درج می کند. |
insertListItem(childIndex, text) | ListItem | یک ListItem جدید را در نمایه مشخص شده ایجاد و درج می کند که حاوی محتوای متن مشخص شده است. |
insertParagraph(childIndex, paragraph) | Paragraph | Paragraph داده شده را در نمایه مشخص شده درج می کند. |
insertParagraph(childIndex, text) | Paragraph | یک Paragraph جدید را در نمایه مشخص شده ایجاد و درج می کند که حاوی محتوای متن مشخص شده است. |
insertTable(childIndex) | Table | یک Table جدید در نمایه مشخص شده ایجاد و درج می کند. |
insertTable(childIndex, cells) | Table | یک Table جدید حاوی سلول های مشخص شده را در نمایه مشخص شده ایجاد و درج می کند. |
insertTable(childIndex, table) | Table | Table داده شده را در شاخص مشخص شده درج می کند. |
removeChild(child) | FooterSection | عنصر فرزند مشخص شده را حذف می کند. |
removeFromParent() | FooterSection | عنصر را از والد خود حذف می کند. |
replaceText(searchPattern, replacement) | Element | با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین میکند. |
setAttributes(attributes) | FooterSection | ویژگی های عنصر را تنظیم می کند. |
setText(text) | FooterSection | محتویات را به صورت متن ساده تنظیم می کند. |
setTextAlignment(textAlignment) | FooterSection | تراز متن را تنظیم می کند. |
Footnote
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
copy() | Footnote | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getFootnoteContents() | FootnoteSection | محتویات عنصر پاورقی را بازیابی می کند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
removeFromParent() | Footnote | عنصر را از والد خود حذف می کند. |
setAttributes(attributes) | Footnote | ویژگی های عنصر را تنظیم می کند. |
FootnoteSection
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
appendParagraph(paragraph) | Paragraph | Paragraph داده شده را ضمیمه می کند. |
appendParagraph(text) | Paragraph | یک Paragraph جدید حاوی محتوای متن مشخص شده ایجاد و اضافه می کند. |
clear() | FootnoteSection | محتویات عنصر را پاک می کند. |
copy() | FootnoteSection | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
editAsText() | Text | یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می کند. |
findElement(elementType) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند. |
findElement(elementType, from) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند، که از RangeElement مشخص شده شروع می شود. |
findText(searchPattern) | RangeElement | با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند. |
findText(searchPattern, from) | RangeElement | محتویات عنصر را برای الگوی متن مشخص شده، از یک نتیجه جستجوی معین شروع می کند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getChild(childIndex) | Element | عنصر فرزند را در نمایه فرزند مشخص شده بازیابی می کند. |
getChildIndex(child) | Integer | شاخص فرزند را برای عنصر فرزند مشخص شده بازیابی می کند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getNumChildren() | Integer | تعداد فرزندان را بازیابی می کند. |
getParagraphs() | Paragraph[] | تمام Paragraphs موجود در بخش (از جمله ListItems ) را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getText() | String | محتویات عنصر را به عنوان یک رشته متنی بازیابی می کند. |
getTextAlignment() | TextAlignment | تراز متن را دریافت می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
insertParagraph(childIndex, paragraph) | Paragraph | Paragraph داده شده را در نمایه مشخص شده درج می کند. |
insertParagraph(childIndex, text) | Paragraph | یک Paragraph جدید را در نمایه مشخص شده ایجاد و درج می کند که حاوی محتوای متن مشخص شده است. |
removeChild(child) | FootnoteSection | عنصر فرزند مشخص شده را حذف می کند. |
removeFromParent() | FootnoteSection | عنصر را از والد خود حذف می کند. |
replaceText(searchPattern, replacement) | Element | با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین میکند. |
setAttributes(attributes) | FootnoteSection | ویژگی های عنصر را تنظیم می کند. |
setText(text) | FootnoteSection | محتویات را به صورت متن ساده تنظیم می کند. |
setTextAlignment(textAlignment) | FootnoteSection | تراز متن را تنظیم می کند. |
GlyphType
خواص
اموال | تایپ کنید | توضیحات |
---|---|---|
BULLET | Enum | گلوله پیش فرض، دایره ای و پر شده است. |
HOLLOW_BULLET | Enum | یک گلوله توخالی |
SQUARE_BULLET | Enum | یک گلوله مربع |
NUMBER | Enum | یک گلوله مبتنی بر عدد. |
LATIN_UPPER | Enum | یک گلوله لاتین با حروف بزرگ. |
LATIN_LOWER | Enum | یک گلوله لاتین با حروف کوچک. |
ROMAN_UPPER | Enum | یک عدد رومی، گلوله بزرگ. |
ROMAN_LOWER | Enum | یک عدد رومی، گلوله کوچک. |
HeaderSection
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
appendHorizontalRule() | HorizontalRule | یک HorizontalRule جدید ایجاد و اضافه می کند. |
appendImage(image) | InlineImage | یک InlineImage جدید از حباب تصویر مشخص شده ایجاد و اضافه می کند. |
appendImage(image) | InlineImage | InlineImage داده شده را اضافه می کند. |
appendListItem(listItem) | ListItem | ListItem داده شده را اضافه می کند. |
appendListItem(text) | ListItem | یک ListItem جدید حاوی محتوای متن مشخص شده ایجاد و اضافه می کند. |
appendParagraph(paragraph) | Paragraph | Paragraph داده شده را ضمیمه می کند. |
appendParagraph(text) | Paragraph | یک Paragraph جدید حاوی محتوای متن مشخص شده ایجاد و اضافه می کند. |
appendTable() | Table | یک Table جدید ایجاد و اضافه می کند. |
appendTable(cells) | Table | یک Table جدید حاوی TableCell برای هر مقدار رشته مشخص شده اضافه می کند. |
appendTable(table) | Table | Table داده شده را ضمیمه می کند. |
clear() | HeaderSection | محتویات عنصر را پاک می کند. |
copy() | HeaderSection | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
editAsText() | Text | یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می کند. |
findElement(elementType) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند. |
findElement(elementType, from) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند، که از RangeElement مشخص شده شروع می شود. |
findText(searchPattern) | RangeElement | با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند. |
findText(searchPattern, from) | RangeElement | محتویات عنصر را برای الگوی متن مشخص شده، از یک نتیجه جستجوی معین شروع می کند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getChild(childIndex) | Element | عنصر فرزند را در نمایه فرزند مشخص شده بازیابی می کند. |
getChildIndex(child) | Integer | شاخص فرزند را برای عنصر فرزند مشخص شده بازیابی می کند. |
getImages() | InlineImage[] | همه InlineImages موجود در بخش را بازیابی می کند. |
getListItems() | ListItem[] | همه ListItems موجود در بخش را بازیابی می کند. |
getNumChildren() | Integer | تعداد فرزندان را بازیابی می کند. |
getParagraphs() | Paragraph[] | تمام Paragraphs موجود در بخش (از جمله ListItems ) را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getTables() | Table[] | تمام Tables موجود در بخش را بازیابی می کند. |
getText() | String | محتویات عنصر را به عنوان یک رشته متنی بازیابی می کند. |
getTextAlignment() | TextAlignment | تراز متن را دریافت می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
insertHorizontalRule(childIndex) | HorizontalRule | یک HorizontalRule جدید در نمایه مشخص شده ایجاد و درج می کند. |
insertImage(childIndex, image) | InlineImage | یک InlineImage از حباب تصویر مشخص شده، در نمایه مشخص شده ایجاد و درج می کند. |
insertImage(childIndex, image) | InlineImage | InlineImage داده شده را در نمایه مشخص شده درج می کند. |
insertListItem(childIndex, listItem) | ListItem | ListItem داده شده را در نمایه مشخص شده درج می کند. |
insertListItem(childIndex, text) | ListItem | یک ListItem جدید را در نمایه مشخص شده ایجاد و درج می کند که حاوی محتوای متن مشخص شده است. |
insertParagraph(childIndex, paragraph) | Paragraph | Paragraph داده شده را در نمایه مشخص شده درج می کند. |
insertParagraph(childIndex, text) | Paragraph | یک Paragraph جدید را در نمایه مشخص شده ایجاد و درج می کند که حاوی محتوای متن مشخص شده است. |
insertTable(childIndex) | Table | یک Table جدید در نمایه مشخص شده ایجاد و درج می کند. |
insertTable(childIndex, cells) | Table | یک Table جدید حاوی سلول های مشخص شده را در نمایه مشخص شده ایجاد و درج می کند. |
insertTable(childIndex, table) | Table | Table داده شده را در شاخص مشخص شده درج می کند. |
removeChild(child) | HeaderSection | عنصر فرزند مشخص شده را حذف می کند. |
removeFromParent() | HeaderSection | عنصر را از والد خود حذف می کند. |
replaceText(searchPattern, replacement) | Element | با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین میکند. |
setAttributes(attributes) | HeaderSection | ویژگی های عنصر را تنظیم می کند. |
setText(text) | HeaderSection | محتویات را به صورت متن ساده تنظیم می کند. |
setTextAlignment(textAlignment) | HeaderSection | تراز متن را تنظیم می کند. |
HorizontalAlignment
خواص
اموال | تایپ کنید | توضیحات |
---|---|---|
LEFT | Enum | گزینه تراز چپ. |
CENTER | Enum | گزینه تراز وسط. |
RIGHT | Enum | گزینه تراز راست. |
JUSTIFY | Enum | گزینه justify-alignment. |
HorizontalRule
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
copy() | HorizontalRule | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
removeFromParent() | HorizontalRule | عنصر را از والد خود حذف می کند. |
setAttributes(attributes) | HorizontalRule | ویژگی های عنصر را تنظیم می کند. |
InlineDrawing
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
copy() | InlineDrawing | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
getAltDescription() | String | توضیحات جایگزین طرح را برمی گرداند. |
getAltTitle() | String | عنوان جایگزین طرح را برمیگرداند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
merge() | InlineDrawing | عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند. |
removeFromParent() | InlineDrawing | عنصر را از والد خود حذف می کند. |
setAltDescription(description) | InlineDrawing | توضیحات جایگزین نقاشی را تنظیم می کند. |
setAltTitle(title) | InlineDrawing | عنوان جایگزین نقاشی را تنظیم می کند. |
setAttributes(attributes) | InlineDrawing | ویژگی های عنصر را تنظیم می کند. |
InlineImage
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
copy() | InlineImage | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
getAltDescription() | String | توضیحات جایگزین تصویر را برمی گرداند. |
getAltTitle() | String | عنوان جایگزین تصویر را برمی گرداند. |
getAs(contentType) | Blob | داده های داخل این شی را به عنوان یک حباب تبدیل به نوع محتوای مشخص شده برگردانید. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getBlob() | Blob | داده های داخل این شی را به صورت حباب برگردانید. |
getHeight() | Integer | ارتفاع تصویر را بر حسب پیکسل بازیابی می کند. |
getLinkUrl() | String | URL پیوند را بازیابی می کند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
getWidth() | Integer | عرض تصویر را بر حسب پیکسل بازیابی می کند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
merge() | InlineImage | عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند. |
removeFromParent() | InlineImage | عنصر را از والد خود حذف می کند. |
setAltDescription(description) | InlineImage | توضیحات جایگزین تصویر را تنظیم می کند. |
setAltTitle(title) | InlineImage | عنوان جایگزین تصویر را تنظیم می کند. |
setAttributes(attributes) | InlineImage | ویژگی های عنصر را تنظیم می کند. |
setHeight(height) | InlineImage | ارتفاع تصویر را بر حسب پیکسل تنظیم می کند. |
setLinkUrl(url) | InlineImage | URL پیوند را تنظیم می کند. |
setWidth(width) | InlineImage | عرض تصویر را بر حسب پیکسل تنظیم می کند. |
ListItem
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
addPositionedImage(image) | PositionedImage | یک PositionedImage جدید از حباب تصویر مشخص شده ایجاد و درج می کند. |
appendHorizontalRule() | HorizontalRule | یک HorizontalRule جدید ایجاد و اضافه می کند. |
appendInlineImage(image) | InlineImage | یک InlineImage جدید از حباب تصویر مشخص شده ایجاد و اضافه می کند. |
appendInlineImage(image) | InlineImage | InlineImage داده شده را اضافه می کند. |
appendPageBreak() | PageBreak | یک PageBreak جدید ایجاد و اضافه می کند. |
appendPageBreak(pageBreak) | PageBreak | PageBreak داده شده را اضافه می کند. |
appendText(text) | Text | یک عنصر Text جدید با محتوای مشخص شده ایجاد و اضافه می کند. |
appendText(text) | Text | عنصر Text داده شده را اضافه می کند. |
clear() | ListItem | محتویات عنصر را پاک می کند. |
copy() | ListItem | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
editAsText() | Text | یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می کند. |
findElement(elementType) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند. |
findElement(elementType, from) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند، که از RangeElement مشخص شده شروع می شود. |
findText(searchPattern) | RangeElement | با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند. |
findText(searchPattern, from) | RangeElement | محتویات عنصر را برای الگوی متن مشخص شده، از یک نتیجه جستجوی معین شروع می کند. |
getAlignment() | HorizontalAlignment | HorizontalAlignment را بازیابی می کند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getChild(childIndex) | Element | عنصر فرزند را در نمایه فرزند مشخص شده بازیابی می کند. |
getChildIndex(child) | Integer | شاخص فرزند را برای عنصر فرزند مشخص شده بازیابی می کند. |
getGlyphType() | GlyphType | GlyphType مورد فهرست را بازیابی می کند. |
getHeading() | ParagraphHeading | ParagraphHeading را بازیابی می کند. |
getIndentEnd() | Number | تورفتگی انتهایی را در نقاط بازیابی می کند. |
getIndentFirstLine() | Number | تورفتگی خط اول را در نقاط بازیابی می کند. |
getIndentStart() | Number | تورفتگی شروع را بازیابی می کند. |
getLineSpacing() | Number | فاصله خطوط را در نقاط بازیابی می کند. |
getLinkUrl() | String | آدرس لینک را بازیابی می کند. |
getListId() | String | شناسه لیست را بازیابی می کند. |
getNestingLevel() | Integer | سطح تودرتوی مورد فهرست را بازیابی می کند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getNumChildren() | Integer | تعداد فرزندان را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getPositionedImage(id) | PositionedImage | با شناسه تصویر یک PositionedImage دریافت می کند. |
getPositionedImages() | PositionedImage[] | تمام اشیاء PositionedImage متصل به پاراگراف را دریافت می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getSpacingAfter() | Number | فاصله بعد از عنصر را در نقاط بازیابی می کند. |
getSpacingBefore() | Number | فاصله قبل از عنصر، در نقاط را بازیابی می کند. |
getText() | String | محتویات عنصر را به عنوان یک رشته متنی بازیابی می کند. |
getTextAlignment() | TextAlignment | تراز متن را دریافت می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
insertHorizontalRule(childIndex) | HorizontalRule | یک HorizontalRule در نمایه مشخص شده ایجاد و درج می کند. |
insertInlineImage(childIndex, image) | InlineImage | یک InlineImage جدید از حباب تصویر مشخص شده، در نمایه مشخص شده ایجاد و درج می کند. |
insertInlineImage(childIndex, image) | InlineImage | InlineImage داده شده را در نمایه مشخص شده درج می کند. |
insertPageBreak(childIndex) | PageBreak | یک PageBreak جدید در ایندکس مشخص شده ایجاد و درج می کند. |
insertPageBreak(childIndex, pageBreak) | PageBreak | PageBreak داده شده را در ایندکس مشخص شده درج می کند. |
insertText(childIndex, text) | Text | یک عنصر متنی جدید را در نمایه مشخص شده ایجاد و درج می کند. |
insertText(childIndex, text) | Text | عنصر Text داده شده را با محتوای متن مشخص شده در فهرست مشخص شده درج می کند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
isLeftToRight() | Boolean | تنظیمات چپ به راست را بازیابی می کند. |
merge() | ListItem | عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند. |
removeChild(child) | ListItem | عنصر فرزند مشخص شده را حذف می کند. |
removeFromParent() | ListItem | عنصر را از والد خود حذف می کند. |
removePositionedImage(id) | Boolean | یک PositionedImage با شناسه تصویر حذف می کند. |
replaceText(searchPattern, replacement) | Element | با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین میکند. |
setAlignment(alignment) | ListItem | HorizontalAlignment را تنظیم می کند. |
setAttributes(attributes) | ListItem | ویژگی های عنصر را تنظیم می کند. |
setGlyphType(glyphType) | ListItem | GlyphType مورد لیست را تنظیم می کند. |
setHeading(heading) | ListItem | ParagraphHeading را تنظیم می کند. |
setIndentEnd(indentEnd) | ListItem | تورفتگی انتهایی را بر حسب نقاط تنظیم می کند. |
setIndentFirstLine(indentFirstLine) | ListItem | تورفتگی خط اول را در نقاط تنظیم می کند. |
setIndentStart(indentStart) | ListItem | تورفتگی شروع را در نقاط تنظیم می کند. |
setLeftToRight(leftToRight) | ListItem | تنظیمات چپ به راست را تنظیم می کند. |
setLineSpacing(multiplier) | ListItem | فاصله خطوط را به عنوان کمیتی تنظیم می کند که نشان دهنده تعداد خطوطی است که برای فاصله گذاری استفاده می شود. |
setLinkUrl(url) | ListItem | آدرس لینک را تنظیم می کند. |
setListId(listItem) | ListItem | شناسه لیست را تنظیم می کند. |
setNestingLevel(nestingLevel) | ListItem | سطح تودرتوی مورد فهرست را تنظیم می کند. |
setSpacingAfter(spacingAfter) | ListItem | فاصله بعد از عنصر را بر حسب نقطه تنظیم می کند. |
setSpacingBefore(spacingBefore) | ListItem | فاصله قبل از عنصر را بر حسب نقطه تنظیم می کند. |
setText(text) | void | محتویات آیتم لیست را به عنوان متن تنظیم می کند. |
setTextAlignment(textAlignment) | ListItem | تراز متن را تنظیم می کند. |
NamedRange
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
getId() | String | شناسه این NamedRange را دریافت می کند. |
getName() | String | نام این NamedRange را می گیرد. |
getRange() | Range | محدوده عناصر مرتبط با این NamedRange را دریافت می کند. |
remove() | void | این NamedRange از برگه حذف می کند. |
PageBreak
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
copy() | PageBreak | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
removeFromParent() | PageBreak | عنصر را از والد خود حذف می کند. |
setAttributes(attributes) | PageBreak | ویژگی های عنصر را تنظیم می کند. |
Paragraph
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
addPositionedImage(image) | PositionedImage | یک PositionedImage جدید از حباب تصویر مشخص شده ایجاد و درج می کند. |
appendHorizontalRule() | HorizontalRule | یک HorizontalRule جدید ایجاد و اضافه می کند. |
appendInlineImage(image) | InlineImage | یک InlineImage جدید از حباب تصویر مشخص شده ایجاد و اضافه می کند. |
appendInlineImage(image) | InlineImage | InlineImage داده شده را اضافه می کند. |
appendPageBreak() | PageBreak | یک PageBreak جدید ایجاد و اضافه می کند. |
appendPageBreak(pageBreak) | PageBreak | PageBreak داده شده را اضافه می کند. |
appendText(text) | Text | یک عنصر Text جدید با محتوای مشخص شده ایجاد و اضافه می کند. |
appendText(text) | Text | عنصر Text داده شده را اضافه می کند. |
clear() | Paragraph | محتویات عنصر را پاک می کند. |
copy() | Paragraph | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
editAsText() | Text | یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می کند. |
findElement(elementType) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند. |
findElement(elementType, from) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند، که از RangeElement مشخص شده شروع می شود. |
findText(searchPattern) | RangeElement | با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند. |
findText(searchPattern, from) | RangeElement | محتویات عنصر را برای الگوی متن مشخص شده، از یک نتیجه جستجوی معین شروع می کند. |
getAlignment() | HorizontalAlignment | HorizontalAlignment را بازیابی می کند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getChild(childIndex) | Element | عنصر فرزند را در نمایه فرزند مشخص شده بازیابی می کند. |
getChildIndex(child) | Integer | شاخص فرزند را برای عنصر فرزند مشخص شده بازیابی می کند. |
getHeading() | ParagraphHeading | ParagraphHeading را بازیابی می کند. |
getIndentEnd() | Number | تورفتگی انتهایی را در نقاط بازیابی می کند. |
getIndentFirstLine() | Number | تورفتگی خط اول را در نقاط بازیابی می کند. |
getIndentStart() | Number | تورفتگی شروع را بازیابی می کند. |
getLineSpacing() | Number | فاصله خطوط را در نقاط بازیابی می کند. |
getLinkUrl() | String | آدرس لینک را بازیابی می کند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getNumChildren() | Integer | تعداد فرزندان را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getPositionedImage(id) | PositionedImage | با شناسه تصویر یک PositionedImage دریافت می کند. |
getPositionedImages() | PositionedImage[] | تمام اشیاء PositionedImage متصل به پاراگراف را دریافت می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getSpacingAfter() | Number | فاصله بعد از عنصر را در نقاط بازیابی می کند. |
getSpacingBefore() | Number | فاصله قبل از عنصر، در نقاط را بازیابی می کند. |
getText() | String | محتویات عنصر را به عنوان یک رشته متنی بازیابی می کند. |
getTextAlignment() | TextAlignment | تراز متن را دریافت می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
insertHorizontalRule(childIndex) | HorizontalRule | یک HorizontalRule در نمایه مشخص شده ایجاد و درج می کند. |
insertInlineImage(childIndex, image) | InlineImage | یک InlineImage جدید از حباب تصویر مشخص شده، در نمایه مشخص شده ایجاد و درج می کند. |
insertInlineImage(childIndex, image) | InlineImage | InlineImage داده شده را در نمایه مشخص شده درج می کند. |
insertPageBreak(childIndex) | PageBreak | یک PageBreak جدید در ایندکس مشخص شده ایجاد و درج می کند. |
insertPageBreak(childIndex, pageBreak) | PageBreak | PageBreak داده شده را در ایندکس مشخص شده درج می کند. |
insertText(childIndex, text) | Text | یک عنصر متنی جدید را در نمایه مشخص شده ایجاد و درج می کند. |
insertText(childIndex, text) | Text | عنصر Text داده شده را با محتوای متن مشخص شده در فهرست مشخص شده درج می کند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
isLeftToRight() | Boolean | تنظیمات چپ به راست را بازیابی می کند. |
merge() | Paragraph | عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند. |
removeChild(child) | Paragraph | عنصر فرزند مشخص شده را حذف می کند. |
removeFromParent() | Paragraph | عنصر را از والد خود حذف می کند. |
removePositionedImage(id) | Boolean | یک PositionedImage با شناسه تصویر حذف می کند. |
replaceText(searchPattern, replacement) | Element | با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین میکند. |
setAlignment(alignment) | Paragraph | HorizontalAlignment را تنظیم می کند. |
setAttributes(attributes) | Paragraph | ویژگی های عنصر را تنظیم می کند. |
setHeading(heading) | Paragraph | ParagraphHeading را تنظیم می کند. |
setIndentEnd(indentEnd) | Paragraph | تورفتگی انتهایی را بر حسب نقاط تنظیم می کند. |
setIndentFirstLine(indentFirstLine) | Paragraph | تورفتگی خط اول را در نقاط تنظیم می کند. |
setIndentStart(indentStart) | Paragraph | تورفتگی شروع را در نقاط تنظیم می کند. |
setLeftToRight(leftToRight) | Paragraph | تنظیمات چپ به راست را تنظیم می کند. |
setLineSpacing(multiplier) | Paragraph | فاصله خطوط را به عنوان کمیتی تنظیم می کند که نشان دهنده تعداد خطوطی است که برای فاصله گذاری استفاده می شود. |
setLinkUrl(url) | Paragraph | آدرس لینک را تنظیم می کند. |
setSpacingAfter(spacingAfter) | Paragraph | فاصله بعد از عنصر را بر حسب نقطه تنظیم می کند. |
setSpacingBefore(spacingBefore) | Paragraph | فاصله قبل از عنصر را بر حسب نقطه تنظیم می کند. |
setText(text) | void | محتوای پاراگراف را به عنوان متن تنظیم می کند. |
setTextAlignment(textAlignment) | Paragraph | تراز متن را تنظیم می کند. |
ParagraphHeading
خواص
اموال | تایپ کنید | توضیحات |
---|---|---|
NORMAL | Enum | گزینه عنوان برای متن معمولی. |
HEADING1 | Enum | بالاترین گزینه سرفصل. |
HEADING2 | Enum | گزینه عنوان دوم. |
HEADING3 | Enum | گزینه عنوان سوم |
HEADING4 | Enum | گزینه سرفصل چهارم. |
HEADING5 | Enum | گزینه سرفصل پنجم. |
HEADING6 | Enum | پایین ترین گزینه سرفصل. |
TITLE | Enum | گزینه عنوان عنوان. |
SUBTITLE | Enum | گزینه عنوان زیرنویس. |
Person
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
copy() | Person | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getEmail() | String | آدرس ایمیل شخص را برمی گرداند. |
getName() | String | در صورت تنظیم، نام نمایشی شخص را برمیگرداند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
merge() | Person | عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند. |
removeFromParent() | Person | عنصر را از والد خود حذف می کند. |
setAttributes(attributes) | Person | ویژگی های عنصر را تنظیم می کند. |
Position
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
getElement() | Element | عنصر حاوی این Position دریافت می کند. |
getOffset() | Integer | موقعیت نسبی این Position را در عنصری که آن را در بر می گیرد، دریافت می کند. |
getSurroundingText() | Text | یک عنصر Text مصنوعی ایجاد می کند که متن و قالب بندی Paragraph یا ListItem را که حاوی Position است، به طور مستقیم یا از طریق زنجیره ای از عناصر فرزند نشان می دهد. |
getSurroundingTextOffset() | Integer | افست این Position را در عنصر Text که توسط getSurroundingText() برگردانده شده است، دریافت می کند. |
insertBookmark() | Bookmark | یک Bookmark جدید را در این Position ایجاد و درج می کند. |
insertInlineImage(image) | InlineImage | یک InlineImage جدید در این Position از حباب تصویر مشخص شده ایجاد و درج می کند. |
insertText(text) | Text | متن مشخص شده را در این Position درج می کند. |
PositionedImage
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
getAs(contentType) | Blob | داده های داخل این شی را به عنوان یک حباب تبدیل به نوع محتوای مشخص شده برگردانید. |
getBlob() | Blob | داده های داخل این شی را به صورت حباب برگردانید. |
getHeight() | Integer | ارتفاع تصویر را بر حسب پیکسل بازیابی می کند. |
getId() | String | شناسه تصویر را می گیرد. |
getLayout() | PositionedLayout | یک مقدار enum دریافت می کند که نشان دهنده نحوه چیدمان تصویر است. |
getLeftOffset() | Number | انحراف تصویر را بر حسب نقطه از سمت چپ پاراگراف دریافت می کند. |
getParagraph() | Paragraph | Paragraph مورد نظر تصویر را دریافت می کند. |
getTopOffset() | Number | انحراف تصویر را بر حسب نقطه از بالای پاراگراف دریافت می کند. |
getWidth() | Integer | عرض تصویر را بر حسب پیکسل بازیابی می کند. |
setHeight(height) | PositionedImage | ارتفاع تصویر را بر حسب پیکسل تنظیم می کند. |
setLayout(layout) | PositionedImage | تعریف نحوه چیدمان تصویر را تنظیم می کند. |
setLeftOffset(offset) | PositionedImage | افست تصویر را بر حسب نقطه از سمت چپ پاراگراف تنظیم می کند. |
setTopOffset(offset) | PositionedImage | افست تصویر را بر حسب نقطه از بالای پاراگراف تنظیم می کند. |
setWidth(width) | PositionedImage | عرض تصویر را بر حسب پیکسل تنظیم می کند. |
PositionedLayout
خواص
اموال | تایپ کنید | توضیحات |
---|---|---|
ABOVE_TEXT | Enum | تصویر در بالای متن قرار گرفته است. |
BREAK_BOTH | Enum | تصویر متن را در سمت چپ و راست می شکند. |
BREAK_LEFT | Enum | تصویر متن سمت چپ را می شکند. |
BREAK_RIGHT | Enum | تصویر متن سمت راست را می شکند. |
WRAP_TEXT | Enum | تصویر با متن پیچیده شده است. |
Range
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
getRangeElements() | RangeElement[] | همه عناصر را در این Range دریافت می کند، از جمله هر عنصر Text جزئی (مثلاً در مورد انتخابی که فقط بخشی از یک عنصر Text را شامل می شود). |
RangeBuilder
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
addElement(element) | RangeBuilder | یک Element کامل را به این RangeBuilder اضافه می کند. |
addElement(textElement, startOffset, endOffsetInclusive) | RangeBuilder | یک عنصر Text جزئی به این RangeBuilder اضافه می کند. |
addElementsBetween(startElement, endElementInclusive) | RangeBuilder | دو عنصر کامل و همه عناصر بین آنها را به این RangeBuilder اضافه می کند. |
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) | RangeBuilder | دو عنصر Text جزئی و همه عناصر بین آنها را به RangeBuilder اضافه می کند. |
addRange(range) | RangeBuilder | محتویات یک Range دیگر را به این RangeBuilder اضافه می کند. |
build() | Range | یک Range از تنظیمات اعمال شده برای سازنده ایجاد می کند. |
getRangeElements() | RangeElement[] | همه عناصر را در این Range دریافت می کند، از جمله هر عنصر Text جزئی (مثلاً در مورد انتخابی که فقط بخشی از یک عنصر Text را شامل می شود). |
RangeElement
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
getElement() | Element | Element مربوط به این RangeElement را دریافت می کند. |
getEndOffsetInclusive() | Integer | موقعیت انتهای یک محدوده جزئی را در عنصر محدوده بدست می آورد. |
getStartOffset() | Integer | موقعیت شروع یک محدوده جزئی را در عنصر محدوده بدست می آورد. |
isPartial() | Boolean | تعیین می کند که آیا این عنصر محدوده کل عنصر را پوشش می دهد یا بخشی از کاراکترهای عنصر را پوشش می دهد. |
RichLink
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
copy() | RichLink | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getMimeType() | String | نوع MIME پیوند را برمیگرداند، که وقتی مورد پیوندی به فایل Drive باشد در دسترس است و در غیر این صورت null . |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getTitle() | String | عنوان نمایش داده شده پیوند را برمی گرداند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
getUrl() | String | URL منبع را برمی گرداند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
merge() | RichLink | عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند. |
removeFromParent() | RichLink | عنصر را از والد خود حذف می کند. |
setAttributes(attributes) | RichLink | ویژگی های عنصر را تنظیم می کند. |
Tab
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
asDocumentTab() | DocumentTab | محتویات برگه را به عنوان یک DocumentTab بازیابی می کند. |
getChildTabs() | Tab[] | برگه های فرزند تو در تو در این برگه را بازیابی می کند. |
getId() | String | شناسه برگه را بازیابی می کند. |
getIndex() | Integer | ایندکس مبتنی بر 0 برگه را در والد بازیابی می کند. |
getTitle() | String | عنوان برگه را بازیابی می کند. |
getType() | TabType | نوع برگه را بازیابی می کند. |
TabType
خواص
اموال | تایپ کنید | توضیحات |
---|---|---|
DOCUMENT_TAB | Enum | نوع مربوط به DocumentTab . |
Table
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
appendTableRow() | TableRow | یک TableRow جدید ایجاد و اضافه می کند. |
appendTableRow(tableRow) | TableRow | TableRow داده شده را اضافه می کند. |
clear() | Table | محتویات عنصر را پاک می کند. |
copy() | Table | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
editAsText() | Text | یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می کند. |
findElement(elementType) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند. |
findElement(elementType, from) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند، که از RangeElement مشخص شده شروع می شود. |
findText(searchPattern) | RangeElement | با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند. |
findText(searchPattern, from) | RangeElement | محتویات عنصر را برای الگوی متن مشخص شده، از یک نتیجه جستجوی معین شروع می کند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getBorderColor() | String | رنگ حاشیه را بازیابی می کند. |
getBorderWidth() | Number | عرض حاشیه را بر حسب نقطه بازیابی می کند. |
getCell(rowIndex, cellIndex) | TableCell | TableCell در ردیف و شاخص های سلول مشخص شده بازیابی می کند. |
getChild(childIndex) | Element | عنصر فرزند را در نمایه فرزند مشخص شده بازیابی می کند. |
getChildIndex(child) | Integer | شاخص فرزند را برای عنصر فرزند مشخص شده بازیابی می کند. |
getColumnWidth(columnIndex) | Number | عرض ستون جدول مشخص شده را در نقاط بازیابی می کند. |
getLinkUrl() | String | آدرس لینک را بازیابی می کند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getNumChildren() | Integer | تعداد فرزندان را بازیابی می کند. |
getNumRows() | Integer | تعداد TableRows را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getRow(rowIndex) | TableRow | TableRow در شاخص ردیف مشخص شده بازیابی می کند. |
getText() | String | محتویات عنصر را به عنوان یک رشته متنی بازیابی می کند. |
getTextAlignment() | TextAlignment | تراز متن را دریافت می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
insertTableRow(childIndex) | TableRow | یک TableRow جدید در ایندکس مشخص شده ایجاد و درج می کند. |
insertTableRow(childIndex, tableRow) | TableRow | TableRow داده شده را در شاخص مشخص شده درج می کند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
removeChild(child) | Table | عنصر فرزند مشخص شده را حذف می کند. |
removeFromParent() | Table | عنصر را از والد خود حذف می کند. |
removeRow(rowIndex) | TableRow | TableRow در فهرست ردیف مشخص شده حذف می کند. |
replaceText(searchPattern, replacement) | Element | با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین میکند. |
setAttributes(attributes) | Table | ویژگی های عنصر را تنظیم می کند. |
setBorderColor(color) | Table | رنگ حاشیه را تنظیم می کند. |
setBorderWidth(width) | Table | عرض حاشیه را بر حسب نقطه تنظیم می کند. |
setColumnWidth(columnIndex, width) | Table | عرض ستون مشخص شده را بر حسب نقطه تنظیم می کند. |
setLinkUrl(url) | Table | آدرس لینک را تنظیم می کند. |
setTextAlignment(textAlignment) | Table | تراز متن را تنظیم می کند. |
TableCell
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
appendHorizontalRule() | HorizontalRule | یک HorizontalRule جدید ایجاد و اضافه می کند. |
appendImage(image) | InlineImage | یک InlineImage جدید از حباب تصویر مشخص شده ایجاد و اضافه می کند. |
appendImage(image) | InlineImage | InlineImage داده شده را اضافه می کند. |
appendListItem(listItem) | ListItem | ListItem داده شده را اضافه می کند. |
appendListItem(text) | ListItem | یک ListItem جدید ایجاد و اضافه می کند. |
appendParagraph(paragraph) | Paragraph | Paragraph داده شده را ضمیمه می کند. |
appendParagraph(text) | Paragraph | یک Paragraph جدید ایجاد و اضافه می کند. |
appendTable() | Table | یک Table جدید ایجاد و اضافه می کند. |
appendTable(cells) | Table | یک Table جدید حاوی سلول های مشخص شده اضافه می کند. |
appendTable(table) | Table | Table داده شده را ضمیمه می کند. |
clear() | TableCell | محتویات عنصر را پاک می کند. |
copy() | TableCell | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
editAsText() | Text | یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می کند. |
findElement(elementType) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند. |
findElement(elementType, from) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند، که از RangeElement مشخص شده شروع می شود. |
findText(searchPattern) | RangeElement | با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند. |
findText(searchPattern, from) | RangeElement | محتویات عنصر را برای الگوی متن مشخص شده، از یک نتیجه جستجوی معین شروع می کند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getBackgroundColor() | String | رنگ پس زمینه را بازیابی می کند. |
getChild(childIndex) | Element | عنصر فرزند را در نمایه فرزند مشخص شده بازیابی می کند. |
getChildIndex(child) | Integer | شاخص فرزند را برای عنصر فرزند مشخص شده بازیابی می کند. |
getColSpan() | Integer | دهانه ستون را بازیابی میکند، که تعداد ستونهای سلولهای جدول این سلول است. |
getLinkUrl() | String | آدرس لینک را بازیابی می کند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getNumChildren() | Integer | تعداد فرزندان را بازیابی می کند. |
getPaddingBottom() | Number | بالشتک پایین را به صورت امتیاز بازیابی می کند. |
getPaddingLeft() | Number | لایه سمت چپ را در نقاط بازیابی می کند. |
getPaddingRight() | Number | بالشتک مناسب را در نقاط بازیابی می کند. |
getPaddingTop() | Number | بالشتک بالا را به صورت امتیاز بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getParentRow() | TableRow | TableRow حاوی TableCell فعلی را بازیابی می کند. |
getParentTable() | Table | Table حاوی TableCell فعلی را بازیابی می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getRowSpan() | Integer | پهنای ردیف را بازیابی میکند، که تعداد ردیفهای سلولهای جدولی است که این سلول در آن قرار دارد. |
getText() | String | محتویات عنصر را به عنوان یک رشته متنی بازیابی می کند. |
getTextAlignment() | TextAlignment | تراز متن را دریافت می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
getVerticalAlignment() | VerticalAlignment | VerticalAlignment را بازیابی می کند. |
getWidth() | Number | عرض ستون حاوی سلول را در نقاط بازیابی می کند. |
insertHorizontalRule(childIndex) | HorizontalRule | یک HorizontalRule جدید در نمایه مشخص شده ایجاد و درج می کند. |
insertImage(childIndex, image) | InlineImage | یک InlineImage از حباب تصویر مشخص شده، در نمایه مشخص شده ایجاد و درج می کند. |
insertImage(childIndex, image) | InlineImage | InlineImage داده شده را در نمایه مشخص شده درج می کند. |
insertListItem(childIndex, listItem) | ListItem | ListItem داده شده را در نمایه مشخص شده درج می کند. |
insertListItem(childIndex, text) | ListItem | یک ListItem جدید را در فهرست مشخص شده ایجاد و درج می کند. |
insertParagraph(childIndex, paragraph) | Paragraph | Paragraph داده شده را در نمایه مشخص شده درج می کند. |
insertParagraph(childIndex, text) | Paragraph | یک Paragraph جدید را در نمایه مشخص شده ایجاد و درج می کند. |
insertTable(childIndex) | Table | یک Table جدید در نمایه مشخص شده ایجاد و درج می کند. |
insertTable(childIndex, cells) | Table | یک Table جدید حاوی سلول های مشخص شده را در نمایه مشخص شده ایجاد و درج می کند. |
insertTable(childIndex, table) | Table | Table داده شده را در شاخص مشخص شده درج می کند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
merge() | TableCell | عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند. |
removeChild(child) | TableCell | عنصر فرزند مشخص شده را حذف می کند. |
removeFromParent() | TableCell | عنصر را از والد خود حذف می کند. |
replaceText(searchPattern, replacement) | Element | با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین میکند. |
setAttributes(attributes) | TableCell | ویژگی های عنصر را تنظیم می کند. |
setBackgroundColor(color) | TableCell | رنگ پس زمینه را تنظیم می کند. |
setLinkUrl(url) | TableCell | آدرس لینک را تنظیم می کند. |
setPaddingBottom(paddingBottom) | TableCell | بالشتک پایین را بر حسب نقاط تنظیم می کند. |
setPaddingLeft(paddingLeft) | TableCell | بالشتک سمت چپ را در نقاط تنظیم می کند. |
setPaddingRight(paddingRight) | TableCell | بالشتک مناسب را در نقاط تنظیم می کند. |
setPaddingTop(paddingTop) | TableCell | بالشتک بالا را در نقاط تنظیم می کند. |
setText(text) | TableCell | محتویات را به صورت متن ساده تنظیم می کند. |
setTextAlignment(textAlignment) | TableCell | تراز متن را تنظیم می کند. |
setVerticalAlignment(alignment) | TableCell | تراز عمودی را تنظیم می کند. |
setWidth(width) | TableCell | عرض ستون حاوی سلول فعلی را بر حسب نقطه تنظیم می کند. |
TableOfContents
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
clear() | TableOfContents | محتویات عنصر را پاک می کند. |
copy() | TableOfContents | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
editAsText() | Text | یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می کند. |
findElement(elementType) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند. |
findElement(elementType, from) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند، که از RangeElement مشخص شده شروع می شود. |
findText(searchPattern) | RangeElement | با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند. |
findText(searchPattern, from) | RangeElement | محتویات عنصر را برای الگوی متن مشخص شده، از یک نتیجه جستجوی معین شروع می کند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getChild(childIndex) | Element | عنصر فرزند را در نمایه فرزند مشخص شده بازیابی می کند. |
getChildIndex(child) | Integer | شاخص فرزند را برای عنصر فرزند مشخص شده بازیابی می کند. |
getLinkUrl() | String | آدرس لینک را بازیابی می کند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getNumChildren() | Integer | تعداد فرزندان را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getText() | String | محتویات عنصر را به عنوان یک رشته متنی بازیابی می کند. |
getTextAlignment() | TextAlignment | تراز متن را دریافت می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
removeFromParent() | TableOfContents | عنصر را از والد خود حذف می کند. |
replaceText(searchPattern, replacement) | Element | با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین میکند. |
setAttributes(attributes) | TableOfContents | ویژگی های عنصر را تنظیم می کند. |
setLinkUrl(url) | TableOfContents | آدرس لینک را تنظیم می کند. |
setTextAlignment(textAlignment) | TableOfContents | تراز متن را تنظیم می کند. |
TableRow
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
appendTableCell() | TableCell | یک TableCell جدید ایجاد و اضافه می کند. |
appendTableCell(textContents) | TableCell | TableCell داده شده را حاوی متن مشخص شده اضافه می کند. |
appendTableCell(tableCell) | TableCell | TableCell داده شده را اضافه می کند. |
clear() | TableRow | محتویات عنصر را پاک می کند. |
copy() | TableRow | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
editAsText() | Text | یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می کند. |
findElement(elementType) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند. |
findElement(elementType, from) | RangeElement | محتویات عنصر را برای یک نسل از نوع مشخص شده جستجو می کند، که از RangeElement مشخص شده شروع می شود. |
findText(searchPattern) | RangeElement | با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند. |
findText(searchPattern, from) | RangeElement | محتویات عنصر را برای الگوی متن مشخص شده، از یک نتیجه جستجوی معین شروع می کند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getCell(cellIndex) | TableCell | TableCell در نمایه سلول مشخص شده بازیابی می کند. |
getChild(childIndex) | Element | عنصر فرزند را در نمایه فرزند مشخص شده بازیابی می کند. |
getChildIndex(child) | Integer | شاخص فرزند را برای عنصر فرزند مشخص شده بازیابی می کند. |
getLinkUrl() | String | آدرس لینک را بازیابی می کند. |
getMinimumHeight() | Number | حداقل ارتفاع را بر حسب امتیاز بازیابی می کند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getNumCells() | Integer | تعداد سلول های ردیف را بازیابی می کند. |
getNumChildren() | Integer | تعداد فرزندان را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getParentTable() | Table | Table حاوی ردیف فعلی را بازیابی می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getText() | String | محتویات عنصر را به عنوان یک رشته متنی بازیابی می کند. |
getTextAlignment() | TextAlignment | تراز متن را دریافت می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
insertTableCell(childIndex) | TableCell | یک TableCell جدید را در نمایه مشخص شده ایجاد و درج می کند. |
insertTableCell(childIndex, textContents) | TableCell | TableCell داده شده را در نمایه مشخص شده، حاوی متن داده شده، درج می کند. |
insertTableCell(childIndex, tableCell) | TableCell | TableCell داده شده را در شاخص مشخص شده درج می کند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
merge() | TableRow | عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند. |
removeCell(cellIndex) | TableCell | TableCell در نمایه سلول مشخص شده حذف می کند. |
removeChild(child) | TableRow | عنصر فرزند مشخص شده را حذف می کند. |
removeFromParent() | TableRow | عنصر را از والد خود حذف می کند. |
replaceText(searchPattern, replacement) | Element | با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین میکند. |
setAttributes(attributes) | TableRow | ویژگی های عنصر را تنظیم می کند. |
setLinkUrl(url) | TableRow | آدرس لینک را تنظیم می کند. |
setMinimumHeight(minHeight) | TableRow | حداقل ارتفاع را بر حسب امتیاز تنظیم می کند. |
setTextAlignment(textAlignment) | TableRow | تراز متن را تنظیم می کند. |
Text
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
appendText(text) | Text | متن مشخص شده را به انتهای این منطقه متن اضافه می کند. |
copy() | Text | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
deleteText(startOffset, endOffsetInclusive) | Text | محدوده ای از متن را حذف می کند. |
editAsText() | Text | یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می کند. |
findText(searchPattern) | RangeElement | با استفاده از عبارات منظم، محتویات عنصر را برای الگوی متن مشخص شده جستجو می کند. |
findText(searchPattern, from) | RangeElement | محتویات عنصر را برای الگوی متن مشخص شده، از یک نتیجه جستجوی معین شروع می کند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getAttributes(offset) | Object | ویژگی ها را در افست کاراکتر مشخص شده بازیابی می کند. |
getBackgroundColor() | String | تنظیمات رنگ پس زمینه را بازیابی می کند. |
getBackgroundColor(offset) | String | رنگ پس زمینه را با افست کاراکتر مشخص شده بازیابی می کند. |
getFontFamily() | String | تنظیم خانواده فونت را بازیابی می کند. |
getFontFamily(offset) | String | خانواده فونت را در افست کاراکتر مشخص شده بازیابی می کند. |
getFontSize() | Number | تنظیم اندازه فونت را بازیابی می کند. |
getFontSize(offset) | Number | اندازه فونت را با افست کاراکتر مشخص شده بازیابی می کند. |
getForegroundColor() | String | تنظیم رنگ پیش زمینه را بازیابی می کند. |
getForegroundColor(offset) | String | رنگ پیش زمینه را در افست کاراکتر مشخص شده بازیابی می کند. |
getLinkUrl() | String | آدرس لینک را بازیابی می کند. |
getLinkUrl(offset) | String | URL پیوند را در فاصله کاراکتر مشخص شده بازیابی می کند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getText() | String | محتویات عنصر را به عنوان یک رشته متنی بازیابی می کند. |
getTextAlignment() | TextAlignment | تراز متن را دریافت می کند. |
getTextAlignment(offset) | TextAlignment | تراز متن را برای یک کاراکتر دریافت می کند. |
getTextAttributeIndices() | Integer[] | مجموعه ای از شاخص های متن را که با شروع اجراهای قالب بندی متن متمایز مطابقت دارند، بازیابی می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
insertText(offset, text) | Text | متن مشخص شده را در افست کاراکتر داده شده درج می کند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
isBold() | Boolean | تنظیم پررنگ را بازیابی می کند. |
isBold(offset) | Boolean | تنظیم پررنگ را در افست کاراکتر مشخص شده بازیابی می کند. |
isItalic() | Boolean | تنظیمات ایتالیک را بازیابی می کند. |
isItalic(offset) | Boolean | تنظیمات ایتالیک را در افست کاراکتر مشخص شده بازیابی می کند. |
isStrikethrough() | Boolean | تنظیم خط خطی را بازیابی می کند. |
isStrikethrough(offset) | Boolean | تنظیم خط خطی را در افست کاراکتر مشخص شده بازیابی می کند. |
isUnderline() | Boolean | تنظیم زیر خط را بازیابی می کند. |
isUnderline(offset) | Boolean | تنظیم زیر خط را در افست کاراکتر مشخص شده بازیابی می کند. |
merge() | Text | عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند. |
removeFromParent() | Text | عنصر را از والد خود حذف می کند. |
replaceText(searchPattern, replacement) | Element | با استفاده از عبارات منظم، تمام رخدادهای یک الگوی متنی را با یک رشته جایگزین معین جایگزین میکند. |
setAttributes(startOffset, endOffsetInclusive, attributes) | Text | ویژگی های مشخص شده را در محدوده کاراکتر داده شده اعمال می کند. |
setAttributes(attributes) | Text | ویژگی های عنصر را تنظیم می کند. |
setBackgroundColor(startOffset, endOffsetInclusive, color) | Text | رنگ پس زمینه را برای محدوده کاراکتر مشخص شده تنظیم می کند. |
setBackgroundColor(color) | Text | رنگ پس زمینه را تنظیم می کند. |
setBold(bold) | Text | تنظیم پررنگ را تنظیم می کند. |
setBold(startOffset, endOffsetInclusive, bold) | Text | تنظیم پررنگ را برای محدوده کاراکتر مشخص شده تنظیم می کند. |
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName) | Text | خانواده فونت را برای محدوده کاراکتر مشخص شده تنظیم می کند. |
setFontFamily(fontFamilyName) | Text | خانواده فونت را تنظیم می کند. |
setFontSize(startOffset, endOffsetInclusive, size) | Text | اندازه قلم را برای محدوده کاراکتر مشخص شده تنظیم می کند. |
setFontSize(size) | Text | اندازه فونت را تنظیم می کند. |
setForegroundColor(startOffset, endOffsetInclusive, color) | Text | رنگ پیش زمینه را برای محدوده کاراکتر مشخص شده تنظیم می کند. |
setForegroundColor(color) | Text | رنگ پیش زمینه را تنظیم می کند. |
setItalic(italic) | Text | تنظیمات ایتالیک را تنظیم می کند. |
setItalic(startOffset, endOffsetInclusive, italic) | Text | تنظیمات ایتالیک را برای محدوده کاراکتر مشخص شده تنظیم می کند. |
setLinkUrl(startOffset, endOffsetInclusive, url) | Text | URL پیوند را برای محدوده کاراکتر مشخص شده تنظیم می کند. |
setLinkUrl(url) | Text | آدرس لینک را تنظیم می کند. |
setStrikethrough(strikethrough) | Text | تنظیم خط خطی را تنظیم می کند. |
setStrikethrough(startOffset, endOffsetInclusive, strikethrough) | Text | تنظیم خط خطی را برای محدوده کاراکتر مشخص شده تنظیم می کند. |
setText(text) | Text | محتوای متن را تنظیم می کند. |
setTextAlignment(startOffset, endOffsetInclusive, textAlignment) | Text | تراز متن را برای یک محدوده کاراکتر معین تنظیم می کند. |
setTextAlignment(textAlignment) | Text | تراز متن را تنظیم می کند. |
setUnderline(underline) | Text | تنظیم زیر خط را تنظیم می کند. |
setUnderline(startOffset, endOffsetInclusive, underline) | Text | تنظیم زیر خط را برای محدوده کاراکتر مشخص شده تنظیم می کند. |
TextAlignment
خواص
اموال | تایپ کنید | توضیحات |
---|---|---|
NORMAL | Enum | تراز معمولی متن |
SUPERSCRIPT | Enum | تراز متن بالانویس. |
SUBSCRIPT | Enum | تراز متن زیرنویس. |
UnsupportedElement
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
copy() | UnsupportedElement | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
merge() | UnsupportedElement | عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند. |
removeFromParent() | UnsupportedElement | عنصر را از والد خود حذف می کند. |
setAttributes(attributes) | UnsupportedElement | ویژگی های عنصر را تنظیم می کند. |
VerticalAlignment
خواص
اموال | تایپ کنید | توضیحات |
---|---|---|
BOTTOM | Enum | گزینه تراز پایین. |
CENTER | Enum | گزینه تراز وسط. |
TOP | Enum | گزینه تراز بالا. |