TextPath (Aspose.Words for Java API Reference)

java.lang.Object
- 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.getTextPath() property to access WordArt properties of a shape. You do not create instances of the TextPath class directly.

See Also:

Shape.getTextPath()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getBold()` True if the font is formatted as bold.
`boolean`	`getFitPath()` Defines whether the text fits the path of a shape.
`boolean`	`getFitShape()` Defines whether the text fits bounding box of a shape.
`java.lang.String`	`getFontFamily()` Defines the family of the textpath font.
`boolean`	`getItalic()` True if the font is formatted as italic.
`boolean`	`getKerning()` Determines whether kerning is turned on.
`boolean`	`getOn()` Defines whether the text is displayed.
`boolean`	`getReverseRows()` Determines whether the layout order of rows is reversed.
`boolean`	`getRotateLetters()` Determines whether the letters of the text are rotated.
`boolean`	`getSameLetterHeights()` Determines whether all letters will be the same height regardless of initial case.
`boolean`	`getShadow()` Defines whether a shadow is applied to the text on a text path.
`double`	`getSize()` Defines the size of the font in points.
`boolean`	`getSmallCaps()` True if the font is formatted as small capital letters.
`double`	`getSpacing()` Defines the amount of spacing for text.
`boolean`	`getStrikeThrough()` True if the font is formatted as strikethrough text.
`java.lang.String`	`getText()` Defines the text of the text path.
`int`	`getTextPathAlignment()` Defines the alignment of text.
`boolean`	`getTrim()` Determines whether extra space is removed above and below the text.
`boolean`	`getUnderline()` True if the font is underlined.
`boolean`	`getXScale()` Determines whether a straight textpath will be used instead of the shape path.
`void`	`setBold(boolean value)` True if the font is formatted as bold.
`void`	`setFitPath(boolean value)` Defines whether the text fits the path of a shape.
`void`	`setFitShape(boolean value)` Defines whether the text fits bounding box of a shape.
`void`	`setFontFamily(java.lang.String value)` Defines the family of the textpath font.
`void`	`setItalic(boolean value)` True if the font is formatted as italic.
`void`	`setKerning(boolean value)` Determines whether kerning is turned on.
`void`	`setOn(boolean value)` Defines whether the text is displayed.
`void`	`setReverseRows(boolean value)` Determines whether the layout order of rows is reversed.
`void`	`setRotateLetters(boolean value)` Determines whether the letters of the text are rotated.
`void`	`setSameLetterHeights(boolean value)` Determines whether all letters will be the same height regardless of initial case.
`void`	`setShadow(boolean value)` Defines whether a shadow is applied to the text on a text path.
`void`	`setSize(double value)` Defines the size of the font in points.
`void`	`setSmallCaps(boolean value)` True if the font is formatted as small capital letters.
`void`	`setSpacing(double value)` Defines the amount of spacing for text.
`void`	`setStrikeThrough(boolean value)` True if the font is formatted as strikethrough text.
`void`	`setText(java.lang.String value)` Defines the text of the text path.
`void`	`setTextPathAlignment(int value)` Defines the alignment of text.
`void`	`setTrim(boolean value)` Determines whether extra space is removed above and below the text.
`void`	`setUnderline(boolean value)` True if the font is underlined.
`void`	`setXScale(boolean value)` Determines whether a straight textpath will be used instead of the shape path.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getOn
```
public boolean getOn()
```
    Defines whether the text is displayed.
    The default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setOn
```
public void setOn(boolean value)
```
    Defines whether the text is displayed.
    The default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getFitPath
```
public boolean getFitPath()
```
    Defines whether the text fits the path of a shape.
    The default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setFitPath
```
public void setFitPath(boolean value)
```
    Defines whether the text fits the path of a shape.
    The default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getFitShape
```
public boolean getFitShape()
```
    Defines whether the text fits bounding box of a shape.
    The default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setFitShape
```
public void setFitShape(boolean value)
```
    Defines whether the text fits bounding box of a shape.
    The default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getFontFamily
```
public java.lang.String getFontFamily()
```
    Defines the family of the textpath font.
    The default value is Arial.
    
    Returns:
    
    The corresponding String value.
  - setFontFamily
```
public void setFontFamily(java.lang.String value)
```
    Defines the family of the textpath font.
    The default value is Arial.
    
    Parameters:
    
    value - The corresponding String value.
  - getSize
```
public double getSize()
```
    Defines the size of the font in points.
    The default value is 36.
    
    Returns:
    
    The corresponding double value.
  - setSize
```
public void setSize(double value)
```
    Defines the size of the font in points.
    The default value is 36.
    
    Parameters:
    
    value - The corresponding double value.
  - getBold
```
public boolean getBold()
```
    True if the font is formatted as bold.
    The default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setBold
```
public void setBold(boolean value)
```
    True if the font is formatted as bold.
    The default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getItalic
```
public boolean getItalic()
```
    True if the font is formatted as italic.
    The default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setItalic
```
public void setItalic(boolean value)
```
    True if the font is formatted as italic.
    The default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getSmallCaps
```
public boolean getSmallCaps()
```
    True if the font is formatted as small capital letters.
    The default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setSmallCaps
```
public void setSmallCaps(boolean value)
```
    True if the font is formatted as small capital letters.
    The default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getRotateLetters
```
public boolean getRotateLetters()
```
    Determines whether the letters of the text are rotated.
    The default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setRotateLetters
```
public void setRotateLetters(boolean value)
```
    Determines whether the letters of the text are rotated.
    The default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getTrim
```
public boolean getTrim()
```
    Determines whether extra space is removed above and below the text.
    The default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setTrim
```
public void setTrim(boolean value)
```
    Determines whether extra space is removed above and below the text.
    The default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getKerning
```
public boolean getKerning()
```
    Determines whether kerning is turned on.
    The default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setKerning
```
public void setKerning(boolean value)
```
    Determines whether kerning is turned on.
    The default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getShadow
```
public boolean getShadow()
```
    Defines whether a shadow is applied to the text on a text path.
    The default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setShadow
```
public void setShadow(boolean value)
```
    Defines whether a shadow is applied to the text on a text path.
    The default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getUnderline
```
public boolean getUnderline()
```
    True if the font is underlined.
    The default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setUnderline
```
public void setUnderline(boolean value)
```
    True if the font is underlined.
    The default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getStrikeThrough
```
public boolean getStrikeThrough()
```
    True if the font is formatted as strikethrough text.
    The default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setStrikeThrough
```
public void setStrikeThrough(boolean value)
```
    True if the font is formatted as strikethrough text.
    The default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getSameLetterHeights
```
public boolean getSameLetterHeights()
```
    Determines whether all letters will be the same height regardless of initial case.
    The default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setSameLetterHeights
```
public void setSameLetterHeights(boolean value)
```
    Determines whether all letters will be the same height regardless of initial case.
    The default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getText
```
public java.lang.String getText()
```
    Defines the text of the text path.
    The default value is an empty string.
    
    Returns:
    
    The corresponding String value.
  - setText
```
public void setText(java.lang.String value)
```
    Defines the text of the text path.
    The default value is an empty string.
    
    Parameters:
    
    value - The corresponding String value.
  - getTextPathAlignment
```
public int getTextPathAlignment()
```
    Defines the alignment of text.
    The default value is TextPathAlignment.CENTER.
    
    Returns:
    
    The corresponding int value. The returned value is one of TextPathAlignment constants.
  - setTextPathAlignment
```
public void setTextPathAlignment(int value)
```
    Defines the alignment of text.
    The default value is TextPathAlignment.CENTER.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of TextPathAlignment constants.
  - getReverseRows
```
public boolean getReverseRows()
```
    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.
    
    Returns:
    
    The corresponding boolean value.
  - setReverseRows
```
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.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getSpacing
```
public double getSpacing()
```
    Defines the amount of spacing for text. 1 means 100%.
    The default value is 1.
    
    Returns:
    
    The corresponding double value.
  - setSpacing
```
public void setSpacing(double value)
```
    Defines the amount of spacing for text. 1 means 100%.
    The default value is 1.
    
    Parameters:
    
    value - The corresponding double value.
  - getXScale
```
public boolean getXScale()
```
    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.
    
    Returns:
    
    The corresponding boolean value.
  - setXScale
```
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.
    
    Parameters:
    
    value - The corresponding boolean value.

Class TextPath

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getOn

setOn

getFitPath

setFitPath

getFitShape

setFitShape

getFontFamily

setFontFamily

getSize

setSize

getBold

setBold

getItalic

setItalic

getSmallCaps

setSmallCaps

getRotateLetters

setRotateLetters

getTrim

setTrim

getKerning

setKerning

getShadow

setShadow

getUnderline

setUnderline

getStrikeThrough

setStrikeThrough

getSameLetterHeights

setSameLetterHeights

getText

setText

getTextPathAlignment

setTextPathAlignment

getReverseRows

setReverseRows

getSpacing

setSpacing

getXScale

setXScale