Class Document

הפונקציה מוסיפה Bookmark במיקום Position בכרטיסייה הראשונה, או בכרטיסייה הפעילה אם הסקריפט מאוגד למסמך. כדי להוסיף סימנייה לכרטיסייה כלשהי, משתמשים בשיטה DocumentTab.addBookmark(position).

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the active or first tab's body and adds a paragraph.
const paragraph = doc.getBody().appendParagraph('My new paragraph.');

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

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

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

פרמטרים

חזרה

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

אישור

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

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

הפונקציה מוסיפה את המשתמש שצוין לרשימת העורכים של Document. אם המשתמש כבר היה ברשימת הצופים, השיטה הזו מוציאה את המשתמש מרשימת הצופים.

פרמטרים

חזרה

‫Document — Document הזה, לשרשור.

אישור

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

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

הפונקציה מוסיפה את המשתמש שצוין לרשימת העורכים של Document. אם המשתמש כבר היה ברשימת הצופים, השיטה הזו מוציאה את המשתמש מרשימת הצופים.

פרמטרים

חזרה

‫Document — Document הזה, לשרשור.

אישור

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

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

מוסיף את מערך המשתמשים שצוין לרשימת בעלי הרשאת העריכה של Document. אם חלק מהמשתמשים כבר היו ברשימת הצופים, השיטה הזו תוציא אותם מרשימת הצופים.

פרמטרים

חזרה

‫Document — Document הזה, לשרשור.

אישור

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

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

מוסיף קטע של כותרת תחתונה, אם הוא לא קיים, לכרטיסייה הראשונה או, בסקריפטים מאוגדים למסמך, לכרטיסייה הפעילה. כדי להוסיף קטע של כותרת תחתונה לכל כרטיסייה, משתמשים בשיטה DocumentTab.addFooter().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Adds a footer to the document's active or first tab.
const footer = doc.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

הפונקציה מוסיפה קטע כותרת, אם לא קיים כזה, לכרטיסייה הראשונה או, אם הסקריפט מאוגד למסמך, לכרטיסייה הפעילה. כדי להוסיף כותרת לכל כרטיסייה, משתמשים בשיטה DocumentTab.addHeader().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Adds a header to the document's active or first tab.
const header = doc.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

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

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

// Creates a named range that includes every table in the active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
// Adds the named range to the document's active tab.
doc.addNamedRange('Document tables', rangeBuilder.build());

פרמטרים

חזרה

NamedRange — The NamedRange.

אישור

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

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

הפונקציה מוסיפה את המשתמש שצוין לרשימת הצופים של Document. אם המשתמש כבר נמצא ברשימת העורכים, לשיטה הזו אין השפעה.

פרמטרים

חזרה

‫Document — Document הזה, לשרשור.

אישור

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

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

הפונקציה מוסיפה את המשתמש שצוין לרשימת הצופים של Document. אם המשתמש כבר נמצא ברשימת העורכים, לשיטה הזו אין השפעה.

פרמטרים

חזרה

‫Document — Document הזה, לשרשור.

אישור

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

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

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

פרמטרים

חזרה

‫Document — Document הזה, לשרשור.

אישור

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

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

מחזירה את Tab הפעיל כרגע של המשתמש במסמך. סקריפט יכול לגשת רק לכרטיסייה הפעילה של המשתמש שמריץ את הסקריפט, ורק אם הסקריפט מקשר למסמך.

// Display a dialog box that shows the title of the tab that the
// user is currently viewing.
const tab = DocumentApp.getActiveDocument().getActiveTab();
DocumentApp.getUi().alert(`ID of selected tab: ${tab.getTitle()}`);

חזרה

‫Tab|null — Tab הפעיל הנוכחי של המשתמש, או null אם הסקריפט לא מקושר למסמך.

אישור

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

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

אחזור התוכן הנוכחי של Document כ-blob מהסוג שצוין.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the document as a PDF.
const pdf = doc.getAs('application/pdf');

// Logs the name of the PDF to the console.
console.log(pdf.getName());

פרמטרים

חזרה

‫Blob — המסמך הנוכחי כאובייקט Blob.

מאחזר את התוכן הנוכחי של Document כ-blob.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Retrieves the current document's contents as a blob and logs it to the
// console.
console.log(doc.getBlob().getContentType());

חזרה

‫Blob — המסמך הנוכחי כאובייקט Blob.

מחזירה את Body של הכרטיסייה הראשונה, או, בסקריפטים שמאוגדים למסמך, את DocumentBodySection של הכרטיסייה הפעילה. כדי לקבל את DocumentBodySection של כרטיסייה כלשהי, משתמשים בשיטה DocumentTab.getBody().

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

שיטות הרכיב ב-Document מוקצות ל-Body הפעיל.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the active or first tab's body.
const body = doc.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

