Element reprezentujący linię poziomą. Tag HorizontalRule
może znajdować się w obrębie znaczników ListItem
lub Paragraph
, ale nie może zawierać żadnych innych elementów. Więcej informacji 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 element potomny. |
getParent() | ContainerElement | Pobiera element nadrzędny. |
getPreviousSibling() | Element | Pobiera element potomny. |
getType() | ElementType | Pobiera element ElementType . |
isAtDocumentEnd() | Boolean | Określa, czy element znajduje się na końcu elementu 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.
Wszystkie jego elementy podrzędne też zostaną skopiowane. Nowy element nie ma elementu nadrzędnego.
Zwróć
HorizontalRule
– nowa kopia.
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
getAttributes()
Pobiera atrybuty elementu.
W rezultacie obiekt zawiera właściwość dla każdego prawidłowego atrybutu elementu, gdzie każda nazwa właściwości odpowiada elementowi na liście DocumentApp.Attribute
.
var body = DocumentApp.getActiveDocument().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]); }
Zwróć
Object
– atrybuty elementu
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
getNextSibling()
Pobiera element potomny.
Kolejne rodzeństwo ma tego samego elementu nadrzędnego i jednocześnie występuje w bieżącym elemencie.
Zwróć
Element
– następny element potomny
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
getParent()
Pobiera element nadrzędny.
Element nadrzędny zawiera bieżący element.
Zwróć
ContainerElement
– element nadrzędny;
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
getPreviousSibling()
Pobiera element potomny.
Poprzednie rodzeństwo ma ten sam element nadrzędny i wyprzedza bieżący element.
Zwróć
Element
– poprzedni element równorzędny.
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
getType()
Pobiera element ElementType
.
Użyj właściwości getType()
, aby dokładnie określić typ danego elementu.
var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document 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.'); }
Zwróć
ElementType
– typ elementu;
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
isAtDocumentEnd()
Określa, czy element znajduje się na końcu elementu Document
.
Zwróć
Boolean
– określa, czy element jest na końcu 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
removeFromParent()
Usuwa element z elementu nadrzędnego.
var body = DocumentApp.getActiveDocument().getBody(); // Remove all images in the document body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Zwróć
HorizontalRule
– usunięty element;
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
setAttributes(attributes)
Ustawia atrybuty elementu.
Wskazany parametr musi być obiektem, w którym każda nazwa właściwości jest elementem w wyliczeniach DocumentApp.Attribute
, a każda wartość właściwości to nowa wartość do zastosowania.
var body = DocumentApp.getActiveDocument().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. |
Zwróć
HorizontalRule
– bieżący element.
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