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 חדש והוספתו לקובץ ה-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

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חיפוש בתוכן של הרכיב אחר צאצא מהסוג שצוין.
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הגדרת כתובת ה-URL של הקישור.
setTextAlignment(textAlignment)ContainerElementהגדרת יישור הטקסט.

Date

Methods

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

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הפונקציה מקבלת את Bookmark עם המזהה שצוין בכרטיסייה הראשונה, או בכרטיסייה הפעילה עבור סקריפטים שמוגדרים למסמך.
getBookmarks()Bookmark[]הפונקציה מקבלת את כל האובייקטים מסוג Bookmark בכרטיסייה הראשונה, או בכרטיסייה הפעילה במקרה של סקריפטים שמוגדרים למסמך.
getCursor()Positionהפונקציה מקבלת את הסמן של המשתמש בכרטיסייה הפעילה.
getEditors()User[]הפונקציה מקבלת את רשימת העורכים של Document הזה.
getFooter()FooterSectionהפונקציה מאחזרת את הקטע של הכותרת התחתונה בכרטיסייה הראשונה, או את הקטע של הכותרת התחתונה בכרטיסייה הפעילה, עבור סקריפטים שמוגדרים למסמך.
getFootnotes()Footnote[]הפונקציה מאחזרת את כל הרכיבים מסוג Footnote בגוף הכרטיסייה הראשונה, או בגוף הכרטיסייה הפעילה בסקריפטים שמוגדרים למסמך.
getHeader()HeaderSectionהפונקציה מאחזרת את קטע הכותרת של הכרטיסייה הראשונה, או את קטע הכותרת של הכרטיסייה הפעילה בסקריפטים שמוגדרים למסמך.
getId()Stringאחזור המזהה הייחודי של המסמך.
getLanguage()Stringהפונקציה מקבלת את קוד השפה של המסמך.
getName()Stringאחזור הכותרת של המסמך.
getNamedRangeById(id)NamedRangeהפונקציה מקבלת את NamedRange עם המזהה שצוין בכרטיסייה הראשונה, או בכרטיסייה הפעילה עבור סקריפטים שמוגדרים למסמך.
getNamedRanges()NamedRange[]הפונקציה מקבלת את כל האובייקטים מסוג NamedRange בכרטיסייה הראשונה, או בכרטיסייה הפעילה במקרה של סקריפטים שמוגדרים למסמך.
getNamedRanges(name)NamedRange[]הפונקציה מקבלת את כל האובייקטים מסוג NamedRange עם השם שצוין בכרטיסייה הראשונה, או בכרטיסייה הפעילה במקרה של סקריפטים שמוצמדים למסמך.
getSelection()Rangeהפונקציה מקבלת את הבחירה של המשתמש בכרטיסייה הפעילה.
getSupportedLanguageCodes()String[]הפונקציה מקבלת את כל קודי השפות שנתמכים בקובצי Google Docs.
getTab(tabId)Tabהפונקציה מקבלת את ה-Tab עם המזהה שצוין.
getTabs()Tab[]הפונקציה מקבלת את כל ה-Tab שאינם בתצוגת עץ ושהם חלק מהמסמך.
getUrl()Stringאחזור כתובת ה-URL לגישה למסמך הנוכחי.
getViewers()User[]הפונקציה מקבלת את רשימת הצופים והמגיבים ב-Document הזה.
newPosition(element, offset)Positionיצירת Position חדש, שהוא הפניה למיקום בכרטיסייה, ביחס לרכיב ספציפי בכרטיסייה הראשונה, או בכרטיסייה הפעילה עבור סקריפטים שמוגבלים למסמך.
newRange()RangeBuilderיצירת בונה המשמש ליצירת אובייקטים מסוג Range מרכיבי כרטיסיות בכרטיסייה הראשונה, או בכרטיסייה הפעילה במקרה של סקריפטים שמקושר למסמך.
removeEditor(emailAddress)Documentהסרת המשתמש הנתון מרשימת העורכים של Document.
removeEditor(user)Documentהסרת המשתמש הנתון מרשימת העורכים של Document.
removeViewer(emailAddress)Documentהסרת המשתמש הרלוונטי מרשימת הצופים והמגיבים ב-Document.
removeViewer(user)Documentהסרת המשתמש הרלוונטי מרשימת הצופים והמגיבים ב-Document.
saveAndClose()voidשמירת Document הנוכחי.
setActiveTab(tabId)voidהפונקציה מגדירה את Tab שנבחר על ידי המשתמש במסמך הנוכחי לכרטיסייה עם המזהה שצוין.
setCursor(position)Documentהגדרת הסמן של המשתמש, בהתאם ל-Position.
setLanguage(languageCode)Documentהגדרת קוד השפה של המסמך.
setName(name)Documentהגדרת כותרת המסמך.
setSelection(range)Documentהגדרת הבחירה של המשתמש בכרטיסייה הפעילה, בהתאם ל-Range.

DocumentApp

מאפיינים