מחזירה את Bookmark עם המזהה שצוין בכרטיסייה הראשונה, או בכרטיסייה הפעילה אם מדובר בסקריפטים מאוגדים למסמך. כדי להוסיף סימנייה לכרטיסייה כלשהי, משתמשים בשיטה DocumentTab.getBookmark(id). השיטה הזו מחזירה null אם לא קיים Bookmark כזה בכרטיסייה.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the bookmark by its ID in the document's active or first tab.
const bookmark = doc.getBookmark('id.xyz654321');

// If the bookmark exists, 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.');
}

פרמטרים

חזרה

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

אישור

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

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

מחזירה את כל האובייקטים Bookmark בכרטיסייה הראשונה, או בכרטיסייה הפעילה אם הסקריפט מאוגד למסמך. כדי לקבל את כל הסימניות בכל כרטיסייה, משתמשים בשיטה DocumentTab.getBookmarks().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
const doc = DocumentApp.openById('123abc');

// Gets all of the bookmarks in the document's active or first tab.
const bookmarks = doc.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

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

// 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.');
}

חזרה

‫Position|null – ייצוג של מיקום הסמן של המשתמש, או null אם המשתמש לא מיקם את הסמן בכרטיסייה או אם הסקריפט לא משויך למסמך.

אישור

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

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

מחזירה את רשימת העורכים של ה-Document הזה.

חזרה

‫User[] — מערך של משתמשים עם הרשאת עריכה.

אישור

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

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

מחזירה את קטע הכותרת התחתונה של הכרטיסייה הראשונה, או של הכרטיסייה הפעילה בסקריפטים מאוגדים למסמך. כדי לקבל את קטע הכותרת התחתונה של כרטיסייה כלשהי, משתמשים בשיטה DocumentTab.getFooter().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

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

חזרה

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

אישור

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

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

מאחזר את כל רכיבי Footnote בגוף של הכרטיסייה הראשונה, או בגוף של הכרטיסייה הפעילה בסקריפטים שמאוגדים למסמך. כדי לקבל את כל הערות השוליים בכל כרטיסייה, משתמשים בשיטה DocumentTab.getFootnotes().

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

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the first footnote in the active or first tab's body.
const footnote = doc.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

מחזירה את קטע הכותרת של הכרטיסייה הראשונה, או, בסקריפטים שמאוגדים למסמך, את קטע הכותרת של הכרטיסייה הפעילה. כדי להגיע לאזור הכותרת של כרטיסייה כלשהי, משתמשים בשיטה DocumentTab.getHeader().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

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

חזרה

‫HeaderSection|null – הכותרת של הכרטיסייה.

אישור

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

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

הפונקציה מחזירה את המזהה הייחודי של המסמך. מזהה המסמך משמש עם DocumentApp.openById() כדי לפתוח מופע מסוים של מסמך.

חזרה

‫String – מזהה המסמך.

אישור

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

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

מחזירה את קוד השפה של המסמך. זו השפה שמוצגת בקובץ > שפה בכלי לעריכת מסמכים, ויכול להיות שהיא לא השפה שבה המסמך כתוב בפועל.

חזרה

‫String|null — שפת המסמך, או null אם לא הוגדרה שפה.

אישור

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

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

הפונקציה מחזירה את הכותרת של המסמך.

חזרה

‫String – שם המסמך.

אישור

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

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

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

פרמטרים

חזרה

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

אישור

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

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

מחזירה את כל האובייקטים NamedRange בכרטיסייה הראשונה, או בכרטיסייה הפעילה אם הסקריפט מאוגד למסמך. כדי לקבל את כל האובייקטים NamedRange בכל כרטיסייה, משתמשים בשיטה DocumentTab.getNamedRanges().

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

חזרה

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

אישור

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

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

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

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

פרמטרים

חזרה

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

אישור

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

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

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

// Display a dialog box that tells the user how many elements are included in
// the selection.
const selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  const elements = selection.getRangeElements();
  DocumentApp.getUi().alert(`Number of selected elements: ${elements.length}`);
} else {
  DocumentApp.getUi().alert('Nothing is selected.');
}

חזרה

‫Range|null — ייצוג של הבחירה של המשתמש, או null אם המשתמש לא בחר כלום בכרטיסייה, אם נבחר רק סוף הפסקה, אם נבחרו רק סוף הפסקה ושורה חדשה, או אם הסקריפט לא מקושר למסמך.

אישור

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

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

מחזירה את כל קודי השפות שנתמכים בקובצי Google Docs.

חזרה

‫String[] – מערך של קודי שפה.

אישור

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

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

מקבל את Tab עם המזהה שצוין. השיטה הזו מחזירה null אם לא קיים Tab כזה. יכולים לגשת לכרטיסיות בכל רמת היררכיה.

פרמטרים

חזרה

‫Tab|null – ה-Tab עם המזהה שצוין, או null אם לא קיים Tab כזה.

אישור

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

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

