NodeType (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.NodeType

public class NodeType
extends java.lang.Object

Specifies the type of a Word document node.

Examples:

Shows how to traverse through a composite node's collection of child nodes.

 
 Document doc = new Document();

 // Add two runs and one shape as child nodes to the first paragraph of this document.
 Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true);
 paragraph.appendChild(new Run(doc, "Hello world! "));

 Shape shape = new Shape(doc, ShapeType.RECTANGLE);
 shape.setWidth(200.0);
 shape.setHeight(200.0);
 // Note that the 'CustomNodeId' is not saved to an output file and exists only during the node lifetime.
 shape.setCustomNodeId(100);
 shape.setWrapType(WrapType.INLINE);
 paragraph.appendChild(shape);

 paragraph.appendChild(new Run(doc, "Hello again!"));

 // Iterate through the paragraph's collection of immediate children,
 // and print any runs or shapes that we find within.
 NodeCollection children = paragraph.getChildNodes(NodeType.ANY, false);

 Assert.assertEquals(3, paragraph.getChildNodes(NodeType.ANY, false).getCount());

 for (Node child : (Iterable<Node>) children)
     switch (child.getNodeType()) {
         case NodeType.RUN:
             System.out.println("Run contents:");
             System.out.println(MessageFormat.format("\t\"{0}\"", child.getText().trim()));
             break;
         case NodeType.SHAPE:
             Shape childShape = (Shape)child;
             System.out.println("Shape:");
             System.out.println(MessageFormat.format("\t{0}, {1}x{2}", childShape.getShapeType(), childShape.getWidth(), childShape.getHeight()));
             break;
     }

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ANY` Indicates all node types.
`static int`	`BODY` A `Body` object that contains the main text of a section (main text story).
`static int`	`BOOKMARK_END` An end of a bookmark marker.
`static int`	`BOOKMARK_START` A beginning of a bookmark marker.
`static int`	`BUILDING_BLOCK` A building block within a glossary document (e.g.
`static int`	`CELL` A cell of a table row.
`static int`	`COMMENT` A comment in a Word document.
`static int`	`COMMENT_RANGE_END` A marker node that represents the end of a commented range.
`static int`	`COMMENT_RANGE_START` A marker node that represents the start of a commented range.
`static int`	`DOCUMENT` A `Document` object that, as the root of the document tree, provides access to the entire Word document.
`static int`	`EDITABLE_RANGE_END` An end of an editable range.
`static int`	`EDITABLE_RANGE_START` A beginning of an editable range.
`static int`	`FIELD_END` A special character that designates the end of a Word field.
`static int`	`FIELD_SEPARATOR` A special character that separates the field code from the field result.
`static int`	`FIELD_START` A special character that designates the start of a Word field.
`static int`	`FOOTNOTE` A footnote or endnote in a Word document.
`static int`	`FORM_FIELD` A form field.
`static int`	`GLOSSARY_DOCUMENT` A glossary document within the main document.
`static int`	`GROUP_SHAPE` A group of shapes, images, OLE objects or other group shapes.
`static int`	`HEADER_FOOTER` A `HeaderFooter` object that contains text of a particular header or footer inside a section.
`static int`	`length`
`static int`	`MOVE_FROM_RANGE_END` An end of an MoveFrom range.
`static int`	`MOVE_FROM_RANGE_START` A beginning of an MoveFrom range.
`static int`	`MOVE_TO_RANGE_END` An end of an MoveTo range.
`static int`	`MOVE_TO_RANGE_START` A beginning of an MoveTo range.
`static int`	`NULL` Reserved for internal use by Aspose.Words.
`static int`	`OFFICE_MATH` An Office Math object.
`static int`	`PARAGRAPH` A paragraph of text.
`static int`	`ROW` A row of a table.
`static int`	`RUN` A run of text.
`static int`	`SECTION` A `Section` object that corresponds to one section in a Word document.
`static int`	`SHAPE` A drawing object, such as an OfficeArt shape, image or an OLE object.
`static int`	`SMART_TAG` A smart tag around one or more inline structures (runs, images, fields,etc.) within a paragraph
`static int`	`SPECIAL_CHAR` A special character that is not one of the more specific special character types.
`static int`	`STRUCTURED_DOCUMENT_TAG` Allows to define customer-specific information and its means of presentation.
`static int`	`STRUCTURED_DOCUMENT_TAG_RANGE_END` A end of ranged structured document tag which accepts multi-sections content.
`static int`	`STRUCTURED_DOCUMENT_TAG_RANGE_START` A start of ranged structured document tag which accepts multi-sections content.
`static int`	`SUB_DOCUMENT` A subdocument node which is a link to another document.
`static int`	`SYSTEM` Reserved for internal use by Aspose.Words.
`static int`	`TABLE` A `Table` object that represents a table in a Word document.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`fromName(java.lang.String nodeTypeName)`
`static java.lang.String`	`getName(int nodeType)`
`static int[]`	`getValues()`
`static java.lang.String`	`toString(int nodeType)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ANY
```
public static int ANY
```
    Indicates all node types. Allows to select all children.
  - DOCUMENT
