StoryType enumeration

StoryType enumeration

Text of a Word document is stored in stories. StoryType identifies a story.

Members

NameDescription
NoneDefault value. There is no such story in the document.
MainTextContains the main text of the document, represented by Body.
FootnotesContains footnote text, represented by Footnote.
EndnotesContains endnotes text, represented by Footnote.
CommentsContains document comments (annotations), represented by Comment.
TextboxContains shape or textbox text, represented by Shape.
EvenPagesHeaderContains text of the even pages header, represented by HeaderFooter.
PrimaryHeaderContains text of the primary header. When header is different for odd and even pages, contains text of the odd pages header. Represented by HeaderFooter.
EvenPagesFooterContains text of the even pages footer, represented by HeaderFooter.
PrimaryFooterContains text of the primary footer. When footer is different for odd and even pages, contains text of the odd pages footer. Represented by HeaderFooter.
FirstPageHeaderContains text of the first page header, represented by HeaderFooter.
FirstPageFooterContains text of the first page footer, represented by HeaderFooter.
FootnoteSeparatorContains the text of the footnote separator.
FootnoteContinuationSeparatorContains the text of the footnote continuation separator.
FootnoteContinuationNoticeContains the text of the footnote continuation notice separator.
EndnoteSeparatorContains the text of the endnote separator.
EndnoteContinuationSeparatorContains the text of the endnote continuation separator.
EndnoteContinuationNoticeContains the text of the endnote continuation notice separator.

Examples

Shows how to remove all shapes from a node.

let doc = new aw.Document();
let builder = new aw.DocumentBuilder(doc);

// Use a DocumentBuilder to insert a shape. This is an inline shape,
// which has a parent Paragraph, which is a child node of the first section's Body.
builder.insertShape(aw.Drawing.ShapeType.Cube, 100.0, 100.0);

expect(doc.getChildNodes(aw.NodeType.Shape, true).count).toEqual(1);

// We can delete all shapes from the child paragraphs of this Body.
expect(doc.firstSection.body.storyType).toEqual(aw.StoryType.MainText);
doc.firstSection.body.deleteShapes();

expect(doc.getChildNodes(aw.NodeType.Shape, true).count).toEqual(0);

See Also