השירות הזה מאפשר לסקריפטים ליצור קובצי Google Docs, לגשת אליהם ולשנות אותם.
// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID');
// Create and open a document.
doc = DocumentApp.create('Document Name');
שיעורים
שם | תיאור קצר |
---|---|
Attribute | ספירה של מאפייני הרכיב. |
Body | התוכן של כרטיסייה במסמך Google Docs. |
Bookmark | אובייקט שמייצג סימנייה. |
ContainerElement | רכיב גנרי שעשוי להכיל אלמנטים אחרים. |
Date | רכיב שמייצג תאריך בפורמט |
Document | מסמך שמכיל אובייקט אחד או יותר מסוג Tab , שכל אחד מהם מכיל טקסט עשיר וגם
רכיבים כמו טבלאות ורשימות. |
DocumentApp | שירות המסמכים יוצר ופותח את Documents שניתן לערוך. |
DocumentTab | כרטיסיית מסמך, שמכילה טקסט עשיר ורכיבים כגון טבלאות ורשימות. |
Element | יסוד כללי. |
ElementType | ספירה של כל סוגי הרכיבים. |
Equation | רכיב שמייצג ביטוי מתמטי. |
EquationFunction | רכיב שמייצג פונקציה בפונקציה Equation מתמטית. |
EquationFunctionArgumentSeparator | רכיב שמייצג מפריד פונקציה בEquation מתמטי. |
EquationSymbol | רכיב שמייצג סמל בEquation מתמטי. |
| מספר של הגופנים הנתמכים. |
FooterSection | רכיב שמייצג קטע של כותרת תחתונה. |
Footnote | רכיב שמייצג הערת שוליים. |
FootnoteSection | רכיב שמייצג קטע של הערת שוליים. |
GlyphType | ספירה של סוגי הגליפים הנתמכים. |
HeaderSection | רכיב שמייצג קטע כותרת. |
HorizontalAlignment | ספירה של סוגי היישור האופקי הנתמכים. |
HorizontalRule | רכיב שמייצג כלל אופקי. |
InlineDrawing | רכיב שמייצג שרטוט מוטמע. |
InlineImage | רכיב שמייצג תמונה מוטמעת. |
ListItem | רכיב שמייצג פריט ברשימה. |
NamedRange | Range עם שם ומזהה שמאפשרים אחזור מאוחר יותר. |
PageBreak | רכיב שמייצג מעבר דף. |
Paragraph | רכיב שמייצג פסקה. |
ParagraphHeading | ספירה של כותרות הפסקאות הרגילות. |
Person | רכיב שמייצג קישור לאדם. |
Position | הפניה למיקום בכרטיסיית המסמך, ביחס לרכיב ספציפי. |
PositionedImage | תמונה במיקום קבוע מעוגנת אל Paragraph . |
PositionedLayout | ספירה שמציינת איך פריסה של PositionedImage ביחס לסביבה
טקסט. |
Range | טווח של רכיבים במסמך. |
RangeBuilder | Builder שמשמש לבניית אובייקטים של Range מרכיבי מסמכים. |
RangeElement | wrapper במסגרת Element עם היסט אפשרי להתחלה ולסיום. |
RichLink | רכיב שמייצג קישור למשאב של Google, כמו קובץ ב-Drive או סרטון ב-YouTube. |
Tab | כרטיסייה במסמך ב-Google Docs. |
TabType | ספירה של כל סוגי הכרטיסיות. |
Table | רכיב שמייצג טבלה. |
TableCell | רכיב שמייצג תא בטבלה. |
TableOfContents | רכיב שמכיל תוכן עניינים. |
TableRow | רכיב שמייצג שורה בטבלה. |
Text | רכיב שמייצג אזור של טקסט עשיר. |
TextAlignment | המספור של סוגי יישור הטקסט. |
UnsupportedElement | רכיב שמייצג אזור שאינו ידוע או שאינו יכול להיות מושפע מסקריפט, כמו מספר דף. |
VerticalAlignment | ספירה של סוגי היישור האנכי הנתמכים. |
Attribute
מאפיינים
נכס | סוג | תיאור |
---|---|---|
BACKGROUND_COLOR | Enum | צבע הרקע של רכיב (פסקה, טבלה וכו') או מסמך. |
BOLD | Enum | ההגדרה של עובי הגופן, לטקסט עשיר. |
BORDER_COLOR | Enum | צבע הגבול, לרכיבי טבלה. |
BORDER_WIDTH | Enum | רוחב הגבול בנקודות, לרכיבים בטבלה. |
CODE | Enum | תוכן הקוד, לרכיבי משוואה. |
FONT_FAMILY | Enum | הגדרה של משפחת הגופנים, לטקסט עשיר. |
FONT_SIZE | Enum | הגדרת גודל הגופן בנקודות, לטקסט עשיר. |
FOREGROUND_COLOR | Enum | ההגדרה של צבע החזית לטקסט עשיר. |
HEADING | Enum | סוג הכותרת, לרכיבי פסקה (לדוגמה, DocumentApp.ParagraphHeading.HEADING1 ). |
HEIGHT | Enum | הגדרת הגובה, לרכיבי תמונה. |
HORIZONTAL_ALIGNMENT | Enum | היישור האופקי, של רכיבי פסקאות (לדוגמה, DocumentApp.HorizontalAlignment.CENTER ). |
INDENT_END | Enum | הגדרת כניסת הפיסקה בסוף, לרכיבי פסקה. |
INDENT_FIRST_LINE | Enum | ההגדרה של כניסת השורה הראשונה בנקודות, לרכיבי פסקה. |
INDENT_START | Enum | ההגדרה של התחלת כניסת הפיסקה בנקודות, עבור רכיבי פסקה. |
ITALIC | Enum | הגדרת סגנון הגופן, לטקסט עשיר. |
GLYPH_TYPE | Enum | סוג הגליף, לרכיבים של פריט ברשימה. |
LEFT_TO_RIGHT | Enum | הגדרת כיוון הטקסט, לטקסט עשיר. |
LINE_SPACING | Enum | ההגדרה של מרווח בין שורות כמכפיל, לרכיבי פסקאות. |
LINK_URL | Enum | כתובת ה-URL של הקישור לטקסט עשיר. |
LIST_ID | Enum | המזהה של הרשימה המקיפה, עבור רכיבים של פריטים ברשימה. |
MARGIN_BOTTOM | Enum | הגדרת השוליים התחתוניים בנקודות, לרכיבי פסקה. |
MARGIN_LEFT | Enum | הגדרת השוליים השמאליים בנקודות, לרכיבי פסקה. |
MARGIN_RIGHT | Enum | הגדרת השוליים הימניים בנקודות, לרכיבי פסקה. |
MARGIN_TOP | Enum | הגדרת השוליים העליונים בנקודות, לרכיבי פסקה. |
NESTING_LEVEL | Enum | רמת הסידור הפנימי של הפריט, לרכיבים של הפריט ברשימה. |
MINIMUM_HEIGHT | Enum | הגדרת הגובה המינימלי בנקודות, לרכיבי השורה בטבלה. |
PADDING_BOTTOM | Enum | הגדרת המרווח הפנימי התחתון בנקודות, לרכיבי תא בטבלה. |
PADDING_LEFT | Enum | הגדרת המרווח הפנימי השמאלי בנקודות, לרכיבי תא בטבלה. |
PADDING_RIGHT | Enum | הגדרת המרווח הפנימי הימני בנקודות, לרכיבי תא בטבלה. |
PADDING_TOP | Enum | הגדרת המרווח הפנימי העליון בנקודות, לרכיבי תא בטבלה. |
PAGE_HEIGHT | Enum | הגדרת גובה הדף בנקודות, למסמכים. |
PAGE_WIDTH | Enum | הגדרת רוחב הדף בנקודות, עבור מסמכים. |
SPACING_AFTER | Enum | הגדרת הריווח התחתון בנקודות, לרכיבי פסקה. |
SPACING_BEFORE | Enum | הגדרת הריווח העליון בנקודות, לרכיבי פסקה. |
STRIKETHROUGH | Enum | הגדרת קו חוצה לטקסט עשיר. |
UNDERLINE | Enum | הגדרת הקו התחתון לטקסט עשיר. |
VERTICAL_ALIGNMENT | Enum | הגדרת היישור האנכי, לרכיבי תא בטבלה. |
WIDTH | Enum | הגדרת הרוחב, לתאים בטבלה ולרכיבי תמונה. |
Body
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
appendHorizontalRule() | HorizontalRule | יצירה והוספה של HorizontalRule חדש. |
appendImage(image) | InlineImage | יצירה והוספה של InlineImage חדש מ-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
מאפיינים
נכס | סוג | תיאור |
---|---|---|
Attribute | Attribute | הספירה Attribute . |
ElementType | ElementType | הספירה ElementType . |
FontFamily |
| הספירה . |
GlyphType | GlyphType | הספירה GlyphType . |
HorizontalAlignment | HorizontalAlignment | הספירה HorizontalAlignment . |
ParagraphHeading | ParagraphHeading | הספירה ParagraphHeading . |
PositionedLayout | PositionedLayout | הספירה PositionedLayout . |
TextAlignment | TextAlignment | הספירה TextAlignment . |
VerticalAlignment | VerticalAlignment | הספירה VerticalAlignment . |
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
create(name) | Document | יצירה והחזרה של מסמך חדש. |
getActiveDocument() | Document | מחזירה את המסמך שאליו הסקריפט כפוף לקונטיינר. |
getUi() | Ui | פונקציה זו מחזירה מופע של סביבת ממשק המשתמש של המסמך שמאפשרת לסקריפט להוסיף תכונות כגון תפריטים, תיבות דו-שיח וסרגלי צד. |
openById(id) | Document | מחזירה את המסמך עם המזהה שצוין. |
openByUrl(url) | Document | פתיחה והחזרה של המסמך עם כתובת ה-URL שצוינה. |
DocumentTab
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
addBookmark(position) | Bookmark | הפונקציה מוסיפה Bookmark ב-Position הנתון. |
addFooter() | FooterSection | הוספת קטע של כותרת תחתונה של כרטיסייה, אם לא קיים קטע כזה. |
addHeader() | HeaderSection | מוסיפה קטע של כותרת כרטיסייה, אם לא קיים קטע כזה. |
addNamedRange(name, range) | NamedRange | הפונקציה מוסיפה NamedRange , שהוא Range שיש לו שם ומזהה לשימוש
באחזור במועד מאוחר יותר. |
getBody() | Body | אחזור של Body של הכרטיסייה. |
getBookmark(id) | Bookmark | הפונקציה מקבלת את Bookmark עם המזהה הנתון. |
getBookmarks() | Bookmark[] | הפונקציה מקבלת את כל Bookmark האובייקטים בכרטיסייה. |
getFooter() | FooterSection | אחזור של הקטע 'כותרת תחתונה' של הכרטיסייה, אם יש כזה. |
getFootnotes() | Footnote[] | אחזור כל רכיבי Footnote בגוף הכרטיסייה. |
getHeader() | HeaderSection | אחזור של קטע הכותרת של הכרטיסייה, אם יש קטע כזה. |
getNamedRangeById(id) | NamedRange | הפונקציה מקבלת את NamedRange עם המזהה הנתון. |
getNamedRanges() | NamedRange[] | הפונקציה מקבלת את כל NamedRange האובייקטים בכרטיסייה. |
getNamedRanges(name) | NamedRange[] | הפונקציה מקבלת את כל NamedRange האובייקטים בכרטיסייה עם השם הנתון. |
newPosition(element, offset) | Position | יוצר Position חדש, שהוא הפניה למיקום בכרטיסייה, ביחס
לרכיב ספציפי. |
newRange() | RangeBuilder | יצירת 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_SECTION | Enum | הסוג שתואם לרכיב Body . |
COMMENT_SECTION | Enum | הסוג שתואם לרכיב . |
DATE | Enum | הסוג שתואם ל-Date
לרכיב מסוים. |
EQUATION | Enum | הסוג שתואם לרכיב Equation . |
EQUATION_FUNCTION | Enum | הסוג שתואם לרכיב EquationFunction . |
EQUATION_FUNCTION_ARGUMENT_SEPARATOR | Enum | הסוג שתואם ל-EquationFunctionArgumentSeparator
לרכיב מסוים. |
EQUATION_SYMBOL | Enum | הסוג שתואם לרכיב EquationSymbol . |
RICH_LINK | Enum | הסוג שתואם לרכיב RichLink . |
FOOTER_SECTION | Enum | הסוג שתואם לרכיב FooterSection . |
FOOTNOTE | Enum | הסוג שתואם לרכיב Footnote . |
FOOTNOTE_SECTION | Enum | הסוג שתואם לרכיב FootnoteSection . |
HEADER_SECTION | Enum | הסוג שתואם לרכיב HeaderSection . |
HORIZONTAL_RULE | Enum | הסוג שתואם לרכיב HorizontalRule . |
INLINE_DRAWING | Enum | הסוג שתואם לרכיב InlineDrawing . |
INLINE_IMAGE | Enum | הסוג שתואם לרכיב InlineImage . |
LIST_ITEM | Enum | הסוג שתואם לרכיב ListItem . |
PAGE_BREAK | Enum | הסוג שתואם לרכיב PageBreak . |
PARAGRAPH | Enum | הסוג שתואם לרכיב Paragraph . |
PERSON | Enum | הסוג שתואם לרכיב Person . |
TABLE | Enum | הסוג שתואם לרכיב Table . |
TABLE_CELL | Enum | הסוג שתואם לרכיב TableCell . |
TABLE_OF_CONTENTS | Enum | הסוג שתואם לרכיב TableOfContents . |
TABLE_ROW | Enum | הסוג שתואם לרכיב TableRow . |
TEXT | Enum | הסוג שתואם ל-Text
לרכיב מסוים. |
UNSUPPORTED | Enum | הסוג התואם ל-UnsupportedElement . |
Equation
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
clear() | Equation | ניקוי התוכן של הרכיב. |
copy() | Equation | הפונקציה מחזירה עותק עמוק בנפרד עבור הרכיב הנוכחי. |
editAsText() | Text | מתקבלת גרסת Text של הרכיב הנוכחי, לעריכה. |
findElement(elementType) | RangeElement | חיפוש תוכן הרכיב כדי למצוא צאצא מהסוג שצוין. |
findElement(elementType, from) | RangeElement | מחפש את תוכן הרכיב כדי למצוא צאצא מהסוג שצוין, החל מ-
ציינת RangeElement . |
findText(searchPattern) | RangeElement | חיפוש תוכן הרכיב לפי דפוס הטקסט שצוין באמצעות ביטויים רגולריים. |
findText(searchPattern, from) | RangeElement | חיפוש תוכן הרכיב לפי תבנית הטקסט שצוינה, החל ממאפיין נתון בתוצאות החיפוש. |
getAttributes() | Object | אחזור המאפיינים של הרכיב. |
getChild(childIndex) | Element | אחזור הרכיב הצאצא באינדקס הצאצא שצוין. |
getChildIndex(child) | Integer | אחזור של אינדקס הצאצא לרכיב הצאצא שצוין. |
getLinkUrl() | String | אחזור כתובת ה-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
מאפיינים
נכס | סוג | תיאור |
---|---|---|
BULLET | Enum | תבליט ברירת המחדל, מעוגל ומלא. |
HOLLOW_BULLET | Enum | תבליט חלול. |
SQUARE_BULLET | Enum | תבליט מרובע. |
NUMBER | Enum | תבליט מבוסס מספר. |
LATIN_UPPER | Enum | תבליט לטיני עם אותיות רישיות. |
LATIN_LOWER | Enum | תבליט לטיני קטן. |
ROMAN_UPPER | Enum | תבליט ספרה רומית, עם אותיות רישיות. |
ROMAN_LOWER | Enum | ספרה רומית, תבליט קטן. |
HeaderSection
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
appendHorizontalRule() | HorizontalRule | יצירה והוספה של HorizontalRule חדש. |
appendImage(image) | InlineImage | יצירה והוספה של InlineImage חדש מ-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
מאפיינים
נכס | סוג | תיאור |
---|---|---|
LEFT | Enum | אפשרות היישור לשמאל. |
CENTER | Enum | אפשרות יישור למרכז. |
RIGHT | Enum | אפשרות היישור לימין. |
JUSTIFY | Enum | אפשרות יישור לשני הצדדים. |
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
מאפיינים
נכס | סוג | תיאור |
---|---|---|
NORMAL | Enum | אפשרות הכותרת של טקסט רגיל. |
HEADING1 | Enum | האפשרות הגבוהה ביותר לכותרת. |
HEADING2 | Enum | האפשרות השנייה לכותרת. |
HEADING3 | Enum | אפשרות לכותרת השלישית |
HEADING4 | Enum | האפשרות הרביעית לכותרת. |
HEADING5 | Enum | אפשרות הכותרת החמישית. |
HEADING6 | Enum | האפשרות הנמוכה ביותר לכותרת. |
TITLE | Enum | האפשרות של כותרת כותרת. |
SUBTITLE | Enum | האפשרות לכותרת כותרת משנה. |
Person
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
copy() | Person | הפונקציה מחזירה עותק עמוק בנפרד עבור הרכיב הנוכחי. |
getAttributes() | Object | אחזור המאפיינים של הרכיב. |
getEmail() | String | מחזירה את כתובת האימייל של המשתמש. |
getName() | String | מחזירה את השם המוצג של האדם, אם הוא מוגדר. |
getNextSibling() | Element | אחזור של רכיב האח הבא של הרכיב. |
getParent() | ContainerElement | אחזור הרכיב ההורה של הרכיב. |
getPreviousSibling() | Element | אחזור של רכיב האח הקודם של הרכיב. |
getType() | ElementType | מאחזר את ElementType של הרכיב. |
isAtDocumentEnd() | Boolean | הפונקציה קובעת אם הרכיב נמצא בסוף Document . |
merge() | Person | התכונה ממזגת את הרכיב עם האח הקודם מאותו סוג. |
removeFromParent() | Person | הסרת הרכיב מרכיב ההורה שלו. |
setAttributes(attributes) | Person | מגדיר את המאפיינים של הרכיב. |
Position
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
getElement() | Element | הפונקציה מקבלת את הרכיב שמכיל את Position הזה. |
getOffset() | Integer | הפונקציה מקבלת את המיקום היחסי של הPosition הזה בתוך הרכיב שמכיל אותו. |
getSurroundingText() | Text | יוצר רכיב Text מלאכותי שמייצג את הטקסט והעיצוב של
Paragraph או ListItem שמכילים את Position , באופן ישיר או דרך שרשרת של רכיבי צאצא. |
getSurroundingTextOffset() | Integer | הפונקציה מקבלת את ההיסט של Position שבתוך הרכיב Text שמוחזר על ידי getSurroundingText() . |
insertBookmark() | Bookmark | יצירה והוספה של Bookmark חדש בPosition הזה. |
insertInlineImage(image) | InlineImage | יצירה והוספה של InlineImage חדש ב-Position מהתמונה שצוינה
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_TEXT | Enum | התמונה ממוקמת מעל הטקסט. |
BREAK_BOTH | Enum | הטקסט ייקטע מימין ומשמאל. |
BREAK_LEFT | Enum | הטקסט ייקטע מימין. |
BREAK_RIGHT | Enum | התמונה קוטעת את הטקסט מימין. |
WRAP_TEXT | Enum | התמונה מוקפת בטקסט. |
Range
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
getRangeElements() | RangeElement[] | מקבל את כל הרכיבים ב-Range , כולל רכיבי Text חלקיים (לדוגמה, במקרה
של בחירה שכוללת רק חלק מרכיב Text ). |
RangeBuilder
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
addElement(element) | RangeBuilder | הוספה של Element שלם אל RangeBuilder . |
addElement(textElement, startOffset, endOffsetInclusive) | RangeBuilder | הוספת רכיב Text חלקי למכשיר RangeBuilder הזה. |
addElementsBetween(startElement, endElementInclusive) | RangeBuilder | הפונקציה מוסיפה שני רכיבים שלמים ואת כל הרכיבים שביניהם לRangeBuilder . |
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) | RangeBuilder | הפונקציה מוסיפה ל-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 | קובע אם רכיב הטווח הזה מכסה את כל הרכיב או בחירה חלקית של של הרכיב. |
RichLink
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
copy() | RichLink | הפונקציה מחזירה עותק עמוק בנפרד עבור הרכיב הנוכחי. |
getAttributes() | Object | אחזור המאפיינים של הרכיב. |
getMimeType() | String | הפונקציה מחזירה את סוג ה-MIME של
הקישור שזמין כאשר הפריט הוא קישור לקובץ ב-Drive ו-null
אחרת. |
getNextSibling() | Element | אחזור של רכיב האח הבא של הרכיב. |
getParent() | ContainerElement | אחזור הרכיב ההורה של הרכיב. |
getPreviousSibling() | Element | אחזור של רכיב האח הקודם של הרכיב. |
getTitle() | String | מחזירה את הכותרת המוצגת של הקישור. |
getType() | ElementType | מאחזר את ElementType של הרכיב. |
getUrl() | String | הפונקציה מחזירה את כתובת ה-URL של המשאב. |
isAtDocumentEnd() | Boolean | הפונקציה קובעת אם הרכיב נמצא בסוף Document . |
merge() | RichLink | התכונה ממזגת את הרכיב עם האח הקודם מאותו סוג. |
removeFromParent() | RichLink | הסרת הרכיב מרכיב ההורה שלו. |
setAttributes(attributes) | RichLink | מגדיר את המאפיינים של הרכיב. |
Tab
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
asDocumentTab() | DocumentTab | אחזור של תוכן הכרטיסייה בתור DocumentTab . |
getChildTabs() | Tab[] | אחזור של כרטיסיות הצאצא שהוצבו בכרטיסייה הזו. |
getId() | String | אחזור של מזהה הכרטיסייה. |
getIndex() | Integer | מאחזר את האינדקס מבוסס 0 של הכרטיסייה בתוך תבנית ההורה. |
getTitle() | String | אחזור של כותרת הכרטיסייה. |
getType() | TabType | אחזור של סוג הכרטיסייה. |
TabType
מאפיינים
נכס | סוג | תיאור |
---|---|---|
DOCUMENT_TAB | Enum | הסוג התואם ל-DocumentTab . |
Table
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
appendTableRow() | TableRow | יצירה והוספה של TableRow חדש. |
appendTableRow(tableRow) | TableRow | הפונקציה מצרפת את הערך של TableRow הנתון. |
clear() | Table | ניקוי התוכן של הרכיב. |
copy() | Table | הפונקציה מחזירה עותק עמוק בנפרד עבור הרכיב הנוכחי. |
editAsText() | Text | מתקבלת גרסת Text של הרכיב הנוכחי, לעריכה. |
findElement(elementType) | RangeElement | חיפוש תוכן הרכיב כדי למצוא צאצא מהסוג שצוין. |
findElement(elementType, from) | RangeElement | מחפש את תוכן הרכיב כדי למצוא צאצא מהסוג שצוין, החל מ-
ציינת RangeElement . |
findText(searchPattern) | RangeElement | חיפוש תוכן הרכיב לפי דפוס הטקסט שצוין באמצעות ביטויים רגולריים. |
findText(searchPattern, from) | RangeElement | חיפוש תוכן הרכיב לפי תבנית הטקסט שצוינה, החל ממאפיין נתון בתוצאות החיפוש. |
getAttributes() | Object | אחזור המאפיינים של הרכיב. |
getBorderColor() | String | אחזור של צבע הגבולות. |
getBorderWidth() | Number | אחזור רוחב הגבול בנקודות. |
getCell(rowIndex, cellIndex) | TableCell | אחזור של TableCell בשורה ובאינדקסי התאים שצוינו. |
getChild(childIndex) | Element | אחזור הרכיב הצאצא באינדקס הצאצא שצוין. |
getChildIndex(child) | Integer | אחזור של אינדקס הצאצא לרכיב הצאצא שצוין. |
getColumnWidth(columnIndex) | Number | אחזור הרוחב של עמודת הטבלה שצוינה, בנקודות. |
getLinkUrl() | String | אחזור כתובת ה-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
מאפיינים
נכס | סוג | תיאור |
---|---|---|
NORMAL | Enum | היישור הרגיל של הטקסט. |
SUPERSCRIPT | Enum | יישור הטקסט בכתב עילי. |
SUBSCRIPT | Enum | יישור הטקסט בכתב תחתי. |
UnsupportedElement
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
copy() | UnsupportedElement | הפונקציה מחזירה עותק עמוק בנפרד עבור הרכיב הנוכחי. |
getAttributes() | Object | אחזור המאפיינים של הרכיב. |
getNextSibling() | Element | אחזור של רכיב האח הבא של הרכיב. |
getParent() | ContainerElement | אחזור הרכיב ההורה של הרכיב. |
getPreviousSibling() | Element | אחזור של רכיב האח הקודם של הרכיב. |
getType() | ElementType | מאחזר את ElementType של הרכיב. |
isAtDocumentEnd() | Boolean | הפונקציה קובעת אם הרכיב נמצא בסוף Document . |
merge() | UnsupportedElement | התכונה ממזגת את הרכיב עם האח הקודם מאותו סוג. |
removeFromParent() | UnsupportedElement | הסרת הרכיב מרכיב ההורה שלו. |
setAttributes(attributes) | UnsupportedElement | מגדיר את המאפיינים של הרכיב. |
VerticalAlignment
מאפיינים
נכס | סוג | תיאור |
---|---|---|
BOTTOM | Enum | אפשרות היישור התחתון. |
CENTER | Enum | אפשרות יישור למרכז. |
TOP | Enum | אפשרות היישור העליון. |