Class DocumentTab

DocumentTab

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

אחזור כרטיסייה של מסמך באמצעות Document.getTabs()[tabIndex].asDocumentTab().

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

שיטות

שיטה	סוג הערך המוחזר	תיאור קצר
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	יצירת builder שמשמש לבניית אובייקטים של 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(DOCUMENT_ID).getTab(TAB_ID).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(DOCUMENT_ID).getTab(TAB_ID).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(DOCUMENT_ID).getTab(TAB_ID).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.
var documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();
var rangeBuilder = documentTab.newRange();
var tables = documentTab.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
documentTab.addNamedRange('Tab t.0 tables', rangeBuilder.build());

פרמטרים

שם	סוג	תיאור
name	String	השם של הטווח, שלא חייב להיות ייחודי. שמות של טווחים חייבים להיות באורך של 1-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(DOCUMENT_ID).getTab(TAB_ID).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 עם המזהה הנתון. השיטה הזו מחזירה את הערך null אם לא קיים 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(DOCUMENT_ID).getTab(TAB_ID).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(DOCUMENT_ID).getTab(TAB_ID).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(DOCUMENT_ID).getTab(TAB_ID).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(DOCUMENT_ID).getTab(TAB_ID).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(DOCUMENT_ID).getTab(TAB_ID).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.
var doc = DocumentApp.openById(DOCUMENT_ID);
var documentTab = doc.getTab(TAB_ID).asDocumentTab();
var paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
var 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()

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

// Change the user's selection to a range that includes every table in the tab.
// TODO(developer): Replace the IDs with your own.
var doc = DocumentApp.openById(DOCUMENT_ID);
var documentTab = doc.getTab(TAB_ID).asDocumentTab();
var rangeBuilder = documentTab.newRange();
var tables = documentTab.getBody().getTables();
for (var 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