Google Apps Script API
    Preparing search index...

    Interface HeaderSection

    An element representing a header section. A Document typically contains at most one HeaderSection. The HeaderSection may contain ListItem, Paragraph, and Table elements. For more information on document structure, see the guide to extending Google Docs.

    interface HeaderSection {
        appendHorizontalRule(): GoogleAppsScript.Document.HorizontalRule;
        appendImage(image: BlobSource): InlineImage;
        appendImage(image: InlineImage): InlineImage;
        appendListItem(
            listItem: GoogleAppsScript.Document.ListItem,
        ): GoogleAppsScript.Document.ListItem;
        appendListItem(text: string): GoogleAppsScript.Document.ListItem;
        appendParagraph(
            paragraph: GoogleAppsScript.Document.Paragraph,
        ): GoogleAppsScript.Document.Paragraph;
        appendParagraph(text: string): GoogleAppsScript.Document.Paragraph;
        appendTable(
            cellsOrTable?: GoogleAppsScript.Document.Table | string[][],
        ): GoogleAppsScript.Document.Table;
        asBody(): GoogleAppsScript.Document.Body;
        asDate(): GoogleAppsScript.Document.Date;
        asEquation(): GoogleAppsScript.Document.Equation;
        asEquationFunction(): EquationFunction;
        asEquationFunctionArgumentSeparator(): EquationFunctionArgumentSeparator;
        asEquationSymbol(): EquationSymbol;
        asFooterSection(): FooterSection;
        asFootnote(): GoogleAppsScript.Document.Footnote;
        asFootnoteSection(): FootnoteSection;
        asHeaderSection(): HeaderSection;
        asHorizontalRule(): GoogleAppsScript.Document.HorizontalRule;
        asInlineDrawing(): InlineDrawing;
        asInlineImage(): InlineImage;
        asListItem(): GoogleAppsScript.Document.ListItem;
        asPageBreak(): GoogleAppsScript.Document.PageBreak;
        asParagraph(): GoogleAppsScript.Document.Paragraph;
        asPerson(): GoogleAppsScript.Document.Person;
        asRichLink(): RichLink;
        asTable(): GoogleAppsScript.Document.Table;
        asTableCell(): GoogleAppsScript.Document.TableCell;
        asTableOfContents(): GoogleAppsScript.Document.TableOfContents;
        asTableRow(): GoogleAppsScript.Document.TableRow;
        asText(): GoogleAppsScript.Document.Text;
        clear(): HeaderSection;
        copy(): HeaderSection;
        editAsText(): GoogleAppsScript.Document.Text;
        findElement(elementType: ElementType, from?: RangeElement): RangeElement;
        findText(searchPattern: string, from?: RangeElement): RangeElement;
        getAttributes(): any;
        getChild(childIndex: number): GoogleAppsScript.Document.Element;
        getChildIndex(child: GoogleAppsScript.Document.Element): number;
        getFootnotes(): GoogleAppsScript.Document.Footnote[];
        getImages(): InlineImage[];
        getLinkUrl(): string;
        getListItems(): GoogleAppsScript.Document.ListItem[];
        getNextSibling(): GoogleAppsScript.Document.Element;
        getNumChildren(): number;
        getParagraphs(): GoogleAppsScript.Document.Paragraph[];
        getParent(): ContainerElement;
        getPreviousSibling(): GoogleAppsScript.Document.Element;
        getTables(): GoogleAppsScript.Document.Table[];
        getText(): string;
        getTextAlignment(): TextAlignment;
        getType(): ElementType;
        insertHorizontalRule(
            childIndex: number,
        ): GoogleAppsScript.Document.HorizontalRule;
        insertImage(childIndex: number, image: BlobSource): InlineImage;
        insertImage(childIndex: number, image: InlineImage): InlineImage;
        insertListItem(
            childIndex: number,
            listItem: GoogleAppsScript.Document.ListItem,
        ): GoogleAppsScript.Document.ListItem;
        insertListItem(
            childIndex: number,
            text: string,
        ): GoogleAppsScript.Document.ListItem;
        insertParagraph(
            childIndex: number,
            paragraph: GoogleAppsScript.Document.Paragraph,
        ): GoogleAppsScript.Document.Paragraph;
        insertParagraph(
            childIndex: number,
            text: string,
        ): GoogleAppsScript.Document.Paragraph;
        insertTable(
            childIndex: number,
            cellsOrTable?: GoogleAppsScript.Document.Table | string[][],
        ): GoogleAppsScript.Document.Table;
        isAtDocumentEnd(): boolean;
        merge(): GoogleAppsScript.Document.Element;
        removeChild(child: GoogleAppsScript.Document.Element): HeaderSection;
        removeFromParent(): HeaderSection;
        replaceText(
            searchPattern: string,
            replacement: string,
        ): GoogleAppsScript.Document.Element;
        setAttributes(attributes: any): HeaderSection;
        setLinkUrl(url: string): HeaderSection;
        setText(text: string): HeaderSection;
        setTextAlignment(textAlignment: TextAlignment): HeaderSection;
    }

    Hierarchy (View Summary)

    Index

    Methods

    appendHorizontalRule appendImage appendListItem appendParagraph appendTable asBody asDate asEquation asEquationFunction asEquationFunctionArgumentSeparator asEquationSymbol asFooterSection asFootnote asFootnoteSection asHeaderSection asHorizontalRule asInlineDrawing asInlineImage asListItem asPageBreak asParagraph asPerson asRichLink asTable asTableCell asTableOfContents asTableRow asText clear copy editAsText findElement findText getAttributes getChild getChildIndex getFootnotes getImages getLinkUrl getListItems getNextSibling getNumChildren getParagraphs getParent getPreviousSibling getTables getText getTextAlignment getType insertHorizontalRule insertImage insertListItem insertParagraph insertTable isAtDocumentEnd merge removeChild removeFromParent replaceText setAttributes setLinkUrl setText setTextAlignment

    Methods

    Settings
    Member Visibility

    On This Page
    Methods
    appendHorizontalRule appendImage appendListItem appendParagraph appendTable asBody asDate asEquation asEquationFunction asEquationFunctionArgumentSeparator asEquationSymbol asFooterSection asFootnote asFootnoteSection asHeaderSection asHorizontalRule asInlineDrawing asInlineImage asListItem asPageBreak asParagraph asPerson asRichLink asTable asTableCell asTableOfContents asTableRow asText clear copy editAsText findElement findText getAttributes getChild getChildIndex getFootnotes getImages getLinkUrl getListItems getNextSibling getNumChildren getParagraphs getParent getPreviousSibling getTables getText getTextAlignment getType insertHorizontalRule insertImage insertListItem insertParagraph insertTable isAtDocumentEnd merge removeChild removeFromParent replaceText setAttributes setLinkUrl setText setTextAlignment