AddTableOfEntries¶
Adds a table of entries block.
1 | |
Entries : Count : number
AddBlockContentControl(blockContentControlType: string, options?: object) :Blocks` : BlockContentControl
Gets the nested blocks.
ContentControlType : ( "Group" | "Bibliography" | "BuildingBlockGallery" | "CheckBox" | "Citation" | "ComboBox" | "Date" | "DocPartObj" | "DropDownList" | "Equation" | "Picture" | "PlainText" | "RepeatingSection" | "RepeatingSectionItem" | "RichText" )
Gets the content control type.
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?: ( ... | ... )) :ElementType` : ...
Name : ...
Gets or sets the bookmark name.
Clone() : ...
GetChildElements(recursively: ...) : ...
GetParentElements() : ... `
Adds a bookmark end marker.
AddBookmarkStart(bookmarkName: string, options?: ( ... | ... )) :ElementType` : ...
Name : ...
Gets or sets the bookmark name.
Clone() : ...
GetChildElements(recursively: ...) : ...
GetParentElements() : ... `
Adds a bookmark start marker.
AddField(fieldType: string, options?: ( ... | ... )) :CharacterFormat` : ...
Gets or sets the character format.
ElementType : ...
FieldType : ...
Gets the field type.
InstructionInlines : ...
Gets the field instruction inlines.
IsDirty : ...
Gets or sets whether the field is dirty.
IsLocked : ...
Gets or sets whether the field is locked.
ResultInlines : ...
Gets the field result inlines.
Clone() : ...
GetChildElements(recursively: ...) : ...
GetInstructionText() : ...
Gets the field instruction text.
GetParentElements() : ...
Update() : ...
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?: ( ... | ... )) :Address` : ...
Gets or sets the hyperlink address.
DisplayInlines : ...
Gets the displayed inline elements.
ElementType : ...
IsBookmarkLink : ...
Gets or sets whether the hyperlink points to a bookmark.
ScreenTip : ...
Gets or sets the screen tip text.
TargetFrame : ...
Gets or sets the target frame.
Clone() : ...
GetChildElements(recursively: ...) : ...
GetParentElements() : ... `
Adds a hyperlink.
AddInlineContentControl(inlineContentControlType: string, options?: ( ... | ... )) :ContentControlType` : ...
Gets the content control type.
ElementType : ...
Inlines : ...
Gets the inline elements in the content control.
Clone() : ...
GetChildElements(recursively: ...) : ...
GetParentElements() : ... `
Adds an inline content control.
AddNote(noteType: string, options?: ( ... | ... )) :Blocks` : ...
Gets the note blocks.
CharacterFormat : ...
Gets or sets the character format.
CustomMark : ...
Gets or sets the custom note mark.
ElementType : ...
NoteType : ...
Gets or sets the note type.
Clone() : ...
GetChildElements(recursively: ...) : ...
GetParentElements() : ... `
Adds a note.
AddRun(options?: ( ... | ... )) :CharacterFormat` : ...
Gets or sets the character format.
ElementType : ...
Text : ...
Gets or sets the run text.
Clone() : ...
GetChildElements(recursively: ...) : ...
GetParentElements() : ... `
Adds a text run.
AddShape(shapeType: string, options?: ( ... | ... )) :ElementType` : ...
Hidden : ...
Gets or sets whether the drawing element is hidden.
MetaData : ...
Gets the drawing metadata.
ShapeType : ...
Gets the shape type.
Clone() : ...
GetChildElements(recursively: ...) : ...
GetParentElements() : ... `
Adds a shape.
AddSpecialCharacter(specialCharacterType: string, options?: ( ... | ... )) :CharacterFormat` : ...
Gets or sets the special character format.
CharacterType : ...
Gets or sets the special character type.
ElementType : ...
Clone() : ...
GetChildElements(recursively: ...) : ...
GetParentElements() : ... `
Adds a special character.
Clear() : void
IndexOf(item:ElementType` : ...
Clone() : ...
GetChildElements(recursively: ...) : ...
GetParentElements() : ... ) : number`
Remove(item:ElementType` : ...
Clone() : ...
GetChildElements(recursively: ...) : ...
GetParentElements() : ... ) : void`
RemoveAt(i: number) : void
ToArray() : Array<...>
Gets the paragraph's inlines.
ParagraphFormat : Alignment : ( ... | ... | ... | ... )
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 : ( ... | ... | ... )
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?: ( ... | ... )) :Cells: ... Gets the table row cells.
Adds a new row to the table.
Clear() : void
IndexOf(item:Cells: ... Gets the table row cells.) : number
Remove(item:Cells: ... Gets the table row cells.) : void
RemoveAt(i: number) : void
ToArray() : Array<...>
Gets the table rows.
Clone() : T
GetChildElements(recursively: boolean) : Array<T>
GetParentElements() : Array<T> `
Adds a table block.
AddTableOfEntries(elementType: string, options?: object) : TableOfEntries
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<...>
GetParentElements() : Array<...> >`
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>
Parameters¶
string elementType
object options optional