com.aspose.words
Class TextPath

java.lang.Object
    extended by com.aspose.words.TextPath

public class TextPath 
extends java.lang.Object

Defines the text and formatting of the text path (of a WordArt object).

Use the Shape.TextPath property to access WordArt properties of a shape. You do not create instances of the TextPath class directly.

See Also:
Shape.TextPath

Property Getters/Setters Summary
booleangetBold()
voidsetBold(boolean value)
           True if the font is formatted as bold.
booleangetFitPath()
voidsetFitPath(boolean value)
           Defines whether the text fits the path of a shape.
booleangetFitShape()
voidsetFitShape(boolean value)
           Defines whether the text fits bounding box of a shape.
java.lang.StringgetFontFamily()
voidsetFontFamily(java.lang.String value)
           Defines the family of the textpath font.
booleangetItalic()
voidsetItalic(boolean value)
           True if the font is formatted as italic.
booleangetKerning()
voidsetKerning(boolean value)
           Determines whether kerning is turned on.
booleangetOn()
voidsetOn(boolean value)
           Defines whether the text is displayed.
booleangetReverseRows()
voidsetReverseRows(boolean value)
           Determines whether the layout order of rows is reversed.
booleangetRotateLetters()
voidsetRotateLetters(boolean value)
           Determines whether the letters of the text are rotated.
booleangetSameLetterHeights()
voidsetSameLetterHeights(boolean value)
           Determines whether all letters will be the same height regardless of initial case.
booleangetShadow()
voidsetShadow(boolean value)
           Defines whether a shadow is applied to the text on a text path.
doublegetSize()
voidsetSize(double value)
           Defines the size of the font in points.
booleangetSmallCaps()
voidsetSmallCaps(boolean value)
           True if the font is formatted as small capital letters.
doublegetSpacing()
voidsetSpacing(double value)
           Defines the amount of spacing for text. 1 means 100%.
booleangetStrikeThrough()
voidsetStrikeThrough(boolean value)
           True if the font is formatted as strikethrough text.
java.lang.StringgetText()
voidsetText(java.lang.String value)
           Defines the text of the text path.
intgetTextPathAlignment()
voidsetTextPathAlignment(int value)
           Defines the alignment of text. The value of the property is TextPathAlignment integer constant.
booleangetTrim()
voidsetTrim(boolean value)
           Determines whether extra space is removed above and below the text.
booleangetUnderline()
voidsetUnderline(boolean value)
           True if the font is underlined.
booleangetXScale()
voidsetXScale(boolean value)
           Determines whether a straight textpath will be used instead of the shape path.
 

Property Getters/Setters Detail

getBold/setBold

public boolean getBold() / public void setBold(boolean value)
True if the font is formatted as bold.

The default value is false.


getFitPath/setFitPath

public boolean getFitPath() / public void setFitPath(boolean value)
Defines whether the text fits the path of a shape.

The default value is false.


getFitShape/setFitShape

public boolean getFitShape() / public void setFitShape(boolean value)
Defines whether the text fits bounding box of a shape.

The default value is false.


getFontFamily/setFontFamily

public java.lang.String getFontFamily() / public void setFontFamily(java.lang.String value)
Defines the family of the textpath font.

The default value is Arial.


getItalic/setItalic

public boolean getItalic() / public void setItalic(boolean value)
True if the font is formatted as italic.

The default value is false.


getKerning/setKerning

public boolean getKerning() / public void setKerning(boolean value)
Determines whether kerning is turned on.

The default value is false.


getOn/setOn

public boolean getOn() / public void setOn(boolean value)
Defines whether the text is displayed.

The default value is false.


getReverseRows/setReverseRows

public boolean getReverseRows() / public void setReverseRows(boolean value)
Determines whether the layout order of rows is reversed.

The default value is false.

If true, the layout order of rows is reversed. This attribute is used for vertical text layout.


getRotateLetters/setRotateLetters

public boolean getRotateLetters() / public void setRotateLetters(boolean value)
Determines whether the letters of the text are rotated.

The default value is false.


getSameLetterHeights/setSameLetterHeights

public boolean getSameLetterHeights() / public void setSameLetterHeights(boolean value)
Determines whether all letters will be the same height regardless of initial case.

The default value is false.


getShadow/setShadow

public boolean getShadow() / public void setShadow(boolean value)
Defines whether a shadow is applied to the text on a text path.

The default value is false.


getSize/setSize

public double getSize() / public void setSize(double value)
Defines the size of the font in points.

The default value is 36.


getSmallCaps/setSmallCaps

public boolean getSmallCaps() / public void setSmallCaps(boolean value)
True if the font is formatted as small capital letters.

The default value is false.


getSpacing/setSpacing

public double getSpacing() / public void setSpacing(double value)
Defines the amount of spacing for text. 1 means 100%.

The default value is 1.


getStrikeThrough/setStrikeThrough

public boolean getStrikeThrough() / public void setStrikeThrough(boolean value)
True if the font is formatted as strikethrough text.

The default value is false.


getText/setText

public java.lang.String getText() / public void setText(java.lang.String value)
Defines the text of the text path.

The default value is an empty string.


getTextPathAlignment/setTextPathAlignment

public int getTextPathAlignment() / public void setTextPathAlignment(int value)
Defines the alignment of text. The value of the property is TextPathAlignment integer constant.

The default value is TextPathAlignment.CENTER.


getTrim/setTrim

public boolean getTrim() / public void setTrim(boolean value)
Determines whether extra space is removed above and below the text.

The default value is false.


getUnderline/setUnderline

public boolean getUnderline() / public void setUnderline(boolean value)
True if the font is underlined.

The default value is false.


getXScale/setXScale

public boolean getXScale() / public void setXScale(boolean value)
Determines whether a straight textpath will be used instead of the shape path.

The default value is false.

If true, the text runs along a path from left to right along the x value of the lower boundary of the shape.


See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.