MsoTextFrame

MsoTextFrame class

Represents the text frame in a Shape object.

class MsoTextFrame;

Properties

PropertyTypeDescription
autoSizebooleanIndicates if size of shape is adjusted automatically according to its content.
isAutoMarginbooleanIndicates whether the margin is auto calculated.
rotateTextWithShapebooleanIndicates whether rotating text with shape.
leftMarginPtnumberReturns the left margin in unit of Points
rightMarginPtnumberReturns the right margin in unit of Points
topMarginPtnumberReturns the top margin in unit of Points
bottomMarginPtnumberReturns the bottom margin in unit of Points

Methods

MethodDescription
getAutoSize()@deprecated. Please use the ‘autoSize’ property instead. Indicates if size of shape is adjusted automatically according to its content.
setAutoSize(boolean)@deprecated. Please use the ‘autoSize’ property instead. Indicates if size of shape is adjusted automatically according to its content.
isAutoMargin()@deprecated. Please use the ‘isAutoMargin’ property instead. Indicates whether the margin is auto calculated.
setIsAutoMargin(boolean)@deprecated. Please use the ‘isAutoMargin’ property instead. Indicates whether the margin is auto calculated.
getRotateTextWithShape()@deprecated. Please use the ‘rotateTextWithShape’ property instead. Indicates whether rotating text with shape.
setRotateTextWithShape(boolean)@deprecated. Please use the ‘rotateTextWithShape’ property instead. Indicates whether rotating text with shape.
getLeftMarginPt()@deprecated. Please use the ’leftMarginPt’ property instead. Returns the left margin in unit of Points
setLeftMarginPt(number)@deprecated. Please use the ’leftMarginPt’ property instead. Returns the left margin in unit of Points
getRightMarginPt()@deprecated. Please use the ‘rightMarginPt’ property instead. Returns the right margin in unit of Points
setRightMarginPt(number)@deprecated. Please use the ‘rightMarginPt’ property instead. Returns the right margin in unit of Points
getTopMarginPt()@deprecated. Please use the ’topMarginPt’ property instead. Returns the top margin in unit of Points
setTopMarginPt(number)@deprecated. Please use the ’topMarginPt’ property instead. Returns the top margin in unit of Points
getBottomMarginPt()@deprecated. Please use the ‘bottomMarginPt’ property instead. Returns the bottom margin in unit of Points
setBottomMarginPt(number)@deprecated. Please use the ‘bottomMarginPt’ property instead. Returns the bottom margin in unit of Points
isNull()Checks whether the implementation object is null.

autoSize

Indicates if size of shape is adjusted automatically according to its content.

autoSize : boolean;

isAutoMargin

Indicates whether the margin is auto calculated.

isAutoMargin : boolean;

rotateTextWithShape

Indicates whether rotating text with shape.

rotateTextWithShape : boolean;

leftMarginPt

Returns the left margin in unit of Points

leftMarginPt : number;

rightMarginPt

Returns the right margin in unit of Points

rightMarginPt : number;

topMarginPt

Returns the top margin in unit of Points

topMarginPt : number;

bottomMarginPt

Returns the bottom margin in unit of Points

bottomMarginPt : number;

getAutoSize()

@deprecated. Please use the ‘autoSize’ property instead. Indicates if size of shape is adjusted automatically according to its content.

getAutoSize() : boolean;

setAutoSize(boolean)

@deprecated. Please use the ‘autoSize’ property instead. Indicates if size of shape is adjusted automatically according to its content.

setAutoSize(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

isAutoMargin()

@deprecated. Please use the ‘isAutoMargin’ property instead. Indicates whether the margin is auto calculated.

isAutoMargin() : boolean;

setIsAutoMargin(boolean)

@deprecated. Please use the ‘isAutoMargin’ property instead. Indicates whether the margin is auto calculated.

setIsAutoMargin(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getRotateTextWithShape()

@deprecated. Please use the ‘rotateTextWithShape’ property instead. Indicates whether rotating text with shape.

getRotateTextWithShape() : boolean;

setRotateTextWithShape(boolean)

@deprecated. Please use the ‘rotateTextWithShape’ property instead. Indicates whether rotating text with shape.

setRotateTextWithShape(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getLeftMarginPt()

@deprecated. Please use the ’leftMarginPt’ property instead. Returns the left margin in unit of Points

getLeftMarginPt() : number;

setLeftMarginPt(number)

@deprecated. Please use the ’leftMarginPt’ property instead. Returns the left margin in unit of Points

setLeftMarginPt(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getRightMarginPt()

@deprecated. Please use the ‘rightMarginPt’ property instead. Returns the right margin in unit of Points

getRightMarginPt() : number;

setRightMarginPt(number)

@deprecated. Please use the ‘rightMarginPt’ property instead. Returns the right margin in unit of Points

setRightMarginPt(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getTopMarginPt()

@deprecated. Please use the ’topMarginPt’ property instead. Returns the top margin in unit of Points

getTopMarginPt() : number;

setTopMarginPt(number)

@deprecated. Please use the ’topMarginPt’ property instead. Returns the top margin in unit of Points

setTopMarginPt(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getBottomMarginPt()

@deprecated. Please use the ‘bottomMarginPt’ property instead. Returns the bottom margin in unit of Points

getBottomMarginPt() : number;

setBottomMarginPt(number)

@deprecated. Please use the ‘bottomMarginPt’ property instead. Returns the bottom margin in unit of Points

setBottomMarginPt(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;