Class DocumentApp

Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
DocumentApp

Usługa dokumentów tworzy i otwiera Documents, które można edytować.

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE');

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

Właściwości

WłaściwośćTypOpis
AttributeAttributeWyliczenie Attribute.
ElementTypeElementTypeWyliczenie ElementType.
FontFamilyFontFamilyWyliczenie FontFamily.
GlyphTypeGlyphTypeWyliczenie GlyphType.
HorizontalAlignmentHorizontalAlignmentWyliczenie HorizontalAlignment.
ParagraphHeadingParagraphHeadingWyliczenie ParagraphHeading.
PositionedLayoutPositionedLayoutWyliczenie PositionedLayout.
TextAlignmentTextAlignmentWyliczenie TextAlignment.
VerticalAlignmentVerticalAlignmentWyliczenie VerticalAlignment.

Metody

MetodaZwracany typKrótki opis
create(name)DocumentTworzy i zwraca nowy dokument.
getActiveDocument()DocumentZwraca dokument, do którego skrypt jest powiązany z kontenerem.
getUi()UiZwraca wystąpienie interfejsu dokumentu i interfejsu użytkownika, które umożliwia skryptowi dodanie funkcji, takich jak menu, okna i paski boczne.
openById(id)DocumentZwraca dokument o podanym identyfikatorze.
openByUrl(url)DocumentOtwiera i zwraca dokument z określonym adresem URL.

Szczegółowa dokumentacja

create(name)

Tworzy i zwraca nowy dokument.

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

Parametry

NazwaTypOpis
nameStringnazwa nowego dokumentu

Zwróć

Document – nowa instancja dokumentu

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

getActiveDocument()

Zwraca dokument, do którego skrypt jest powiązany z kontenerem. Aby wejść w interakcję z dokumentem, z którym skrypt nie jest powiązany w kontenerze, użyj metody openById(id) lub openByUrl(url).

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

Zwróć

Document – instancja dokumentu

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

getUi()

Zwraca wystąpienie interfejsu dokumentu i interfejsu użytkownika, które umożliwia skryptowi dodanie funkcji, takich jak menu, okna i paski boczne. Skrypt może wchodzić w interakcję z interfejsem tylko w przypadku bieżącego wystąpienia otwartego dokumentu i tylko wtedy, gdy jest on powiązany z dokumentem. Więcej informacji znajdziesz w przewodnikach po menu oraz oknach i paskach bocznych.

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

Zwróć

Ui – wystąpienie tego dokumentu i środowiska użytkownika


openById(id)

Zwraca dokument o podanym identyfikatorze. Jeśli skrypt jest powiązany z kontenerem, użyj zdarzenia getActiveDocument().

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE');

Parametry

NazwaTypOpis
idStringidentyfikator dokumentu do otwarcia.

Zwróć

Document – instancja dokumentu

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

openByUrl(url)

Otwiera i zwraca dokument z określonym adresem URL. Jeśli skrypt jest powiązany z kontenerem, użyj zdarzenia getActiveDocument().

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

Parametry

NazwaTypOpis
urlStringadres URL dokumentu do otwarcia.

Zwróć

Document – instancja dokumentu

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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