דף זה תורגם על ידי Cloud Translation API.

Class Position

הפניה למיקום בכרטיסיית המסמך, ביחס לרכיב ספציפי. הסמן של המשתמש מיוצג בתור 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().

חזרה

Element – הקונטיינר או הרכיב Text שבהם נמצא האובייקט Position הזה

`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()`

יצירה והוספה של Bookmark חדש בPosition הזה.

חזרה

Bookmark – הסימנייה החדשה

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`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