AddHyperlink¶
Adds a hyperlink.
1 | |
Gets or sets the hyperlink address.
DisplayInlines : Count : number
AddBookmarkEnd(bookmarkName: string, options?: object) :ElementType` : string
Name : string
Gets or sets the bookmark name.
Clone() : T
GetChildElements(recursively: boolean) : Array<T>
GetParentElements() : Array<T> `
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<T>
GetParentElements() : Array<T> `
Adds a bookmark start marker.
AddField(fieldType: string, options?: object) :CharacterFormat:AllCaps` : boolean
BackgroundColor : string
Bold : boolean
DoubleStrikethrough : boolean
FontColor : string
FontName : string
Hidden : boolean
HighlightColor : string
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 : boolean
Kerning : number
Position : number
RightToLeft : boolean
Scaling : number
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 : number
SmallCaps : boolean
Spacing : number
Strikethrough : boolean
Subscript : boolean
Superscript : boolean
UnderlineColor : string
UnderlineStyle : ( ... | ... | ... | ... | ... | ... | ... | ... | ... | ... )
ClearFormatting() : void
Clone(resolveValues?: ( ... | ... | ... )) : CharacterFormat
Clones the character format.
Gets or sets the character format.
ElementType : string
FieldType : ( "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoNum" )
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<T>
GetInstructionText() : string
Gets the field instruction text.
GetParentElements() : Array<T>
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) : Hyperlink
Adds a hyperlink.
AddInlineContentControl(inlineContentControlType: string, options?: object) :ContentControlType: ("Group"|"Bibliography"|"BuildingBlockGallery"|"CheckBox"|"Citation"|"ComboBox"|"Date"|"DocPartObj"|"DropDownList"|"Equation"|"Picture"|"PlainText"|"RepeatingSection"|"RepeatingSectionItem"|"RichText"` )
Gets the content control type.
ElementType : string
Inlines : InlineCollection
Gets the inline elements in the content control.
Clone() : T
GetChildElements(recursively: boolean) : Array<T>
GetParentElements() : Array<T> `
Adds an inline content control.
AddNote(noteType: string, options?: object) :Blocks:Count` : number
AddBlockContentControl(blockContentControlType: string, options?: ( ... | ... )) :Blocks` : ...
Gets the nested blocks.
ContentControlType : ...
Gets the content control type.
ElementType : ...
Clone() : ...
GetChildElements(recursively: ...) : ...
GetParentElements() : ... `
Adds a block content control.
AddParagraph(options?: ( ... | ... )) :ElementType` : ...
Inlines : ...
Gets the paragraph's inlines.
ParagraphFormat : ...
Gets the paragraph format.
Clone() : ...
GetChildElements(recursively: ...) : ...
GetParentElements() : ... `
Adds a paragraph block.
AddTable(options?: ( ... | ... )) :ElementType` : ...
Rows : ...
Gets the table rows.
Clone() : ...
GetChildElements(recursively: ...) : ...
GetParentElements() : ... `
Adds a table block.
AddTableOfEntries(elementType: string, options?: ( ... | ... )) :ElementType` : ...
Entries : ...
Gets the table's entries.
FieldType : ...
Gets the field type. The field type must be one of the following: Index, TOA, TOC
InstructionText : ...
Gets or sets the field's instruction text.
IsDirty : ...
Indicates whether this
IsLocked : ...
Indicates whether this
Clone() : ...
GetChildElements(recursively: ...) : ...
GetParentElements() : ... `
Adds a table of entries block.
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 note blocks.
CharacterFormat : AllCaps : boolean
BackgroundColor : string
Bold : boolean
DoubleStrikethrough : boolean
FontColor : string
FontName : string
Hidden : boolean
HighlightColor : string
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 : boolean
Kerning : number
Position : number
RightToLeft : boolean
Scaling : number
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 : number
SmallCaps : boolean
Spacing : number
Strikethrough : boolean
Subscript : boolean
Superscript : boolean
UnderlineColor : string
UnderlineStyle : ( ... | ... | ... | ... | ... | ... | ... | ... | ... | ... )
ClearFormatting() : void
Clone(resolveValues?: ( ... | ... | ... )) : CharacterFormat
Clones the character format.
Gets or sets the character format.
CustomMark : string
Gets or sets the custom note mark.
ElementType : string
NoteType : ( "Endnote" | "Footnote" )
Gets or sets the note type.
Clone() : T
GetChildElements(recursively: boolean) : Array<T>
GetParentElements() : Array<T> `
Adds a note.
AddRun(options?: object) :CharacterFormat:AllCaps` : boolean
BackgroundColor : string
Bold : boolean
DoubleStrikethrough : boolean
FontColor : string
FontName : string
Hidden : boolean
HighlightColor : string
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 : boolean
Kerning : number
Position : number
RightToLeft : boolean
Scaling : number
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 : number
SmallCaps : boolean
Spacing : number
Strikethrough : boolean
Subscript : boolean
Superscript : boolean
UnderlineColor : string
UnderlineStyle : ( ... | ... | ... | ... | ... | ... | ... | ... | ... | ... )
ClearFormatting() : void
Clone(resolveValues?: ( ... | ... | ... )) : CharacterFormat
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<T>
GetParentElements() : Array<T> `
Adds a text run.
AddShape(shapeType: string, options?: object) :ElementType` : string
Hidden : boolean
Gets or sets whether the drawing element is hidden.
MetaData : Description : string
Gets or sets the drawing description.
Name : string
Gets or sets the drawing name.
Title : string
Gets or sets the drawing title.
Gets the drawing metadata.
ShapeType : ( "Custom" | "Diamond" | "DownArrow" | "FlowchartConnector" | "FlowchartDecision" | "FlowchartManualInput" | "FlowchartProcess" | "Hexagon" | "IsoscelesTriangle" | "LeftArrow" | "LeftRightArrow" | "Line" | "Octagon" | "Oval" | "OvalCallout" | "Parallelogram" | "Pentagon" | "PentagonArrow" | "Rectangle" | "RectangularCallout" | "RightArrow" | "RightTriangle" | "RoundDiagonalCornerRectangle" | "RoundedRectangle" | "RoundedRectangularCallout" | "RoundSameSideCornerRectangle" | "RoundSingleCornerRectangle" | "SnipSingleCornerRectangle" | "SnipDiagonalCornerRectangle" | "TextPath" | "Trapezoid" | "UpArrow" | "UpDownArrow" )
Gets the shape type.
Clone() : T
GetChildElements(recursively: boolean) : Array<T>
GetParentElements() : Array<T> `
Adds a shape.
AddSpecialCharacter(specialCharacterType: string, options?: object) :CharacterFormat:AllCaps` : boolean
BackgroundColor : string
Bold : boolean
DoubleStrikethrough : boolean
FontColor : string
FontName : string
Hidden : boolean
HighlightColor : string
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 : boolean
Kerning : number
Position : number
RightToLeft : boolean
Scaling : number
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 : number
SmallCaps : boolean
Spacing : number
Strikethrough : boolean
Subscript : boolean
Superscript : boolean
UnderlineColor : string
UnderlineStyle : ( ... | ... | ... | ... | ... | ... | ... | ... | ... | ... )
ClearFormatting() : void
Clone(resolveValues?: ( ... | ... | ... )) : CharacterFormat
Clones the character format.
Gets or sets the special character format.
CharacterType : ( "CarriageReturn" | "ColumnBreak" | "ContinuationSeparator" | "LineBreak" | "NoteMark" | "PageBreak" | "Separator" | "Tab" )
Gets or sets the special character type.
ElementType : string
Clone() : T
GetChildElements(recursively: boolean) : Array<T>
GetParentElements() : Array<T> `
Adds a special character.
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 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<T>
GetParentElements() : Array<T>
Parameters¶
object options optional