com.spire.doc.formatting
Class TextBoxFormat

java.lang.Object
  com.spire.doc.OwnerHolder
      com.spire.doc.documents.xml.DocumentSerializable
          com.spire.doc.formatting.FormatBase
              com.spire.doc.formatting.AttrCollection
                  com.spire.doc.formatting.WordAttrCollection
                      com.spire.doc.formatting.TextBoxFormat

All Implemented Interfaces:

IDocumentSerializable

public class TextBoxFormat
extends WordAttrCollection

Constructor Summary

TextBoxFormat(TextBox txtBox)
Initializes a new instance of the class.

Method Summary

TextBoxFormat	deepClone() Clone textbox format.
java.awt.Color	getFillColor() Gets or sets the fill color of the textbox.
Background	getFillEffects() Gets the fill effects.
float	getHeight() Get/set textbox height
ShapeHorizontalAlignment	getHorizontalAlignment() Get/set textbox horizontal alignment
HorizontalOrigin	getHorizontalOrigin() Get/set horizontal origin
float	getHorizontalPosition() Get/set textbox horizontal position
InternalMargin	getInternalMargin() Gets the internal margin.
TextDirection	getLayoutFlowAlt() Gets or sets the text direction of the textbox.
java.awt.Color	getLineColor() Get/set line color.
LineDashing	getLineDashing() Get/set line dashing for textbox
TextBoxLineStyle	getLineStyle() Get/set text box linestyle
float	getLineWidth() Get/set textbox line width
boolean	getNoLine() Get/set value which defines if there is a line around textbox shape
ShapeVerticalAlignment	getTextAnchor() Gets or sets the vertical anchoring of text.
TextWrappingStyle	getTextWrappingStyle() Get/set text Wrapping style
TextWrappingType	getTextWrappingType() Get/set wrapping type for textbox
ShapeVerticalAlignment	getVerticalAlignment() Get/set textbox vertical alignment
VerticalOrigin	getVerticalOrigin() Get/set vertical origin
float	getVerticalPosition() Get/set textbox vertical position
float	getWidth() Get/set textbox width
boolean	isFitShapeToText() Gets or Sets a value.
void	isFitShapeToText(boolean value) Gets or Sets a value.
void	setFillColor(java.awt.Color value) Gets or sets the fill color of the textbox.
void	setHeight(float value) Get/set textbox height
void	setHorizontalAlignment(ShapeHorizontalAlignment value) Get/set textbox horizontal alignment
void	setHorizontalOrigin(HorizontalOrigin value) Get/set horizontal origin
void	setHorizontalPosition(float value) Get/set textbox horizontal position
void	setLayoutFlowAlt(TextDirection value) Gets or sets the text direction of the textbox.
void	setLineColor(java.awt.Color value) Get/set line color.
void	setLineDashing(LineDashing value) Get/set line dashing for textbox
void	setLineStyle(TextBoxLineStyle value) Get/set text box linestyle
void	setLineWidth(float value) Get/set textbox line width
void	setNoLine(boolean value) Get/set value which defines if there is a line around textbox shape
void	setTextAnchor(ShapeVerticalAlignment value) Gets or sets the vertical anchoring of text.
void	setTextWrappingStyle(TextWrappingStyle value) Get/set text Wrapping style
void	setTextWrappingType(TextWrappingType value) Get/set wrapping type for textbox
void	setVerticalAlignment(ShapeVerticalAlignment value) Get/set textbox vertical alignment
void	setVerticalOrigin(VerticalOrigin value) Get/set vertical origin
void	setVerticalPosition(float value) Get/set textbox vertical position
void	setWidth(float value) Get/set textbox width

Methods inherited from class com.spire.doc.formatting.FormatBase

clearBackground, clearFormatting, hasKey, isDefault

Methods inherited from class com.spire.doc.OwnerHolder

getDocument

Constructor Detail

TextBoxFormat

public TextBoxFormat(TextBox txtBox)

Initializes a new instance of the class.

Parameters:

txtBox - the parent textbox.

Method Detail

getHorizontalOrigin

public HorizontalOrigin getHorizontalOrigin()

Get/set horizontal origin

