Class DocumentTab

כרטיסייתהמסמך

כרטיסיית מסמך שמכילה טקסט עשיר ורכיבים כמו טבלאות ורשימות.

כדי לאחזר כרטיסיית מסמך, מקישים על Document.getTabs()[tabIndex].asDocumentTab().

// Get a specific document tab based on the tab ID.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
addBookmark(position)	Bookmark	הוספת Bookmark ב-Position שצוין.
addFooter()	FooterSection	הוספת קטע כותרת תחתונה לכרטיסייה, אם אין כזה.
addHeader()	HeaderSection	הוספת קטע של כותרת כרטיסייה, אם אין כזה.
addNamedRange(name, range)	NamedRange	הוספת NamedRange, שהוא Range עם שם ומזהה לשימוש לאחזור מאוחר יותר.
getBody()	Body	אחזור של Body של הכרטיסייה.
getBookmark(id)	Bookmark	הפונקציה מקבלת את Bookmark עם המזהה הנתון.
getBookmarks()	Bookmark[]	אחזור כל האובייקטים מסוג Bookmark בכרטיסייה.
getFooter()	FooterSection	אחזור הקטע של הכותרת התחתונה של הכרטיסייה, אם יש כזה.
getFootnotes()	Footnote[]	אחזור כל הרכיבים מסוג Footnote בגוף הכרטיסייה.
getHeader()	HeaderSection	אחזור של קטע הכותרת של הכרטיסייה, אם יש כזה.
getNamedRangeById(id)	NamedRange	הפונקציה מקבלת את NamedRange עם המזהה הנתון.
getNamedRanges()	NamedRange[]	אחזור כל האובייקטים מסוג NamedRange בכרטיסייה.
getNamedRanges(name)	NamedRange[]	הפונקציה מקבלת את כל אובייקטי ה-NamedRange בכרטיסייה עם השם שצוין.
newPosition(element, offset)	Position	יצירת Position חדש, שהוא הפניה למיקום בכרטיסייה ביחס לרכיב ספציפי.
newRange()	RangeBuilder	יצירת בונה המשמש ליצירת אובייקטים מסוג Range מרכיבי כרטיסיות.

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

addBookmark(position)

הוספת Bookmark ב-Position שצוין.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the tab body and adds a paragraph.
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');

// Creates a position at the first character of the paragraph text.
const position = documentTab.newPosition(paragraph.getChild(0), 0);

// Adds a bookmark at the first character of the paragraph text.
const bookmark = documentTab.addBookmark(position);

// Logs the bookmark ID to the console.
console.log(bookmark.getId());

פרמטרים

שם	סוג	תיאור
position	Position	המיקום של הסימנייה החדשה.

חזרה

Bookmark — הסימנייה החדשה.

אישור

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

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

---

addFooter()

הוספת קטע כותרת תחתונה לכרטיסייה, אם אין כזה.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Adds a footer to the tab.
const footer = documentTab.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

חזרה

FooterSection — הכותרת התחתונה של הכרטיסייה.

אישור

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

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

---

addHeader()

הוספת קטע של כותרת כרטיסייה, אם אין כזה.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Adds a header to the tab.
const header = documentTab.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

חזרה

HeaderSection — כותרת הכרטיסייה.

אישור

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

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

---

addNamedRange(name, range)

הוספת NamedRange, שהוא Range עם שם ומזהה לשימוש לאחזור מאוחר יותר. השמות לא חייבים להיות ייחודיים, גם בין כרטיסיות. כמה טווחים שונים באותו מסמך יכולים לשתף את אותו שם, בדומה לכיתה ב-HTML. לעומת זאת, מזהים הם ייחודיים במסמך, כמו מזהה ב-HTML. אחרי שמוסיפים את התג NamedRange, אי אפשר לשנות אותו, אפשר רק להסיר אותו.

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

// Creates a named range that includes every table in a tab by its ID.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
documentTab.addNamedRange('Tab t.0 tables', rangeBuilder.build());

פרמטרים

שם	סוג	תיאור
name	String	השם של הטווח, שלא חייב להיות ייחודי. שמות של טווחים חייבים להכיל בין תו אחד ל-256 תווים.
range	Range	טווח הרכיבים שרוצים לשייך לשם. הטווח יכול להיות תוצאת חיפוש או טווח שנוצר באופן ידני באמצעות newRange().

חזרה

NamedRange — הNamedRange.

אישור

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

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

---

getBody()

אחזור של Body של הכרטיסייה.

