TextBox
TextBox class
Encapsulates the object that represents a textbox in a spreadsheet.
class TextBox extends Shape;
Example
const { Workbook, PlacementType, Color, MsoLineStyle, MsoLineDashStyle, SaveFormat } = AsposeCells;
//Instantiate a new Workbook.
var workbook = new Workbook();
//Get the first worksheet in the book.
var worksheet = workbook.worksheets.get(0);
//Add a new textbox to the collection.
var textboxIndex = worksheet.textBoxes.add(2, 1, 160, 200);
//Get the textbox object.
var textbox0 = worksheet.textBoxes.get(textboxIndex);
//Fill the text.
textbox0.text = "ASPOSE CELLS";
//Set the textbox to adjust it according to its contents.
textbox0.textBody.textAlignment.autoSize = true;
//Set the placement.
textbox0.placement = PlacementType.FreeFloating;
//Set the font color.
textbox0.font.color = Color.Blue;
//Set the font to bold.
textbox0.font.isBold = true;
//Set the font size.
textbox0.font.size = 14;
//Set font attribute to italic.
textbox0.font.isItalic = true;
//Add a hyperlink to the textbox.
textbox0.addHyperlink("https://www.aspose.com/");
//Get the filformat of the textbox.
var fillformat = textbox0.fill;
//Set the fillcolor.
fillformat.solidFill.color = Color.Silver;
//Get the lineformat type of the textbox.
var lineformat = textbox0.line;
//Set the line style.
lineformat.compoundType = MsoLineStyle.ThinThick;
//Set the line weight.
lineformat.weight = 6;
//Set the dash style to squaredot.
lineformat.dashStyle = MsoLineDashStyle.SquareDot;
//Add another textbox.
textboxIndex = worksheet.textBoxes.add(15, 4, 85, 120);
//Get the second textbox.
var textbox1 = worksheet.textBoxes.get(textboxIndex);
//Input some text to it.
textbox1.text = "This is another simple text box";
//Set the placement type as the textbox will move and
//resize with cells.
textbox1.placement = PlacementType.MoveAndSize;
//Save the excel file.
var uint8Array = workbook.save(SaveFormat.Xlsx);
Constructors
| Name | Description |
|---|---|
| constructor(Shape) | Constructs from a parent object convertible to this. |
Properties
| Property | Type | Description |
|---|---|---|
| macroName | string | Gets and sets the name of macro. |
| isEquation | boolean | Readonly. Indicates whether the shape only contains an equation. |
| isSmartArt | boolean | Readonly. Indicates whether the shape is a smart art. |
| zOrderPosition | number | Returns the position of a shape in the z-order. |
| name | string | Gets and sets the name of the shape. |
| alternativeText | string | Returns or sets the descriptive (alternative) text string of the Shape object. |
| title | string | Specifies the title (caption) of the current shape object. |
| line | LineFormat | Readonly. Gets line style |
| fill | FillFormat | Readonly. Returns a FillFormat object that contains fill formatting properties for the specified shape. |
| shadowEffect | ShadowEffect | Readonly. Represents a Drawing.ShadowEffect object that specifies shadow effect for the chart element or shape. |
| reflection | ReflectionEffect | Readonly. Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape. |
| glow | GlowEffect | Readonly. Represents a GlowEffect object that specifies glow effect for the chart element or shape. |
| softEdges | number | Gets and sets the radius of blur to apply to the edges, in unit of points. |
| threeDFormat | ThreeDFormat | Readonly. Gets and sets 3d format of the shape. |
| formatPicture | MsoFormatPicture | Readonly. Gets and sets the options of the picture format. |
| isHidden | boolean | Indicates whether the object is visible. |
| isLockAspectRatio | boolean | True means that aspect ratio of the shape is locked. |
| isAspectRatioLocked | boolean | True means that aspect ratio of the shape is locked. |
| rotationAngle | number | Gets and sets the rotation of the shape. |
| hyperlink | Hyperlink | Readonly. Gets the hyperlink of the shape. |
| id | number | Readonly. Gets the identifier of this shape. |
| spid | string | Readonly. Specifies an optional string identifier that an application can use to identify the particular shape. |
| spt | number | Readonly. Specifies an optional number that an application can use to associate the particular shape with a defined shape type. |
| worksheet | Worksheet | Readonly. Gets the Worksheet object which contains this shape. |
| isGroup | boolean | Readonly. Indicates whether this shape is a group shape. |
| isInGroup | boolean | Readonly. Indicates whether the shape is grouped. |
| isWordArt | boolean | Readonly. Indicates whether this shape is a word art. |
| textEffect | TextEffectFormat | Readonly. Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape. Applies to Shape objects that represent WordArt. |
| isLocked | boolean | True means the object can not be modified when the sheet is protected. Note that this value is meaningful only if the worksheet or objects in the worksheet are protected. |
| isPrintable | boolean | Indicates whether the object is printable. If False, this shape will not be printed when printing. |
| msoDrawingType | MsoDrawingType | Readonly. Gets drawing type. |
| autoShapeType | AutoShapeType | Gets and sets the auto shape type. |
| anchorType | ShapeAnchorType | Gets and set the type of the shape anchor placeholder. |
| placement | PlacementType | Represents the way the drawing object is attached to the cells below it. The property controls the placement of an object on a worksheet. |
| upperLeftRow | number | Represents the top row index. |
| upperDeltaY | number | Gets or sets the shape’s vertical offset from its upper left corner row. |
| upperLeftColumn | number | Represents upper left corner column index. |
| upperDeltaX | number | Gets or sets the shape’s horizontal offset from its upper left corner column. |
| lowerRightRow | number | Represents lower right corner row index. |
| lowerDeltaY | number | Gets or sets the shape’s vertical offset from its lower right corner row. |
| lowerRightColumn | number | Represents lower right corner column index. |
| lowerDeltaX | number | Gets or sets the shape’s horizontal offset from its lower right corner column. |
| right | number | Represents the width of the shape’s horizontal offset from its lower right corner column, in unit of pixels. |
| bottom | number | Represents the width of the shape’s vertical offset from its lower bottom corner row, in unit of pixels. |
| width | number | Represents the width of shape, in unit of pixels. |
| widthInch | number | Represents the width of the shape, in unit of inch. |
| widthPt | number | Represents the width of the shape, in unit of point. |
| widthCM | number | Represents the width of the shape, in unit of centimeters. |
| height | number | Represents the height of shape, in unit of pixel. |
| heightInch | number | Represents the height of the shape, in unit of inches. |
| heightPt | number | Represents the height of the shape, in unit of points. |
| heightCM | number | Represents the height of the shape, in unit of centimeters. |
| left | number | Represents the horizontal offset of shape from its left column, in unit of pixels. |
| leftInch | number | Represents the horizontal offset of shape from its left column, in unit of inches. |
| leftCM | number | Represents the horizontal offset of shape from its left column, in unit of centimeters. |
| top | number | Represents the vertical offset of shape from its top row, in unit of pixels. |
| topInch | number | Represents the vertical offset of shape from its top row, in unit of inches. |
| topCM | number | Represents the vertical offset of shape from its top row, in unit of centimeters. |
| topToCorner | number | Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels. |
| leftToCorner | number | Gets and sets the horizonal offset of shape from worksheet left border. |
| x | number | Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels. |
| y | number | Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels. |
| widthScale | number | Gets and sets the width scale, in unit of percent of the original picture width. If the shape is not picture ,the WidthScale property only returns 100; |
| heightScale | number | Gets and sets the height scale,in unit of percent of the original picture height. If the shape is not picture ,the HeightScale property only returns 100; |
| topInShape | number | Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape. |
| leftInShape | number | Represents the horizontal offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape. |
| widthInShape | number | Represents the width of the shape, in unit of 1/4000 of the parent shape. |
| heightInShape | number | Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.. |
| group | GroupShape | Readonly. Gets the group shape which contains this shape. |
| type | AutoShapeType | Readonly. Gets the auto shape type. |
| hasLine | boolean | Gets and sets the line border of the shape is visible. |
| isFilled | boolean | Indicates whether the fill format is visible. |
| isFlippedHorizontally | boolean | Gets and sets whether shape is horizontally flipped . |
| isFlippedVertically | boolean | Gets and sets whether shape is vertically flipped . |
| actualLowerRightRow | number | Readonly. Get the actual bottom row. |
| relativeToOriginalPictureSize | boolean | Indicates whether shape is relative to original picture size. |
| linkedCell | string | Gets or sets the worksheet range linked to the control’s value. |
| inputRange | string | Gets or sets the worksheet range used to fill the specified combo box. |
| textShapeType | AutoShapeType | Gets and sets the preset text shape type. |
| textBody | FontSettingCollection | Readonly. Gets and sets the setting of the shape’s text. |
| font | Font | Represents the font of shape. |
| textOptions | TextOptions | Represents the text options of the shape. |
| text | string | Gets and sets the text of this shape. |
| isRichText | boolean | Readonly. Whether or not the text is rich text. |
| htmlText | string | Gets and sets the html string which contains data and some formats in this textbox. |
| textVerticalOverflow | TextOverflowType | Gets and sets the text vertical overflow type of the shape which contains text. |
| textHorizontalOverflow | TextOverflowType | Gets and sets the text horizontal overflow type of the shape which contains text. |
| isTextWrapped | boolean | Gets and sets the text wrapped type of the shape which contains text. |
| textOrientationType | TextOrientationType | Gets and sets the text orientation type of the shape. |
| textHorizontalAlignment | TextAlignmentType | Gets and sets the text horizontal alignment type of the shape. |
| textVerticalAlignment | TextAlignmentType | Gets and sets the text vertical alignment type of the shape. |
| textDirection | TextDirectionType | Gets/Sets the direction of the text flow for this object. |
| textBoxOptions | TextBoxOptions | Readonly. Gets the text information in the shape |
| controlData | Uint8Array | Readonly. Gets the data of control. |
| activeXControl | ActiveXControl | Readonly. Gets the ActiveX control. |
| paths | ShapePathCollection | Readonly. Gets the paths of a custom geometric shape. |
| geometry | Geometry | Readonly. Gets the geometry |
| isDecorative | boolean | Indicates whether the object is decorative. |
Methods
| Method | Description |
|---|---|
| getEquationParagraph(number) | Get the specified math paragraph from the TextBody property of the TextBox object. Notice: (1) Returns NULL when the index is out of bounds or not found. (2) Also returns NULL if the specified index position is not a math paragraph. |
| getEquationParagraph() | Gets the first math paragraph from the TextBody property of the TextBox object. |
| toFrontOrBack(number) | Brings the shape to the front or sends the shape to back. |
| getLockedProperty(ShapeLockType) | Gets the value of locked property. |
| setLockedProperty(ShapeLockType, boolean) | Set the locked property. |
| addHyperlink(string) | Adds a hyperlink to the shape. |
| removeHyperlink() | Removes the hyperlink of the shape. |
| moveToRange(number, number, number, number) | Moves the shape to a specified range. |
| alignTopRightCorner(number, number) | Moves the picture to the top-right corner. |
| getConnectionPoints() | Get the connection points |
| toImageAsync(ImageType) | Creates the shape image and saves it to a stream in the specified format. |
| toImageAsync(string, ImageOrPrintOptions) | Saves the shape to a file. |
| toImageAsync(ImageOrPrintOptions) | Saves the shape to a stream. |
| toImage(ImageType) | Creates the shape image and saves it to a stream in the specified format. |
| toImage(string, ImageOrPrintOptions) | Saves the shape to a file. |
| toImage(ImageOrPrintOptions) | Saves the shape to a stream. |
| getLinkedCell(boolean, boolean) | Gets the range linked to the control’s value. |
| setLinkedCell(string, boolean, boolean) | Sets the range linked to the control’s value. |
| getInputRange(boolean, boolean) | Gets the range used to fill the control. |
| setInputRange(string, boolean, boolean) | Sets the range used to fill the control. |
| updateSelectedValue() | Update the selected value by the value of the linked cell. |
| calculateTextSize() | Recalculate the text area |
| formatCharacters(number, number, Font, StyleFlag) | Formats some characters with the font setting. |
| characters(number, number) | Returns a Characters object that represents a range of characters within the text. |
| getRichFormattings() | Returns all Characters objects that represents a range of characters within the text . |
| removeActiveXControl() | Remove activeX control. |
| getActualBox() | Get the actual position and size of the shape (after applying rotation, flip, etc.) |
| fitToTextSize() | Recalculate a text area suitable for displaying all text content. |
| getResultOfSmartArt() | Converting smart art to grouped shapes. |
| isSameSetting(VObject) | Returns whether the shape is same. |
constructor(Shape)
Constructs from a parent object convertible to this.
constructor(obj: Shape);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | Shape | The parent object. |
macroName
Gets and sets the name of macro.
macroName : string;
isEquation
Readonly. Indicates whether the shape only contains an equation.
isEquation : boolean;
isSmartArt
Readonly. Indicates whether the shape is a smart art.
isSmartArt : boolean;
Remarks
Only for ooxml file.
zOrderPosition
Returns the position of a shape in the z-order.
zOrderPosition : number;
name
Gets and sets the name of the shape.
name : string;
alternativeText
Returns or sets the descriptive (alternative) text string of the Shape object.
alternativeText : string;
title
Specifies the title (caption) of the current shape object.
title : string;
line
Readonly. Gets line style
line : LineFormat;
fill
Readonly. Returns a FillFormat object that contains fill formatting properties for the specified shape.
fill : FillFormat;
shadowEffect
Readonly. Represents a Drawing.ShadowEffect object that specifies shadow effect for the chart element or shape.
shadowEffect : ShadowEffect;
reflection
Readonly. Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
reflection : ReflectionEffect;
glow
Readonly. Represents a GlowEffect object that specifies glow effect for the chart element or shape.
glow : GlowEffect;
softEdges
Gets and sets the radius of blur to apply to the edges, in unit of points.
softEdges : number;
threeDFormat
Readonly. Gets and sets 3d format of the shape.
threeDFormat : ThreeDFormat;
formatPicture
Readonly. Gets and sets the options of the picture format.
formatPicture : MsoFormatPicture;
isHidden
Indicates whether the object is visible.
isHidden : boolean;
isLockAspectRatio
True means that aspect ratio of the shape is locked.
isLockAspectRatio : boolean;
Remarks
Only for pictures and Ole Objects. NOTE: This member is now obsolete. Instead, please use Shape.IsAspectRatioLocked property. This property will be removed 12 months later since July 2024. Aspose apologizes for any inconvenience you may have experienced.
isAspectRatioLocked
True means that aspect ratio of the shape is locked.
isAspectRatioLocked : boolean;
Remarks
Only for pictures and Ole Objects.
rotationAngle
Gets and sets the rotation of the shape.
rotationAngle : number;
hyperlink
Readonly. Gets the hyperlink of the shape.
hyperlink : Hyperlink;
id
Readonly. Gets the identifier of this shape.
id : number;
spid
Readonly. Specifies an optional string identifier that an application can use to identify the particular shape.
spid : string;
spt
Readonly. Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
spt : number;
worksheet
Readonly. Gets the Worksheet object which contains this shape.
worksheet : Worksheet;
isGroup
Readonly. Indicates whether this shape is a group shape.
isGroup : boolean;
isInGroup
Readonly. Indicates whether the shape is grouped.
isInGroup : boolean;
isWordArt
Readonly. Indicates whether this shape is a word art.
isWordArt : boolean;
Remarks
Only for the Legacy Shape of xls file.
textEffect
Readonly. Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape. Applies to Shape objects that represent WordArt.
textEffect : TextEffectFormat;
isLocked
True means the object can not be modified when the sheet is protected. Note that this value is meaningful only if the worksheet or objects in the worksheet are protected.
isLocked : boolean;
isPrintable
Indicates whether the object is printable. If False, this shape will not be printed when printing.
isPrintable : boolean;
msoDrawingType
Readonly. Gets drawing type.
msoDrawingType : MsoDrawingType;
autoShapeType
Gets and sets the auto shape type.
autoShapeType : AutoShapeType;
anchorType
Gets and set the type of the shape anchor placeholder.
anchorType : ShapeAnchorType;
placement
Represents the way the drawing object is attached to the cells below it. The property controls the placement of an object on a worksheet.
placement : PlacementType;
upperLeftRow
Represents the top row index.
upperLeftRow : number;
Remarks
If the shape is in the shape or in the group , UpperLeftRow will be ignored.
upperDeltaY
Gets or sets the shape’s vertical offset from its upper left corner row.
upperDeltaY : number;
Remarks
The range of value is 0 to 256.
upperLeftColumn
Represents upper left corner column index.
upperLeftColumn : number;
upperDeltaX
Gets or sets the shape’s horizontal offset from its upper left corner column.
upperDeltaX : number;
Remarks
The range of value is 0 to 1024.
lowerRightRow
Represents lower right corner row index.
lowerRightRow : number;
lowerDeltaY
Gets or sets the shape’s vertical offset from its lower right corner row.
lowerDeltaY : number;
Remarks
The range of value is 0 to 256.
lowerRightColumn
Represents lower right corner column index.
lowerRightColumn : number;
lowerDeltaX
Gets or sets the shape’s horizontal offset from its lower right corner column.
lowerDeltaX : number;
Remarks
The range of value is 0 to 1024.
right
Represents the width of the shape’s horizontal offset from its lower right corner column, in unit of pixels.
right : number;
bottom
Represents the width of the shape’s vertical offset from its lower bottom corner row, in unit of pixels.
bottom : number;
width
Represents the width of shape, in unit of pixels.
width : number;
widthInch
Represents the width of the shape, in unit of inch.
widthInch : number;
widthPt
Represents the width of the shape, in unit of point.
widthPt : number;
widthCM
Represents the width of the shape, in unit of centimeters.
widthCM : number;
height
Represents the height of shape, in unit of pixel.
height : number;
heightInch
Represents the height of the shape, in unit of inches.
heightInch : number;
heightPt
Represents the height of the shape, in unit of points.
heightPt : number;
heightCM
Represents the height of the shape, in unit of centimeters.
heightCM : number;
left
Represents the horizontal offset of shape from its left column, in unit of pixels.
left : number;
leftInch
Represents the horizontal offset of shape from its left column, in unit of inches.
leftInch : number;
leftCM
Represents the horizontal offset of shape from its left column, in unit of centimeters.
leftCM : number;
top
Represents the vertical offset of shape from its top row, in unit of pixels.
top : number;
Remarks
If the shape is in the chart, represents the vertical offset of shape from its top border.
topInch
Represents the vertical offset of shape from its top row, in unit of inches.
topInch : number;
topCM
Represents the vertical offset of shape from its top row, in unit of centimeters.
topCM : number;
topToCorner
Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
topToCorner : number;
leftToCorner
Gets and sets the horizonal offset of shape from worksheet left border.
leftToCorner : number;
x
Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
x : number;
y
Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
y : number;
widthScale
Gets and sets the width scale, in unit of percent of the original picture width. If the shape is not picture ,the WidthScale property only returns 100;
widthScale : number;
heightScale
Gets and sets the height scale,in unit of percent of the original picture height. If the shape is not picture ,the HeightScale property only returns 100;
heightScale : number;
topInShape
Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
topInShape : number;
Remarks
Only Applies when this shape in the group or chart.
leftInShape
Represents the horizontal offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
leftInShape : number;
Remarks
Only Applies when this shape in the group or chart.
widthInShape
Represents the width of the shape, in unit of 1/4000 of the parent shape.
widthInShape : number;
Remarks
Only Applies when this shape in the group or chart.
heightInShape
Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
heightInShape : number;
Remarks
Only Applies when this shape in the group or chart.
group
Readonly. Gets the group shape which contains this shape.
group : GroupShape;
type
Readonly. Gets the auto shape type.
type : AutoShapeType;
hasLine
Gets and sets the line border of the shape is visible.
hasLine : boolean;
isFilled
Indicates whether the fill format is visible.
isFilled : boolean;
isFlippedHorizontally
Gets and sets whether shape is horizontally flipped .
isFlippedHorizontally : boolean;
isFlippedVertically
Gets and sets whether shape is vertically flipped .
isFlippedVertically : boolean;
actualLowerRightRow
Readonly. Get the actual bottom row.
actualLowerRightRow : number;
relativeToOriginalPictureSize
Indicates whether shape is relative to original picture size.
relativeToOriginalPictureSize : boolean;
linkedCell
Gets or sets the worksheet range linked to the control’s value.
linkedCell : string;
inputRange
Gets or sets the worksheet range used to fill the specified combo box.
inputRange : string;
textShapeType
Gets and sets the preset text shape type.
textShapeType : AutoShapeType;
textBody
Readonly. Gets and sets the setting of the shape’s text.
textBody : FontSettingCollection;
font
Represents the font of shape.
font : Font;
textOptions
Represents the text options of the shape.
textOptions : TextOptions;
text
Gets and sets the text of this shape.
text : string;
isRichText
Readonly. Whether or not the text is rich text.
isRichText : boolean;
htmlText
Gets and sets the html string which contains data and some formats in this textbox.
htmlText : string;
textVerticalOverflow
Gets and sets the text vertical overflow type of the shape which contains text.
textVerticalOverflow : TextOverflowType;
textHorizontalOverflow
Gets and sets the text horizontal overflow type of the shape which contains text.
textHorizontalOverflow : TextOverflowType;
isTextWrapped
Gets and sets the text wrapped type of the shape which contains text.
isTextWrapped : boolean;
textOrientationType
Gets and sets the text orientation type of the shape.
textOrientationType : TextOrientationType;
textHorizontalAlignment
Gets and sets the text horizontal alignment type of the shape.
textHorizontalAlignment : TextAlignmentType;
textVerticalAlignment
Gets and sets the text vertical alignment type of the shape.
textVerticalAlignment : TextAlignmentType;
textDirection
Gets/Sets the direction of the text flow for this object.
textDirection : TextDirectionType;
textBoxOptions
Readonly. Gets the text information in the shape
textBoxOptions : TextBoxOptions;
controlData
Readonly. Gets the data of control.
controlData : Uint8Array;
activeXControl
Readonly. Gets the ActiveX control.
activeXControl : ActiveXControl;
paths
Readonly. Gets the paths of a custom geometric shape.
paths : ShapePathCollection;
geometry
Readonly. Gets the geometry
geometry : Geometry;
isDecorative
Indicates whether the object is decorative.
isDecorative : boolean;
getEquationParagraph(number)
Get the specified math paragraph from the TextBody property of the TextBox object. Notice: (1) Returns NULL when the index is out of bounds or not found. (2) Also returns NULL if the specified index position is not a math paragraph.
getEquationParagraph(index: number) : EquationNode;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | number | The position index of the math paragraph, starting from 0. |
Returns
Returns the math paragraph specified by index.
getEquationParagraph()
Gets the first math paragraph from the TextBody property of the TextBox object.
getEquationParagraph() : EquationNode;
Returns
If there has math paragraph, returns the first one, otherwise returns null.
toFrontOrBack(number)
Brings the shape to the front or sends the shape to back.
toFrontOrBack(orders: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| orders | number | If it’s less than zero, sets the shape to back. /// If it’s greater than zero, brings the shape to front. |
getLockedProperty(ShapeLockType)
Gets the value of locked property.
getLockedProperty(type: ShapeLockType) : boolean;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| type | ShapeLockType | The type of the shape locked property. |
Returns
Returns the value of locked property.
setLockedProperty(ShapeLockType, boolean)
Set the locked property.
setLockedProperty(type: ShapeLockType, value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| type | ShapeLockType | The locked type. |
| value | boolean | The value of the property. |
addHyperlink(string)
Adds a hyperlink to the shape.
addHyperlink(address: string) : Hyperlink;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| address | string | Address of the hyperlink. |
Returns
Return the new hyperlink object.
removeHyperlink()
Removes the hyperlink of the shape.
removeHyperlink() : void;
moveToRange(number, number, number, number)
Moves the shape to a specified range.
moveToRange(upperLeftRow: number, upperLeftColumn: number, lowerRightRow: number, lowerRightColumn: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| upperLeftRow | number | Upper left row index. |
| upperLeftColumn | number | Upper left column index. |
| lowerRightRow | number | Lower right row index |
| lowerRightColumn | number | Lower right column index |
alignTopRightCorner(number, number)
Moves the picture to the top-right corner.
alignTopRightCorner(topRow: number, rightColumn: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| topRow | number | the row index. |
| rightColumn | number | the column index. |
getConnectionPoints()
Get the connection points
getConnectionPoints() : number[][];
Returns
[X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
toImageAsync(ImageType)
Creates the shape image and saves it to a stream in the specified format.
toImageAsync(imageType: ImageType) : Promise<Uint8Array>;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| imageType | ImageType | The type in which to save the image. |
Returns
The result stream
Remarks
The following formats are supported: .bmp, .gif, .jpg, .jpeg, .tiff, .emf.
toImageAsync(string, ImageOrPrintOptions)
Saves the shape to a file.
toImageAsync(imageFile: string, options: ImageOrPrintOptions) : Promise<void>;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| imageFile | string | |
| options | ImageOrPrintOptions |
Returns
toImageAsync(ImageOrPrintOptions)
Saves the shape to a stream.
toImageAsync(options: ImageOrPrintOptions) : Promise<Uint8Array>;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | ImageOrPrintOptions |
Returns
The result stream
toImage(ImageType)
Creates the shape image and saves it to a stream in the specified format.
toImage(imageType: ImageType) : Uint8Array;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| imageType | ImageType | The type in which to save the image. |
Returns
The result stream
Remarks
The following formats are supported: .bmp, .gif, .jpg, .jpeg, .tiff, .emf.
toImage(string, ImageOrPrintOptions)
Saves the shape to a file.
toImage(imageFile: string, options: ImageOrPrintOptions) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| imageFile | string | |
| options | ImageOrPrintOptions |
toImage(ImageOrPrintOptions)
Saves the shape to a stream.
toImage(options: ImageOrPrintOptions) : Uint8Array;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | ImageOrPrintOptions |
Returns
The result stream
getLinkedCell(boolean, boolean)
Gets the range linked to the control’s value.
getLinkedCell(isR1C1: boolean, isLocal: boolean) : string;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| isR1C1 | boolean | Whether the formula needs to be formatted as R1C1. |
| isLocal | boolean | Whether the formula needs to be formatted by locale. |
Returns
The range linked to the control’s value.
setLinkedCell(string, boolean, boolean)
Sets the range linked to the control’s value.
setLinkedCell(formula: string, isR1C1: boolean, isLocal: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| formula | string | The range linked to the control’s value. |
| isR1C1 | boolean | Whether the formula needs to be formatted as R1C1. |
| isLocal | boolean | Whether the formula needs to be formatted by locale. |
getInputRange(boolean, boolean)
Gets the range used to fill the control.
getInputRange(isR1C1: boolean, isLocal: boolean) : string;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| isR1C1 | boolean | Whether the formula needs to be formatted as R1C1. |
| isLocal | boolean | Whether the formula needs to be formatted by locale. |
Returns
The range used to fill the control.
setInputRange(string, boolean, boolean)
Sets the range used to fill the control.
setInputRange(formula: string, isR1C1: boolean, isLocal: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| formula | string | The range used to fill the control. |
| isR1C1 | boolean | Whether the formula needs to be formatted as R1C1. |
| isLocal | boolean | Whether the formula needs to be formatted by locale. |
updateSelectedValue()
Update the selected value by the value of the linked cell.
updateSelectedValue() : void;
calculateTextSize()
Recalculate the text area
calculateTextSize() : number[];
Returns
Text’s Size in an array(width and height).
formatCharacters(number, number, Font, StyleFlag)
Formats some characters with the font setting.
formatCharacters(startIndex: number, length: number, font: Font, flag: StyleFlag) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| startIndex | number | The start index. |
| length | number | The length. |
| font | Font | The font setting. |
| flag | StyleFlag | The flag of the font setting. |
characters(number, number)
Returns a Characters object that represents a range of characters within the text.
characters(startIndex: number, length: number) : FontSetting;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| startIndex | number | The index of the start of the character. |
| length | number | The number of characters. |
Returns
Characters object.
Remarks
This method only works on shape with title.
getRichFormattings()
Returns all Characters objects that represents a range of characters within the text .
getRichFormattings() : FontSetting[];
Returns
All Characters objects
removeActiveXControl()
Remove activeX control.
removeActiveXControl() : void;
getActualBox()
Get the actual position and size of the shape (after applying rotation, flip, etc.)
getActualBox() : number[];
Returns
Return the position and size in the order of x, y, w, h
Remarks
Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.
fitToTextSize()
Recalculate a text area suitable for displaying all text content.
fitToTextSize() : void;
getResultOfSmartArt()
Converting smart art to grouped shapes.
getResultOfSmartArt() : GroupShape;
Returns
isSameSetting(VObject)
Returns whether the shape is same.
isSameSetting(obj: VObject) : boolean;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | VObject |