Element reprezentujący regułę poziomą. Element HorizontalRule
może być zawarty w elemencie
ListItem
lub Paragraph
, ale sam nie może zawierać żadnego innego elementu. Więcej
informacje o strukturze dokumentów znajdziesz w przewodniku po rozszerzeniach Dokumentów Google.
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
copy() | HorizontalRule | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
isAtDocumentEnd() | Boolean | Określa, czy element jest na końcu Document . |
removeFromParent() | HorizontalRule | Usuwa element z elementu nadrzędnego. |
setAttributes(attributes) | HorizontalRule | Ustawia atrybuty elementu. |
Szczegółowa dokumentacja
copy()
Zwraca odłączoną, głęboką kopię bieżącego elementu.
Skopiowane są też wszystkie elementy podrzędne zawarte w elemencie. Nowy element nie ma elementu nadrzędnego.
Powrót
HorizontalRule
– nowa wersja,
Autoryzacja
Skrypty korzystające 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
getAttributes()
Pobiera atrybuty elementu.
Wynikiem jest obiekt zawierający właściwość każdego prawidłowego atrybutu elementu,
nazwa właściwości odpowiada elementowi na liście DocumentApp.Attribute
.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Append a styled paragraph. var par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. var atts = par.getAttributes(); // Log the paragraph attributes. for (var att in atts) { Logger.log(att + ":" + atts[att]); }
Powrót
Object
– atrybuty elementu.
Autoryzacja
Skrypty korzystające 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
getNextSibling()
Pobiera kolejny element równorzędny elementu.
Następne elementy równorzędne mają tego samego elementu nadrzędnego i następują po bieżącym elemencie.
Powrót
Element
– następny element równorzędny.
Autoryzacja
Skrypty korzystające 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
getParent()
Pobiera element nadrzędny elementu.
Element nadrzędny zawiera bieżący element.
Powrót
ContainerElement
– element nadrzędny.
Autoryzacja
Skrypty korzystające 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
getPreviousSibling()
Pobiera poprzedni element równorzędny elementu.
Poprzednie elementy nadrzędne mają tego samego elementu nadrzędnego i wyprzedzają bieżący element.
Powrót
Element
– poprzedni element równorzędny.
Autoryzacja
Skrypty korzystające 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
getType()
Pobiera wartość ElementType
elementu.
Aby określić dokładny typ danego elementu, użyj właściwości getType()
.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Obtain the first element in the active tab's body. var 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
ElementType
– typ elementu.
Autoryzacja
Skrypty korzystające 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
isAtDocumentEnd()
Określa, czy element jest na końcu Document
.
Powrót
Boolean
– określa, czy element jest na końcu karty.
Autoryzacja
Skrypty korzystające 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
removeFromParent()
Usuwa element z elementu nadrzędnego.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab() var body = documentTab.getBody(); // Remove all images in the active tab's body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Powrót
HorizontalRule
– usunięty element.
Autoryzacja
Skrypty korzystające 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
setAttributes(attributes)
Ustawia atrybuty elementu.
Określony parametr atrybutów musi być obiektem, w którym każda nazwa właściwości jest elementem w
wyliczenie DocumentApp.Attribute
, a każda wartość właściwości jest nową wartością do
zastosowano.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Define a custom paragraph style. var 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. var 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
HorizontalRule
– bieżący element.
Autoryzacja
Skrypty korzystające 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