TextAreaProperties Class

Contains properties that define the appearance and behavior of the text area.

Declaration

public class TextAreaProperties extends OfficeObject

Remarks

The following code snippet configures a two-column layout with custom column spacing for a shape text area:

Java

import com.devexpress.docs.presentation.*;
import com.devexpress.docs.office.*;
//...
// Set two-column layout with spacing.
TextAreaProperties properties = shape.getTextArea().getProperties();
properties.setColumnCount(2);
properties.setColumnSpacing(20.0f);

Inherited Members

deepClone()

notifyChange(Object sender, String propertyName)

com.devexpress.system.JavaObject.clone()

com.devexpress.system.JavaObject.equals(java.lang.Object)

com.devexpress.system.JavaObject.hashCode()

com.devexpress.system.JavaObject.initFields()

com.devexpress.system.JavaObject.memberwiseClone()

com.devexpress.system.JavaObject.toString()

java.lang.Object.finalize()

java.lang.Object.getClass()

java.lang.Object.notify()

java.lang.Object.notifyAll()

java.lang.Object.wait()

java.lang.Object.wait(long)

java.lang.Object.wait(long,int)

Inheritance

Object

JavaObject

OfficeObject

TextAreaProperties

TextAreaProperties()

Initializes a new instance of the TextAreaProperties class.

Declaration

public TextAreaProperties()

Methods

deepClone() Method

Returns a deep copy of this TextAreaProperties instance.

Declaration

public TextAreaProperties deepClone()

Returns

Type	Description
TextAreaProperties	A deep copy of this TextAreaProperties.

getAutoFit() Method

Returns how text is resized to fit within a text area.

Declaration

public TextAutoSize getAutoFit()

Returns

Type	Description
TextAutoSize	The text auto size setting for the text area.

getBottomMargin() Method

Returns the bottom margin of the text area in Document units (1/300 of an inch).

Declaration

public @Nullable Float getBottomMargin()

Returns

Type	Description
	The bottom margin of the text area in Document units (1/300 of an inch).

getColumnCount() Method

Returns the number of columns in the text area.

Declaration

public @Nullable Integer getColumnCount()

Returns

Type	Description
	The number of columns in the text area.

getColumnSpacing() Method

Returns the spacing between columns in the text area.

Declaration

public @Nullable Float getColumnSpacing()

Returns

Type	Description
	The spacing between columns in the text area.

getHorizontalAnchorCenter() Method

Returns a value that indicates whether the text area is horizontally centered.

Declaration

public @Nullable Boolean getHorizontalAnchorCenter()

Returns

Type	Description
	true if the text area is horizontally centered, otherwise, false.

getLeftMargin() Method

Returns the left margin of the text area in Document units (1/300 of an inch).

Declaration

public @Nullable Float getLeftMargin()

Returns

Type	Description
	The left margin of the text area in Document units (1/300 of an inch).

getPresetTextWarp() Method

Returns the preset text warp type for the text area.

Declaration

public PresetTextWarp getPresetTextWarp()

Returns

Type	Description
PresetTextWarp	The preset text warp type for the text area.

getRightMargin() Method

Returns the right margin of the text area in Document units (1/300 of an inch).

Declaration

public @Nullable Float getRightMargin()

Returns

Type	Description
	The right margin of the text area in Document units (1/300 of an inch).

getRightToLeftColumns() Method

Returns a value that indicates whether columns in the text area are arranged from right to left.

Declaration

public @Nullable Boolean getRightToLeftColumns()

Returns

Type	Description
	true if columns in the text area are arranged from right to left; otherwise, false.

getRotationAngle() Method

Returns the rotation angle of the text area.

Declaration

public @Nullable Float getRotationAngle()

Returns

Type	Description
	The rotation angle of the text area.

getText3D() Method

Returns the 3D text settings for the text area.

Declaration

public Text3DSettings getText3D()

Returns

Type	Description
Text3DSettings	The 3D text settings for the text area.

getTextVerticalType() Method

Returns the vertical text orientation type for the text area.

Declaration

public @Nullable TextOrientationType getTextVerticalType()

Returns

Type	Description
TextOrientationType	The vertical text orientation type for the text area.

getTextWrapping() Method

Returns the text wrapping type for the text area.

Declaration

public @Nullable TextWrappingType getTextWrapping()

Returns

Type	Description
TextWrappingType	The text wrapping type for the text area.

getTopMargin() Method

