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|nullיוצר ומכניס InlineImage חדש במיקום Position הזה מ-blob התמונה שצוין.
insertText(text)Text|nullהוספת הטקסט שצוין במיקום 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 – רכיב התמונה החדש, או null אם הרכיב שבו נמצא Position לא מאפשר הוספה של תמונות

אישור

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

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

insertText(text)

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

פרמטרים

שםסוגתיאור
textStringהמחרוזת שרוצים להוסיף במיקום Position

חזרה

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

אישור

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

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