נכססוגתיאור
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הפונקציה מקבלת את Bookmark עם המזהה הנתון.
getBookmarks()Bookmark[]אחזור כל האובייקטים מסוג Bookmark בכרטיסייה.
getFooter()FooterSectionאחזור הקטע של הכותרת התחתונה של הכרטיסייה, אם יש כזה.
getFootnotes()Footnote[]אחזור כל הרכיבים מסוג Footnote בגוף הכרטיסייה.
getHeader()HeaderSectionאחזור של קטע הכותרת של הכרטיסייה, אם יש כזה.
getNamedRangeById(id)NamedRangeהפונקציה מקבלת את NamedRange עם המזהה הנתון.
getNamedRanges()NamedRange[]אחזור כל האובייקטים מסוג NamedRange בכרטיסייה.
getNamedRanges(name)NamedRange[]הפונקציה מקבלת את כל אובייקטי ה-NamedRange בכרטיסייה עם השם שצוין.
newPosition(element, offset)Positionיצירת Position חדש, שהוא הפניה למיקום בכרטיסייה ביחס לרכיב ספציפי.
newRange()RangeBuilderיצירת בונה המשמש ליצירת אובייקטים מסוג Range מרכיבי כרטיסיות.

Element

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אחזור הרכיב הבא של הרכיב.
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

Methods

שיטהסוג הערך המוחזרתיאור קצר
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הגדרת כתובת ה-URL של הקישור.
setTextAlignment(textAlignment)Equationהגדרת יישור הטקסט.

EquationFunction

Methods

שיטהסוג הערך המוחזרתיאור קצר
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הגדרת כתובת ה-URL של הקישור.
setTextAlignment(textAlignment)EquationFunctionהגדרת יישור הטקסט.

EquationFunctionArgumentSeparator

Methods

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

EquationSymbol

Methods

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

Methods

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

Methods

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

FootnoteSection

Methods

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

Methods

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

HorizontalRule

Methods

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

InlineDrawing

Methods

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

Methods

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

Methods

שיטהסוג הערך המוחזרתיאור קצר
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הגדרת כתובת ה-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אחזור הרכיב הבא של הרכיב.
getParent()ContainerElementאחזור של רכיב ההורה של האלמנט.
getPreviousSibling()Elementאחזור של רכיב האח הקודם של הרכיב.
getType()ElementTypeאחזור הערך של ElementType ברכיב.
isAtDocumentEnd()Booleanהפונקציה קובעת אם הרכיב נמצא בסוף ה-Document.
removeFromParent()PageBreakהסרת הרכיב מהרכיב ההורה שלו.
setAttributes(attributes)PageBreakהגדרת המאפיינים של האלמנט.

Paragraph

Methods

שיטהסוג הערך המוחזרתיאור קצר
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הגדרת כתובת ה-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הפונקציה מחזירה את השם המוצג של האדם, אם הוא מוגדר.
getNextSibling()Elementאחזור הרכיב הבא של הרכיב.
getParent()ContainerElementאחזור של רכיב ההורה של האלמנט.
getPreviousSibling()Elementאחזור של רכיב האח הקודם של הרכיב.
getType()ElementTypeאחזור הערך של ElementType ברכיב.
isAtDocumentEnd()Booleanהפונקציה קובעת אם הרכיב נמצא בסוף ה-Document.
merge()Personמיזוג הרכיב עם האח/ה הקודם/ה מאותו סוג.
removeFromParent()Personהסרת הרכיב מהרכיב ההורה שלו.
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יצירת InlineImage חדש והוספה שלו ל-Position הזה מה-blob של התמונה שצוין.
insertText(text)Textהוספת הטקסט שצוין ב-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הפונקציה מחזירה את סוג ה-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

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חיפוש בתוכן של הרכיב אחר צאצא מהסוג שצוין.
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הגדרת כתובת ה-URL של הקישור.
setTextAlignment(textAlignment)Tableהגדרת יישור הטקסט.

TableCell

Methods

שיטהסוג הערך המוחזרתיאור קצר
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הגדרת כתובת ה-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חיפוש בתוכן של הרכיב אחר צאצא מהסוג שצוין.
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הגדרת כתובת ה-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חיפוש בתוכן של הרכיב אחר צאצא מהסוג שצוין.
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הגדרת כתובת ה-URL של הקישור.
setMinimumHeight(minHeight)TableRowהגדרת הגובה המינימלי, בפונטים.
setTextAlignment(textAlignment)TableRowהגדרת יישור הטקסט.

Text

Methods

שיטהסוג הערך המוחזרתיאור קצר
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הגדרת כתובת ה-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אחזור הרכיב הבא של הרכיב.
getParent()ContainerElementאחזור של רכיב ההורה של האלמנט.
getPreviousSibling()Elementאחזור של רכיב האח הקודם של הרכיב.
getType()ElementTypeאחזור הערך של ElementType ברכיב.
isAtDocumentEnd()Booleanהפונקציה קובעת אם הרכיב נמצא בסוף ה-Document.
merge()UnsupportedElementמיזוג הרכיב עם האח/ה הקודם/ה מאותו סוג.
removeFromParent()UnsupportedElementהסרת הרכיב מהרכיב ההורה שלו.
setAttributes(attributes)UnsupportedElementהגדרת המאפיינים של האלמנט.

VerticalAlignment

מאפיינים

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