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טווח של רכיבים במסמך.
RangeBuilderBuilder שמשמש לבניית אובייקטים של Range מרכיבי מסמכים.
RangeElementwrapper במסגרת 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

שיטות

שיטהסוג הערך המוחזרתיאור קצר
appendHorizontalRule()HorizontalRuleיצירה והוספה של HorizontalRule חדש.
appendImage(image)InlineImageיצירה והוספה של InlineImage חדש מ-blob של התמונה שצוין.
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 מה-blob של התמונה שצוין, בתרחיש שצוין להוסיף לאינדקס.
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אחזור כתובת ה-URL של הקישור.
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.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 כ-blob מהסוג שצוין.
getBlob()Blobאחזור של התוכן הנוכחי של Document כ-blob.
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יצירת ה-builder שמשמש לבניית אובייקטים של Range מרכיבי כרטיסייה Tab הראשון או, עבור סקריפטים שמקושרים המסמך, הכרטיסייה הפעילה.
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.

שיטות

שיטהסוג הערך המוחזרתיאור קצר
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יצירת builder שמשמש לבניית אובייקטים של 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 Sheets.
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_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

שיטות

שיטהסוג הערך המוחזרתיאור קצר
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אחזור כתובת ה-URL של הקישור.
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אחזור כתובת ה-URL של הקישור.
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 חדש מ-blob של התמונה שצוין.
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 מה-blob של התמונה שצוין, בתרחיש שצוין להוסיף לאינדקס.
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

מאפיינים

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

HeaderSection

שיטות

שיטהסוג הערך המוחזרתיאור קצר
appendHorizontalRule()HorizontalRuleיצירה והוספה של HorizontalRule חדש.
appendImage(image)InlineImageיצירה והוספה של InlineImage חדש מ-blob של התמונה שצוין.
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 מה-blob של התמונה שצוין, בתרחיש שצוין להוסיף לאינדקס.
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

מאפיינים

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

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החזרת הנתונים שבתוך האובייקט הזה כ-blob שהומר לסוג התוכן שצוין.
getAttributes()Objectאחזור המאפיינים של הרכיב.
getBlob()Blobהחזרת הנתונים שבתוך האובייקט הזה כ-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 חדש מ-blob של התמונה שצוין.
appendHorizontalRule()HorizontalRuleיצירה והוספה של HorizontalRule חדש.
appendInlineImage(image)InlineImageיצירה והוספה של InlineImage חדש מ-blob של התמונה שצוין.
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אחזור כתובת ה-URL של הקישור.
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 חדש מ-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מאחזר את ההגדרה משמאל לימין.
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 חדש מ-blob של התמונה שצוין.
appendHorizontalRule()HorizontalRuleיצירה והוספה של HorizontalRule חדש.
appendInlineImage(image)InlineImageיצירה והוספה של InlineImage חדש מ-blob של התמונה שצוין.
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אחזור כתובת ה-URL של הקישור.
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 חדש מ-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מאחזר את ההגדרה משמאל לימין.
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

מאפיינים

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

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 מהתמונה שצוינה blob.
insertText(text)Textהוספת הטקסט שצוין ב-Position הזה.

PositionedImage

שיטות

שיטהסוג הערך המוחזרתיאור קצר
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

שיטות

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

RangeElement

שיטות

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

שיטות

שיטהסוג הערך המוחזרתיאור קצר
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_TABEnumהסוג התואם ל-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אחזור כתובת ה-URL של הקישור.
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 חדש מ-blob של התמונה שצוין.
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אחזור כתובת ה-URL של הקישור.
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 מה-blob של התמונה שצוין, בתרחיש שצוין להוסיף לאינדקס.
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אחזור כתובת ה-URL של הקישור.
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אחזור כתובת ה-URL של הקישור.
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אחזור כתובת ה-URL של הקישור.
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מגדיר את כתובת האתר של הקישור עבור טווח התווים שצוין.
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

מאפיינים

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

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

מאפיינים

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