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.worksheets.get(0).shapes;
shapes.addTextEffect(MsoPresetTextEffect.TextEffect1, "Aspose", "Arial", 30, false, false, 0, 0, 0, 0, 100, 200);
var textEffectFormat = shapes.get(0).textEffect;
textEffectFormat.setTextEffect(MsoPresetTextEffect.TextEffect10);
workbook.save("output/TextEffectFormat.xls");
Properties
| Property | Type | Description |
|---|---|---|
| text | string | The text in the WordArt. |
| fontName | string | The name of the font used in the WordArt. |
| fontBold | boolean | Indicates whether font is bold. |
| fontItalic | boolean | Indicates whether font is italic. |
| rotatedChars | boolean | If true,characters in the specified WordArt are rotated 90 degrees relative to the WordArt’s bounding shape. |
| fontSize | number | The size (in points) of the font used in the WordArt. |
| presetShape | MsoPresetTextEffectShape | Gets and sets the preset shape type. |
Methods
| Method | Description |
|---|---|
| getText() | @deprecated. Please use the ’text’ property instead. The text in the WordArt. |
| setText(string) | @deprecated. Please use the ’text’ property instead. The text in the WordArt. |
| getFontName() | @deprecated. Please use the ‘fontName’ property instead. The name of the font used in the WordArt. |
| setFontName(string) | @deprecated. Please use the ‘fontName’ property instead. The name of the font used in the WordArt. |
| getFontBold() | @deprecated. Please use the ‘fontBold’ property instead. Indicates whether font is bold. |
| setFontBold(boolean) | @deprecated. Please use the ‘fontBold’ property instead. Indicates whether font is bold. |
| getFontItalic() | @deprecated. Please use the ‘fontItalic’ property instead. Indicates whether font is italic. |
| setFontItalic(boolean) | @deprecated. Please use the ‘fontItalic’ property instead. Indicates whether font is italic. |
| getRotatedChars() | @deprecated. Please use the ‘rotatedChars’ property instead. If true,characters in the specified WordArt are rotated 90 degrees relative to the WordArt’s bounding shape. |
| setRotatedChars(boolean) | @deprecated. Please use the ‘rotatedChars’ property instead. If true,characters in the specified WordArt are rotated 90 degrees relative to the WordArt’s bounding shape. |
| getFontSize() | @deprecated. Please use the ‘fontSize’ property instead. The size (in points) of the font used in the WordArt. |
| setFontSize(number) | @deprecated. Please use the ‘fontSize’ property instead. The size (in points) of the font used in the WordArt. |
| getPresetShape() | @deprecated. Please use the ‘presetShape’ property instead. Gets and sets the preset shape type. |
| setPresetShape(MsoPresetTextEffectShape) | @deprecated. Please use the ‘presetShape’ property instead. Gets and sets the preset shape type. |
| setTextEffect(MsoPresetTextEffect) | Sets the preset text effect. |
| isNull() | Checks whether the implementation object is null. |
text
The text in the WordArt.
text : string;
fontName
The name of the font used in the WordArt.
fontName : string;
fontBold
Indicates whether font is bold.
fontBold : boolean;
fontItalic
Indicates whether font is italic.
fontItalic : boolean;
rotatedChars
If true,characters in the specified WordArt are rotated 90 degrees relative to the WordArt’s bounding shape.
rotatedChars : boolean;
fontSize
The size (in points) of the font used in the WordArt.
fontSize : number;
presetShape
Gets and sets the preset shape type.
presetShape : MsoPresetTextEffectShape;
getText()
@deprecated. Please use the ’text’ property instead. The text in the WordArt.
getText() : string;
setText(string)
@deprecated. Please use the ’text’ property instead. The text in the WordArt.
setText(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getFontName()
@deprecated. Please use the ‘fontName’ property instead. The name of the font used in the WordArt.
getFontName() : string;
setFontName(string)
@deprecated. Please use the ‘fontName’ property instead. The name of the font used in the WordArt.
setFontName(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getFontBold()
@deprecated. Please use the ‘fontBold’ property instead. Indicates whether font is bold.
getFontBold() : boolean;
setFontBold(boolean)
@deprecated. Please use the ‘fontBold’ property instead. Indicates whether font is bold.
setFontBold(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getFontItalic()
@deprecated. Please use the ‘fontItalic’ property instead. Indicates whether font is italic.
getFontItalic() : boolean;
setFontItalic(boolean)
@deprecated. Please use the ‘fontItalic’ property instead. Indicates whether font is italic.
setFontItalic(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getRotatedChars()
@deprecated. Please use the ‘rotatedChars’ property instead. If true,characters in the specified WordArt are rotated 90 degrees relative to the WordArt’s bounding shape.
getRotatedChars() : boolean;
setRotatedChars(boolean)
@deprecated. Please use the ‘rotatedChars’ property instead. If true,characters in the specified WordArt are rotated 90 degrees relative to the WordArt’s bounding shape.
setRotatedChars(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getFontSize()
@deprecated. Please use the ‘fontSize’ property instead. The size (in points) of the font used in the WordArt.
getFontSize() : number;
setFontSize(number)
@deprecated. Please use the ‘fontSize’ property instead. The size (in points) of the font used in the WordArt.
setFontSize(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getPresetShape()
@deprecated. Please use the ‘presetShape’ property instead. Gets and sets the preset shape type.
getPresetShape() : MsoPresetTextEffectShape;
Returns
setPresetShape(MsoPresetTextEffectShape)
@deprecated. Please use the ‘presetShape’ property instead. Gets and sets the preset shape type.
setPresetShape(value: MsoPresetTextEffectShape) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | MsoPresetTextEffectShape | The value to set. |
setTextEffect(MsoPresetTextEffect)
Sets the preset text effect.
setTextEffect(effect: MsoPresetTextEffect) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| effect | MsoPresetTextEffect | The preset text effect. |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;