כרטיסיות יכולות להכיל סוגים שונים של קטעים (לדוגמה, HeaderSection, FooterSection). הקטע הפעיל בכרטיסייה הוא Body.

שיטות הרכיבים ב-DocumentTab מעבירות את הגישה ל-Body.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the tab body.
const body = documentTab.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

חזרה

Body – קטע הגוף של הכרטיסייה.

אישור

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

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

---

getBookmark(id)

הפונקציה מקבלת את Bookmark עם המזהה הנתון. אם אין Bookmark כזה בכרטיסייה הזו, ה-method מחזיר את הערך null.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the bookmark by its ID.
const bookmark = documentTab.getBookmark('id.xyz654321');

// If the bookmark exists within the tab, logs the character offset of its
// position to the console. Otherwise, logs 'No bookmark exists with the given
// ID.' to the console.
if (bookmark) {
  console.log(bookmark.getPosition().getOffset());
} else {
  console.log('No bookmark exists with the given ID.');
}

פרמטרים

שם	סוג	תיאור
id	String	המזהה של Bookmark.

חזרה

Bookmark – ה-Bookmark עם המזהה הנתון, או null אם לא קיים Bookmark כזה בכרטיסייה.

אישור

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

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

---

getBookmarks()

אחזור כל האובייקטים מסוג Bookmark בכרטיסייה.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets all of the bookmarks in the tab.
const bookmarks = documentTab.getBookmarks();

// Logs the number of bookmarks in the tab to the console.
console.log(bookmarks.length);

חזרה

Bookmark[] – מערך של אובייקטי Bookmark בכרטיסייה.

אישור

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

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

---

getFooter()

אחזור הקטע של הכותרת התחתונה של הכרטיסייה, אם יש כזה.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the text of the tab's footer and logs it to the console.
console.log(documentTab.getFooter().getText());

חזרה

FooterSection – הכותרת התחתונה של הכרטיסייה.

אישור

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

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

---

getFootnotes()

אחזור כל הרכיבים מסוג Footnote בגוף הכרטיסייה.

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

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the first footnote.
const footnote = documentTab.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

חזרה

Footnote[] — הערות השוליים של הכרטיסייה.

אישור

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

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

---

getHeader()

אחזור של קטע הכותרת של הכרטיסייה, אם יש כזה.

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the text of the tab's header and logs it to the console.
console.log(documentTab.getHeader().getText());

חזרה

HeaderSection — הכותרת של הכרטיסייה.

אישור

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

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

---

getNamedRangeById(id)

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

פרמטרים

שם	סוג	תיאור
id	String	המזהה של הטווח, שהוא ייחודי בכרטיסייה.

חזרה

NamedRange – ה-NamedRange עם המזהה שצוין, או null אם אין טווח כזה בכרטיסייה.

אישור

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

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

---

getNamedRanges()

אחזור כל האובייקטים מסוג NamedRange בכרטיסייה.

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

חזרה

NamedRange[] – מערך של אובייקטי NamedRange בכרטיסייה, שעשוי לכלול כמה טווחים עם אותו שם.

אישור

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

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

---

getNamedRanges(name)

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

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

פרמטרים

שם	סוג	תיאור
name	String	שם הטווח, שלא חייב להיות ייחודי.

חזרה

NamedRange[] – מערך של אובייקטי NamedRange בכרטיסייה עם השם שצוין.

אישור

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

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

---

newPosition(element, offset)

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

// Append a paragraph, then place the user's cursor after the first word of the
// new paragraph.
// TODO(developer): Replace the IDs with your own.
const doc = DocumentApp.openById('123abc');
const documentTab = doc.getTab('123abc').asDocumentTab();
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
const position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

פרמטרים

שם	סוג	תיאור
element	Element	הרכיב שמכיל את ה-Position החדש שנוצר. הרכיב הזה חייב להיות רכיב Text או רכיב קונטיינר כמו Paragraph.
offset	Integer	ברכיבי Text, מספר התווים לפני Position. ברכיבים אחרים, מספר רכיבי הצאצאים לפני Position באותו רכיב קונטיינר.

חזרה

Position — השדה החדש Position.

אישור

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

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

---

newRange()

יצירת בונה המשמש ליצירת אובייקטים מסוג Range מרכיבי כרטיסיות.

// Change the user's selection to a range that includes every table in the tab.
// TODO(developer): Replace the IDs with your own.
const doc = DocumentApp.openById('123abc');
const documentTab = doc.getTab('123abc').asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

חזרה

RangeBuilder – ה-builder החדש.

אישור

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

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