Class DocumentApp

DocumentApp

שירות המסמכים יוצר ופותח Documents שאפשר לערוך. 

// Open a document by ID.
// TODO(developer): Replace the ID with your own.
let doc = DocumentApp.openById('DOCUMENT_ID');

// Create and open a document.
doc = DocumentApp.create('Document Name');

מאפיינים

נכססוגתיאור
AttributeAttributeהספירה Attribute.
ElementTypeElementTypeהספירה ElementType.
FontFamilyFontFamilyהספירה FontFamily.
GlyphTypeGlyphTypeהספירה GlyphType.
HorizontalAlignmentHorizontalAlignmentהספירה HorizontalAlignment.
ParagraphHeadingParagraphHeadingהספירה ParagraphHeading.
PositionedLayoutPositionedLayoutהספירה PositionedLayout.
TextAlignmentTextAlignmentהספירה TextAlignment.
VerticalAlignmentVerticalAlignmentהספירה VerticalAlignment.

Methods

שיטהסוג הערך שמוחזרתיאור קצר
create(name)Documentיוצר ומחזיר מסמך חדש.
getActiveDocument()Documentמחזירה את המסמך שאליו הסקריפט משויך.
getUi()Uiהפונקציה מחזירה מופע של סביבת ממשק המשתמש של המסמך, שמאפשר לסקריפט להוסיף תכונות כמו תפריטים, תיבות דו-שיח וסרגלי צד.
openById(id)Documentמחזירה את המסמך עם המזהה שצוין.
openByUrl(url)Documentפותחת את המסמך עם כתובת ה-URL שצוינה ומחזירה אותו.

תיעוד מפורט

create(name)

יוצר ומחזיר מסמך חדש. 

// Create and open a new document.
const doc = DocumentApp.create('Document Name');

פרמטרים

שםסוגתיאור
nameStringהשם של המסמך החדש.

חזרה

‫Document – מופע המסמך החדש.

אישור

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

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

getActiveDocument()

מחזירה את המסמך שאליו הסקריפט משויך. כדי לבצע פעולות במסמך שהסקריפט לא קשור אליו, צריך להשתמש ב-openById(id) או ב-openByUrl(url). 

// Get the document to which this script is bound.
const doc = DocumentApp.getActiveDocument();

חזרה

‫Document – מופע המסמך

אישור

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

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

getUi()

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

// Add a custom menu to the active document, including a separator and a
// sub-menu.
function onOpen(e) {
  DocumentApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(
          DocumentApp.getUi()
              .createMenu('My sub-menu')
              .addItem('One sub-menu item', 'mySecondFunction')
              .addItem('Another sub-menu item', 'myThirdFunction'),
          )
      .addToUi();
}

חזרה

‫Ui — מופע של סביבת ממשק המשתמש של המסמך הזה

openById(id)

מחזירה את המסמך עם המזהה שצוין. אם הסקריפט קשור למסמך, צריך להשתמש ב-getActiveDocument() במקום זאת. 

// Open a document by ID.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('DOCUMENT_ID');

פרמטרים

שםסוגתיאור
idStringהמזהה של המסמך שרוצים לפתוח.

חזרה

‫Document – מופע המסמך.

אישור

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

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

openByUrl(url)

פותחת את המסמך עם כתובת ה-URL שצוינה ומחזירה אותו. אם הסקריפט קשור למסמך, צריך להשתמש ב-getActiveDocument() במקום זאת. 

// Open a document by URL.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit',
);

פרמטרים

שםסוגתיאור
urlStringכתובת ה-URL של המסמך שרוצים לפתוח

חזרה

‫Document – מופע המסמך

אישור

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

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