FontSettingCollection

FontSettingCollection class

Represents the list of FontSetting.

class FontSettingCollection;

Properties

PropertyTypeDescription
textAlignmentShapeTextAlignmentReadonly. Represents the alignment setting of the text body.
textParagraphsTextParagraphCollectionReadonly. Gets all paragraphs.
textstringGets and sets the text of the shape.
htmlStringstringGets and sets the html string which contains data and some formats in this shape.

Methods

MethodDescription
get(number)Gets the FontSetting by the index.
setWordArtStyle(PresetWordArtStyle)Sets the preset WordArt style.
getParagraphEnumerator()Gets the enumerator of the paragraphs.
appendText(string)Appends the text.
insertText(number, string)Insert index at the position.
replace(number, number, string)Replace the text.
replace(string, string)Replace the text.
deleteText(number, number)Delete some characters.
format(number, number, Font, StyleFlag)Format the text with font setting.
clear()Clear all setting.
equals(VObject)
getHashCode()

textAlignment

Readonly. Represents the alignment setting of the text body.

textAlignment : ShapeTextAlignment;

textParagraphs

Readonly. Gets all paragraphs.

textParagraphs : TextParagraphCollection;

text

Gets and sets the text of the shape.

text : string;

htmlString

Gets and sets the html string which contains data and some formats in this shape.

htmlString : string;

get(number)

Gets the FontSetting by the index.

get(index: number) : FontSetting;

Parameters:

ParameterTypeDescription
indexnumberThe index.

Returns

FontSetting

setWordArtStyle(PresetWordArtStyle)

Sets the preset WordArt style.

setWordArtStyle(style: PresetWordArtStyle) : void;

Parameters:

ParameterTypeDescription
stylePresetWordArtStyleThe preset WordArt style.

getParagraphEnumerator()

Gets the enumerator of the paragraphs.

getParagraphEnumerator() : TextParagraphEnumerator;

Returns

TextParagraphEnumerator

appendText(string)

Appends the text.

appendText(text: string) : void;

Parameters:

ParameterTypeDescription
textstringThe text.

insertText(number, string)

Insert index at the position.

insertText(index: number, text: string) : void;

Parameters:

ParameterTypeDescription
indexnumberThe start index.
textstringThe text.

replace(number, number, string)

Replace the text.

replace(index: number, count: number, text: string) : void;

Parameters:

ParameterTypeDescription
indexnumberThe start index.
countnumberThe count of characters.
textstringThe text.

replace(string, string)

Replace the text.

replace(oldValue: string, newValue: string) : void;

Parameters:

ParameterTypeDescription
oldValuestringThe old text.
newValuestringThe new text.

deleteText(number, number)

Delete some characters.

deleteText(index: number, count: number) : void;

Parameters:

ParameterTypeDescription
indexnumberThe start index.
countnumberThe count of characters.

format(number, number, Font, StyleFlag)

Format the text with font setting.

format(startIndex: number, length: number, font: Font, flag: StyleFlag) : void;

Parameters:

ParameterTypeDescription
startIndexnumberThe start index.
lengthnumberThe length.
fontFontThe font.
flagStyleFlagThe flags of the font.

clear()

Clear all setting.

clear() : void;

equals(VObject)

equals(obj: VObject) : boolean;

Parameters:

ParameterTypeDescription
objVObject

getHashCode()

getHashCode() : number;