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

public class TextBoxFormat
extends WordAttrCollection

Constructor Summary

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

Method Summary

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

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

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 TextBoxFormat class.

Parameters:

txtBox - TextBox

Method Detail

getHorizontalOrigin

public HorizontalOrigin getHorizontalOrigin()

Get horizontal origin

Returns:

HorizontalOrigin

setHorizontalOrigin

public void setHorizontalOrigin(HorizontalOrigin value)

Set horizontal origin

Parameters:

value - HorizontalOrigin

getVerticalOrigin

public VerticalOrigin getVerticalOrigin()

Get vertical origin

Returns:

VerticalOrigin

setVerticalOrigin

public void setVerticalOrigin(VerticalOrigin value)

Set vertical origin

Parameters:

value - VerticalOrigin

getFillColor

public java.awt.Color getFillColor()

Gets the fill color of the textbox.

Returns:

color

setFillColor

public void setFillColor(java.awt.Color value)

Sets the fill color of the textbox.

Parameters:

value - color

getFillEfects

public Background getFillEfects()

Gets the fill effects.

Returns:

Background

getLineStyle

public TextBoxLineStyle getLineStyle()

Get text box linestyle

Returns:

TextBoxLineStyle

setLineStyle

public void setLineStyle(TextBoxLineStyle value)

Set text box linestyle

Parameters:

value - TextBoxLineStyle

getWidth

public float getWidth()

Get textbox width

Returns:

textbox width

setWidth

public void setWidth(float value)

Set textbox width

Parameters:

value - textbox width

getHeight

public float getHeight()

Get textbox height

Returns:

textbox height

setHeight

public void setHeight(float value)

Set textbox height

Parameters:

value - textbox height

getLineColor

public java.awt.Color getLineColor()

Get line color.

Returns:

color

setLineColor

public void setLineColor(java.awt.Color color)

Set line color.

Parameters:

color - color

getNoLine

public boolean getNoLine()

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

Returns:

no line

setNoLine

public void setNoLine(boolean value)

Set value which defines if there is a line around textbox shape.

Parameters:

value - no line

getHorizontalPosition

public float getHorizontalPosition()

Get textbox horizontal position

Returns:

HorizontalPosition float value

setHorizontalPosition

public void setHorizontalPosition(float value)

Set textbox horizontal position

Parameters:

value - HorizontalPosition float value

isFitShapeToText

public boolean isFitShapeToText()

Gets a value.Specifies whether the spape stretches to fit the text in the textbox.

Returns:

Default is false.

isFitShapeToText

public void isFitShapeToText(boolean value)

Sets a value.Specifies whether the spape stretches to fit the text in the textbox.

Parameters:

value - Default is false.

getVerticalPosition

public float getVerticalPosition()

Get textbox vertical position

Returns:

VerticalPosition float value

setVerticalPosition

public void setVerticalPosition(float value)

Set textbox vertical position

Parameters:

value - VerticalPosition float value

getTextWrappingStyle

public TextWrappingStyle getTextWrappingStyle()

Get text Wrapping style

Returns:

TextWrappingStyle

setTextWrappingStyle

public void setTextWrappingStyle(TextWrappingStyle value)

Set text Wrapping style

Parameters:

value - TextWrappingStyle

getTextWrappingType

public TextWrappingType getTextWrappingType()

Get wrapping type for textbox

Returns:

TextWrappingType

setTextWrappingType

public void setTextWrappingType(TextWrappingType value)

Set wrapping type for textbox

Parameters:

value - TextWrappingType

getLineWidth

public float getLineWidth()

Get textbox line width

Returns:

textbox line width

setLineWidth

public void setLineWidth(float value)

Set textbox line width

Parameters:

value - textbox line width

getLineDashing

public LineDashing getLineDashing()

Get line dashing for textbox

Returns:

LineDashing

setLineDashing

public void setLineDashing(LineDashing value)

Set line dashing for textbox

Parameters:

value - LineDashing

getHorizontalAlignment

public ShapeHorizontalAlignment getHorizontalAlignment()

Get textbox horizontal alignment

Returns:

ShapeHorizontalAlignment

setHorizontalAlignment

public void setHorizontalAlignment(ShapeHorizontalAlignment value)

Set textbox horizontal alignment

Parameters:

value - ShapeHorizontalAlignment

getVerticalAlignment

public ShapeVerticalAlignment getVerticalAlignment()

Get textbox vertical alignment

Returns:

ShapeVerticalAlignment

setVerticalAlignment

public void setVerticalAlignment(ShapeVerticalAlignment value)

Set textbox vertical alignment

Parameters:

value - ShapeVerticalAlignment

getLayoutFlowAlt

public TextDirection getLayoutFlowAlt()

Gets the text direction of the textbox.

Returns:

TextDirection

setLayoutFlowAlt

public void setLayoutFlowAlt(TextDirection value)

Sets the text direction of the textbox.

Parameters:

value - TextDirection

getTextAnchor

public ShapeVerticalAlignment getTextAnchor()

Gets the vertical anchoring of text.

Returns:

Default is top.

setTextAnchor

public void setTextAnchor(ShapeVerticalAlignment value)

Sets the vertical anchoring of text.

Parameters:

value - 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