Google Apps Script API
    Preparing search index...

    Interface Document

    A document, containing rich text and elements such as tables and lists.

    Documents may be opened or created using DocumentApp.

    // Open a document by ID.
var doc = DocumentApp.openById("<my-id>");

// Create and open a document.
doc = DocumentApp.create("Document Title");
    interface Document {
        addBookmark(position: GoogleAppsScript.Document.Position): Bookmark;
        addEditor(emailAddress: string): GoogleAppsScript.Document.Document;
        addEditor(
            user: GoogleAppsScript.Base.User,
        ): GoogleAppsScript.Document.Document;
        addEditors(emailAddresses: string[]): GoogleAppsScript.Document.Document;
        addFooter(): FooterSection;
        addHeader(): HeaderSection;
        addNamedRange(
            name: string,
            range: GoogleAppsScript.Document.Range,
        ): GoogleAppsScript.Document.NamedRange;
        addViewer(emailAddress: string): GoogleAppsScript.Document.Document;
        addViewer(
            user: GoogleAppsScript.Base.User,
        ): GoogleAppsScript.Document.Document;
        addViewers(emailAddresses: string[]): GoogleAppsScript.Document.Document;
        getActiveTab(): Tab;
        getAs(contentType: string): Blob;
        getBlob(): Blob;
        getBody(): GoogleAppsScript.Document.Body;
        getBookmark(id: string): Bookmark;
        getBookmarks(): Bookmark[];
        getCursor(): GoogleAppsScript.Document.Position;
        getEditors(): GoogleAppsScript.Base.User[];
        getFooter(): FooterSection;
        getFootnotes(): GoogleAppsScript.Document.Footnote[];
        getHeader(): HeaderSection;
        getId(): string;
        getLanguage(): string;
        getName(): string;
        getNamedRangeById(id: string): GoogleAppsScript.Document.NamedRange;
        getNamedRanges(name?: string): GoogleAppsScript.Document.NamedRange[];
        getSelection(): GoogleAppsScript.Document.Range;
        getSupportedLanguageCodes(): string[];
        getTab(tabId: string): Tab;
        getTabs(): Tab[];
        getUrl(): string;
        getViewers(): GoogleAppsScript.Base.User[];
        newPosition(
            element: GoogleAppsScript.Document.Element,
            offset: number,
        ): GoogleAppsScript.Document.Position;
        newRange(): RangeBuilder;
        removeEditor(emailAddress: string): GoogleAppsScript.Document.Document;
        removeEditor(
            user: GoogleAppsScript.Base.User,
        ): GoogleAppsScript.Document.Document;
        removeViewer(emailAddress: string): GoogleAppsScript.Document.Document;
        removeViewer(
            user: GoogleAppsScript.Base.User,
        ): GoogleAppsScript.Document.Document;
        saveAndClose(): void;
        setActiveTab(tabId: string): void;
        setCursor(
            position: GoogleAppsScript.Document.Position,
        ): GoogleAppsScript.Document.Document;
        setLanguage(languageCode: string): GoogleAppsScript.Document.Document;
        setName(name: string): GoogleAppsScript.Document.Document;
        setSelection(
            range: GoogleAppsScript.Document.Range,
        ): GoogleAppsScript.Document.Document;
    }
    Index

    Methods

    addBookmark addEditor addEditors addFooter addHeader addNamedRange addViewer addViewers getActiveTab getAs getBlob getBody getBookmark getBookmarks getCursor getEditors getFooter getFootnotes getHeader getId getLanguage getName getNamedRangeById getNamedRanges getSelection getSupportedLanguageCodes getTab getTabs getUrl getViewers newPosition newRange removeEditor removeViewer saveAndClose setActiveTab setCursor setLanguage setName setSelection

    Methods

    Settings
    Member Visibility

    On This Page
    Methods