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אובייקט שמייצג סימנייה.
ContainerElementרכיב כללי שיכול להכיל רכיבים אחרים.
Dateרכיב שמייצג תאריך מפורמט
Documentמסמך שמכיל אובייקט Tab אחד או יותר, שכל אחד מהם מכיל טקסט עשיר ורכיבים כמו טבלאות ורשימות.
DocumentAppשירות המסמכים יוצר ופותח Documents שאפשר לערוך.
DocumentTabכרטיסיית מסמך שמכילה טקסט עשיר ורכיבים כמו טבלאות ורשימות.
Elementרכיב כללי.
ElementTypeרשימה של כל סוגי הרכיבים.
Equationרכיב שמייצג ביטוי מתמטי.
EquationFunctionרכיב שמייצג פונקציה ב-Equation מתמטית.
EquationFunctionArgumentSeparatorרכיב שמייצג מפריד פונקציות בביטוי מתמטי Equation.
EquationSymbolרכיב שמייצג סמל ב-Equation מתמטי.
FontFamilyרשימה של הגופנים הנתמכים.
FooterSectionרכיב שמייצג קטע של כותרת תחתונה.
Footnoteרכיב שמייצג הערת שוליים.
FootnoteSectionרכיב שמייצג קטע של הערות שוליים.
GlyphTypeרשימה של סוגי הגליפים הנתמכים.
HeaderSectionרכיב שמייצג קטע כותרת.
HorizontalAlignmentרשימה של סוגי היישור האופקי הנתמכים.
HorizontalRuleרכיב שמייצג קו אופקי.
InlineDrawingרכיב שמייצג ציור מוטמע.
InlineImageרכיב שמייצג תמונה מוטמעת.
ListItemרכיב שמייצג פריט ברשימה.
NamedRangeRange שיש לו שם ומזהה כדי לאפשר אחזור מאוחר יותר.
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_COLOREnumצבע הרקע של רכיב (פסקה, טבלה וכו') או של המסמך.
BOLDEnumהגדרת משקל הגופן, לטקסט עשיר.
BORDER_COLOREnumצבע הגבול של רכיבי הטבלה.
BORDER_WIDTHEnumרוחב הגבול בנקודות, עבור רכיבי טבלה.
CODEEnumתוכן הקוד, עבור רכיבי משוואה.
FONT_FAMILYEnumהגדרת משפחת הגופנים לטקסט עשיר.
FONT_SIZEEnumהגדרת גודל הגופן בנקודות, לטקסט עשיר.
FOREGROUND_COLOREnumהגדרת צבע החזית של טקסט עשיר.
HEADINGEnumסוג הכותרת, לרכיבי פסקה (לדוגמה, DocumentApp.ParagraphHeading.HEADING1).
HEIGHTEnumהגדרת הגובה של רכיבי תמונות.
HORIZONTAL_ALIGNMENTEnumהיישור האופקי, לרכיבי פסקה (לדוגמה, DocumentApp.HorizontalAlignment.CENTER).
INDENT_ENDEnumהגדרת הכניסה של סוף הפסקה בנקודות, עבור רכיבי פסקה.
INDENT_FIRST_LINEEnumהגדרת הכניסה של השורה הראשונה בנקודות, עבור רכיבי פסקה.
INDENT_STARTEnumהגדרת הכניסה לתחילת הפסקה בנקודות, עבור רכיבי פסקה.
ITALICEnumהגדרת סגנון הגופן, לטקסט עשיר.
GLYPH_TYPEEnumסוג הגליף, עבור רכיבי פריטים ברשימה.
LEFT_TO_RIGHTEnumההגדרה של כיוון הטקסט, לטקסט עשיר.
LINE_SPACINGEnumהגדרת הריווח בין השורות כמכפיל, עבור רכיבי פסקה.
LINK_URLEnumכתובת ה-URL של הקישור, לטקסט עשיר.
LIST_IDEnumהמזהה של הרשימה המכילה, עבור רכיבי פריטים ברשימה.
MARGIN_BOTTOMEnumהגדרת השוליים התחתונים בנקודות, עבור אלמנטים של פסקה.
MARGIN_LEFTEnumהגדרת השוליים השמאליים בנקודות, עבור רכיבי פסקה.
MARGIN_RIGHTEnumהגדרת השוליים הימניים בנקודות, עבור רכיבי פסקה.
MARGIN_TOPEnumהגדרת השוליים העליונים בנקודות, עבור רכיבי פסקה.
NESTING_LEVELEnumרמת הקינון של הפריט, עבור רכיבי פריט ברשימה.
MINIMUM_HEIGHTEnumהגדרת הגובה המינימלי בנקודות, עבור רכיבי שורות בטבלה.
PADDING_BOTTOMEnumהגדרת המרווח הפנימי התחתון בנקודות, עבור רכיבי תא בטבלה.
PADDING_LEFTEnumהגדרת המרווח הפנימי השמאלי בנקודות, עבור רכיבי תא בטבלה.
PADDING_RIGHTEnumהגדרת המרווח הפנימי הימני בנקודות, עבור רכיבי תאים בטבלה.
PADDING_TOPEnumהגדרת המרווח הפנימי העליון בנקודות, עבור רכיבי תא בטבלה.
PAGE_HEIGHTEnumהגדרת גובה הדף בנקודות, למסמכים.
PAGE_WIDTHEnumהגדרת רוחב הדף בנקודות, למסמכים.
SPACING_AFTEREnumהגדרת המרווח התחתון בנקודות, עבור רכיבי פסקה.
SPACING_BEFOREEnumהגדרת המרווח העליון בנקודות, לרכיבי פסקה.
STRIKETHROUGHEnumההגדרה של קו חוצה, לטקסט עשיר.
UNDERLINEEnumההגדרה של קו תחתון, לטקסט עשיר.
VERTICAL_ALIGNMENTEnumהגדרת היישור האנכי של רכיבי תאים בטבלה.
WIDTHEnumהגדרת הרוחב של תאי טבלה ורכיבי תמונה.

Body

Methods

שיטהסוג הערך שמוחזרתיאור קצר
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|nullמחפש בתוכן של הרכיב צאצא מסוג מסוים.
findElement(elementType, from)RangeElement|nullהפונקציה מחפשת בתוכן של הרכיב צאצא מסוג מסוים, החל מRangeElement שצוין.
findText(searchPattern)RangeElement|nullמחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים.
findText(searchPattern, from)RangeElement|nullמחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getChild(childIndex)Elementמאחזר את רכיב הצאצא באינדקס הצאצא שצוין.
getChildIndex(child)Integerמאחזר את אינדקס הצאצא של רכיב הצאצא שצוין.
getHeadingAttributes(paragraphHeading)Objectהפונקציה מאחזרת את קבוצת המאפיינים של ParagraphHeading שצוין.
getImages()InlineImage[]|nullמאחזר את כל ה-InlineImages שמופיעים בקטע.
getListItems()ListItem[]|nullמאחזר את כל ה-ListItems שמופיעים בקטע.
getMarginBottom()Number|nullהפונקציה מאחזרת את השוליים התחתונים, בנקודות.
getMarginLeft()Number|nullמאחזרת את השוליים השמאליים, בנקודות.
getMarginRight()Number|nullמאחזר את השוליים הימניים.
getMarginTop()Number|nullהפונקציה מחזירה את השוליים העליונים.
getNumChildren()Integerמאחזר את מספר הילדים.
getPageHeight()Number|nullמאחזר את גובה הדף, בנקודות.
getPageWidth()Number|nullמאחזר את רוחב הדף, בנקודות.
getParagraphs()Paragraph[]|nullמאחזר את כל ה-Paragraphs שמופיעים בקטע (כולל ListItems).
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getTables()Table[]|nullמאחזר את כל ה-Tables שמופיעים בקטע.
getText()Stringמאחזרת את התוכן של הרכיב כמחרוזת טקסט.
getTextAlignment()TextAlignment|nullמקבל את יישור הטקסט.
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

Methods

שיטהסוג הערך שמוחזרתיאור קצר
getId()Stringהפונקציה מחזירה את המזהה של Bookmark.
getPosition()Positionהפונקציה מקבלת את Position של Bookmark בתוך DocumentTab.
remove()voidמחיקת Bookmark.

ContainerElement

Methods

שיטהסוג הערך שמוחזרתיאור קצר
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|nullמחפש בתוכן של הרכיב צאצא מסוג מסוים.
findElement(elementType, from)RangeElement|nullהפונקציה מחפשת בתוכן של הרכיב צאצא מסוג מסוים, החל מRangeElement שצוין.
findText(searchPattern)RangeElement|nullמחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים.
findText(searchPattern, from)RangeElement|nullמחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getChild(childIndex)Elementמאחזר את רכיב הצאצא באינדקס הצאצא שצוין.
getChildIndex(child)Integerמאחזר את אינדקס הצאצא של רכיב הצאצא שצוין.
getLinkUrl()String|nullהפונקציה מחזירה את כתובת ה-URL של הקישור.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getNumChildren()Integerמאחזר את מספר הילדים.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getText()Stringמאחזרת את התוכן של הרכיב כמחרוזת טקסט.
getTextAlignment()TextAlignment|nullמקבל את יישור הטקסט.
getType()ElementTypeאחזור ElementType של הרכיב.
isAtDocumentEnd()Booleanההגדרה קובעת אם הרכיב נמצא בסוף Document.
merge()ContainerElement|nullמיזוג הרכיב עם הרכיב הקודם מאותו סוג.
removeFromParent()ContainerElement|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
replaceText(searchPattern, replacement)Elementהפונקציה מחליפה את כל המופעים של תבנית טקסט נתונה במחרוזת חלופית נתונה, באמצעות ביטויים רגולריים.
setAttributes(attributes)ContainerElementהגדרת המאפיינים של האלמנט.
setLinkUrl(url)ContainerElementמגדיר את כתובת ה-URL של הקישור.
setTextAlignment(textAlignment)ContainerElementהגדרת יישור הטקסט.

Date

Methods

שיטהסוג הערך שמוחזרתיאור קצר
copy()Dateמחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getDisplayText()Stringהפונקציה מחזירה את ערך התצוגה שמוצג במסמך.
getLocale()Stringהפונקציה מחזירה את הלוקאל של התאריך שמשמש לערך התצוגה.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getTimestamp()Dateהפונקציה מחזירה את חותמת הזמן שמשויכת לתאריך.
getType()ElementTypeאחזור ElementType של הרכיב.
isAtDocumentEnd()Booleanההגדרה קובעת אם הרכיב נמצא בסוף Document.
merge()Date|nullמיזוג הרכיב עם הרכיב הקודם מאותו סוג.
removeFromParent()Date|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
setAttributes(attributes)Dateהגדרת המאפיינים של האלמנט.

Document

Methods

שיטהסוג הערך שמוחזרתיאור קצר
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 כ-blob מהסוג שצוין.
getBlob()Blobמאחזר את התוכן הנוכחי של Document כ-blob.
getBody()Bodyהפונקציה מחזירה את Body של הכרטיסייה הראשונה, או את DocumentBodySection של הכרטיסייה הפעילה אם הסקריפט מאוגד למסמך.
getBookmark(id)Bookmark|nullמחזירה את Bookmark עם המזהה שצוין בכרטיסייה הראשונה, או בכרטיסייה הפעילה אם מדובר בסקריפטים מאוגדים למסמך.
getBookmarks()Bookmark[]מחזירה את כל האובייקטים Bookmark בכרטיסייה הראשונה, או בכרטיסייה הפעילה אם הסקריפט מאוגד למסמך.
getCursor()Position|nullמקבל את מיקום הסמן של המשתמש בכרטיסייה הפעילה.
getEditors()User[]מקבל את רשימת העורכים של Document.
getFooter()FooterSection|nullהפונקציה מחזירה את קטע הכותרת התחתונה של הכרטיסייה הראשונה, או את קטע הכותרת התחתונה של הכרטיסייה הפעילה בסקריפטים מאוגדים למסמך.
getFootnotes()Footnote[]|nullמאחזר את כל רכיבי Footnote בגוף של הכרטיסייה הראשונה, או בגוף של הכרטיסייה הפעילה בסקריפטים שמאוגדים למסמך.
getHeader()HeaderSection|nullמחזירה את קטע הכותרת של הכרטיסייה הראשונה, או של הכרטיסייה הפעילה בסקריפטים מאוגדים למסמך.
getId()Stringמאחזר את המזהה הייחודי של המסמך.
getLanguage()Stringמקבל את קוד השפה של המסמך.
getName()Stringהפונקציה מחזירה את הכותרת של המסמך.
getNamedRangeById(id)NamedRange|nullמחזירה את NamedRange עם המזהה שצוין בכרטיסייה הראשונה, או בכרטיסייה הפעילה אם מדובר בסקריפטים מאוגדים למסמך.
getNamedRanges()NamedRange[]מחזירה את כל האובייקטים NamedRange בכרטיסייה הראשונה, או בכרטיסייה הפעילה אם הסקריפט מאוגד למסמך.
getNamedRanges(name)NamedRange[]מחזירה את כל אובייקטי NamedRange עם השם שצוין בכרטיסייה הראשונה, או בכרטיסייה הפעילה אם הסקריפט מקשר למסמך.
getSelection()Range|nullמקבל את הבחירה של המשתמש בכרטיסייה הפעילה.
getSupportedLanguageCodes()String[]מחזירה את כל קודי השפות שנתמכים בקובצי Google Docs.
getTab(tabId)Tabמקבל את Tab עם המזהה שצוין.
getTabs()Tab[]מחזירה את כל התגים Tab שלא מוטמעים בתגים אחרים, שמופיעים במסמך.
getUrl()Stringמחזירה את כתובת ה-URL לגישה למסמך הנוכחי.
getViewers()User[]מחזירה את רשימת הצופים והמגיבים של Document.
newPosition(element, offset)Positionיוצרת Position חדש, שהוא הפניה למיקום בכרטיסייה, ביחס לרכיב ספציפי בכרטיסייה הראשונה או, עבור סקריפטים מאוגדים למסמך, הכרטיסייה הפעילה.
newRange()RangeBuilderיוצר אובייקט builder שמשמש ליצירת אובייקטים מסוג 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

מאפיינים

נכססוגתיאור
AttributeAttributeהספירה Attribute.
ElementTypeElementTypeהספירה ElementType.
FontFamilyFontFamilyהספירה FontFamily.
GlyphTypeGlyphTypeהספירה GlyphType.
HorizontalAlignmentHorizontalAlignmentהספירה HorizontalAlignment.
ParagraphHeadingParagraphHeadingהספירה ParagraphHeading.
PositionedLayoutPositionedLayoutהספירה PositionedLayout.
TextAlignmentTextAlignmentהספירה TextAlignment.
VerticalAlignmentVerticalAlignmentהספירה VerticalAlignment.

Methods

שיטהסוג הערך שמוחזרתיאור קצר
create(name)Documentיוצר ומחזיר מסמך חדש.
getActiveDocument()Documentהפונקציה מחזירה את המסמך שאליו הסקריפט משויך.
getUi()Uiהפונקציה מחזירה מופע של סביבת ממשק המשתמש של המסמך, שמאפשר לסקריפט להוסיף תכונות כמו תפריטים, תיבות דו-שיח וסרגלי צד.
openById(id)Documentהפונקציה מחזירה את המסמך עם המזהה שצוין.
openByUrl(url)Documentפותחת את המסמך עם כתובת ה-URL שצוינה ומחזירה אותו.

DocumentTab

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addBookmark(position)Bookmarkהפונקציה מוסיפה Bookmark ב-Position שצוין.
addFooter()FooterSectionמוסיף קטע של כותרת תחתונה לכרטיסייה, אם לא קיים כזה.
addHeader()HeaderSectionמוסיף קטע של כותרת לכרטיסייה, אם לא קיים כזה.
addNamedRange(name, range)NamedRangeמוסיף NamedRange, שהוא Range עם שם ומזהה לשימוש באחזור מאוחר יותר.
getBody()Bodyמאחזר את Body של הכרטיסייה.
getBookmark(id)Bookmark|nullמקבל את Bookmark עם המזהה הנתון.
getBookmarks()Bookmark[]מקבל את כל האובייקטים של Bookmark בכרטיסייה.
getFooter()FooterSection|nullמאחזר את קטע הכותרת התחתונה של הכרטיסייה, אם קיים.
getFootnotes()Footnote[]|nullהפונקציה מאחזרת את כל רכיבי Footnote בגוף הכרטיסייה.
getHeader()HeaderSection|nullמחזירה את קטע הכותרת של הכרטיסייה, אם קיים.
getNamedRangeById(id)NamedRange|nullמקבל את NamedRange עם המזהה הנתון.
getNamedRanges()NamedRange[]מקבל את כל האובייקטים של NamedRange בכרטיסייה.
getNamedRanges(name)NamedRange[]מחזירה את כל האובייקטים מסוג NamedRange בכרטיסייה עם השם שצוין.
newPosition(element, offset)Positionיוצרת אובייקט Position חדש, שהוא הפניה למיקום בכרטיסייה, ביחס לרכיב ספציפי.
newRange()RangeBuilderיוצרת כלי לבנייה שמשמש ליצירת אובייקטים מסוג Range מרכיבי כרטיסיות.

Element

Methods

שיטהסוג הערך שמוחזרתיאור קצר
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 Sheets.
asTable()Tableמחזירה את הרכיב הנוכחי כ-Table.
asTableCell()TableCellמחזירה את הרכיב הנוכחי כ-TableCell.
asTableOfContents()TableOfContentsמחזירה את הרכיב הנוכחי כ-TableOfContents.
asTableRow()TableRowמחזירה את הרכיב הנוכחי כ-TableRow.
asText()Textמחזירה את הרכיב הנוכחי כ-Text.
copy()Elementמחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getType()ElementTypeאחזור ElementType של הרכיב.
isAtDocumentEnd()Booleanההגדרה קובעת אם הרכיב נמצא בסוף Document.
merge()Element|nullמיזוג הרכיב עם הרכיב הקודם מאותו סוג.
removeFromParent()Element|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
setAttributes(attributes)Elementהגדרת המאפיינים של האלמנט.

ElementType

מאפיינים

נכססוגתיאור
BODY_SECTIONEnumהסוג שמתאים לרכיב Body.
COMMENT_SECTIONEnumהסוג שמתאים לרכיב CommentSection.
DATEEnumהסוג שמתאים לרכיב Date.
EQUATIONEnumהסוג שמתאים לרכיב Equation.
EQUATION_FUNCTIONEnumהסוג שמתאים לרכיב EquationFunction.
EQUATION_FUNCTION_ARGUMENT_SEPARATOREnumהסוג שמתאים לרכיב EquationFunctionArgumentSeparator.
EQUATION_SYMBOLEnumהסוג שמתאים לרכיב EquationSymbol.
RICH_LINKEnumהסוג שמתאים לרכיב RichLink.
FOOTER_SECTIONEnumהסוג שמתאים לרכיב FooterSection.
FOOTNOTEEnumהסוג שמתאים לרכיב Footnote.
FOOTNOTE_SECTIONEnumהסוג שמתאים לרכיב FootnoteSection.
HEADER_SECTIONEnumהסוג שמתאים לרכיב HeaderSection.
HORIZONTAL_RULEEnumהסוג שמתאים לרכיב HorizontalRule.
INLINE_DRAWINGEnumהסוג שמתאים לרכיב InlineDrawing.
INLINE_IMAGEEnumהסוג שמתאים לרכיב InlineImage.
LIST_ITEMEnumהסוג שמתאים לרכיב ListItem.
PAGE_BREAKEnumהסוג שמתאים לרכיב PageBreak.
PARAGRAPHEnumהסוג שמתאים לרכיב Paragraph.
PERSONEnumהסוג שמתאים לרכיב Person.
TABLEEnumהסוג שמתאים לרכיב Table.
TABLE_CELLEnumהסוג שמתאים לרכיב TableCell.
TABLE_OF_CONTENTSEnumהסוג שמתאים לרכיב TableOfContents.
TABLE_ROWEnumהסוג שמתאים לרכיב TableRow.
TEXTEnumהסוג שמתאים לרכיב Text.
UNSUPPORTEDEnumהסוג שמתאים ל-UnsupportedElement.

Equation

Methods

שיטהסוג הערך שמוחזרתיאור קצר
clear()Equationמחיקת התוכן של הרכיב.
copy()Equationמחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
editAsText()Textמקבלים גרסה Text של הרכיב הנוכחי לצורך עריכה.
findElement(elementType)RangeElement|nullמחפש בתוכן של הרכיב צאצא מסוג מסוים.
findElement(elementType, from)RangeElement|nullהפונקציה מחפשת בתוכן של הרכיב צאצא מסוג מסוים, החל מRangeElement שצוין.
findText(searchPattern)RangeElement|nullמחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים.
findText(searchPattern, from)RangeElement|nullמחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getChild(childIndex)Elementמאחזר את רכיב הצאצא באינדקס הצאצא שצוין.
getChildIndex(child)Integerמאחזר את אינדקס הצאצא של רכיב הצאצא שצוין.
getLinkUrl()String|nullהפונקציה מחזירה את כתובת ה-URL של הקישור.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getNumChildren()Integerמאחזר את מספר הילדים.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getText()Stringמאחזרת את התוכן של הרכיב כמחרוזת טקסט.
getTextAlignment()TextAlignment|nullמקבל את יישור הטקסט.
getType()ElementTypeאחזור ElementType של הרכיב.
isAtDocumentEnd()Booleanההגדרה קובעת אם הרכיב נמצא בסוף Document.
merge()Equation|nullמיזוג הרכיב עם הרכיב הקודם מאותו סוג.
removeFromParent()Equation|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
replaceText(searchPattern, replacement)Elementהפונקציה מחליפה את כל המופעים של תבנית טקסט נתונה במחרוזת חלופית נתונה, באמצעות ביטויים רגולריים.
setAttributes(attributes)Equationהגדרת המאפיינים של האלמנט.
setLinkUrl(url)Equationמגדיר את כתובת ה-URL של הקישור.
setTextAlignment(textAlignment)Equationהגדרת יישור הטקסט.

EquationFunction

Methods

שיטהסוג הערך שמוחזרתיאור קצר
clear()EquationFunctionמחיקת התוכן של הרכיב.
copy()EquationFunctionמחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
editAsText()Textמקבלים גרסה Text של הרכיב הנוכחי לצורך עריכה.
findElement(elementType)RangeElement|nullמחפש בתוכן של הרכיב צאצא מסוג מסוים.
findElement(elementType, from)RangeElement|nullהפונקציה מחפשת בתוכן של הרכיב צאצא מסוג מסוים, החל מRangeElement שצוין.
findText(searchPattern)RangeElement|nullמחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים.
findText(searchPattern, from)RangeElement|nullמחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getChild(childIndex)Elementמאחזר את רכיב הצאצא באינדקס הצאצא שצוין.
getChildIndex(child)Integerמאחזר את אינדקס הצאצא של רכיב הצאצא שצוין.
getCode()Stringמאחזר את הקוד שמתאים לפונקציית המשוואה.
getLinkUrl()String|nullהפונקציה מחזירה את כתובת ה-URL של הקישור.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getNumChildren()Integerמאחזר את מספר הילדים.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getText()Stringמאחזרת את התוכן של הרכיב כמחרוזת טקסט.
getTextAlignment()TextAlignment|nullמקבל את יישור הטקסט.
getType()ElementTypeאחזור ElementType של הרכיב.
isAtDocumentEnd()Booleanההגדרה קובעת אם הרכיב נמצא בסוף Document.
merge()EquationFunction|nullמיזוג הרכיב עם הרכיב הקודם מאותו סוג.
removeFromParent()EquationFunction|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
replaceText(searchPattern, replacement)Elementהפונקציה מחליפה את כל המופעים של תבנית טקסט נתונה במחרוזת חלופית נתונה, באמצעות ביטויים רגולריים.
setAttributes(attributes)EquationFunctionהגדרת המאפיינים של האלמנט.
setLinkUrl(url)EquationFunctionמגדיר את כתובת ה-URL של הקישור.
setTextAlignment(textAlignment)EquationFunctionהגדרת יישור הטקסט.

EquationFunctionArgumentSeparator

Methods

שיטהסוג הערך שמוחזרתיאור קצר
copy()EquationFunctionArgumentSeparatorמחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getType()ElementTypeאחזור ElementType של הרכיב.
isAtDocumentEnd()Booleanההגדרה קובעת אם הרכיב נמצא בסוף Document.
merge()EquationFunctionArgumentSeparator|nullמיזוג הרכיב עם הרכיב הקודם מאותו סוג.
removeFromParent()EquationFunctionArgumentSeparator|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
setAttributes(attributes)EquationFunctionArgumentSeparatorהגדרת המאפיינים של האלמנט.

EquationSymbol

Methods

שיטהסוג הערך שמוחזרתיאור קצר
copy()EquationSymbolמחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getCode()Stringמאחזרת את הקוד שמתאים לסמל המשוואה.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getType()ElementTypeאחזור ElementType של הרכיב.
isAtDocumentEnd()Booleanההגדרה קובעת אם הרכיב נמצא בסוף Document.
merge()EquationSymbol|nullמיזוג הרכיב עם הרכיב הקודם מאותו סוג.
removeFromParent()EquationSymbol|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
setAttributes(attributes)EquationSymbolהגדרת המאפיינים של האלמנט.

FontFamily

FooterSection

Methods

שיטהסוג הערך שמוחזרתיאור קצר
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|nullמחפש בתוכן של הרכיב צאצא מסוג מסוים.
findElement(elementType, from)RangeElement|nullהפונקציה מחפשת בתוכן של הרכיב צאצא מסוג מסוים, החל מRangeElement שצוין.
findText(searchPattern)RangeElement|nullמחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים.
findText(searchPattern, from)RangeElement|nullמחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getChild(childIndex)Elementמאחזר את רכיב הצאצא באינדקס הצאצא שצוין.
getChildIndex(child)Integerמאחזר את אינדקס הצאצא של רכיב הצאצא שצוין.
getImages()InlineImage[]|nullמאחזר את כל ה-InlineImages שמופיעים בקטע.
getListItems()ListItem[]|nullמאחזר את כל ה-ListItems שמופיעים בקטע.
getNumChildren()Integerמאחזר את מספר הילדים.
getParagraphs()Paragraph[]|nullמאחזר את כל ה-Paragraphs שמופיעים בקטע (כולל ListItems).
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getTables()Table[]|nullמאחזר את כל ה-Tables שמופיעים בקטע.
getText()Stringמאחזרת את התוכן של הרכיב כמחרוזת טקסט.
getTextAlignment()TextAlignment|nullמקבל את יישור הטקסט.
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|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
replaceText(searchPattern, replacement)Elementהפונקציה מחליפה את כל המופעים של תבנית טקסט נתונה במחרוזת חלופית נתונה, באמצעות ביטויים רגולריים.
setAttributes(attributes)FooterSectionהגדרת המאפיינים של האלמנט.
setText(text)FooterSectionהגדרת התוכן כטקסט פשוט.
setTextAlignment(textAlignment)FooterSectionהגדרת יישור הטקסט.

Footnote

Methods

שיטהסוג הערך שמוחזרתיאור קצר
copy()Footnoteמחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getFootnoteContents()FootnoteSection|nullאחזור התוכן של רכיב הערת השוליים.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getType()ElementTypeאחזור ElementType של הרכיב.
isAtDocumentEnd()Booleanההגדרה קובעת אם הרכיב נמצא בסוף Document.
removeFromParent()Footnote|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
setAttributes(attributes)Footnoteהגדרת המאפיינים של האלמנט.

FootnoteSection

Methods

שיטהסוג הערך שמוחזרתיאור קצר
appendParagraph(paragraph)Paragraphהוספה של Paragraph שצוין.
appendParagraph(text)Paragraphיוצרת ומצרפת רכיב Paragraph חדש שמכיל את תוכן הטקסט שצוין.
clear()FootnoteSectionמחיקת התוכן של הרכיב.
copy()FootnoteSectionמחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
editAsText()Textמקבלים גרסה Text של הרכיב הנוכחי לצורך עריכה.
findElement(elementType)RangeElement|nullמחפש בתוכן של הרכיב צאצא מסוג מסוים.
findElement(elementType, from)RangeElement|nullהפונקציה מחפשת בתוכן של הרכיב צאצא מסוג מסוים, החל מRangeElement שצוין.
findText(searchPattern)RangeElement|nullמחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים.
findText(searchPattern, from)RangeElement|nullמחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getChild(childIndex)Elementמאחזר את רכיב הצאצא באינדקס הצאצא שצוין.
getChildIndex(child)Integerמאחזר את אינדקס הצאצא של רכיב הצאצא שצוין.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getNumChildren()Integerמאחזר את מספר הילדים.
getParagraphs()Paragraph[]|nullמאחזר את כל ה-Paragraphs שמופיעים בקטע (כולל ListItems).
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getText()Stringמאחזרת את התוכן של הרכיב כמחרוזת טקסט.
getTextAlignment()TextAlignment|nullמקבל את יישור הטקסט.
getType()ElementTypeאחזור ElementType של הרכיב.
insertParagraph(childIndex, paragraph)Paragraphהפונקציה מוסיפה את Paragraph שצוין באינדקס שצוין.
insertParagraph(childIndex, text)Paragraphיוצרת ומכניסה Paragraph חדש באינדקס שצוין, שמכיל את תוכן הטקסט שצוין.
removeChild(child)FootnoteSectionהסרת רכיב הבן שצוין.
removeFromParent()FootnoteSection|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
replaceText(searchPattern, replacement)Elementהפונקציה מחליפה את כל המופעים של תבנית טקסט נתונה במחרוזת חלופית נתונה, באמצעות ביטויים רגולריים.
setAttributes(attributes)FootnoteSectionהגדרת המאפיינים של האלמנט.
setText(text)FootnoteSectionהגדרת התוכן כטקסט פשוט.
setTextAlignment(textAlignment)FootnoteSectionהגדרת יישור הטקסט.

GlyphType

מאפיינים

נכססוגתיאור
BULLETEnumכברירת מחדל, התבליט הוא עיגול מלא.
HOLLOW_BULLETEnumתבליט חלול.
SQUARE_BULLETEnumתבליט מרובע.
NUMBEREnumתבליט עם מספר.
LATIN_UPPEREnumתבליט באות לטינית רישית.
LATIN_LOWEREnumתבליט לטיני באותיות קטנות.
ROMAN_UPPEREnumספרה רומית, תבליט באותיות רישיות.
ROMAN_LOWEREnumספרה רומית, תבליט באותיות קטנות.

HeaderSection

Methods

שיטהסוג הערך שמוחזרתיאור קצר
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|nullמחפש בתוכן של הרכיב צאצא מסוג מסוים.
findElement(elementType, from)RangeElement|nullהפונקציה מחפשת בתוכן של הרכיב צאצא מסוג מסוים, החל מRangeElement שצוין.
findText(searchPattern)RangeElement|nullמחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים.
findText(searchPattern, from)RangeElement|nullמחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getChild(childIndex)Elementמאחזר את רכיב הצאצא באינדקס הצאצא שצוין.
getChildIndex(child)Integerמאחזר את אינדקס הצאצא של רכיב הצאצא שצוין.
getImages()InlineImage[]|nullמאחזר את כל ה-InlineImages שמופיעים בקטע.
getListItems()ListItem[]|nullמאחזר את כל ה-ListItems שמופיעים בקטע.
getNumChildren()Integerמאחזר את מספר הילדים.
getParagraphs()Paragraph[]|nullמאחזר את כל ה-Paragraphs שמופיעים בקטע (כולל ListItems).
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getTables()Table[]|nullמאחזר את כל ה-Tables שמופיעים בקטע.
getText()Stringמאחזרת את התוכן של הרכיב כמחרוזת טקסט.
getTextAlignment()TextAlignment|nullמקבל את יישור הטקסט.
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|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
replaceText(searchPattern, replacement)Elementהפונקציה מחליפה את כל המופעים של תבנית טקסט נתונה במחרוזת חלופית נתונה, באמצעות ביטויים רגולריים.
setAttributes(attributes)HeaderSectionהגדרת המאפיינים של האלמנט.
setText(text)HeaderSectionהגדרת התוכן כטקסט פשוט.
setTextAlignment(textAlignment)HeaderSectionהגדרת יישור הטקסט.

HorizontalAlignment

מאפיינים

נכססוגתיאור
LEFTEnumאפשרות היישור לשמאל.
CENTEREnumאפשרות היישור למרכז.
RIGHTEnumהאפשרות ליישור לימין.
JUSTIFYEnumאפשרות היישור לשני הצדדים.

HorizontalRule

Methods

שיטהסוג הערך שמוחזרתיאור קצר
copy()HorizontalRuleמחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getType()ElementTypeאחזור ElementType של הרכיב.
isAtDocumentEnd()Booleanההגדרה קובעת אם הרכיב נמצא בסוף Document.
removeFromParent()HorizontalRule|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
setAttributes(attributes)HorizontalRuleהגדרת המאפיינים של האלמנט.

InlineDrawing

Methods

שיטהסוג הערך שמוחזרתיאור קצר
copy()InlineDrawingמחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
getAltDescription()String|nullמחזירה את התיאור החלופי של הציור.
getAltTitle()String|nullמחזירה את הכותרת החלופית של הציור.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getType()ElementTypeאחזור ElementType של הרכיב.
isAtDocumentEnd()Booleanההגדרה קובעת אם הרכיב נמצא בסוף Document.
merge()InlineDrawing|nullמיזוג הרכיב עם הרכיב הקודם מאותו סוג.
removeFromParent()InlineDrawing|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
setAltDescription(description)InlineDrawingההגדרה הזו קובעת את התיאור החלופי של הציור.
setAltTitle(title)InlineDrawingההגדרה הזו קובעת את הכותרת החלופית של הציור.
setAttributes(attributes)InlineDrawingהגדרת המאפיינים של האלמנט.

InlineImage

Methods

שיטהסוג הערך שמוחזרתיאור קצר
copy()InlineImageמחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
getAltDescription()String|nullהפונקציה מחזירה את התיאור החלופי של התמונה.
getAltTitle()String|nullהפונקציה מחזירה את הכותרת החלופית של התמונה.
getAs(contentType)Blobהחזרת הנתונים בתוך האובייקט הזה כ-Blob שהומר לסוג התוכן שצוין.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getBlob()Blobהחזרת הנתונים בתוך האובייקט הזה כ-blob.
getHeight()Integerמאחזר את גובה התמונה, בפיקסלים.
getLinkUrl()String|nullמאחזר את כתובת ה-URL של הקישור.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getType()ElementTypeאחזור ElementType של הרכיב.
getWidth()Integerמאחזר את רוחב התמונה, בפיקסלים.
isAtDocumentEnd()Booleanההגדרה קובעת אם הרכיב נמצא בסוף Document.
merge()InlineImage|nullמיזוג הרכיב עם הרכיב הקודם מאותו סוג.
removeFromParent()InlineImage|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
setAltDescription(description)InlineImageההגדרה הזו קובעת את התיאור החלופי של התמונה.
setAltTitle(title)InlineImageההגדרה הזו קובעת את הכותרת החלופית של התמונה.
setAttributes(attributes)InlineImageהגדרת המאפיינים של האלמנט.
setHeight(height)InlineImageהגובה של התמונה בפיקסלים.
setLinkUrl(url)InlineImageמגדיר את כתובת ה-URL של הקישור.
setWidth(width)InlineImageההגדרה הזו קובעת את רוחב התמונה בפיקסלים.

ListItem

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addPositionedImage(image)PositionedImageיוצר ומכניס PositionedImage חדש מ-blob התמונה שצוין.
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|nullמחפש בתוכן של הרכיב צאצא מסוג מסוים.
findElement(elementType, from)RangeElement|nullהפונקציה מחפשת בתוכן של הרכיב צאצא מסוג מסוים, החל מRangeElement שצוין.
findText(searchPattern)RangeElement|nullמחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים.
findText(searchPattern, from)RangeElement|nullמחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה.
getAlignment()HorizontalAlignment|nullמאחזר את HorizontalAlignment.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getChild(childIndex)Elementמאחזר את רכיב הצאצא באינדקס הצאצא שצוין.
getChildIndex(child)Integerמאחזר את אינדקס הצאצא של רכיב הצאצא שצוין.
getGlyphType()GlyphType|nullאחזור GlyphType של הפריט ברשימה.
getHeading()ParagraphHeading|nullמאחזר את ParagraphHeading.
getIndentEnd()Number|nullמאחזר את ההזחה בסוף, בנקודות.
getIndentFirstLine()Number|nullהפונקציה מאחזרת את גודל הכניסה של השורה הראשונה, בנקודות.
getIndentStart()Number|nullמחזירה את ההזחה של תחילת הפסקה.
getLineSpacing()Number|nullמאחזרת את הריווח בין השורות, בנקודות.
getLinkUrl()String|nullהפונקציה מחזירה את כתובת ה-URL של הקישור.
getListId()String|nullמאחזר את מזהה הרשימה.
getNestingLevel()Integerמאחזר את רמת הקינון של הפריט ברשימה.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getNumChildren()Integerמאחזר את מספר הילדים.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getPositionedImage(id)PositionedImageמקבלים PositionedImage לפי מזהה התמונה.
getPositionedImages()PositionedImage[]מקבל את כל אובייקטי PositionedImage שמעוגנים לפסקה.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getSpacingAfter()Number|nullמאחזר את הריווח אחרי הרכיב, בנקודות.
getSpacingBefore()Number|nullמחזירה את הריווח לפני הרכיב, בנקודות.
getText()Stringמאחזרת את התוכן של הרכיב כמחרוזת טקסט.
getTextAlignment()TextAlignment|nullמקבל את יישור הטקסט.
getType()ElementTypeאחזור ElementType של הרכיב.
insertHorizontalRule(childIndex)HorizontalRuleיוצרת את התג HorizontalRule ומוסיפה אותו לאינדקס שצוין.
insertInlineImage(childIndex, image)InlineImageיוצר ומכניס InlineImage חדש מ-blob של תמונה שצוין, באינדקס שצוין.
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|nullמאחזר את ההגדרה משמאל לימין.
merge()ListItem|nullמיזוג הרכיב עם הרכיב הקודם מאותו סוג.
removeChild(child)ListItemהסרת רכיב הבן שצוין.
removeFromParent()ListItem|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
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מגדיר את כתובת ה-URL של הקישור.
setListId(listItem)ListItemמגדיר את המזהה של רשימת הפריטים.
setNestingLevel(nestingLevel)ListItemקובעת את רמת הקינון של הפריט ברשימה.
setSpacingAfter(spacingAfter)ListItemמגדיר את הריווח אחרי הרכיב, בנקודות.
setSpacingBefore(spacingBefore)ListItemמגדיר את הריווח לפני הרכיב, בנקודות.
setText(text)voidמגדיר את התוכן של הפריט ברשימה כטקסט.
setTextAlignment(textAlignment)ListItemהגדרת יישור הטקסט.

NamedRange

Methods

שיטהסוג הערך שמוחזרתיאור קצר
getId()Stringהפונקציה מחזירה את המזהה של NamedRange.
getName()Stringהפונקציה מחזירה את השם של NamedRange.
getRange()Rangeמחזירה את טווח הרכיבים שמשויכים ל-NamedRange הזה.
remove()voidהסרה של NamedRange מהכרטיסייה.

PageBreak

Methods

שיטהסוג הערך שמוחזרתיאור קצר
copy()PageBreakמחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getType()ElementTypeאחזור ElementType של הרכיב.
isAtDocumentEnd()Booleanההגדרה קובעת אם הרכיב נמצא בסוף Document.
removeFromParent()PageBreak|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
setAttributes(attributes)PageBreakהגדרת המאפיינים של האלמנט.

Paragraph

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addPositionedImage(image)PositionedImageיוצר ומכניס PositionedImage חדש מ-blob התמונה שצוין.
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|nullמחפש בתוכן של הרכיב צאצא מסוג מסוים.
findElement(elementType, from)RangeElement|nullהפונקציה מחפשת בתוכן של הרכיב צאצא מסוג מסוים, החל מRangeElement שצוין.
findText(searchPattern)RangeElement|nullמחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים.
findText(searchPattern, from)RangeElement|nullמחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה.
getAlignment()HorizontalAlignment|nullמאחזר את HorizontalAlignment.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getChild(childIndex)Elementמאחזר את רכיב הצאצא באינדקס הצאצא שצוין.
getChildIndex(child)Integerמאחזר את אינדקס הצאצא של רכיב הצאצא שצוין.
getHeading()ParagraphHeading|nullמאחזר את ParagraphHeading.
getIndentEnd()Number|nullמאחזר את ההזחה בסוף, בנקודות.
getIndentFirstLine()Number|nullהפונקציה מאחזרת את גודל הכניסה של השורה הראשונה, בנקודות.
getIndentStart()Number|nullמחזירה את ההזחה של תחילת הפסקה.
getLineSpacing()Number|nullמאחזרת את הריווח בין השורות, בנקודות.
getLinkUrl()String|nullהפונקציה מחזירה את כתובת ה-URL של הקישור.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getNumChildren()Integerמאחזר את מספר הילדים.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getPositionedImage(id)PositionedImageמקבלים PositionedImage לפי מזהה התמונה.
getPositionedImages()PositionedImage[]מקבל את כל אובייקטי PositionedImage שמעוגנים לפסקה.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getSpacingAfter()Number|nullמאחזר את הריווח אחרי הרכיב, בנקודות.
getSpacingBefore()Number|nullמחזירה את הריווח לפני הרכיב, בנקודות.
getText()Stringמאחזרת את התוכן של הרכיב כמחרוזת טקסט.
getTextAlignment()TextAlignment|nullמקבל את יישור הטקסט.
getType()ElementTypeאחזור ElementType של הרכיב.
insertHorizontalRule(childIndex)HorizontalRuleיוצרת את התג HorizontalRule ומוסיפה אותו לאינדקס שצוין.
insertInlineImage(childIndex, image)InlineImageיוצר ומכניס InlineImage חדש מ-blob של תמונה שצוין, באינדקס שצוין.
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|nullמאחזר את ההגדרה משמאל לימין.
merge()Paragraph|nullמיזוג הרכיב עם הרכיב הקודם מאותו סוג.
removeChild(child)Paragraphהסרת רכיב הבן שצוין.
removeFromParent()Paragraph|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
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מגדיר את כתובת ה-URL של הקישור.
setSpacingAfter(spacingAfter)Paragraphמגדיר את הריווח אחרי הרכיב, בנקודות.
setSpacingBefore(spacingBefore)Paragraphמגדיר את הריווח לפני הרכיב, בנקודות.
setText(text)voidמגדיר את התוכן של הפסקה כטקסט.
setTextAlignment(textAlignment)Paragraphהגדרת יישור הטקסט.

ParagraphHeading

מאפיינים

נכססוגתיאור
NORMALEnumאפשרות הכותרת לטקסט רגיל.
HEADING1Enumאפשרות הכותרת הכי גבוהה.
HEADING2Enumאפשרות הכותרת השנייה.
HEADING3Enumאפשרות הכותרת השלישית
HEADING4Enumאפשרות הכותרת הרביעית.
HEADING5Enumאפשרות הכותרת החמישית.
HEADING6Enumאפשרות הכותרת הנמוכה ביותר.
TITLEEnumאפשרות הכותרת.
SUBTITLEEnumאפשרות הכותרת של כתוביות.

Person

Methods

שיטהסוג הערך שמוחזרתיאור קצר
copy()Personמחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getEmail()Stringמחזירה את כתובת האימייל של האדם.
getName()String|nullהפונקציה מחזירה את השם לתצוגה של האדם, אם הוא מוגדר.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getType()ElementTypeאחזור ElementType של הרכיב.
isAtDocumentEnd()Booleanההגדרה קובעת אם הרכיב נמצא בסוף Document.
merge()Person|nullמיזוג הרכיב עם הרכיב הקודם מאותו סוג.
removeFromParent()Person|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
setAttributes(attributes)Personהגדרת המאפיינים של האלמנט.

Position

Methods

שיטהסוג הערך שמוחזרתיאור קצר
getElement()Elementמחזירה את הרכיב שמכיל את Position.
getOffset()Integerמחזירה את המיקום היחסי של Position בתוך הרכיב שמכיל אותו.
getSurroundingText()Textיוצר רכיב Text מלאכותי שמייצג את הטקסט והעיצוב של הרכיב Paragraph או ListItem שמכיל את הרכיב Position, באופן ישיר או דרך שרשרת של רכיבי צאצא.
getSurroundingTextOffset()Integerמחזירה את ההיסט של Position בתוך רכיב Text שמוחזר על ידי getSurroundingText().
insertBookmark()Bookmarkיוצרת ומכניסה Bookmark חדש בPosition הזה.
insertInlineImage(image)InlineImage|nullיוצר ומכניס InlineImage חדש במיקום Position הזה מ-blob התמונה שצוין.
insertText(text)Text|nullהוספת הטקסט שצוין במיקום Position.

PositionedImage

Methods

שיטהסוג הערך שמוחזרתיאור קצר
getAs(contentType)Blobהחזרת הנתונים בתוך האובייקט הזה כ-Blob שהומר לסוג התוכן שצוין.
getBlob()Blobהחזרת הנתונים בתוך האובייקט הזה כ-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_TEXTEnumהתמונה ממוקמת מעל הטקסט.
BREAK_BOTHEnumהתמונה מפרידה בין הטקסט מימין ומשמאל.
BREAK_LEFTEnumהתמונה מפרידה בין חלקי הטקסט שמימין.
BREAK_RIGHTEnumהתמונה מפרידה בין חלקי הטקסט משמאל.
WRAP_TEXTEnumהתמונה מוקפת בטקסט.

Range

Methods

שיטהסוג הערך שמוחזרתיאור קצר
getRangeElements()RangeElement[]מחזירה את כל הרכיבים ב-Range, כולל רכיבי Text חלקיים (לדוגמה, במקרה של בחירה שכוללת רק חלק מרכיב Text).

RangeBuilder

Methods

שיטהסוג הערך שמוחזרתיאור קצר
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 מההגדרות שחלות על ה-builder.
getRangeElements()RangeElement[]מחזירה את כל הרכיבים ב-Range, כולל רכיבי Text חלקיים (לדוגמה, במקרה של בחירה שכוללת רק חלק מרכיב Text).

RangeElement

Methods

שיטהסוג הערך שמוחזרתיאור קצר
getElement()Elementהפונקציה מחזירה את Element שתואם ל-RangeElement הזה.
getEndOffsetInclusive()Integerמחזירה את המיקום של סוף טווח חלקי בתוך רכיב הטווח.
getStartOffset()Integerמחזירה את המיקום של תחילת טווח חלקי בתוך רכיב הטווח.
isPartial()Booleanקובע אם רכיב הטווח הזה מכסה את כל הרכיב או בחירה חלקית של התווים של הרכיב.

Methods

שיטהסוג הערך שמוחזרתיאור קצר
copy()RichLinkמחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getMimeType()String|nullמחזירה את סוג ה-MIME של הקישור, שזמין כשהפריט הוא קישור לקובץ ב-Drive, אחרת מחזירה null.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getTitle()Stringמחזירה את השם המוצג של הקישור.
getType()ElementTypeאחזור ElementType של הרכיב.
getUrl()Stringהפונקציה מחזירה את כתובת ה-URL של המשאב.
isAtDocumentEnd()Booleanההגדרה קובעת אם הרכיב נמצא בסוף Document.
merge()RichLink|nullמיזוג הרכיב עם הרכיב הקודם מאותו סוג.
removeFromParent()RichLink|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
setAttributes(attributes)RichLinkהגדרת המאפיינים של האלמנט.

Tab

Methods

שיטהסוג הערך שמוחזרתיאור קצר
asDocumentTab()DocumentTabמאחזר את תוכן הכרטיסייה כ-DocumentTab.
getChildTabs()Tab[]הפונקציה מחזירה את כרטיסיות הצאצא שמוטמעות בכרטיסייה הזו.
getId()Stringמאחזר את המזהה של הכרטיסייה.
getIndex()Integerהפונקציה מחזירה את האינדקס של הכרטיסייה בתוך רכיב ההורה, על בסיס 0.
getTitle()Stringהפונקציה מחזירה את שם הכרטיסייה.
getType()TabTypeמאחזר את סוג הכרטיסייה.

TabType

מאפיינים

נכססוגתיאור
DOCUMENT_TABEnumהסוג שמתאים ל-DocumentTab.

Table

Methods

שיטהסוג הערך שמוחזרתיאור קצר
appendTableRow()TableRowיוצרת TableRow חדש ומצרפת אותו.
appendTableRow(tableRow)TableRowהוספה של TableRow שצוין.
clear()Tableמחיקת התוכן של הרכיב.
copy()Tableמחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
editAsText()Textמקבלים גרסה Text של הרכיב הנוכחי לצורך עריכה.
findElement(elementType)RangeElement|nullמחפש בתוכן של הרכיב צאצא מסוג מסוים.
findElement(elementType, from)RangeElement|nullהפונקציה מחפשת בתוכן של הרכיב צאצא מסוג מסוים, החל מRangeElement שצוין.
findText(searchPattern)RangeElement|nullמחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים.
findText(searchPattern, from)RangeElement|nullמחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getBorderColor()String|nullמחזירה את צבע הגבול.
getBorderWidth()Number|nullמאחזרת את רוחב הגבול, בנקודות.
getCell(rowIndex, cellIndex)TableCell|nullאחזור הערך TableCell באינדקסים של השורה והתא שצוינו.
getChild(childIndex)Elementמאחזר את רכיב הצאצא באינדקס הצאצא שצוין.
getChildIndex(child)Integerמאחזר את אינדקס הצאצא של רכיב הצאצא שצוין.
getColumnWidth(columnIndex)Number|nullהפונקציה מאחזרת את רוחב העמודה שצוינה בטבלה, בנקודות.
getLinkUrl()String|nullהפונקציה מחזירה את כתובת ה-URL של הקישור.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getNumChildren()Integerמאחזר את מספר הילדים.
getNumRows()Integerהפונקציה מאחזרת את מספר TableRows.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getRow(rowIndex)TableRow|nullמאחזרת את TableRow באינדקס השורה שצוין.
getText()Stringמאחזרת את התוכן של הרכיב כמחרוזת טקסט.
getTextAlignment()TextAlignment|nullמקבל את יישור הטקסט.
getType()ElementTypeאחזור ElementType של הרכיב.
insertTableRow(childIndex)TableRowיוצרת ומכניסה אובייקט TableRow חדש באינדקס שצוין.
insertTableRow(childIndex, tableRow)TableRowהפונקציה מוסיפה את TableRow שצוין באינדקס שצוין.
isAtDocumentEnd()Booleanההגדרה קובעת אם הרכיב נמצא בסוף Document.
removeChild(child)Tableהסרת רכיב הבן שצוין.
removeFromParent()Table|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
removeRow(rowIndex)TableRowמסירה את TableRow באינדקס השורה שצוין.
replaceText(searchPattern, replacement)Elementהפונקציה מחליפה את כל המופעים של תבנית טקסט נתונה במחרוזת חלופית נתונה, באמצעות ביטויים רגולריים.
setAttributes(attributes)Tableהגדרת המאפיינים של האלמנט.
setBorderColor(color)Tableהגדרת צבע הגבול.
setBorderWidth(width)Tableמגדיר את רוחב הגבול, בנקודות.
setColumnWidth(columnIndex, width)Tableהפונקציה מגדירה את הרוחב של העמודה שצוינה, בנקודות.
setLinkUrl(url)Tableמגדיר את כתובת ה-URL של הקישור.
setTextAlignment(textAlignment)Tableהגדרת יישור הטקסט.

TableCell

Methods

שיטהסוג הערך שמוחזרתיאור קצר
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|nullמחפש בתוכן של הרכיב צאצא מסוג מסוים.
findElement(elementType, from)RangeElement|nullהפונקציה מחפשת בתוכן של הרכיב צאצא מסוג מסוים, החל מRangeElement שצוין.
findText(searchPattern)RangeElement|nullמחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים.
findText(searchPattern, from)RangeElement|nullמחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getBackgroundColor()String|nullמחזירה את צבע הרקע.
getChild(childIndex)Elementמאחזר את רכיב הצאצא באינדקס הצאצא שצוין.
getChildIndex(child)Integerמאחזר את אינדקס הצאצא של רכיב הצאצא שצוין.
getColSpan()Integerמאחזרת את טווח העמודות, שהוא מספר העמודות של תאי הטבלה שהתא הזה משתרע עליהן.
getLinkUrl()String|nullהפונקציה מחזירה את כתובת ה-URL של הקישור.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getNumChildren()Integerמאחזר את מספר הילדים.
getPaddingBottom()Number|nullמאחזר את המרווח הפנימי התחתון, בנקודות.
getPaddingLeft()Number|nullמאחזר את המרווח הפנימי השמאלי, בנקודות.
getPaddingRight()Number|nullמאחזר את המרווח הפנימי הימני, בנקודות.
getPaddingTop()Number|nullמאחזר את המרווח הפנימי העליון, בנקודות.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getParentRow()TableRow|nullאחזור TableRow שמכיל את TableCell הנוכחי.
getParentTable()Table|nullאחזור Table שמכיל את TableCell הנוכחי.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getRowSpan()Integerהפונקציה מאחזרת את מספר השורות שהתא הזה משתרע עליהן בטבלה.
getText()Stringמאחזרת את התוכן של הרכיב כמחרוזת טקסט.
getTextAlignment()TextAlignment|nullמקבל את יישור הטקסט.
getType()ElementTypeאחזור ElementType של הרכיב.
getVerticalAlignment()VerticalAlignment|nullמאחזר את VerticalAlignment.
getWidth()Number|nullהפונקציה מאחזרת את רוחב העמודה שמכילה את התא, בנקודות.
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|nullמיזוג הרכיב עם הרכיב הקודם מאותו סוג.
removeChild(child)TableCellהסרת רכיב הבן שצוין.
removeFromParent()TableCell|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
replaceText(searchPattern, replacement)Elementהפונקציה מחליפה את כל המופעים של תבנית טקסט נתונה במחרוזת חלופית נתונה, באמצעות ביטויים רגולריים.
setAttributes(attributes)TableCellהגדרת המאפיינים של האלמנט.
setBackgroundColor(color)TableCellהגדרת צבע הרקע.
setLinkUrl(url)TableCellמגדיר את כתובת ה-URL של הקישור.
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

Methods

שיטהסוג הערך שמוחזרתיאור קצר
clear()TableOfContentsמחיקת התוכן של הרכיב.
copy()TableOfContentsמחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
editAsText()Textמקבלים גרסה Text של הרכיב הנוכחי לצורך עריכה.
findElement(elementType)RangeElement|nullמחפש בתוכן של הרכיב צאצא מסוג מסוים.
findElement(elementType, from)RangeElement|nullהפונקציה מחפשת בתוכן של הרכיב צאצא מסוג מסוים, החל מRangeElement שצוין.
findText(searchPattern)RangeElement|nullמחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים.
findText(searchPattern, from)RangeElement|nullמחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getChild(childIndex)Elementמאחזר את רכיב הצאצא באינדקס הצאצא שצוין.
getChildIndex(child)Integerמאחזר את אינדקס הצאצא של רכיב הצאצא שצוין.
getLinkUrl()String|nullהפונקציה מחזירה את כתובת ה-URL של הקישור.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getNumChildren()Integerמאחזר את מספר הילדים.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getText()Stringמאחזרת את התוכן של הרכיב כמחרוזת טקסט.
getTextAlignment()TextAlignment|nullמקבל את יישור הטקסט.
getType()ElementTypeאחזור ElementType של הרכיב.
isAtDocumentEnd()Booleanההגדרה קובעת אם הרכיב נמצא בסוף Document.
removeFromParent()TableOfContents|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
replaceText(searchPattern, replacement)Elementהפונקציה מחליפה את כל המופעים של תבנית טקסט נתונה במחרוזת חלופית נתונה, באמצעות ביטויים רגולריים.
setAttributes(attributes)TableOfContentsהגדרת המאפיינים של האלמנט.
setLinkUrl(url)TableOfContentsמגדיר את כתובת ה-URL של הקישור.
setTextAlignment(textAlignment)TableOfContentsהגדרת יישור הטקסט.

TableRow

Methods

שיטהסוג הערך שמוחזרתיאור קצר
appendTableCell()TableCellיוצרת TableCell חדש ומצרפת אותו.
appendTableCell(textContents)TableCellמוסיפה את TableCell הנתון שמכיל את הטקסט שצוין.
appendTableCell(tableCell)TableCellהוספה של TableCell שצוין.
clear()TableRowמחיקת התוכן של הרכיב.
copy()TableRowמחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
editAsText()Textמקבלים גרסה Text של הרכיב הנוכחי לצורך עריכה.
findElement(elementType)RangeElement|nullמחפש בתוכן של הרכיב צאצא מסוג מסוים.
findElement(elementType, from)RangeElement|nullהפונקציה מחפשת בתוכן של הרכיב צאצא מסוג מסוים, החל מRangeElement שצוין.
findText(searchPattern)RangeElement|nullמחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים.
findText(searchPattern, from)RangeElement|nullמחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getCell(cellIndex)TableCell|nullמאחזרת את TableCell באינדקס התא שצוין.
getChild(childIndex)Elementמאחזר את רכיב הצאצא באינדקס הצאצא שצוין.
getChildIndex(child)Integerמאחזר את אינדקס הצאצא של רכיב הצאצא שצוין.
getLinkUrl()String|nullהפונקציה מחזירה את כתובת ה-URL של הקישור.
getMinimumHeight()Number|nullמאחזר את הגובה המינימלי, בנקודות.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getNumCells()Integerהפונקציה מאחזרת את מספר התאים בשורה.
getNumChildren()Integerמאחזר את מספר הילדים.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getParentTable()Table|nullמחזירה את Table שמכיל את השורה הנוכחית.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getText()Stringמאחזרת את התוכן של הרכיב כמחרוזת טקסט.
getTextAlignment()TextAlignment|nullמקבל את יישור הטקסט.
getType()ElementTypeאחזור ElementType של הרכיב.
insertTableCell(childIndex)TableCellיוצרת ומכניסה אובייקט TableCell חדש באינדקס שצוין.
insertTableCell(childIndex, textContents)TableCellהוספת המחרוזת TableCell שצוינה באינדקס שצוין, שמכילה את הטקסט שצוין.
insertTableCell(childIndex, tableCell)TableCellהפונקציה מוסיפה את TableCell שצוין באינדקס שצוין.
isAtDocumentEnd()Booleanההגדרה קובעת אם הרכיב נמצא בסוף Document.
merge()TableRow|nullמיזוג הרכיב עם הרכיב הקודם מאותו סוג.
removeCell(cellIndex)TableCellהסרת TableCell באינדקס התא שצוין.
removeChild(child)TableRowהסרת רכיב הבן שצוין.
removeFromParent()TableRow|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
replaceText(searchPattern, replacement)Elementהפונקציה מחליפה את כל המופעים של תבנית טקסט נתונה במחרוזת חלופית נתונה, באמצעות ביטויים רגולריים.
setAttributes(attributes)TableRowהגדרת המאפיינים של האלמנט.
setLinkUrl(url)TableRowמגדיר את כתובת ה-URL של הקישור.
setMinimumHeight(minHeight)TableRowהגדרת הגובה המינימלי, בנקודות.
setTextAlignment(textAlignment)TableRowהגדרת יישור הטקסט.

Text

Methods

שיטהסוג הערך שמוחזרתיאור קצר
appendText(text)Textהוספת הטקסט שצוין לסוף אזור הטקסט הזה.
copy()Textמחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
deleteText(startOffset, endOffsetInclusive)Textמחיקת טווח של טקסט.
editAsText()Textמקבלים גרסה Text של הרכיב הנוכחי לצורך עריכה.
findText(searchPattern)RangeElement|nullמחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים.
findText(searchPattern, from)RangeElement|nullמחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getAttributes(offset)Objectהפונקציה מאחזרת את המאפיינים בהיסט התווים שצוין.
getBackgroundColor()String|nullמאחזר את הגדרת צבע הרקע.
getBackgroundColor(offset)String|nullמאחזרת את צבע הרקע בהיסט התווים שצוין.
getFontFamily()String|nullמאחזר את ההגדרה של משפחת הגופנים.
getFontFamily(offset)String|nullהפונקציה מאחזרת את משפחת הגופנים בהיסט התווים שצוין.
getFontSize()Number|nullמאחזר את ההגדרה של גודל הגופן.
getFontSize(offset)Number|nullהפונקציה מאחזרת את גודל הגופן בהיסט התווים שצוין.
getForegroundColor()String|nullמאחזר את הגדרת צבע החזית.
getForegroundColor(offset)String|nullהפונקציה מאחזרת את צבע החזית במיקום התו שצוין.
getLinkUrl()String|nullהפונקציה מחזירה את כתובת ה-URL של הקישור.
getLinkUrl(offset)String|nullהפונקציה מאחזרת את כתובת ה-URL של הקישור בהיסט התווים שצוין.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getText()Stringמאחזרת את התוכן של הרכיב כמחרוזת טקסט.
getTextAlignment()TextAlignment|nullמקבל את יישור הטקסט.
getTextAlignment(offset)TextAlignment|nullמקבלת את יישור הטקסט של תו יחיד.
getTextAttributeIndices()Integer[]מאחזר את קבוצת אינדקסים של טקסט שתואמים להתחלה של רצפים נפרדים של עיצוב טקסט.
getType()ElementTypeאחזור ElementType של הרכיב.
insertText(offset, text)Textהפונקציה מוסיפה את הטקסט שצוין בהיסט התווים שצוין.
isAtDocumentEnd()Booleanההגדרה קובעת אם הרכיב נמצא בסוף Document.
isBold()Boolean|nullמאחזר את ההגדרה של הטקסט המודגש.
isBold(offset)Boolean|nullאחזור הגדרת ההדגשה בהיסט התווים שצוין.
isItalic()Boolean|nullמאחזר את ההגדרה של הטקסט המוטה.
isItalic(offset)Boolean|nullאחזור ההגדרה של הטיית הטקסט במיקום התו שצוין.
isStrikethrough()Boolean|nullמאחזר את הגדרת הקו החוצה.
isStrikethrough(offset)Boolean|nullהפונקציה מאחזרת את הגדרת הקו החוצה במיקום התו שצוין.
isUnderline()Boolean|nullמאחזר את הגדרת הקו התחתון.
isUnderline(offset)Boolean|nullהפונקציה מאחזרת את הגדרת הקו התחתון במיקום התו שצוין.
merge()Text|nullמיזוג הרכיב עם הרכיב הקודם מאותו סוג.
removeFromParent()Text|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
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מגדיר את כתובת ה-URL של הקישור.
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

מאפיינים

נכססוגתיאור
NORMALEnumהיישור הרגיל של הטקסט.
SUPERSCRIPTEnumהיישור של הטקסט בכתב עילי.
SUBSCRIPTEnumהיישור של הטקסט בכתב תחתי.

UnsupportedElement

Methods

שיטהסוג הערך שמוחזרתיאור קצר
copy()UnsupportedElementמחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getType()ElementTypeאחזור ElementType של הרכיב.
isAtDocumentEnd()Booleanההגדרה קובעת אם הרכיב נמצא בסוף Document.
merge()UnsupportedElement|nullמיזוג הרכיב עם הרכיב הקודם מאותו סוג.
removeFromParent()UnsupportedElement|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
setAttributes(attributes)UnsupportedElementהגדרת המאפיינים של האלמנט.

VerticalAlignment

מאפיינים

נכססוגתיאור
BOTTOMEnumאפשרות היישור לתחתית.
CENTEREnumאפשרות היישור למרכז.
TOPEnumאפשרות היישור העליון.