Returns the top margin of the text area in Document units (1/300 of an inch).

Declaration

public @Nullable Float getTopMargin()

Returns

Type	Description
	The top margin of the text area in Document units (1/300 of an inch).

getVerticalAnchorType() Method

Returns the vertical anchor type for the text area.

Declaration

public @Nullable TextVerticalAnchorType getVerticalAnchorType()

Returns

Type	Description
TextVerticalAnchorType	The vertical anchor type for the text area.

setAutoFit(TextAutoSize value) Method

Sets how text is resized to fit within a text area.

Declaration

public void setAutoFit(TextAutoSize value)

Parameters

Name	Type	Description
value	TextAutoSize	The text auto size setting for the text area.

setBottomMargin(@Nullable Float value) Method

Sets the bottom margin of the text area in Document units (1/300 of an inch).

Declaration

public void setBottomMargin(@Nullable Float value)

Parameters

Name	Type	Description
value		The bottom margin of the text area in Document units (1/300 of an inch).

setColumnCount(@Nullable Integer value) Method

Sets the number of columns in the text area.

Declaration

public void setColumnCount(@Nullable Integer value)

Parameters

Name	Type	Description
value		The number of columns in the text area.

setColumnSpacing(@Nullable Float value) Method

Sets the spacing between columns in the text area.

Declaration

public void setColumnSpacing(@Nullable Float value)

Parameters

Name	Type	Description
value		The spacing between columns in the text area.

setHorizontalAnchorCenter(@Nullable Boolean value) Method

Sets whether the text area is horizontally centered.

Declaration

public void setHorizontalAnchorCenter(@Nullable Boolean value)

Parameters

Name	Type	Description
value		true if the text area is horizontally centered; otherwise, false.

setLeftMargin(@Nullable Float value) Method

Sets the left margin of the text area in Document units (1/300 of an inch).

Declaration

public void setLeftMargin(@Nullable Float value)

Parameters

Name	Type	Description
value		The left margin of the text area in Document units (1/300 of an inch).

setPresetTextWarp(PresetTextWarp value) Method

Sets the preset text warp type for the text area.

Declaration

public void setPresetTextWarp(PresetTextWarp value)

Parameters

Name	Type	Description
value	PresetTextWarp	The preset text warp type for the text area.

setRightMargin(@Nullable Float value) Method

Sets the right margin of the text area in Document units (1/300 of an inch).

Declaration

public void setRightMargin(@Nullable Float value)

Parameters

Name	Type	Description
value		The right margin of the text area in Document units (1/300 of an inch).

setRightToLeftColumns(@Nullable Boolean value) Method

Sets whether columns in the text area are arranged from right to left.

Declaration

public void setRightToLeftColumns(@Nullable Boolean value)

Parameters

Name	Type	Description
value		true if columns in the text area are arranged from right to left; otherwise, false.

setRotationAngle(@Nullable Float value) Method

Sets the rotation angle of the text area.

Declaration

public void setRotationAngle(@Nullable Float value)

Parameters

Name	Type	Description
value		The rotation angle of the text area.

setText3D(Text3DSettings value) Method

Sets the 3D text settings for the text area.

Declaration

public void setText3D(Text3DSettings value)

Parameters

Name	Type	Description
value	Text3DSettings	The 3D text settings for the text area.

setTextVerticalType(@Nullable TextOrientationType value) Method

Sets the vertical text orientation type for the text area.

Declaration

public void setTextVerticalType(@Nullable TextOrientationType value)

Parameters

Name	Type	Description
value	TextOrientationType	The vertical text orientation type for the text area.

setTextWrapping(@Nullable TextWrappingType value) Method

Sets the text wrapping type for the text area.

Declaration

public void setTextWrapping(@Nullable TextWrappingType value)

Parameters

Name	Type	Description
value	TextWrappingType	The text wrapping type for the text area.

setTopMargin(@Nullable Float value) Method

Sets the top margin of the text area in Document units (1/300 of an inch).

Declaration

public void setTopMargin(@Nullable Float value)

Parameters

Name	Type	Description
value		The top margin of the text area in Document units (1/300 of an inch).

setVerticalAnchorType(@Nullable TextVerticalAnchorType value) Method

Sets the vertical anchor type for the text area.

Declaration

public void setVerticalAnchorType(@Nullable TextVerticalAnchorType value)

Parameters

Name	Type	Description
value	TextVerticalAnchorType	The vertical anchor type for the text area.