Sections¶

The document sections.

1	readonly `Count` : number

Add(options?: object) :Blocks:Count` : number

AddBlockContentControl(blockContentControlType: string, options?: object) :Blocks` : BlockContentControl
Gets the nested blocks.

ContentControlType : ( ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... )
Gets the content control type.

ElementType : string

Clone() : T

GetChildElements(recursively: boolean) : Array<...>

GetParentElements() : Array<...> `
Adds a block content control.

AddParagraph(options?: object) :ElementType` : string

Inlines : Count : ...

AddBookmarkEnd(bookmarkName: ..., options?: ...) : ...
Adds a bookmark end marker.

AddBookmarkStart(bookmarkName: ..., options?: ...) : ...
Adds a bookmark start marker.

AddField(fieldType: ..., options?: ...) : ...
Adds a field.

AddHyperlink(options?: ...) : ...
Adds a hyperlink.

AddInlineContentControl(inlineContentControlType: ..., options?: ...) : ...
Adds an inline content control.

AddNote(noteType: ..., options?: ...) : ...
Adds a note.

AddRun(options?: ...) : ...
Adds a text run.

AddShape(shapeType: ..., options?: ...) : ...
Adds a shape.

AddSpecialCharacter(specialCharacterType: ..., options?: ...) : ...
Adds a special character.

Clear() : ...

IndexOf(item: ...) : ...

Remove(item: ...) : ...

RemoveAt(i: ...) : ...

ToArray() : ...
Gets the paragraph's inlines.

ParagraphFormat : Alignment : ...
Gets or sets the text alignment for the paragraph.

BackgroundColor : ...
Gets or sets the paragraph background color.

KeepLinesTogether : ...
When true, all lines for this paragraph are maintained on a single page whenever possible.

KeepWithNext : ...
When true, the paragraph is on the same page as the following paragraph whenever possible.

LeftIndentation : ...
Gets or sets (in points) the left indentation for the paragraph.

LineSpacing : ...
Gets or sets the line spacing.

LineSpacingRule : ...
Gets or sets the line spacing rule.

MirrorIndents : ...
Gets or sets whether the paragraph indents should be interpreted as mirrored indents.

NoSpaceBetweenParagraphsOfSameStyle : ...
When true, spacing between paragraphs with the same style will be ignored.

PageBreakBefore : ...
When true, this paragraph is rendered at the start of a new page in the document.

RightIndentation : ...
Gets or sets (in points) the right indentation for the paragraph.

RightToLeft : ...
When true, this is a right-to-left paragraph.

SpaceAfter : ...
Gets or sets the amount of spacing after the paragraph (in points).

SpaceBefore : ...
Gets or sets the amount of spacing before the paragraph (in points).

SpecialIndentation : ...
Gets or sets the special indentation for the paragraph.

WordWrap : ...
Gets or sets a value indicating whether to break text which exceeds the text extents of a line by moving the word to the new line or breaking the word on the character level.

ClearFormatting() : ...
Clears the formatting.
Gets the paragraph format.

Clone() : T

GetChildElements(recursively: boolean) : Array<...>

GetParentElements() : Array<...> `
Adds a paragraph block.

AddTable(options?: object) :ElementType` : string

Rows : Count : ...

Add(options?: ...) : ...
Adds a new row to the table.

Clear() : ...

IndexOf(item: ...) : ...

Remove(item: ...) : ...

RemoveAt(i: ...) : ...

ToArray() : ...
Gets the table rows.

Clone() : T

GetChildElements(recursively: boolean) : Array<...>

GetParentElements() : Array<...> `
Adds a table block.

AddTableOfEntries(elementType: string, options?: object) :ElementType` : string

Entries : BlockCollection
Gets the table's entries.

FieldType : ( ... | ... | ... | ... | ... )
Gets the field type. The field type must be one of the following: Index, TOA, TOC

InstructionText : string
Gets or sets the field's instruction text.

IsDirty : boolean
Indicates whether this

IsLocked : boolean
Indicates whether this

Clone() : T

GetChildElements(recursively: boolean) : Array<...>

GetParentElements() : Array<...> `
Adds a table of entries block.

Clear() : void

IndexOf(item:ElementType` : string

Clone() : T

GetChildElements(recursively: boolean) : Array<...>

GetParentElements() : Array<...> ) : number`

Remove(item:ElementType` : string

Clone() : T

GetChildElements(recursively: boolean) : Array<...>

GetParentElements() : Array<...> ) : void`

RemoveAt(i: number) : void

ToArray() : Array<ElementType` : ...

Clone() : ...

GetChildElements(recursively: ...) : ...

GetParentElements() : ... >`
Gets the blocks in the section.

ElementType : string

HeadersFooters : Count : number

Add(headerFooterType: string, options?: object) :Blocks:Count` : ...

AddBlockContentControl(blockContentControlType: ..., options?: ...) : ...
Adds a block content control.

AddParagraph(options?: ...) : ...
Adds a paragraph block.

AddTable(options?: ...) : ...
Adds a table block.

AddTableOfEntries(elementType: ..., options?: ...) : ...
Adds a table of entries block.

Clear() : ...

IndexOf(item: ...) : ...

Remove(item: ...) : ...

RemoveAt(i: ...) : ...

ToArray() : ...
Gets the blocks in the header or footer.

ElementType : string

HeaderFooterType : ( ... | ... | ... | ... | ... | ... )
Gets the header or footer type.

IsHeader : boolean
Gets a value indicating whether this instance is a header.

Clone() : T

GetChildElements(recursively: boolean) : Array<...>

GetParentElements() : Array<...> `
Adds a header or footer.

Clear() : void

IndexOf(item:Blocks:Count` : ...

AddBlockContentControl(blockContentControlType: ..., options?: ...) : ...
Adds a block content control.

AddParagraph(options?: ...) : ...
Adds a paragraph block.

AddTable(options?: ...) : ...
Adds a table block.

AddTableOfEntries(elementType: ..., options?: ...) : ...
Adds a table of entries block.

Clear() : ...

IndexOf(item: ...) : ...

Remove(item: ...) : ...

RemoveAt(i: ...) : ...

ToArray() : ...
Gets the blocks in the header or footer.

ElementType : string

HeaderFooterType : ( ... | ... | ... | ... | ... | ... )
Gets the header or footer type.

IsHeader : boolean
Gets a value indicating whether this instance is a header.

Clone() : T

GetChildElements(recursively: boolean) : Array<...>

GetParentElements() : Array<...> ) : number`

Remove(item:Blocks:Count` : ...

AddBlockContentControl(blockContentControlType: ..., options?: ...) : ...
Adds a block content control.

AddParagraph(options?: ...) : ...
Adds a paragraph block.

AddTable(options?: ...) : ...
Adds a table block.

AddTableOfEntries(elementType: ..., options?: ...) : ...
Adds a table of entries block.

Clear() : ...

IndexOf(item: ...) : ...

Remove(item: ...) : ...

RemoveAt(i: ...) : ...

ToArray() : ...
Gets the blocks in the header or footer.

ElementType : string

HeaderFooterType : ( ... | ... | ... | ... | ... | ... )
Gets the header or footer type.

IsHeader : boolean
Gets a value indicating whether this instance is a header.

Clone() : T

GetChildElements(recursively: boolean) : Array<...>

GetParentElements() : Array<...> ) : void`

RemoveAt(i: number) : void

ToArray() : Array<Blocks` : ...
Gets the blocks in the header or footer.

ElementType : ...

HeaderFooterType : ...
Gets the header or footer type.

IsHeader : ...
Gets a value indicating whether this instance is a header.

Clone() : ...

GetChildElements(recursively: ...) : ...

GetParentElements() : ... >`
Gets the section headers and footers.

PageSetup : Orientation : ( "Landscape" | "Portrait" )
Gets or sets the page setup.

PageBorders : AlwaysDisplayInFront : boolean
Gets or sets a value indicating whether the page border is positioned above or below intersecting texts and objects in this document.

ApplyToAllExceptFirstPage : boolean
Gets or sets a value indicating whether to apply page borders to all pages of the section, except the first page.
Gets the page borders.

PageColor : string
Gets or sets the background color for all pages of the parent section.
Gets or sets the page setup for the section.

Clone() : T

GetChildElements(recursively: boolean) : Array<T>

GetParentElements() : Array<T> `
Adds a new section to the document.

Clear() : void

IndexOf(item:Blocks:Count` : number