הפניה למיקום במסמך, ביחס לרכיב ספציפי. הסמן של המשתמש מיוצג, בין היתר, בתור Position
. סקריפטים יכולים לגשת רק לסמן של המשתמש שמריץ את הסקריפט, ורק אם הסקריפט מקושר למסמך.
// Insert some text at the cursor position and make it bold. var cursor = DocumentApp.getActiveDocument().getCursor(); if (cursor) { // Attempt to insert text at the cursor position. If the insertion returns null, the cursor's // containing element doesn't allow insertions, so show the user an error message. var element = cursor.insertText('ಠ‿ಠ'); if (element) { element.setBold(true); } else { DocumentApp.getUi().alert('Cannot insert text here.'); } } else { DocumentApp.getUi().alert('Cannot find a cursor.'); }
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
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 . |
תיעוד מפורט
getElement()
הפונקציה מקבלת את הרכיב שמכיל את ה-Position
הזה. זה יכול להיות רכיב Text
או רכיב קונטיינר כמו Paragraph
. בכל מקרה, ניתן לקבוע את המיקום היחסי בתוך הרכיב באמצעות getOffset()
.
החזרות
getOffset()
הפונקציה מקבלת את המיקום היחסי של Position
בתוך הרכיב שמכיל אותו. אם הרכיב הוא רכיב Text
, ההיסט הוא מספר התווים לפני Position
(כלומר, האינדקס של התו אחרי Position
). לכל רכיב אחר, ההיסט הוא מספר האלמנטים הצאצאים שמופיעים לפני Position
באותו רכיב קונטיינר (כלומר, האינדקס של רכיב הצאצא אחרי Position
).
החזרות
Integer
– עבור רכיבי Text
, מספר התווים לפני Position
; עבור רכיבים אחרים, מספר רכיבי הצאצא לפני Position
הזה בתוך אותו רכיב מאגר
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSurroundingText()
יוצרת רכיב Text
מלאכותי שמייצג את הטקסט ואת העיצוב של
Paragraph
או של ListItem
שמכיל את Position
, באופן ישיר או דרך שרשרת של אלמנטים צאצאים. כדי לקבוע את הקיזוז של Position
ברכיב Text
שהוחזר, יש להשתמש בפונקציה getSurroundingTextOffset()
.
החזרות
Text
- רכיב שווה ערך לתוצאת הקריאה ל-editAsText()
ב-Paragraph
או ב-ListItem
שמכיל את Position
, באופן ישיר או דרך שרשרת של רכיבי צאצא
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSurroundingTextOffset()
הפונקציה מקבלת את הקיזוז של Position
הזה בתוך הרכיב Text
שהוחזר על ידי getSurroundingText()
. ההיסט הוא מספר התווים לפני Position
(כלומר, האינדקס של התו אחרי Position
).
החזרות
Integer
– מספר התווים לפני Position
ב-Paragraph
או ב-ListItem
שמכילים את Position
, באופן ישיר או דרך שרשרת של רכיבי צאצא
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertBookmark()
insertInlineImage(image)
הפונקציה יוצרת ומוסיפה InlineImage
חדש ב-Position
מה-blob
של התמונה שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
image | BlobSource | נתוני התמונה להוספה בPosition |
החזרות
InlineImage
- רכיב התמונה החדש. לחלופין, null
אם הרכיב שבו נמצא Position
לא מאפשר הוספה של תמונות
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertText(text)
הוספת הטקסט שצוין בשדה Position
. השיטה הזו יוצרת רכיב Text
חדש, גם אם המחרוזת מוכנסת לתוך רכיב Text
קיים, כך שקל
לעצב את הרכיב החדש.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
text | String | המחרוזת שיש להוסיף ב-Position |
החזרות
Text
- רכיב הטקסט החדש, או null
אם לא ניתן להוסיף טקסט לאלמנט שבו Position
נמצא
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents