Class DocumentApp

DocumentApp

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

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

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

מאפיינים

נכס	סוג	תיאור
Attribute	Attribute	הספירה Attribute.
ElementType	ElementType	הספירה ElementType.
FontFamily	FontFamily	הספירה FontFamily.
GlyphType	GlyphType	הספירה GlyphType.
HorizontalAlignment	HorizontalAlignment	הספירה HorizontalAlignment.
ParagraphHeading	ParagraphHeading	הספירה ParagraphHeading.
PositionedLayout	PositionedLayout	הספירה PositionedLayout.
TextAlignment	TextAlignment	הספירה TextAlignment.
VerticalAlignment	VerticalAlignment	הספירה VerticalAlignment.

שיטות

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

מסמכי תיעוד מפורטים

create(name)

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

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

פרמטרים

שם	סוג	תיאור
name	String	שם המסמך החדש.

חזרה

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

אישור

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

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

---

getActiveDocument()

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

// Get the document to which this script is bound.
var 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.
var doc = DocumentApp.openById('DOCUMENT_ID');

פרמטרים

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

חזרה

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

אישור

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

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

---

openByUrl(url)

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

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

פרמטרים

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

חזרה

Document – מופע המסמך

אישור

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

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