ITextFrameFormat

public interface ITextFrameFormat

Contains the TextFrame’s formatting properties.

Methods

Method Description
getTextStyle() Returns text’s style.
getMarginLeft() Returns or sets the left margin (points) in a TextFrame.
setMarginLeft(double value) Returns or sets the left margin (points) in a TextFrame.
getMarginRight() Returns or sets the right margin (points) in a TextFrame.
setMarginRight(double value) Returns or sets the right margin (points) in a TextFrame.
getMarginTop() Returns or sets the top margin (points) in a TextFrame.
setMarginTop(double value) Returns or sets the top margin (points) in a TextFrame.
getMarginBottom() Returns or sets the bottom margin (points) in a TextFrame.
setMarginBottom(double value) Returns or sets the bottom margin (points) in a TextFrame.
getWrapText() True if text is wrapped at TextFrame’s margins.
setWrapText(byte value) True if text is wrapped at TextFrame’s margins.
getAnchoringType() Returns or sets vertical anchor text in a TextFrame.
setAnchoringType(byte value) Returns or sets vertical anchor text in a TextFrame.
getCenterText() If NullableBool.True then text should be centered in box horizontally.
setCenterText(byte value) If NullableBool.True then text should be centered in box horizontally.
getTextVerticalType() Determines text orientation.
setTextVerticalType(byte value) Determines text orientation.
getAutofitType() Returns or sets text’s autofit mode.
setAutofitType(byte value) Returns or sets text’s autofit mode.
getColumnCount() Returns or sets number of columns in the text area.
setColumnCount(int value) Returns or sets number of columns in the text area.
getColumnSpacing() Returns or sets the space between text columns in the text area (in points).
setColumnSpacing(double value) Returns or sets the space between text columns in the text area (in points).
getThreeDFormat() Returns the ThreeDFormat object that represents 3d effect properties for a text.
getKeepTextFlat() Returns or set keeping text out of 3D scene entirely.
setKeepTextFlat(boolean value) Returns or set keeping text out of 3D scene entirely.
getRotationAngle() Specifies the custom rotation that is being applied to the text within the bounding box.
setRotationAngle(float value) Specifies the custom rotation that is being applied to the text within the bounding box.
getTransform() Gets or sets text wrapping shape.
setTransform(byte value) Gets or sets text wrapping shape.
getEffective() Gets effective text frame formatting data with the inheritance applied.

getTextStyle()

public abstract ITextStyle getTextStyle()

Returns text’s style. Read-only ITextStyle.

Returns: ITextStyle

getMarginLeft()

public abstract double getMarginLeft()

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

Returns: double

setMarginLeft(double value)

public abstract void setMarginLeft(double value)

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

Parameters:

Parameter Type Description
value double

getMarginRight()

public abstract double getMarginRight()

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

Returns: double

setMarginRight(double value)

public abstract void setMarginRight(double value)

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

Parameters:

Parameter Type Description
value double

getMarginTop()

public abstract double getMarginTop()

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

Returns: double

setMarginTop(double value)

public abstract void setMarginTop(double value)

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

Parameters:

Parameter Type Description
value double

getMarginBottom()

public abstract double getMarginBottom()

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

Returns: double

setMarginBottom(double value)

public abstract void setMarginBottom(double value)

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

Parameters:

Parameter Type Description
value double

getWrapText()

public abstract byte getWrapText()

True if text is wrapped at TextFrame’s margins. Read/write NullableBool.

Returns: byte

setWrapText(byte value)

public abstract void setWrapText(byte value)

True if text is wrapped at TextFrame’s margins. Read/write NullableBool.

Parameters:

Parameter Type Description
value byte

getAnchoringType()

public abstract byte getAnchoringType()

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

Returns: byte

setAnchoringType(byte value)

public abstract void setAnchoringType(byte value)

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

Parameters:

Parameter Type Description
value byte

getCenterText()

public abstract byte getCenterText()

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

Returns: byte

setCenterText(byte value)

public abstract void setCenterText(byte value)

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

Parameters:

Parameter Type Description
value byte

getTextVerticalType()

public abstract 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.

Returns: byte

setTextVerticalType(byte value)

public abstract 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.

Parameters:

Parameter Type Description
value byte

getAutofitType()

public abstract byte getAutofitType()

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

Returns: byte