מחזירה את כל התגים Tab שלא מוטמעים בתגים אחרים, שמופיעים במסמך.

כרטיסיות יכולות להכיל כרטיסיות צאצא, כלומר כרטיסייה שמוטמעת בתוך כרטיסייה אחרת. אפשר לגשת לכרטיסיות של ילדים באמצעות Tab.getChildTabs().

חזרה

Tab[] — רשימת כל Tabs שמופיעים במסמך.

אישור

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

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

מחזירה את כתובת ה-URL לגישה למסמך הנוכחי.

const doc = DocumentApp.getActiveDocument();

// Send out the link to open the document.
MailApp.sendEmail('<email-address>', doc.getName(), doc.getUrl());

חזרה

‫String – כתובת ה-URL לגישה למסמך הנוכחי.

אישור

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

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

הפונקציה מחזירה את רשימת הצופים והמגיבים של ה-Document הזה.

חזרה

‫User[] — מערך של משתמשים עם הרשאת צפייה או תגובה.

אישור

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

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

יוצרת Position חדש, שהוא הפניה למיקום בכרטיסייה, ביחס לרכיב ספציפי בכרטיסייה הראשונה או, עבור סקריפטים מאוגדים למסמך, הכרטיסייה הפעילה. כדי ליצור Position ביחס למיקום בכרטיסייה כלשהי, משתמשים בשיטה DocumentTab.newPosition(element, offset). הסמן של המשתמש מיוצג כ-Position, בין היתר.

// Append a paragraph to the active tab, then place the user's cursor after the
// first word of the new paragraph.
const doc = DocumentApp.getActiveDocument();
const paragraph = doc.getBody().appendParagraph('My new paragraph.');
const position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

פרמטרים

חזרה

Position — הגרסה החדשה של Position.

אישור

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

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

יוצר אובייקט builder שמשמש ליצירת אובייקטים מסוג Range מרכיבי כרטיסיות בכרטיסייה הראשונה, או בכרטיסייה הפעילה בסקריפטים מקשרים למסמך. כדי ליצור כלי לבניית אובייקטים מסוג DocumentRange מרכיבי כרטיסיות בכל כרטיסייה, משתמשים בשיטה DocumentTab.newRange().

// Change the user's selection to a range that includes every table in the
// active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

חזרה

‫RangeBuilder – הכלי החדש ליצירת קהלים.

אישור

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

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

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

בקבצים ב-Drive, הפעולה הזו מסירה את המשתמש גם מרשימת הצופים.

פרמטרים

חזרה

‫Document — Document הזה, לשרשור.

אישור

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

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

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

בקבצים ב-Drive, הפעולה הזו מסירה את המשתמש גם מרשימת הצופים.

פרמטרים

חזרה

‫Document — Document הזה, לשרשור.

אישור

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

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

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

במקרה של קבצים ב-Drive, הפעולה הזו מסירה את המשתמש גם מרשימת העורכים.

פרמטרים

חזרה

‫Document — This Document for chaining.

אישור

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

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

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

במקרה של קבצים ב-Drive, הפעולה הזו מסירה את המשתמש גם מרשימת העורכים.

פרמטרים

חזרה

‫Document — This Document for chaining.

אישור

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

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

שמירת Document הנוכחי. גורם לניקוי של עדכונים בהמתנה ולהחלתם.

השיטה saveAndClose() מופעלת באופן אוטומטי בסוף הביצוע של הסקריפט לכל Document פתוח שניתן לעריכה.

אי אפשר לערוך Document שנסגר. משתמשים ב-DocumentApp.openById() כדי לפתוח מחדש מסמך מסוים לעריכה.

אישור

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

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

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

const doc = DocumentApp.getActiveDocument();

// Sets the user's selected tab by its ID.
// TODO(developer): Replace the ID with your own.
const tab = doc.setActiveTab('123abc');

פרמטרים

אישור

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

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

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

אם מספקים Position מTab לא פעיל, הכרטיסייה הפעילה של המשתמש תשתנה.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();

// Append a paragraph, then place the user's cursor after the first word of the
// new paragraph.
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
const position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

פרמטרים

חזרה

‫Document — Document הזה, לשרשור.

אישור

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

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

הגדרת קוד השפה של המסמך. זו השפה שמוצגת בקובץ > שפה בכלי לעריכת מסמכים, ויכול להיות שהיא לא השפה שבה המסמך כתוב בפועל. כדי לקבל את כל קודי השפה התקינים, משתמשים ב-getSupportedLanguageCodes().

פרמטרים

חזרה

‫Document — Document הזה, לשרשור.

אישור

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

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

הגדרת שם המסמך.

פרמטרים

חזרה

‫Document – המסמך הנוכחי.

אישור

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

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

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

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();

// Change the user's selection to a range that includes every table in the
// document.
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());

פרמטרים

חזרה

‫Document — Document הזה, לשרשור.

אישור

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

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