ShapeTextAlignment
ShapeTextAlignment class
Represents the setting of shape’s text alignment;
class ShapeTextAlignment;
Properties
Property | Type | Description |
---|---|---|
isTextWrapped | boolean | Gets or sets the text wrapped type of the shape which contains text. |
rotateTextWithShape | boolean | Indicates whether rotating text with shape. |
textVerticalOverflow | TextOverflowType | Gets and sets the text vertical overflow type of the text box. |
textHorizontalOverflow | TextOverflowType | Gets and sets the text horizontal overflow type of the text box. |
rotationAngle | number | Gets and sets the rotation of the shape. |
textVerticalType | TextVerticalType | Gets and sets the text direction. |
isLockedText | boolean | Indicates whether the shape is locked when worksheet is protected. |
autoSize | boolean | Indicates if size of shape is adjusted automatically according to its content. |
textShapeType | AutoShapeType | Gets and set the transform type of text. |
topMarginPt | number | Returns the top margin in unit of Points |
bottomMarginPt | number | Returns the bottom margin in unit of Points |
leftMarginPt | number | Returns the left margin in unit of Points |
rightMarginPt | number | Returns the right margin in unit of Points |
isAutoMargin | boolean | Indicates whether the margin of the text frame is automatic. |
numberOfColumns | number | Gets and sets the number of columns of text in the bounding rectangle. |
Methods
Method | Description |
---|---|
equals(VObject) | Determines whether this instance has the same value as another specified ShapeTextAlignment object. |
getHashCode() |
isTextWrapped
Gets or sets the text wrapped type of the shape which contains text.
isTextWrapped : boolean;
rotateTextWithShape
Indicates whether rotating text with shape.
rotateTextWithShape : boolean;
textVerticalOverflow
Gets and sets the text vertical overflow type of the text box.
textVerticalOverflow : TextOverflowType;
textHorizontalOverflow
Gets and sets the text horizontal overflow type of the text box.
textHorizontalOverflow : TextOverflowType;
rotationAngle
Gets and sets the rotation of the shape.
rotationAngle : number;
textVerticalType
Gets and sets the text direction.
textVerticalType : TextVerticalType;
isLockedText
Indicates whether the shape is locked when worksheet is protected.
isLockedText : boolean;
Remarks
Only works when worksheet is protected.
autoSize
Indicates if size of shape is adjusted automatically according to its content.
autoSize : boolean;
textShapeType
Gets and set the transform type of text.
textShapeType : AutoShapeType;
topMarginPt
Returns the top margin in unit of Points
topMarginPt : number;
bottomMarginPt
Returns the bottom margin in unit of Points
bottomMarginPt : number;
leftMarginPt
Returns the left margin in unit of Points
leftMarginPt : number;
rightMarginPt
Returns the right margin in unit of Points
rightMarginPt : number;
isAutoMargin
Indicates whether the margin of the text frame is automatic.
isAutoMargin : boolean;
numberOfColumns
Gets and sets the number of columns of text in the bounding rectangle.
numberOfColumns : number;
equals(VObject)
Determines whether this instance has the same value as another specified ShapeTextAlignment object.
equals(obj: VObject) : boolean;
Parameters:
Parameter | Type | Description |
---|---|---|
obj | VObject | The ShapeTextAlignment object to compare with this instance. |
Returns
true if the value of the obj parameter is the same as the value of this instance; otherwise, false. If obj is null, this method returns false.
getHashCode()
getHashCode() : number;