Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Wiki  API  Corporate

com.aspose.powerpoint
Class TextHolder

java.lang.Object
  extended by com.aspose.powerpoint.Placeholder
      extended by com.aspose.powerpoint.TextHolder

public final class TextHolder
extends Placeholder

Represents the text placeholder.


Method Summary
 java.lang.String getAlternativeText()
          Returns the alternative text associated with a textholder in a Web presentation.
 int getAnchorText()
          Returns the anchor text in a TextHolder.
 FillFormat getFillFormat()
          Returns the FillFormat object that contains fill formatting properties for a TextHolder.
 int getHeight()
          Returns the height of a frame.
 LineFormat getLineFormat()
          Returns the LineFormat object that contains line formatting properties for a TextHolder.
 Links getLinks()
          Returns the list of all links in a frame.
 double getMarginBottom()
          Returns the bottom margin (mm) in a TextHolder.
 double getMarginLeft()
          Returns the left margin (mm) in a TextHolder.
 double getMarginRight()
          Returns the right margin (mm) in a TextHolder.
 double getMarginTop()
          Returns the top margin (mm) in a TextHolder.
 Paragraphs getParagraphs()
          Returns the list of all paragraphs in a frame.
 boolean getRotateTextBy90Degrees()
           
 Shape getShapeRef()
          Returns the Shape object which contains real properties of a TextHolder.
 java.lang.String getText()
          Returns the plain text for a TextHolder.
 int getWidth()
          Returns the width of a frame.
 int getX()
          Returns the x-coordinate of the upper-left corner of a frame.
 int getY()
          Returns the y-coordinate of the upper-left corner of a frame.
 boolean isFitShapeToText()
          Determines whether the TextHolder size fitted to the text.
 boolean isWrapText()
          Determines whether the text is wrapped at TextHolder's margins.
 void setAlternativeText(java.lang.String value)
          Sets the alternative text associated with a textholder in a Web presentation.
 void setAnchorText(int value)
          Sets the anchor text in a TextHolder.
 void setFitShapeToText(boolean value)
          Sets whether the TextHolder size fitted to the text.
 void setHeight(int value)
          Sets the height of a frame.
 void setMarginBottom(double value)
          Sets the bottom margin (mm) in a TextHolder.
 void setMarginLeft(double value)
          Sets the left margin (mm) in a TextHolder.
 void setMarginRight(double value)
          Sets the right margin (mm) in a TextHolder.
 void setMarginTop(double value)
          Sets the top margin (mm) in a TextHolder.
 void setRotateTextBy90Degrees(boolean value)
           
 void setWidth(int value)
          Sets the width of a frame.
 void setWrapText(boolean value)
          Sets whether the text is wrapped at TextHolder's margins.
 void setX(int value)
          Sets the x-coordinate of the upper-left corner of a frame.
 void setY(int value)
          Sets the y-coordinate of the upper-left corner of a frame.
 
Methods inherited from class com.aspose.powerpoint.Placeholder
getParent, getPlaceholderType
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getLineFormat

public LineFormat getLineFormat()
Returns the LineFormat object that contains line formatting properties for a TextHolder.

Returns:
The LineFormat object.

getFillFormat

public FillFormat getFillFormat()
Returns the FillFormat object that contains fill formatting properties for a TextHolder.

Returns:
The FillFormat object.

getText

public java.lang.String getText()
Returns the plain text for a TextHolder.

Returns:
The plain text.

getParagraphs

public Paragraphs getParagraphs()
Returns the list of all paragraphs in a frame.

Returns:
The paragraph list. See Paragraphs.

getLinks

public Links getLinks()
Returns the list of all links in a frame.

Returns:
The links list. See Links.

getAlternativeText

public java.lang.String getAlternativeText()
Returns the alternative text associated with a textholder in a Web presentation.

Returns:
The alternative text.

setAlternativeText

public void setAlternativeText(java.lang.String value)
Sets the alternative text associated with a textholder in a Web presentation.

Parameters:
value - the alternative text.

getShapeRef

public Shape getShapeRef()
Returns the Shape object which contains real properties of a TextHolder.

Returns:
The shape object.

getX

public int getX()
Returns the x-coordinate of the upper-left corner of a frame.

Overrides:
getX in class Placeholder
Returns:
The x coordinate.

setX

public void setX(int value)
Sets the x-coordinate of the upper-left corner of a frame.

Overrides:
setX in class Placeholder
Parameters:
value - new x coordinate.

getY

public int getY()
Returns the y-coordinate of the upper-left corner of a frame.

Overrides:
getY in class Placeholder
Returns:
The y coordinate.

setY

public void setY(int value)
Sets the y-coordinate of the upper-left corner of a frame.

Overrides:
setY in class Placeholder
Parameters:
value - new y coordinate.

getWidth

public int getWidth()
Returns the width of a frame.

Overrides:
getWidth in class Placeholder
Returns:
The width of a frame.

setWidth

public void setWidth(int value)
Sets the width of a frame.

Overrides:
setWidth in class Placeholder
Parameters:
value - new width of a frame.

getHeight

public int getHeight()
Returns the height of a frame.

Overrides:
getHeight in class Placeholder
Returns:
The height of a frame.

setHeight

public void setHeight(int value)
Sets the height of a frame.

Overrides:
setHeight in class Placeholder
Parameters:
value - new height of a frame.

getMarginLeft

public double getMarginLeft()
Returns the left margin (mm) in a TextHolder.

Returns:
The left margin.

setMarginLeft

public void setMarginLeft(double value)
                   throws PptPropertyException
Sets the left margin (mm) in a TextHolder.

Parameters:
value - new left margin.
Throws:
PptPropertyException

getMarginRight

public double getMarginRight()
Returns the right margin (mm) in a TextHolder.

Returns:
The right margin.

setMarginRight

public void setMarginRight(double value)
                    throws PptPropertyException
Sets the right margin (mm) in a TextHolder.

Parameters:
value - new right margin.
Throws:
PptPropertyException

getMarginTop

public double getMarginTop()
Returns the top margin (mm) in a TextHolder.

Returns:
The top margin.

setMarginTop

public void setMarginTop(double value)
                  throws PptPropertyException
Sets the top margin (mm) in a TextHolder.

Parameters:
value - new top margin.
Throws:
PptPropertyException

getMarginBottom

public double getMarginBottom()
Returns the bottom margin (mm) in a TextHolder.

Returns:
The bottom margin.

setMarginBottom

public void setMarginBottom(double value)
                     throws PptPropertyException
Sets the bottom margin (mm) in a TextHolder.

Parameters:
value - new bottom margin.
Throws:
PptPropertyException

getAnchorText

public int getAnchorText()
Returns the anchor text in a TextHolder.

Returns:
The text anchor. See AnchorText.

setAnchorText

public void setAnchorText(int value)
Sets the anchor text in a TextHolder.

Parameters:
value - new text anchor. See AnchorText.

isWrapText

public boolean isWrapText()
Determines whether the text is wrapped at TextHolder's margins.

Returns:
true if text is wrapped.

setWrapText

public void setWrapText(boolean value)
Sets whether the text is wrapped at TextHolder's margins.

Parameters:
value - true to wrap the text.

isFitShapeToText

public boolean isFitShapeToText()
Determines whether the TextHolder size fitted to the text.

Returns:
false if TextHolder size fitted to the text.

setFitShapeToText

public void setFitShapeToText(boolean value)
Sets whether the TextHolder size fitted to the text.

Parameters:
value - true to fit TextHolder's size to the text.

getRotateTextBy90Degrees

public boolean getRotateTextBy90Degrees()

setRotateTextBy90Degrees

public void setRotateTextBy90Degrees(boolean value)