שירות זה מאפשר לסקריפטים ליצור קובצי Google Docs, לגשת אליהם ולשנות אותם.
// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE');
// Create and open a document.
doc = DocumentApp.create('Document Name');
מחלקות
שם | תיאור קצר |
---|---|
Attribute | זהו ספירה של מאפייני הרכיב. |
Body | רכיב שמייצג גוף מסמך. |
Bookmark | אובייקט שמייצג סימנייה. |
ContainerElement | רכיב גנרי שעשוי להכיל רכיבים אחרים. |
Date | רכיב שמייצג תאריך בפורמט |
Document | מסמך, שמכיל טקסט עשיר ורכיבים כמו טבלאות ורשימות. |
DocumentApp | שירות המסמכים יוצר ופותח קובץ Documents שניתן לערוך. |
Element | רכיב כללי. |
ElementType | זהו ספירה של כל סוגי הרכיבים. |
Equation | רכיב שמייצג ביטוי מתמטי. |
EquationFunction | רכיב שמייצג פונקציה בפונקציה Equation מתמטית. |
EquationFunctionArgumentSeparator | רכיב שמייצג מפריד פונקציה בפונקציה Equation מתמטית. |
EquationSymbol | רכיב שמייצג סמל בפונקציה Equation מתמטית. |
| המספור של הגופנים הנתמכים. |
FooterSection | רכיב שמייצג קטע של כותרת תחתונה. |
Footnote | רכיב שמייצג הערת שוליים. |
FootnoteSection | רכיב שמייצג קטע של הערת שוליים. |
GlyphType | ספירה של סוגי הגליף הנתמכים. |
HeaderSection | רכיב שמייצג קטע של כותרת. |
HorizontalAlignment | המספור של סוגי היישור האופקי הנתמכים. |
HorizontalRule | רכיב שמייצג כלל אופקי. |
InlineDrawing | רכיב שמייצג שרטוט מוטמע. |
InlineImage | רכיב שמייצג תמונה מוטמעת. |
ListItem | רכיב שמייצג פריט ברשימה. |
NamedRange | Range שיש לו שם ומזהה שמאפשרים אחזור מאוחר יותר. |
PageBreak | רכיב שמייצג מעבר דף. |
Paragraph | רכיב שמייצג פסקה. |
ParagraphHeading | זהו ספירה של הכותרות הרגילות של פסקאות. |
Person | רכיב שמייצג קישור לאדם. |
Position | הפניה למיקום במסמך, ביחס לרכיב ספציפי. |
PositionedImage | תמונה במיקום קבוע מעוגנת ל-Paragraph . |
PositionedLayout | ספירה שמציינת איך לפרוס PositionedImage ביחס לטקסט
סביב. |
Range | טווח של רכיבים במסמך. |
RangeBuilder | כלי לבניית מודלים של Range אובייקטים מרכיבי מסמכים. |
RangeElement | wrapper מסביב ל-Element עם אפשרות לקיזוז התחלה וסיום. |
RichLink | רכיב שמייצג קישור למשאב של Google, כמו קובץ ב-Drive או סרטון ב-YouTube. |
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 בתוך Document . |
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
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
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 . |
getAs(contentType) | Blob | מאחזר את התוכן הנוכחי של Document כ-blob מהסוג שצוין. |
getBlob() | Blob | אחזור התוכן הנוכחי של Document כ-blob. |
getBody() | Body | מאחזר את Body של המסמך הפעיל. |
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. |
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 . |
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 שצוינה. |
Element
שיטות
ElementType
תכונות
נכס | תיאור | התיאור |
---|---|---|
BODY_SECTION | Enum | הסוג שמתאים לרכיב Body . |
COMMENT_SECTION | Enum | הסוג שמתאים לרכיב . |
DATE | Enum | הסוג שמתאים לרכיב Date . |
DOCUMENT | Enum | הסוג שתואם לשורש של המסמך. |
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 | מגדיר את כתובת האתר של הקישור. |
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 מההגדרות שהוחלו על הבונה. |
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 | מגדיר את מאפייני הרכיב. |
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 | מגדיר את כתובת ה-URL לקישור בטווח התווים שצוין. |
setLinkUrl(url) | Text | מגדיר את כתובת האתר של הקישור. |
setStrikethrough(strikethrough) | Text | מגדיר את ההגדרה של קו חוצה. |
setStrikethrough(startOffset, endOffsetInclusive, strikethrough) | Text | קובע את ההגדרה של קו חוצה לטווח התווים שצוין. |
setText(text) | Text | מגדיר את תוכן הטקסט. |
setTextAlignment(startOffset, endOffsetInclusive, textAlignment) | Text | מגדיר את יישור הטקסט לטווח תווים נתון. |
setTextAlignment(textAlignment) | Text | הגדרת יישור הטקסט. |
setUnderline(underline) | Text | קביעת ההגדרה של קו תחתון. |
setUnderline(startOffset, endOffsetInclusive, underline) | Text | קביעת ההגדרה של קו תחתון לטווח התווים שצוין. |
TextAlignment
תכונות
נכס | תיאור | התיאור |
---|---|---|
NORMAL | Enum | היישור הרגיל של הטקסט. |
SUPERSCRIPT | Enum | יישור הטקסט בכתב עילי. |
SUBSCRIPT | Enum | היישור של הטקסט בכתב תחתי. |
UnsupportedElement
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
copy() | UnsupportedElement | מחזירה עותק מנותק ועמוק של הרכיב הנוכחי. |
getAttributes() | Object | מאחזר את מאפייני הרכיב. |
getNextSibling() | Element | שולפת את הרכיב האח הבא של הרכיב. |
getParent() | ContainerElement | אחזור של רכיב ההורה של הרכיב. |
getPreviousSibling() | Element | אחזור הרכיב האח הקודם של הרכיב. |
getType() | ElementType | אחזור ה-ElementType של הרכיב. |
isAtDocumentEnd() | Boolean | קובע אם הרכיב נמצא בסוף Document . |
merge() | UnsupportedElement | ממזג את הרכיב עם האח הקודם מאותו הסוג. |
removeFromParent() | UnsupportedElement | מסיר את הרכיב מההורה שלו. |
setAttributes(attributes) | UnsupportedElement | מגדיר את מאפייני הרכיב. |
VerticalAlignment
תכונות
נכס | תיאור | התיאור |
---|---|---|
BOTTOM | Enum | אפשרות היישור התחתון. |
CENTER | Enum | אפשרות היישור למרכז. |
TOP | Enum | אפשרות היישור העליון. |