Skip to content

AddSpecialCharacter

Adds a special character.

1
myInlineCollection.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 : ( "None" | "Dashed" | "DotDash" | "DotDotDash" | "Dotted" | "Double" | "DoubleWave" | "Single" | "UnderlineNonSpaceCharactersOnly" | "Wave" )

ClearFormatting() : void

Clone(resolveValues?: boolean) : 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>

Parameters

string specialCharacterType

object options optional