Class Position

מיקום

הפניה למיקום בכרטיסייה של המסמך, ביחס לרכיב ספציפי. הסמן של המשתמש מיוצג כ-Position, בין היתר. תסריטים יכולים לגשת לסמן של המשתמש שמפעיל את הסקריפט, ורק אם הסקריפט קשור למסמך. 

// Insert some text at the cursor position and make it bold.
const 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.
  const element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

Methods

שיטהסוג הערך המוחזרתיאור קצר
getElement()Elementהפונקציה מקבלת את הרכיב שמכיל את Position הזה.
getOffset()Integerהפונקציה מקבלת את המיקום היחסי של Position בתוך הרכיב שמכיל אותו.
getSurroundingText()Textיצירת רכיב Text מלאכותי שמייצג את הטקסט והפורמט של ה-Paragraph או ה-ListItem שמכיל את ה-Position, באופן ישיר או באמצעות שרשרת של רכיבי צאצא.
getSurroundingTextOffset()Integerהפונקציה מקבלת את ההיסט של Position בתוך רכיב Text שמוחזר על ידי getSurroundingText().
insertBookmark()Bookmarkיצירת Bookmark חדש והוספתו ל-Position הזה.
insertInlineImage(image)InlineImageיצירת InlineImage חדש והוספה שלו ל-Position הזה מה-blob של התמונה שצוין.
insertText(text)Textהוספת הטקסט שצוין ב-Position הזה.

מסמכים מפורטים

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 של התמונה שצוין.

פרמטרים

שםסוגתיאור
imageBlobSourceנתוני התמונה שרוצים להוסיף ב-Position הזה

חזרה

InlineImage – אלמנט התמונה החדש, או null אם האלמנט שבו נמצא Position לא מאפשר להוסיף תמונות

אישור

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

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

insertText(text)

הוספת הטקסט שצוין ב-Position הזה. השיטה הזו יוצרת אלמנט Text חדש, גם אם המחרוזת מוכנסת לאלמנט Text קיים, כדי שיהיה קל לעצב את האלמנט החדש.

פרמטרים

שםסוגתיאור
textStringהמחרוזת להוספה ב-Position הזה

חזרה

Text – רכיב הטקסט החדש, או null אם הרכיב שבו נמצא Position לא מאפשר להוסיף טקסט

אישור

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

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