TextBlock

TextBlock class

Contains elements that specify the alignment, margins, and default tab stop positions of text in a shape’s text block.

Methods

Name	Description
deepClone()	Creates deep copy of this instance.
getBottomMargin()	Determines the distance between the bottom border of the text block and the last line of text it contains. The default i
getDefaultTabStop()	Specifies the interval of the default tab stops in a text block.
getDel()	A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted loca
getLeftMargin()	Specifies the distance between the left border of the text block and the text it contains. This value is independent of
getRightMargin()	Specifies the distance between the right border of the text block and the text it contains. This value is independent of
getTextBkgnd()	Specifies the text background color for a shape.
getTextBkgndTrans()	Specifies the transparency level for the background color of a shape’s text block, from 0 (completely opaque) to 1 (comp
getTextDirection()	Specifies the direction of the characters in a text block.
getTopMargin()	Specifies the distance between the top border of the text block and the first line of text it contains.
getVerticalAlign()	Specifies the vertical alignment of text within the text block.
setBottomMargin()	Determines the distance between the bottom border of the text block and the last line of text it contains. The default i
setDefaultTabStop()	Specifies the interval of the default tab stops in a text block.
setDel()	A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted loca
setLeftMargin()	Specifies the distance between the left border of the text block and the text it contains. This value is independent of
setRightMargin()	Specifies the distance between the right border of the text block and the text it contains. This value is independent of
setTextBkgnd()	Specifies the text background color for a shape.
setTextBkgndTrans()	Specifies the transparency level for the background color of a shape’s text block, from 0 (completely opaque) to 1 (comp
setTextDirection()	Specifies the direction of the characters in a text block.
setTopMargin()	Specifies the distance between the top border of the text block and the first line of text it contains.
setVerticalAlign()	Specifies the vertical alignment of text within the text block.

deepClone()

Creates deep copy of this instance.

Returns: Object — Object

getBottomMargin()

Determines the distance between the bottom border of the text block and the last line of text it contains. The default is 4 pt. This value is independent of the scale of the drawing. If the drawing is scaled, the bottom margin remains the same.

getDefaultTabStop()

Specifies the interval of the default tab stops in a text block.

getDel()

A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted locally. The value of the property is BOOL integer constant.

getLeftMargin()

Specifies the distance between the left border of the text block and the text it contains. This value is independent of the scale of the drawing. If the drawing is scaled, the left margin remains the same.

getRightMargin()

Specifies the distance between the right border of the text block and the text it contains. This value is independent of the scale of the drawing. If the drawing is scaled, the right margin remains the same.

getTextBkgnd()

Specifies the text background color for a shape.

getTextBkgndTrans()

Specifies the transparency level for the background color of a shape’s text block, from 0 (completely opaque) to 1 (completely transparent).

getTextDirection()

Specifies the direction of the characters in a text block.

getTopMargin()

Specifies the distance between the top border of the text block and the first line of text it contains.

getVerticalAlign()

Specifies the vertical alignment of text within the text block.

setBottomMargin()

Determines the distance between the bottom border of the text block and the last line of text it contains. The default is 4 pt. This value is independent of the scale of the drawing. If the drawing is scaled, the bottom margin remains the same.

setDefaultTabStop()

Specifies the interval of the default tab stops in a text block.

setDel()

A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted locally. The value of the property is BOOL integer constant.

setLeftMargin()

Specifies the distance between the left border of the text block and the text it contains. This value is independent of the scale of the drawing. If the drawing is scaled, the left margin remains the same.

setRightMargin()

Specifies the distance between the right border of the text block and the text it contains. This value is independent of the scale of the drawing. If the drawing is scaled, the right margin remains the same.

setTextBkgnd()

Specifies the text background color for a shape.

setTextBkgndTrans()

Specifies the transparency level for the background color of a shape’s text block, from 0 (completely opaque) to 1 (completely transparent).

setTextDirection()

Specifies the direction of the characters in a text block.

setTopMargin()

Specifies the distance between the top border of the text block and the first line of text it contains.

setVerticalAlign()

Specifies the vertical alignment of text within the text block.