setAutofitType(byte value)

public abstract void setAutofitType(byte value)

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

Parameters:

Parameter Type Description
value byte

getColumnCount()

public abstract int getColumnCount()

Returns or sets number of columns in the text area. This value must be a positive number. Otherwise, the value will be set to zero. Value 0 means undefined value. Read/write int.

Returns: int

setColumnCount(int value)

public abstract void setColumnCount(int value)

Returns or sets number of columns in the text area. This value must be a positive number. Otherwise, the value will be set to zero. Value 0 means undefined value. Read/write int.

Parameters:

Parameter Type Description
value int

getColumnSpacing()

public abstract double getColumnSpacing()

Returns or sets the space between text columns in the text area (in points). This should only apply when there is more than 1 column present. This value must be a positive number. Otherwise, the value will be set to zero. Read/write double.

Returns: double

setColumnSpacing(double value)

public abstract void setColumnSpacing(double value)

Returns or sets the space between text columns in the text area (in points). This should only apply when there is more than 1 column present. This value must be a positive number. Otherwise, the value will be set to zero. Read/write double.

Parameters:

Parameter Type Description
value double

getThreeDFormat()

public abstract IThreeDFormat getThreeDFormat()

Returns the ThreeDFormat object that represents 3d effect properties for a text. Read-only IThreeDFormat.


Presentation pres = new Presentation();
 try {
     IAutoShape autoShape = pres.getSlides().get_Item(0).getShapes().addAutoShape(ShapeType.Rectangle, 10, 20, 400, 300);
     ITextFrame textFrame = autoShape.getTextFrame();
     textFrame.setText("Aspose.Slide Test Text");
     // Set text transformation
     textFrame.getTextFrameFormat().setTransform(TextShapeType.ArchUpPour);
     // Set Extrusion
     textFrame.getTextFrameFormat().getThreeDFormat().getExtrusionColor().setColor(Color.ORANGE);
     textFrame.getTextFrameFormat().getThreeDFormat().setExtrusionHeight(6);
     // Set Contour
     textFrame.getTextFrameFormat().getThreeDFormat().getContourColor().setColor(Color.DARK_GRAY);
     textFrame.getTextFrameFormat().getThreeDFormat().setContourWidth(1.5);
     // Set Depth
     textFrame.getTextFrameFormat().getThreeDFormat().setDepth(3);
     // Set Material
     textFrame.getTextFrameFormat().getThreeDFormat().setMaterial(MaterialPresetType.Plastic);
     // Set Lighting
     textFrame.getTextFrameFormat().getThreeDFormat().getLightRig().setDirection(LightingDirection.Top);
     textFrame.getTextFrameFormat().getThreeDFormat().getLightRig().setLightType(LightRigPresetType.Balanced);
     textFrame.getTextFrameFormat().getThreeDFormat().getLightRig().setRotation(0, 0, 40);
     // Set camera type
     textFrame.getTextFrameFormat().getThreeDFormat().getCamera().setCameraType(CameraPresetType.PerspectiveContrastingRightFacing);
 } finally {
     if (pres != null) pres.dispose();
 }

Returns: IThreeDFormat

getKeepTextFlat()

public abstract boolean getKeepTextFlat()

Returns or set keeping text out of 3D scene entirely. Read/write boolean.

Returns: boolean

setKeepTextFlat(boolean value)

public abstract void setKeepTextFlat(boolean value)

Returns or set keeping text out of 3D scene entirely. Read/write boolean.

Parameters:

Parameter Type Description
value boolean

getRotationAngle()

public abstract float getRotationAngle()

Specifies the custom 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.

Returns: float

setRotationAngle(float value)

public abstract void setRotationAngle(float value)

Specifies the custom 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.

Parameters:

Parameter Type Description
value float

getTransform()

public abstract byte getTransform()

Gets or sets text wrapping shape. Read/write TextShapeType.

Returns: byte

setTransform(byte value)

public abstract void setTransform(byte value)

Gets or sets text wrapping shape. Read/write TextShapeType.

Parameters:

Parameter Type Description
value byte

getEffective()

public abstract ITextFrameFormatEffectiveData getEffective()

Gets effective text frame formatting data with the inheritance applied.

Returns: ITextFrameFormatEffectiveData - A ITextFrameFormatEffectiveData.