setHorizontalOrigin

public void setHorizontalOrigin(HorizontalOrigin value)

Get/set horizontal origin

getVerticalOrigin

public VerticalOrigin getVerticalOrigin()

Get/set vertical origin

setVerticalOrigin

public void setVerticalOrigin(VerticalOrigin value)

Get/set vertical origin

getFillColor

public java.awt.Color getFillColor()

Gets or sets the fill color of the textbox.

setFillColor

public void setFillColor(java.awt.Color value)

Gets or sets the fill color of the textbox.

getFillEffects

public Background getFillEffects()

Gets the fill effects.

Returns:

The fill effects.

getLineStyle

public TextBoxLineStyle getLineStyle()

Get/set text box linestyle

setLineStyle

public void setLineStyle(TextBoxLineStyle value)

Get/set text box linestyle

getWidth

public float getWidth()

Get/set textbox width

setWidth

public void setWidth(float value)

Get/set textbox width

getHeight

public float getHeight()

Get/set textbox height

setHeight

public void setHeight(float value)

Get/set textbox height

getLineColor

public java.awt.Color getLineColor()

Get/set line color.

setLineColor

public void setLineColor(java.awt.Color value)

Get/set line color.

getNoLine

public boolean getNoLine()

Get/set value which defines if there is a line around textbox shape

setNoLine

public void setNoLine(boolean value)

Get/set value which defines if there is a line around textbox shape

getHorizontalPosition

public float getHorizontalPosition()

Get/set textbox horizontal position

setHorizontalPosition

public void setHorizontalPosition(float value)

Get/set textbox horizontal position

isFitShapeToText

public boolean isFitShapeToText()

Gets or Sets a value. Specifies whether the spape stretches to fit the text in the textbox. Default is false.

isFitShapeToText

public void isFitShapeToText(boolean value)

Gets or Sets a value. Specifies whether the spape stretches to fit the text in the textbox. Default is false.

getVerticalPosition

public float getVerticalPosition()

Get/set textbox vertical position

setVerticalPosition

public void setVerticalPosition(float value)

Get/set textbox vertical position

getTextWrappingStyle

public TextWrappingStyle getTextWrappingStyle()

Get/set text Wrapping style

setTextWrappingStyle

public void setTextWrappingStyle(TextWrappingStyle value)

Get/set text Wrapping style

getTextWrappingType

public TextWrappingType getTextWrappingType()

Get/set wrapping type for textbox

setTextWrappingType

public void setTextWrappingType(TextWrappingType value)

Get/set wrapping type for textbox

getLineWidth

public float getLineWidth()

Get/set textbox line width

setLineWidth

public void setLineWidth(float value)

Get/set textbox line width

getLineDashing

public LineDashing getLineDashing()

Get/set line dashing for textbox

setLineDashing

public void setLineDashing(LineDashing value)

Get/set line dashing for textbox

getHorizontalAlignment

public ShapeHorizontalAlignment getHorizontalAlignment()

Get/set textbox horizontal alignment

setHorizontalAlignment

public void setHorizontalAlignment(ShapeHorizontalAlignment value)

Get/set textbox horizontal alignment

getVerticalAlignment

public ShapeVerticalAlignment getVerticalAlignment()

Get/set textbox vertical alignment

setVerticalAlignment

public void setVerticalAlignment(ShapeVerticalAlignment value)

Get/set textbox vertical alignment

getLayoutFlowAlt

public TextDirection getLayoutFlowAlt()

Gets or sets the text direction of the textbox.

setLayoutFlowAlt

public void setLayoutFlowAlt(TextDirection value)

Gets or sets the text direction of the textbox.

getTextAnchor

public ShapeVerticalAlignment getTextAnchor()

Gets or sets the vertical anchoring of text. Default is top.

setTextAnchor

public void setTextAnchor(ShapeVerticalAlignment value)

Gets or sets the vertical anchoring of text. Default is top.

getInternalMargin

public InternalMargin getInternalMargin()

Gets the internal margin.

Returns:

The internal margin.

deepClone

public TextBoxFormat deepClone()

Clone textbox format.

Overrides:

deepClone in class AttrCollection

Returns: