Entries¶

Gets the table's entries.

1	readonly `Count` : number

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

ElementType : string

Clone() : T

GetChildElements(recursively: boolean) : Array<T>

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

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

Inlines : Count : number

AddBookmarkEnd(bookmarkName: string, options?: object) :ElementType` : string

Name : string
Gets or sets the bookmark name.

Clone() : T

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

GetParentElements() : Array<...> `
Adds a bookmark end marker.

AddBookmarkStart(bookmarkName: string, options?: object) :ElementType` : string

Name : string
Gets or sets the bookmark name.

Clone() : T

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

GetParentElements() : Array<...> `
Adds a bookmark start marker.

AddField(fieldType: string, options?: object) :CharacterFormat:AllCaps` : ...

BackgroundColor : ...

Bold : ...

DoubleStrikethrough : ...

FontColor : ...

FontName : ...

Hidden : ...

HighlightColor : ...
Highlighting color must be one of the following: Black, Blue, Cyan, DarkBlue, DarkCyan, DarkGray, DarkGreen, DarkMagenta, DarkRed, DarkYellow, Green, LightGray, Magenta, Empty, Red, WhiteYellow

Italic : ...

Kerning : ...

Position : ...

RightToLeft : ...

Scaling : ...
Gets or sets the percentage by which each character is expanded or compressed when it is rendered in the document. Supported only in DOCX and DOC formats.

Size : ...

SmallCaps : ...

Spacing : ...

Strikethrough : ...

Subscript : ...

Superscript : ...

UnderlineColor : ...

UnderlineStyle : ...

ClearFormatting() : ...

Clone(resolveValues?: ...) : ...
Clones the character format.
Gets or sets the character format.

ElementType : string

FieldType : ( ... | ... | ... | ... | ... )
Gets the field type.

InstructionInlines : InlineCollection
Gets the field instruction inlines.

IsDirty : boolean
Gets or sets whether the field is dirty.

IsLocked : boolean
Gets or sets whether the field is locked.

ResultInlines : InlineCollection
Gets the field result inlines.

Clone() : T

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

GetInstructionText() : string
Gets the field instruction text.

GetParentElements() : Array<...>

Update() : void
This Update() method currently supports updating the following field types: Author,Comments,Compare,Date,DocProperty,DocVariable,If,FileName,FormCheckBox,FormDropDown,Formula,IncludePicture,Keywords,LastSavedBy,MacroButton,PrintDate,SaveDateSet,Symbol,Subject,Time,Title,DisplayBarcode`
Adds a field.

AddHyperlink(options?: object) :Address` : string
Gets or sets the hyperlink address.

DisplayInlines : InlineCollection
Gets the displayed inline elements.

ElementType : string

IsBookmarkLink : boolean
Gets or sets whether the hyperlink points to a bookmark.

ScreenTip : string
Gets or sets the screen tip text.

TargetFrame : string
Gets or sets the target frame.

Clone() : T

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

GetParentElements() : Array<...> `
Adds a hyperlink.

AddInlineContentControl(inlineContentControlType: string, options?: object) :ContentControlType` : ( ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... )
Gets the content control type.

ElementType : string

Inlines : InlineCollection
Gets the inline elements in the content control.

Clone() : T

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

GetParentElements() : Array<...> `
Adds an inline content control.

AddNote(noteType: string, options?: object) :Blocks` : BlockCollection
Gets the note blocks.

CharacterFormat : AllCaps : ...

BackgroundColor : ...

Bold : ...

DoubleStrikethrough : ...

FontColor : ...

FontName : ...

Hidden : ...

HighlightColor : ...
Highlighting color must be one of the following: Black, Blue, Cyan, DarkBlue, DarkCyan, DarkGray, DarkGreen, DarkMagenta, DarkRed, DarkYellow, Green, LightGray, Magenta, Empty, Red, WhiteYellow

Italic : ...

Kerning : ...

Position : ...

RightToLeft : ...

Scaling : ...
Gets or sets the percentage by which each character is expanded or compressed when it is rendered in the document. Supported only in DOCX and DOC formats.

Size : ...

SmallCaps : ...

Spacing : ...

Strikethrough : ...

Subscript : ...

Superscript : ...

UnderlineColor : ...

UnderlineStyle : ...

ClearFormatting() : ...

Clone(resolveValues?: ...) : ...
Clones the character format.
Gets or sets the character format.

CustomMark : string
Gets or sets the custom note mark.

ElementType : string

NoteType : ( ... | ... )
Gets or sets the note type.

Clone() : T

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

GetParentElements() : Array<...> `
Adds a note.

AddRun(options?: object) :CharacterFormat:AllCaps` : ...

BackgroundColor : ...

Bold : ...

DoubleStrikethrough : ...

FontColor : ...

FontName : ...

Hidden : ...

HighlightColor : ...
Highlighting color must be one of the following: Black, Blue, Cyan, DarkBlue, DarkCyan, DarkGray, DarkGreen, DarkMagenta, DarkRed, DarkYellow, Green, LightGray, Magenta, Empty, Red, WhiteYellow

Italic : ...

Kerning : ...

Position : ...

RightToLeft : ...

Scaling : ...
Gets or sets the percentage by which each character is expanded or compressed when it is rendered in the document. Supported only in DOCX and DOC formats.

Size : ...

SmallCaps : ...

Spacing : ...

Strikethrough : ...

Subscript : ...

Superscript : ...

UnderlineColor : ...

UnderlineStyle : ...

ClearFormatting() : ...

Clone(resolveValues?: ...) : ...
Clones the character format.
Gets or sets the character format.

ElementType : string

Text : string
Gets or sets the run text.

Clone() : T

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

GetParentElements() : Array<...> `
Adds a text run.

AddShape(shapeType: string, options?: object) :ElementType` : string

Hidden : boolean
Gets or sets whether the drawing element is hidden.

MetaData : Description : ...
Gets or sets the drawing description.

Name : ...
Gets or sets the drawing name.

Title : ...
Gets or sets the drawing title.
Gets the drawing metadata.

ShapeType : ( ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... )
Gets the shape type.

Clone() : T

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

GetParentElements() : Array<...> `
Adds a shape.

AddSpecialCharacter(specialCharacterType: string, options?: object) :CharacterFormat:AllCaps` : ...

BackgroundColor : ...

Bold : ...

DoubleStrikethrough : ...

FontColor : ...

FontName : ...

Hidden : ...

HighlightColor : ...
Highlighting color must be one of the following: Black, Blue, Cyan, DarkBlue, DarkCyan, DarkGray, DarkGreen, DarkMagenta, DarkRed, DarkYellow, Green, LightGray, Magenta, Empty, Red, WhiteYellow

Italic : ...

Kerning : ...

Position : ...

RightToLeft : ...

Scaling : ...
Gets or sets the percentage by which each character is expanded or compressed when it is rendered in the document. Supported only in DOCX and DOC formats.

Size : ...

SmallCaps : ...

Spacing : ...

Strikethrough : ...

Subscript : ...

Superscript : ...

UnderlineColor : ...

UnderlineStyle : ...

ClearFormatting() : ...

Clone(resolveValues?: ...) : ...
Clones the character format.
Gets or sets the special character format.

CharacterType : ( ... | ... | ... | ... | ... | ... | ... | ... )
Gets or sets the special character type.

ElementType : string

Clone() : T

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

GetParentElements() : Array<...> `
Adds a special character.

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 paragraph's inlines.

ParagraphFormat : Alignment : ( "Center" | "Justify" | "Left" | "Right" )
Gets or sets the text alignment for the paragraph.

BackgroundColor : string
Gets or sets the paragraph background color.

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

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

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

LineSpacing : number
Gets or sets the line spacing.

LineSpacingRule : ( "AtLeast" | "Exactly" | "Multiple" )
Gets or sets the line spacing rule.

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

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

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

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

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

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

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

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

WordWrap : boolean
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() : void
Clears the formatting.
Gets the paragraph format.

Clone() : T

GetChildElements(recursively: boolean) : Array<T>

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

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

Rows : Count : number

Add(options?: object) :Cells:Count` : ...

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

Clear() : ...

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

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

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

ToArray() : ...
Gets the table row cells.`
Adds a new row to the table.

Clear() : void

IndexOf(item:Cells:Count` : ...

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

Clear() : ...

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

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

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

ToArray() : ...
Gets the table row cells.) : number`

Remove(item:Cells:Count` : ...

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

Clear() : ...

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

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

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

ToArray() : ...
Gets the table row cells.) : void`

RemoveAt(i: number) : void

ToArray() : Array<Cells: ... Gets the table row cells.>
Gets the table rows.

Clone() : T

GetChildElements(recursively: boolean) : Array<T>

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

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

Entries : BlockCollection
Gets the table's entries.

FieldType : ( "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoNum" )
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<T>

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

Clear() : void

IndexOf(item:ElementType` : string

Clone() : T

GetChildElements(recursively: boolean) : Array<T>

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

Remove(item:ElementType` : string

Clone() : T

GetChildElements(recursively: boolean) : Array<T>

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

RemoveAt(i: number) : void

ToArray() : Array<ElementType` : string

Clone() : T

GetChildElements(recursively: boolean) : Array<T>

GetParentElements() : Array<T> >` myTableOfEntries.Entries