TextEffectFormat

TextEffectFormat class

Contains properties and methods that apply to WordArt objects.

class TextEffectFormat;

Example

const { Workbook, MsoPresetTextEffect } = require("aspose.cells.node");

//Instantiating a Workbook object
var workbook = new Workbook();
var shapes = workbook.getWorksheets().get(0).getShapes();
shapes.addTextEffect(MsoPresetTextEffect.TextEffect1, "Aspose", "Arial", 30, false, false, 0, 0, 0, 0, 100, 200);
var textEffectFormat = shapes.get(0).getTextEffect();
textEffectFormat.setTextEffect(MsoPresetTextEffect.TextEffect10);
workbook.save("output/TextEffectFormat.xls");

Methods

MethodDescription
getText()The text in the WordArt.
setText(string)The text in the WordArt.
getFontName()The name of the font used in the WordArt.
setFontName(string)The name of the font used in the WordArt.
getFontBold()Indicates whether font is bold.
setFontBold(boolean)Indicates whether font is bold.
getFontItalic()Indicates whether font is italic.
setFontItalic(boolean)Indicates whether font is italic.
getRotatedChars()If true,characters in the specified WordArt are rotated 90 degrees relative to the WordArt’s bounding shape.
setRotatedChars(boolean)If true,characters in the specified WordArt are rotated 90 degrees relative to the WordArt’s bounding shape.
getFontSize()The size (in points) of the font used in the WordArt.
setFontSize(number)The size (in points) of the font used in the WordArt.
getPresetShape()Gets and sets the preset shape type.
setPresetShape(MsoPresetTextEffectShape)Gets and sets the preset shape type.
setTextEffect(MsoPresetTextEffect)Sets the preset text effect.
isNull()Checks whether the implementation object is null.

getText()

The text in the WordArt.

getText() : string;

setText(string)

The text in the WordArt.

setText(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getFontName()

The name of the font used in the WordArt.

getFontName() : string;

setFontName(string)

The name of the font used in the WordArt.

setFontName(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getFontBold()

Indicates whether font is bold.

getFontBold() : boolean;

setFontBold(boolean)

Indicates whether font is bold.

setFontBold(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getFontItalic()

Indicates whether font is italic.

getFontItalic() : boolean;

setFontItalic(boolean)

Indicates whether font is italic.

setFontItalic(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getRotatedChars()

If true,characters in the specified WordArt are rotated 90 degrees relative to the WordArt’s bounding shape.

getRotatedChars() : boolean;

setRotatedChars(boolean)

If true,characters in the specified WordArt are rotated 90 degrees relative to the WordArt’s bounding shape.

setRotatedChars(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getFontSize()

The size (in points) of the font used in the WordArt.

getFontSize() : number;

setFontSize(number)

The size (in points) of the font used in the WordArt.

setFontSize(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getPresetShape()

Gets and sets the preset shape type.

getPresetShape() : MsoPresetTextEffectShape;

Returns

MsoPresetTextEffectShape

setPresetShape(MsoPresetTextEffectShape)

Gets and sets the preset shape type.

setPresetShape(value: MsoPresetTextEffectShape) : void;

Parameters:

ParameterTypeDescription
valueMsoPresetTextEffectShapeThe value to set.

setTextEffect(MsoPresetTextEffect)

Sets the preset text effect.

setTextEffect(effect: MsoPresetTextEffect) : void;

Parameters:

ParameterTypeDescription
effectMsoPresetTextEffectThe preset text effect.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;