Ogólny element. Treści Document
są reprezentowane jako elementy. Na przykład elementy List
, Paragraph
i Table
dziedziczą wszystkie metody zdefiniowane przez element Element
, takie jak get
.
Implementacja klas
Nazwa | Krótki opis |
---|---|
Body | Treść karty w dokumencie Dokumentów Google. |
Container | Element ogólny, który może zawierać inne elementy. |
Date | Element reprezentujący sformatowaną datę |
Equation | Element reprezentujący wyrażenie matematyczne. |
Equation | Element reprezentujący funkcję w ujęciu matematycznym Equation . |
Equation | Element reprezentujący separator funkcji w funkcji matematycznej Equation . |
Equation | Element reprezentujący symbol w matematycznym Equation . |
Footer | Element reprezentujący sekcję stopki. |
Footnote | Element reprezentujący przypis. |
Footnote | Element reprezentujący sekcję przypisu. |
Header | Element reprezentujący sekcję nagłówka. |
Horizontal | Element reprezentujący linię poziomą. |
Inline | Element reprezentujący osadzony rysunek. |
Inline | Element reprezentujący osadzony obraz. |
List | Element reprezentujący element listy. |
Page | Element reprezentujący podział strony. |
Paragraph | Element reprezentujący akapit. |
Person | Element reprezentujący link do osoby. |
Rich | Element reprezentujący link do zasobu Google, takiego jak plik na Dysku lub film w YouTube. |
Table | Element reprezentujący tabelę. |
Table | Element reprezentujący komórkę tabeli. |
Table | Element zawierający spis treści. |
Table | Element reprezentujący wiersz tabeli. |
Text | Element reprezentujący region tekstu sformatowanego. |
Unsupported | Element reprezentujący region, który jest nieznany lub na który skrypt nie może wpływać, np. numer strony. |
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
as | Body | Zwraca bieżący element jako Body . |
as | Date | Zwraca bieżący element jako Date . |
as | Equation | Zwraca bieżący element jako Equation . |
as | Equation | Zwraca bieżący element jako Equation . |
as | Equation | Zwraca bieżący element jako Equation . |
as | Equation | Zwraca bieżący element jako Equation . |
as | Footer | Zwraca bieżący element jako Footer . |
as | Footnote | Zwraca bieżący element jako Footnote . |
as | Footnote | Zwraca bieżący element jako Footnote . |
as | Header | Zwraca bieżący element jako Header . |
as | Horizontal | Zwraca bieżący element jako Horizontal . |
as | Inline | Zwraca bieżący element jako Inline . |
as | Inline | Zwraca bieżący element jako Inline . |
as | List | Zwraca bieżący element jako List . |
as | Page | Zwraca bieżący element jako Page . |
as | Paragraph | Zwraca bieżący element jako Paragraph . |
as | Person | Zwraca bieżący element jako Person . |
as | Rich | Zwraca bieżący element jako Rich , np. link do pliku Arkuszy Google. |
as | Table | Zwraca bieżący element jako Table . |
as | Table | Zwraca bieżący element jako Table . |
as | Table | Zwraca bieżący element jako Table . |
as | Table | Zwraca bieżący element jako Table . |
as | Text | Zwraca bieżący element jako Text . |
copy() | Element | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
get | Object | Pobiera atrybuty elementu. |
get | Element | Pobiera następny element nadrzędny. |
get | Container | Pobiera element nadrzędny. |
get | Element | Pobiera poprzedni element nadrzędny elementu. |
get | Element | Pobiera wartość atrybutu Element elementu. |
is | Boolean | Określa, czy element znajduje się na końcu Document . |
merge() | Element | Łączy element z poprzednim elementem tego samego typu. |
remove | Element | Usuwa element z jego elementu nadrzędnego. |
set | Element | Ustawia atrybuty elementu. |
Szczegółowa dokumentacja
as Body()
Zwraca bieżący element jako Body
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Body
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Date()
Zwraca bieżący element jako Date
.
Jeśli wiesz, że element jest elementem Date
, użyj tej metody, aby ustawić jego typ jako Date
. Dzięki temu autouzupełnianie w edytorze Apps Script będzie wyświetlać metody, których możesz używać z użyciem Date
.
Powrót
Date
– bieżący element o typie Date
.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Equation()
Zwraca bieżący element jako Equation
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Equation
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Equation Function()
Zwraca bieżący element jako Equation
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Equation
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Equation Function Argument Separator()
Zwraca bieżący element jako Equation
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Equation
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Equation Symbol()
Zwraca bieżący element jako Equation
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Equation
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Footnote()
Zwraca bieżący element jako Footnote
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Footnote
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Footnote Section()
Zwraca bieżący element jako Footnote
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Footnote
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Header Section()
Zwraca bieżący element jako Header
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Header
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Horizontal Rule()
Zwraca bieżący element jako Horizontal
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Horizontal
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Inline Drawing()
Zwraca bieżący element jako Inline
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Inline
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Inline Image()
Zwraca bieżący element jako Inline
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Inline
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as List Item()
Zwraca bieżący element jako List
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
List
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Page Break()
Zwraca bieżący element jako Page
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Page
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Paragraph()
Zwraca bieżący element jako Paragraph
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Paragraph
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Person()
Zwraca bieżący element jako Person
.
Gdy wiesz, że element jest Person
, użyj tej metody, aby ustawić jego typ jako osoba.
Dzięki temu autouzupełnianie w edytorze Apps Script będzie wyświetlać metody, których możesz używać z elementem person.
Powrót
Person
– bieżący element o typie Person
.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Rich Link()
Zwraca bieżący element jako Rich
, np. link do pliku Arkuszy Google.
Jeśli wiesz, że element jest elementem Rich
, użyj tej metody, aby ustawić jego typ jako Rich
. Dzięki temu autouzupełnianie w edytorze Apps Script będzie wyświetlać metody, których możesz używać z użyciem Rich
.
Powrót
Rich
– bieżący element o typie Rich
.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Table()
Zwraca bieżący element jako Table
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Table
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Table Cell()
Zwraca bieżący element jako Table
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Table
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Table Of Contents()
Zwraca bieżący element jako Table
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Table
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Table Row()
Zwraca bieżący element jako Table
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Table
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Text()
Zwraca bieżący element jako Text
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Text
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
copy()
Zwraca odłączoną, głęboką kopię bieżącego elementu.
Skopiowane zostaną też wszystkie elementy podrzędne obecne w danym elemencie. Nowy element nie ma rodzica.
Powrót
Element
– nowa kopia.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Attributes()
Pobiera atrybuty elementu.
Wynikiem jest obiekt zawierający właściwość dla każdego prawidłowego atrybutu elementu, przy czym każda nazwa właściwości odpowiada elementowi w wyliczeniu Document
.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Append a styled paragraph. const par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. const atts = par.getAttributes(); // Log the paragraph attributes. for (const att in atts) { Logger.log(`${att}:${atts[att]}`); }
Powrót
Object
– atrybuty elementu.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Next Sibling()
Pobiera następny element nadrzędny.
Następny element równego rzędu ma tego samego rodzica i następuje po bieżącym elemencie.
Powrót
Element
– następny element równorzędny.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Parent()
Pobiera element nadrzędny.
Element nadrzędny zawiera bieżący element.
Powrót
Container
– element nadrzędny.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Previous Sibling()
Pobiera poprzedni element nadrzędny elementu.
Poprzedni element ma tego samego rodzica i poprzedza bieżący element.
Powrót
Element
– poprzedni równorzędny element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Type()
Pobiera wartość atrybutu Element
elementu.
Aby określić dokładny typ danego elementu, użyj właściwości get
.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Obtain the first element in the active tab's body. const firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
Powrót
Element
– typ elementu.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
is At Document End()
Określa, czy element znajduje się na końcu Document
.
Powrót
Boolean
– określa, czy element znajduje się na końcu karty.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
merge()
Łączy element z poprzednim elementem tego samego typu.
Można scalać tylko elementy tego samego Element
. Wszystkie elementy podrzędne zawarte w bieżącym elemencie zostaną przeniesione do poprzedniego elementu nadrzędnego.
Bieżący element zostanie usunięty z dokumentu.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document's active tab. const par1 = body.appendParagraph('Paragraph 1.'); const par2 = body.appendParagraph('Paragraph 2.'); // Merge the newly added paragraphs into a single paragraph. par2.merge(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's cell contents. const cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'], ]; // Build a table from the array. const table = body.appendTable(cells); // Get the first row in the table. const row = table.getRow(0); // Get the two cells in this row. const cell1 = row.getCell(0); const cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. const merged = cell2.merge();
Powrót
Element
– scalony element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
remove From Parent()
Usuwa element z jego elementu nadrzędnego.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Remove all images in the active tab's body. const imgs = body.getImages(); for (let i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Powrót
Element
– usunięty element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Attributes(attributes)
Ustawia atrybuty elementu.
Parametr specified attributes musi być obiektem, w którym każda nazwa właściwości jest elementem zbioru wyliczenia Document
, a każda wartość właściwości jest nową wartością do zastosowania.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Define a custom paragraph style. const style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. const par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
Parametry
Nazwa | Typ | Opis |
---|---|---|
attributes | Object | atrybuty elementu, |
Powrót
Element
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents