com.aspose.slides
Class TextFrameFormat

java.lang.Object
  extended by com.aspose.slides.PVIObject
      extended by com.aspose.slides.TextFrameFormat
All Implemented Interfaces:
IChartTextBlockFormat, ITextFrameFormat

public class TextFrameFormat
extends PVIObject
implements ITextFrameFormat, IChartTextBlockFormat

Contains the TextFrame's formatTextFrameFormatting properties.


Method Summary
 byte getAnchoringType()
           Returns or sets vertical anchor text in a TextFrameEx.
 byte getAutofitType()
           Returns or sets text's autofit mode.
 byte getCenterText()
           If NullableBool.True then text should be centered in box horizontally.
 double getMarginBottom()
           Returns or sets the bottom margin (points) in a TextFrame.
 double getMarginLeft()
           Returns or sets the left margin (points) in a TextFrame.
 double getMarginRight()
           Returns or sets the right margin (points) in a TextFrame.
 double getMarginTop()
           Returns or sets the top margin (points) in a TextFrame.
 com.aspose.slides.IDOMObject getParent_Immediate()
           Returns Parent_Immediate object.
 IPresentationComponent getParent_IPresentationComponent()
           
 float getRotationAngle()
           Specifies custom the rotation that is being applied to the text within the bounding box.
 ITextStyle getTextStyle()
           Returns text's style.
 byte getTextVerticalType()
           Determines text orientation.
 long getVersion()
           
 byte getWrapText()
           <b>True</b> if text is wrapped at TextFrame's margins.
 void setAnchoringType(byte value)
           Returns or sets vertical anchor text in a TextFrameEx.
 void setAutofitType(byte value)
           Returns or sets text's autofit mode.
 void setCenterText(byte value)
           If NullableBool.True then text should be centered in box horizontally.
 void setMarginBottom(double value)
           Returns or sets the bottom margin (points) in a TextFrame.
 void setMarginLeft(double value)
           Returns or sets the left margin (points) in a TextFrame.
 void setMarginRight(double value)
           Returns or sets the right margin (points) in a TextFrame.
 void setMarginTop(double value)
           Returns or sets the top margin (points) in a TextFrame.
 void setRotationAngle(float value)
           Specifies custom the rotation that is being applied to the text within the bounding box.
 void setTextVerticalType(byte value)
           Determines text orientation.
 void setWrapText(byte value)
           <b>True</b> if text is wrapped at TextFrame's margins.
 
Methods inherited from class com.aspose.slides.PVIObject
equals, getParent_Immediate, getParent_IPresentationComponent, getPresentation, getSlide, getVersion, hashCode
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getTextStyle

public final ITextStyle getTextStyle()

Returns text's style. Read-only ITextStyle.

Specified by:
getTextStyle in interface ITextFrameFormat

getMarginLeft

public final double getMarginLeft()

Returns or sets the left margin (points) in a TextFrame. Read/write double.

Specified by:
getMarginLeft in interface IChartTextBlockFormat
Specified by:
getMarginLeft in interface ITextFrameFormat

setMarginLeft

public final void setMarginLeft(double value)

Returns or sets the left margin (points) in a TextFrame. Read/write double.

Specified by:
setMarginLeft in interface IChartTextBlockFormat
Specified by:
setMarginLeft in interface ITextFrameFormat

getMarginRight

public final double getMarginRight()

Returns or sets the right margin (points) in a TextFrame. Read/write double.

Specified by:
getMarginRight in interface IChartTextBlockFormat
Specified by:
getMarginRight in interface ITextFrameFormat

setMarginRight

public final void setMarginRight(double value)

Returns or sets the right margin (points) in a TextFrame. Read/write double.

Specified by:
setMarginRight in interface IChartTextBlockFormat
Specified by:
setMarginRight in interface ITextFrameFormat

getMarginTop

public final double getMarginTop()

Returns or sets the top margin (points) in a TextFrame. Read/write double.

Specified by:
getMarginTop in interface IChartTextBlockFormat
Specified by:
getMarginTop in interface ITextFrameFormat

setMarginTop

public final void setMarginTop(double value)

Returns or sets the top margin (points) in a TextFrame. Read/write double.

Specified by:
setMarginTop in interface IChartTextBlockFormat
Specified by:
setMarginTop in interface ITextFrameFormat

getMarginBottom

public final double getMarginBottom()

Returns or sets the bottom margin (points) in a TextFrame. Read/write double.

Specified by:
getMarginBottom in interface IChartTextBlockFormat
Specified by:
getMarginBottom in interface ITextFrameFormat

setMarginBottom

public final void setMarginBottom(double value)

Returns or sets the bottom margin (points) in a TextFrame. Read/write double.

Specified by:
setMarginBottom in interface IChartTextBlockFormat
Specified by:
setMarginBottom in interface ITextFrameFormat

getWrapText

public final byte getWrapText()

<b>True</b> if text is wrapped at TextFrame's margins. Read/write NullableBool.

Specified by:
getWrapText in interface IChartTextBlockFormat
Specified by:
getWrapText in interface ITextFrameFormat

setWrapText

public final void setWrapText(byte value)

<b>True</b> if text is wrapped at TextFrame's margins. Read/write NullableBool.

Specified by:
setWrapText in interface IChartTextBlockFormat
Specified by:
setWrapText in interface ITextFrameFormat

getAnchoringType

public final byte getAnchoringType()

Returns or sets vertical anchor text in a TextFrameEx. Read/write TextAnchorType.

Specified by:
getAnchoringType in interface IChartTextBlockFormat
Specified by:
getAnchoringType in interface ITextFrameFormat

setAnchoringType

public final void setAnchoringType(byte value)

Returns or sets vertical anchor text in a TextFrameEx. Read/write TextAnchorType.

Specified by:
setAnchoringType in interface IChartTextBlockFormat
Specified by:
setAnchoringType in interface ITextFrameFormat

getCenterText

public final byte getCenterText()

If NullableBool.True then text should be centered in box horizontally. Read/write NullableBool.

Specified by:
getCenterText in interface IChartTextBlockFormat
Specified by:
getCenterText in interface ITextFrameFormat

setCenterText

public final void setCenterText(byte value)

If NullableBool.True then text should be centered in box horizontally. Read/write NullableBool.

Specified by:
setCenterText in interface IChartTextBlockFormat
Specified by:
setCenterText in interface ITextFrameFormat

getTextVerticalType

public final byte getTextVerticalType()

Determines text orientation. The resulted value of visual text rotation summarized from this property and custom angle in property RotationAngle. Read/write TextVerticalType.

Specified by:
getTextVerticalType in interface IChartTextBlockFormat
Specified by:
getTextVerticalType in interface ITextFrameFormat

setTextVerticalType

public final void setTextVerticalType(byte value)

Determines text orientation. The resulted value of visual text rotation summarized from this property and custom angle in property RotationAngle. Read/write TextVerticalType.

Specified by:
setTextVerticalType in interface IChartTextBlockFormat
Specified by:
setTextVerticalType in interface ITextFrameFormat

getAutofitType

public final byte getAutofitType()

Returns or sets text's autofit mode. Read/write TextAutofitType.

Specified by:
getAutofitType in interface IChartTextBlockFormat
Specified by:
getAutofitType in interface ITextFrameFormat

setAutofitType

public final void setAutofitType(byte value)

Returns or sets text's autofit mode. Read/write TextAutofitType.

Specified by:
setAutofitType in interface IChartTextBlockFormat
Specified by:
setAutofitType in interface ITextFrameFormat

getRotationAngle

public final float getRotationAngle()

Specifies custom the rotation that is being applied to the text within the bounding box. If it not specified, the rotation of the accompanying shape is used. If it is specified, then this is applied independently from the shape. That is the shape can have a rotation applied in addition to the text itself having a rotation applied to it. The resulted value of visual text rotation summarized from this property and predefined vertical type in property TextVerticalType. Read/write float.


 Consider the case where a shape has a rotation of 90 degrees clockwise applied to it. 
 In addition to this, the text body itself has a rotation of -90 degrees 
 counter-clockwise applied to it. Then the resulting shape would appear to
 be rotated but the text within it would appear as though it had not been rotated at all.
 

Specified by:
getRotationAngle in interface IChartTextBlockFormat
Specified by:
getRotationAngle in interface ITextFrameFormat

setRotationAngle

public final void setRotationAngle(float value)

Specifies custom the rotation that is being applied to the text within the bounding box. If it not specified, the rotation of the accompanying shape is used. If it is specified, then this is applied independently from the shape. That is the shape can have a rotation applied in addition to the text itself having a rotation applied to it. The resulted value of visual text rotation summarized from this property and predefined vertical type in property TextVerticalType. Read/write float.


 Consider the case where a shape has a rotation of 90 degrees clockwise applied to it. 
 In addition to this, the text body itself has a rotation of -90 degrees 
 counter-clockwise applied to it. Then the resulting shape would appear to
 be rotated but the text within it would appear as though it had not been rotated at all.
 

Specified by:
setRotationAngle in interface IChartTextBlockFormat
Specified by:
setRotationAngle in interface ITextFrameFormat

getParent_IPresentationComponent

public IPresentationComponent getParent_IPresentationComponent()

getVersion

public long getVersion()

getParent_Immediate

public com.aspose.slides.IDOMObject getParent_Immediate()

Returns Parent_Immediate object. Read-only IDOMObject.



Copyright © Copyright 2004-2016 Aspose Pty Ltd. All Rights Reserved.