Enum ElementType
Stay organized with collections
Save and categorize content based on your preferences.
ElementType
An enumeration of all the element types.
To call an enum, you call its parent class, name, and property. For example,
DocumentApp.ElementType.BODY_SECTION
.
Use the ElementType
enumeration to check the type of a given element, for instance:
const documentTab =
DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const firstChild = documentTab.getBody().getChild(0);
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
// It's a paragraph, apply a paragraph heading.
firstChild.asParagraph().setHeading(DocumentApp.ParagraphHeading.HEADING1);
}
Properties
Property | Type | Description |
BODY_SECTION | Enum | The type corresponding to the Body element. |
COMMENT_SECTION | Enum | The type corresponding to the CommentSection element. |
DATE | Enum | The type corresponding to the Date
element. |
EQUATION | Enum | The type corresponding to the Equation element. |
EQUATION_FUNCTION | Enum | The type corresponding to the EquationFunction element. |
EQUATION_FUNCTION_ARGUMENT_SEPARATOR | Enum | The type corresponding to the EquationFunctionArgumentSeparator
element. |
EQUATION_SYMBOL | Enum | The type corresponding to the EquationSymbol element. |
RICH_LINK | Enum | The type corresponding to the RichLink element. |
FOOTER_SECTION | Enum | The type corresponding to the FooterSection element. |
FOOTNOTE | Enum | The type corresponding to the Footnote element. |
FOOTNOTE_SECTION | Enum | The type corresponding to the FootnoteSection element. |
HEADER_SECTION | Enum | The type corresponding to the HeaderSection element. |
HORIZONTAL_RULE | Enum | The type corresponding to the HorizontalRule element. |
INLINE_DRAWING | Enum | The type corresponding to the InlineDrawing element. |
INLINE_IMAGE | Enum | The type corresponding to the InlineImage element. |
LIST_ITEM | Enum | The type corresponding to the ListItem element. |
PAGE_BREAK | Enum | The type corresponding to the PageBreak element. |
PARAGRAPH | Enum | The type corresponding to the Paragraph element. |
PERSON | Enum | The type corresponding to the Person element. |
TABLE | Enum | The type corresponding to the Table element. |
TABLE_CELL | Enum | The type corresponding to the TableCell element. |
TABLE_OF_CONTENTS | Enum | The type corresponding to the TableOfContents element. |
TABLE_ROW | Enum | The type corresponding to the TableRow element. |
TEXT | Enum | The type corresponding to the Text
element. |
UNSUPPORTED | Enum | The type corresponding to UnsupportedElement . Unsupported elements
represent document portions that do not support scripting. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-03 UTC.
[null,null,["Last updated 2024-12-03 UTC."],[[["\u003cp\u003e\u003ccode\u003eElementType\u003c/code\u003e is an enumeration used to identify the type of elements within a Google Doc.\u003c/p\u003e\n"],["\u003cp\u003eYou can access \u003ccode\u003eElementType\u003c/code\u003e properties using the format \u003ccode\u003eDocumentApp.ElementType.PROPERTY_NAME\u003c/code\u003e, such as \u003ccode\u003eDocumentApp.ElementType.PARAGRAPH\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003egetType()\u003c/code\u003e method can be used to determine the type of a specific element, enabling conditional logic based on element types.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eElementType\u003c/code\u003e supports a wide range of element types like paragraphs, tables, images, equations, and more, as detailed in the provided properties table.\u003c/p\u003e\n"]]],[],null,["# Enum ElementType\n\nElementType\n\nAn enumeration of all the element types.\n\nTo call an enum, you call its parent class, name, and property. For example, `\nDocumentApp.ElementType.BODY_SECTION`.\n\nUse the [ElementType](#) enumeration to check the type of a given element, for instance:\n\n```javascript\nconst documentTab =\n DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();\nconst firstChild = documentTab.getBody().getChild(0);\nif (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {\n // It's a paragraph, apply a paragraph heading.\n firstChild.asParagraph().setHeading(DocumentApp.ParagraphHeading.HEADING1);\n}\n``` \n\n### Properties\n\n| Property | Type | Description |\n|----------------------------------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `BODY_SECTION` | `Enum` | The type corresponding to the [Body](/apps-script/reference/document/body) element. |\n| `COMMENT_SECTION` | `Enum` | The type corresponding to the CommentSection element. |\n| `DATE` | `Enum` | The type corresponding to the [Date](/apps-script/reference/document/date) element. |\n| `EQUATION` | `Enum` | The type corresponding to the [Equation](/apps-script/reference/document/equation) element. |\n| `EQUATION_FUNCTION` | `Enum` | The type corresponding to the [EquationFunction](/apps-script/reference/document/equation-function) element. |\n| `EQUATION_FUNCTION_ARGUMENT_SEPARATOR` | `Enum` | The type corresponding to the [EquationFunctionArgumentSeparator](/apps-script/reference/document/equation-function-argument-separator) element. |\n| `EQUATION_SYMBOL` | `Enum` | The type corresponding to the [EquationSymbol](/apps-script/reference/document/equation-symbol) element. |\n| `RICH_LINK` | `Enum` | The type corresponding to the [RichLink](/apps-script/reference/document/rich-link) element. |\n| `FOOTER_SECTION` | `Enum` | The type corresponding to the [FooterSection](/apps-script/reference/document/footer-section) element. |\n| `FOOTNOTE` | `Enum` | The type corresponding to the [Footnote](/apps-script/reference/document/footnote) element. |\n| `FOOTNOTE_SECTION` | `Enum` | The type corresponding to the [FootnoteSection](/apps-script/reference/document/footnote-section) element. |\n| `HEADER_SECTION` | `Enum` | The type corresponding to the [HeaderSection](/apps-script/reference/document/header-section) element. |\n| `HORIZONTAL_RULE` | `Enum` | The type corresponding to the [HorizontalRule](/apps-script/reference/document/horizontal-rule) element. |\n| `INLINE_DRAWING` | `Enum` | The type corresponding to the [InlineDrawing](/apps-script/reference/document/inline-drawing) element. |\n| `INLINE_IMAGE` | `Enum` | The type corresponding to the [InlineImage](/apps-script/reference/document/inline-image) element. |\n| `LIST_ITEM` | `Enum` | The type corresponding to the [ListItem](/apps-script/reference/document/list-item) element. |\n| `PAGE_BREAK` | `Enum` | The type corresponding to the [PageBreak](/apps-script/reference/document/page-break) element. |\n| `PARAGRAPH` | `Enum` | The type corresponding to the [Paragraph](/apps-script/reference/document/paragraph) element. |\n| `PERSON` | `Enum` | The type corresponding to the [Person](/apps-script/reference/document/person) element. |\n| `TABLE` | `Enum` | The type corresponding to the [Table](/apps-script/reference/document/table) element. |\n| `TABLE_CELL` | `Enum` | The type corresponding to the [TableCell](/apps-script/reference/document/table-cell) element. |\n| `TABLE_OF_CONTENTS` | `Enum` | The type corresponding to the [TableOfContents](/apps-script/reference/document/table-of-contents) element. |\n| `TABLE_ROW` | `Enum` | The type corresponding to the [TableRow](/apps-script/reference/document/table-row) element. |\n| `TEXT` | `Enum` | The type corresponding to the [Text](/apps-script/reference/document/text) element. |\n| `UNSUPPORTED` | `Enum` | The type corresponding to [UnsupportedElement](/apps-script/reference/document/unsupported-element). Unsupported elements represent document portions that do not support scripting. |"]]