```
public static int DOCUMENT
```
    A Document object that, as the root of the document tree, provides access to the entire Word document.
    
    A Document node can have Section nodes.
  - SECTION
```
public static int SECTION
```
    A Section object that corresponds to one section in a Word document.
    
    A Section node can have Body and HeaderFooter nodes.
  - BODY
```
public static int BODY
```
    A Body object that contains the main text of a section (main text story).
    
    A Body node can have Paragraph and Table nodes.
  - HEADER_FOOTER
```
public static int HEADER_FOOTER
```
    A HeaderFooter object that contains text of a particular header or footer inside a section.
    
    A HeaderFooter node can have Paragraph and Table nodes.
  - TABLE
```
public static int TABLE
```
    A Table object that represents a table in a Word document.
    
    A Table node can have Row nodes.
  - ROW
```
public static int ROW
```
    A row of a table.
    
    A Row node can have Cell nodes.
  - CELL
```
public static int CELL
```
    A cell of a table row.
    
    A Cell node can have Paragraph and Table nodes.
  - PARAGRAPH
```
public static int PARAGRAPH
```
    A paragraph of text.
    
    A Paragraph node is a container for inline level elements Run, FieldStart, FieldSeparator, FieldEnd, FormField, Shape, GroupShape, Footnote, Comment, SpecialChar, as well as BookmarkStart and BookmarkEnd.
  - BOOKMARK_START
```
public static int BOOKMARK_START
```
    A beginning of a bookmark marker.
  - BOOKMARK_END
```
public static int BOOKMARK_END
```
    An end of a bookmark marker.
  - EDITABLE_RANGE_START
```
public static int EDITABLE_RANGE_START
```
    A beginning of an editable range.
  - EDITABLE_RANGE_END
```
public static int EDITABLE_RANGE_END
```
    An end of an editable range.
  - MOVE_FROM_RANGE_START
```
public static int MOVE_FROM_RANGE_START
```
    A beginning of an MoveFrom range.
  - MOVE_FROM_RANGE_END
```
public static int MOVE_FROM_RANGE_END
```
    An end of an MoveFrom range.
  - MOVE_TO_RANGE_START
```
public static int MOVE_TO_RANGE_START
```
    A beginning of an MoveTo range.
  - MOVE_TO_RANGE_END
```
public static int MOVE_TO_RANGE_END
```
    An end of an MoveTo range.
  - GROUP_SHAPE
```
public static int GROUP_SHAPE
```
    A group of shapes, images, OLE objects or other group shapes.
    
    A GroupShape node can contain other Shape and GroupShape nodes.
  - SHAPE
```
public static int SHAPE
```
    A drawing object, such as an OfficeArt shape, image or an OLE object.
    
    A Shape node can contain Paragraph and Table nodes.
  - COMMENT
```
public static int COMMENT
```
    A comment in a Word document.
    
    A Comment node can have Paragraph and Table nodes.
  - FOOTNOTE
