此页面由 Cloud Translation API 翻译。

Class 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`	返回具有指定 ID 的文档。
`openByUrl(url)`	`Document`	使用指定网址打开并返回文档。

详细文档

`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)`

返回具有指定 ID 的文档。如果脚本是与文档绑定的请改用 getActiveDocument()。

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

参数

名称	类型	说明
`id`	`String`	要打开的文档的 ID。

Document - 文档实例。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`openByUrl(url)`

使用指定网址打开并返回文档。如果脚本是文档，请改用 getActiveDocument()。

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

参数

名称	类型	说明
`url`	`String`	要打开的文档的网址

Document - 文档实例

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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