```
public static int FOOTNOTE
```
    A footnote or endnote in a Word document.
    
    A Footnote node can have Paragraph and Table nodes.
  - RUN
```
public static int RUN
```
    A run of text.
  - FIELD_START
```
public static int FIELD_START
```
    A special character that designates the start of a Word field.
  - FIELD_SEPARATOR
```
public static int FIELD_SEPARATOR
```
    A special character that separates the field code from the field result.
  - FIELD_END
```
public static int FIELD_END
```
    A special character that designates the end of a Word field.
  - FORM_FIELD
```
public static int FORM_FIELD
```
    A form field.
  - SPECIAL_CHAR
```
public static int SPECIAL_CHAR
```
    A special character that is not one of the more specific special character types.
  - SMART_TAG
```
public static int SMART_TAG
```
    A smart tag around one or more inline structures (runs, images, fields,etc.) within a paragraph
  - STRUCTURED_DOCUMENT_TAG
```
public static int STRUCTURED_DOCUMENT_TAG
```
    Allows to define customer-specific information and its means of presentation.
  - STRUCTURED_DOCUMENT_TAG_RANGE_START
```
public static int STRUCTURED_DOCUMENT_TAG_RANGE_START
```
    A start of ranged structured document tag which accepts multi-sections content.
  - STRUCTURED_DOCUMENT_TAG_RANGE_END
```
public static int STRUCTURED_DOCUMENT_TAG_RANGE_END
```
    A end of ranged structured document tag which accepts multi-sections content.
  - GLOSSARY_DOCUMENT
```
public static int GLOSSARY_DOCUMENT
```
    A glossary document within the main document.
  - BUILDING_BLOCK
```
public static int BUILDING_BLOCK
```
    A building block within a glossary document (e.g. glossary document entry).
  - COMMENT_RANGE_START
```
public static int COMMENT_RANGE_START
```
    A marker node that represents the start of a commented range.
  - COMMENT_RANGE_END
```
public static int COMMENT_RANGE_END
```
    A marker node that represents the end of a commented range.
  - OFFICE_MATH
```
public static int OFFICE_MATH
```
    An Office Math object. Can be equation, function, matrix or one of other mathematical objects. Can be a collection of mathematical object and also can contain some non-mathematical objects such as runs of text.
  - SUB_DOCUMENT
```
public static int SUB_DOCUMENT
```
    A subdocument node which is a link to another document.
  - SYSTEM
```
public static int SYSTEM
```
    Reserved for internal use by Aspose.Words.
  - NULL
```
public static int NULL
```
    Reserved for internal use by Aspose.Words.
  - length
```
public static int length
```
- Method Detail
  - getName
```
public static java.lang.String getName(int nodeType)
```
  - toString
```
public static java.lang.String toString(int nodeType)
```
  - fromName
```
public static int fromName(java.lang.String nodeTypeName)
```
  - getValues
```
public static int[] getValues()
```

Class NodeType

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ANY

DOCUMENT

SECTION

BODY

HEADER_FOOTER

TABLE

ROW

CELL

PARAGRAPH

BOOKMARK_START

BOOKMARK_END

EDITABLE_RANGE_START

EDITABLE_RANGE_END

MOVE_FROM_RANGE_START

MOVE_FROM_RANGE_END

MOVE_TO_RANGE_START

MOVE_TO_RANGE_END

GROUP_SHAPE

SHAPE

COMMENT

FOOTNOTE

RUN

FIELD_START

FIELD_SEPARATOR

FIELD_END

FORM_FIELD

SPECIAL_CHAR

SMART_TAG

STRUCTURED_DOCUMENT_TAG

STRUCTURED_DOCUMENT_TAG_RANGE_START

STRUCTURED_DOCUMENT_TAG_RANGE_END

GLOSSARY_DOCUMENT

BUILDING_BLOCK

COMMENT_RANGE_START

COMMENT_RANGE_END

OFFICE_MATH

SUB_DOCUMENT

SYSTEM

NULL

length

Method Detail

getName

toString

fromName

getValues