TextBox
TextBox class
Encapsulates the object that represents a textbox in a spreadsheet.
Properties
| Name | Type | Description |
|---|---|---|
| MacroName | String | Gets and sets the name of macro. |
| IsEquation | boolean | Indicates whether the shape only contains an equation. |
| IsSmartArt | boolean | Indicates whether the shape is a smart art. Only for ooxml file. |
| ZOrderPosition | int | 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. |
| LineFormat | MsoLineFormat | Returns a MsoLineFormat object that contains line formatting properties for the specified shape. NOTE: This member is no |
| FillFormat | MsoFillFormat | Returns a MsoFillFormat object that contains fill formatting properties for the specified shape. NOTE: This member is no |
| Line | LineFormat | Gets line style |
| Fill | FillFormat | Returns a FillFormat object that contains fill formatting properties for the specified shape. |
| ShadowEffect | ShadowEffect | Represents a ShadowEffect object that specifies shadow effect for the chart element or shape. |
| Reflection | ReflectionEffect | Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape. |
| Glow | GlowEffect | Represents a GlowEffect object that specifies glow effect for the chart element or shape. |
| SoftEdges | float | Gets and sets the radius of blur to apply to the edges, in unit of points. |
| ThreeDFormat | ThreeDFormat | Gets and sets 3d format of the shape. |
| FormatPicture | MsoFormatPicture | 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. Only for pictures and Ole Objects. NOTE: This member is now obsolet |
| IsAspectRatioLocked | boolean | True means that aspect ratio of the shape is locked. Only for pictures and Ole Objects. |
| RotationAngle | float | Gets and sets the rotation of the shape. |
| Hyperlink | Hyperlink | Gets the hyperlink of the shape. |
| Id | int | Gets the identifier of this shape. |
| Spid | String | Specifies an optional string identifier that an application can use to identify the particular shape. |
| Spt | int | Specifies an optional number that an application can use to associate the particular shape with a defined shape type. |
| Worksheet | Worksheet | Gets the Worksheet object which contains this shape. |
| IsGroup | boolean | Indicates whether this shape is a group shape. |
| IsInGroup | boolean | Indicates whether the shape is grouped. |
| IsWordArt | boolean | Indicates whether this shape is a word art. Only for the Legacy Shape of xls file. |
| TextEffect | TextEffectFormat | Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape. Applies to Sh |
| IsLocked | boolean | True means the object can not be modified when the sheet is protected. Note that this value is meaningful only if the wo |
| IsPrintable | boolean | Indicates whether the object is printable. If False, this shape will not be printed when printing. |
| MsoDrawingType | int | Gets drawing type. The value of the property is MsoDrawingType integer constant. |
| AutoShapeType | int | Gets and sets the auto shape type. The value of the property is AutoShapeType integer constant. |
| AnchorType | int | Gets and set the type of the shape anchor placeholder. The value of the property is ShapeAnchorType integer constant. |
| Placement | int | Represents the way the drawing object is attached to the cells below it. The property controls the placement of an objec |
| UpperLeftRow | int | Represents the top row index. If the shape is in the shape or in the group , UpperLeftRow will be ignored. |
| UpperDeltaY | int | Gets or sets the shape’s vertical offset from its upper left corner row. The range of value is 0 to 256. |
| UpperLeftColumn | int | Represents upper left corner column index. |
| UpperDeltaX | int | Gets or sets the shape’s horizontal offset from its upper left corner column. The range of value is 0 to 1024. |
| LowerRightRow | int | Represents lower right corner row index. |
| LowerDeltaY | int | Gets or sets the shape’s vertical offset from its lower right corner row. The range of value is 0 to 256. |
| LowerRightColumn | int | Represents lower right corner column index. |
| LowerDeltaX | int | Gets or sets the shape’s horizontal offset from its lower right corner column. The range of value is 0 to 1024. |
| Right | int | Represents the width of the shape’s horizontal offset from its lower right corner column, in unit of pixels. |
| Bottom | int | Represents the width of the shape’s vertical offset from its lower bottom corner row, in unit of pixels. |
| Width | int | Represents the width of shape, in unit of pixels. |
| WidthInch | float | Represents the width of the shape, in unit of inch. |
| WidthPt | float | Represents the width of the shape, in unit of point. |
| WidthCM | float | Represents the width of the shape, in unit of centimeters. |
| Height | int | Represents the height of shape, in unit of pixel. |
| HeightInch | float | Represents the height of the shape, in unit of inches. |
| HeightPt | float | Represents the height of the shape, in unit of points. |
| HeightCM | float | Represents the height of the shape, in unit of centimeters. |
| Left | int | Represents the horizontal offset of shape from its left column, in unit of pixels. |
| LeftInch | float | Represents the horizontal offset of shape from its left column, in unit of inches. |
| LeftCM | float | Represents the horizontal offset of shape from its left column, in unit of centimeters. |
| Top | int | Represents the vertical offset of shape from its top row, in unit of pixels. If the shape is in the chart, represents th |
| TopInch | float | Represents the vertical offset of shape from its top row, in unit of inches. |
| TopCM | float | Represents the vertical offset of shape from its top row, in unit of centimeters. |
| TopToCorner | int | Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels. |
| LeftToCorner | int | Gets and sets the horizonal offset of shape from worksheet left border. |
| X | int | Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels. |
| Y | int | Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels. |
| WidthScale | int | Gets and sets the width scale, in unit of percent of the original picture width. If the shape is not picture ,the WidthS |
| HeightScale | int | Gets and sets the height scale,in unit of percent of the original picture height. If the shape is not picture ,the Heigh |
| TopInShape | int | Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the pare |
| LeftInShape | int | Represents the horizontal offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the pa |
| WidthInShape | int | Represents the width of the shape, in unit of 1/4000 of the parent shape. Only Applies when this shape in the group or c |
| HeightInShape | int | Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the pare |
| Group | GroupShape | Gets the group shape which contains this shape. |
| Type | int | Gets the auto shape type. The value of the property is AutoShapeType integer constant. |
| 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 | int | 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 | int | Gets and sets the preset text shape type. The value of the property is AutoShapeType integer constant. |
| TextBody | FontSettingCollection | 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 | 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 | int | Gets and sets the text vertical overflow type of the shape which contains text. The value of the property is TextOverflo |
| TextHorizontalOverflow | int | Gets and sets the text horizontal overflow type of the shape which contains text. The value of the property is TextOverf |
| IsTextWrapped | boolean | Gets and sets the text wrapped type of the shape which contains text. |
| TextOrientationType | int | Gets and sets the text orientation type of the shape. The value of the property is TextOrientationType integer constant. |
| TextHorizontalAlignment | int | Gets and sets the text horizontal alignment type of the shape. The value of the property is TextAlignmentType integer co |
| TextVerticalAlignment | int | Gets and sets the text vertical alignment type of the shape. The value of the property is TextAlignmentType integer cons |
| TextDirection | int | Gets/Sets the direction of the text flow for this object. The value of the property is TextDirectionType integer constan |
| TextBoxOptions | TextBoxOptions | |
| ControlData | byte[] | Gets the data of control. |
| Paths | ShapePathCollection | Gets the paths of a custom geometric shape. |
| Geometry | Geometry | Gets the geometry |
| CreateId | UUID | Gets and sets create id for this shape. |
| IsDecorative | boolean | Indicates whether the object is decorative. |
Methods
| Name | Description |
|---|---|
| getEquationParagraph | Get the specified math paragraph from the TextBody property of the TextBox object. Notice: (1) Returns NULL when the ind |
| getLinkedCell | Gets the range linked to the control’s value. |
| setLinkedCell | Sets the range linked to the control’s value. |
| getInputRange | Gets the range used to fill the control. |
| setInputRange | 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 | Formats some characters with the font setting. |
| characters | Returns a Characters object that represents a range of characters within the text. |
This method only works on shape with | | getCharacters | Returns all Characters objects that represents a range of characters within the text .
NOTE: This method is now obsolet | | getRichFormattings | Returns all Characters objects that represents a range of characters within the text . | | removeActiveXControl | Remove activeX control. | | isSameSetting | Returns whether the shape is same. | | getActualBox | Get the actual position and size of the shape (after applying rotation, flip, etc.)
Note:The interface is not fully fun | | fitToTextSize | | | getConnectionPoints | Get the connection points | | toImage | Saves the shape to a file. | | getResultOfSmartArt | Converting smart art to grouped shapes. | | toFrontOrBack | Brings the shape to the front or sends the shape to back. | | getLockedProperty | Gets the value of locked property. | | setLockedProperty | Set the locked property. | | addHyperlink | Adds a hyperlink to the shape. | | removeHyperlink | Removes the hyperlink of the shape. | | moveToRange | Moves the shape to a specified range. | | alignTopRightCorner | Moves the picture to the top-right corner. |
TextBox.MacroName property
Gets and sets the name of macro.
Type: String
TextBox.IsEquation property
Indicates whether the shape only contains an equation.
Type: boolean
TextBox.IsSmartArt property
Indicates whether the shape is a smart art. Only for ooxml file.
Type: boolean
TextBox.ZOrderPosition property
Returns the position of a shape in the z-order.
Type: int
TextBox.Name property
Gets and sets the name of the shape.
Type: String
TextBox.AlternativeText property
Returns or sets the descriptive (alternative) text string of the Shape object.
Type: String
TextBox.Title property
Specifies the title (caption) of the current shape object.
Type: String
TextBox.LineFormat property
Returns a MsoLineFormat object that contains line formatting properties for the specified shape. NOTE: This member is now obsolete. Instead, please use Shape.Line property. This property will be removed 12 months later since July 2016. Aspose apologizes for any inconvenience you may have experienced.
Type: MsoLineFormat
TextBox.FillFormat property
Returns a MsoFillFormat object that contains fill formatting properties for the specified shape. NOTE: This member is now obsolete. Instead, please use Shape.Fill property. This property will be removed 12 months later since July 2016. Aspose apologizes for any inconvenience you may have experienced.
Type: MsoFillFormat
TextBox.Line property
Gets line style
Type: LineFormat
TextBox.Fill property
Returns a FillFormat object that contains fill formatting properties for the specified shape.
Type: FillFormat
TextBox.ShadowEffect property
Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
Type: ShadowEffect
TextBox.Reflection property
Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
Type: ReflectionEffect
TextBox.Glow property
Represents a GlowEffect object that specifies glow effect for the chart element or shape.
Type: GlowEffect
TextBox.SoftEdges property
Gets and sets the radius of blur to apply to the edges, in unit of points.
Type: float
TextBox.ThreeDFormat property
Gets and sets 3d format of the shape.
Type: ThreeDFormat
TextBox.FormatPicture property
Gets and sets the options of the picture format.
Type: MsoFormatPicture
TextBox.IsHidden property
Indicates whether the object is visible.
Type: boolean
TextBox.IsLockAspectRatio property
True means that aspect ratio of the shape is locked. 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.
Type: boolean
TextBox.IsAspectRatioLocked property
True means that aspect ratio of the shape is locked. Only for pictures and Ole Objects.
Type: boolean
TextBox.RotationAngle property
Gets and sets the rotation of the shape.
Type: float
TextBox.Hyperlink property
Gets the hyperlink of the shape.
Type: Hyperlink
TextBox.Id property
Gets the identifier of this shape.
Type: int
TextBox.Spid property
Specifies an optional string identifier that an application can use to identify the particular shape.
Type: String
TextBox.Spt property
Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
Type: int
TextBox.Worksheet property
Gets the Worksheet object which contains this shape.
Type: Worksheet
TextBox.IsGroup property
Indicates whether this shape is a group shape.
Type: boolean
TextBox.IsInGroup property
Indicates whether the shape is grouped.
Type: boolean
TextBox.IsWordArt property
Indicates whether this shape is a word art. Only for the Legacy Shape of xls file.
Type: boolean
TextBox.TextEffect property
Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape. Applies to Shape objects that represent WordArt.
Type: TextEffectFormat
TextBox.IsLocked property
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.
Type: boolean
TextBox.IsPrintable property
Indicates whether the object is printable. If False, this shape will not be printed when printing.
Type: boolean
TextBox.MsoDrawingType property
Gets drawing type. The value of the property is MsoDrawingType integer constant.
Type: int
TextBox.AutoShapeType property
Gets and sets the auto shape type. The value of the property is AutoShapeType integer constant.
Type: int
TextBox.AnchorType property
Gets and set the type of the shape anchor placeholder. The value of the property is ShapeAnchorType integer constant.
Type: int
TextBox.Placement property
Represents the way the drawing object is attached to the cells below it. The property controls the placement of an object on a worksheet. The value of the property is PlacementType integer constant.
Type: int
TextBox.UpperLeftRow property
Represents the top row index. If the shape is in the shape or in the group , UpperLeftRow will be ignored.
Type: int
TextBox.UpperDeltaY property
Gets or sets the shape’s vertical offset from its upper left corner row. The range of value is 0 to 256.
Type: int
TextBox.UpperLeftColumn property
Represents upper left corner column index.
Type: int
TextBox.UpperDeltaX property
Gets or sets the shape’s horizontal offset from its upper left corner column. The range of value is 0 to 1024.
Type: int
TextBox.LowerRightRow property
Represents lower right corner row index.
Type: int
TextBox.LowerDeltaY property
Gets or sets the shape’s vertical offset from its lower right corner row. The range of value is 0 to 256.
Type: int
TextBox.LowerRightColumn property
Represents lower right corner column index.
Type: int
TextBox.LowerDeltaX property
Gets or sets the shape’s horizontal offset from its lower right corner column. The range of value is 0 to 1024.
Type: int
TextBox.Right property
Represents the width of the shape’s horizontal offset from its lower right corner column, in unit of pixels.
Type: int
TextBox.Bottom property
Represents the width of the shape’s vertical offset from its lower bottom corner row, in unit of pixels.
Type: int
TextBox.Width property
Represents the width of shape, in unit of pixels.
Type: int
TextBox.WidthInch property
Represents the width of the shape, in unit of inch.
Type: float
TextBox.WidthPt property
Represents the width of the shape, in unit of point.
Type: float
TextBox.WidthCM property
Represents the width of the shape, in unit of centimeters.
Type: float
TextBox.Height property
Represents the height of shape, in unit of pixel.
Type: int
TextBox.HeightInch property
Represents the height of the shape, in unit of inches.
Type: float
TextBox.HeightPt property
Represents the height of the shape, in unit of points.
Type: float
TextBox.HeightCM property
Represents the height of the shape, in unit of centimeters.
Type: float
TextBox.Left property
Represents the horizontal offset of shape from its left column, in unit of pixels.
Type: int
TextBox.LeftInch property
Represents the horizontal offset of shape from its left column, in unit of inches.
Type: float
TextBox.LeftCM property
Represents the horizontal offset of shape from its left column, in unit of centimeters.
Type: float
TextBox.Top property
Represents the vertical offset of shape from its top row, in unit of pixels. If the shape is in the chart, represents the vertical offset of shape from its top border.
Type: int
TextBox.TopInch property
Represents the vertical offset of shape from its top row, in unit of inches.
Type: float
TextBox.TopCM property
Represents the vertical offset of shape from its top row, in unit of centimeters.
Type: float
TextBox.TopToCorner property
Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
Type: int
TextBox.LeftToCorner property
Gets and sets the horizonal offset of shape from worksheet left border.
Type: int
TextBox.X property
Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
Type: int
TextBox.Y property
Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
Type: int
TextBox.WidthScale property
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;
Type: int
TextBox.HeightScale property
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;
Type: int
TextBox.TopInShape property
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. Only Applies when this shape in the group or chart.
Type: int
TextBox.LeftInShape property
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. Only Applies when this shape in the group or chart.
Type: int
TextBox.WidthInShape property
Represents the width of the shape, in unit of 1/4000 of the parent shape. Only Applies when this shape in the group or chart.
Type: int
TextBox.HeightInShape property
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.. Only Applies when this shape in the group or chart.
Type: int
TextBox.Group property
Gets the group shape which contains this shape.
Type: GroupShape
TextBox.Type property
Gets the auto shape type. The value of the property is AutoShapeType integer constant.
Type: int
TextBox.HasLine property
Gets and sets the line border of the shape is visible.
Type: boolean
TextBox.IsFilled property
Indicates whether the fill format is visible.
Type: boolean
TextBox.IsFlippedHorizontally property
Gets and sets whether shape is horizontally flipped .
Type: boolean
TextBox.IsFlippedVertically property
Gets and sets whether shape is vertically flipped .
Type: boolean
TextBox.ActualLowerRightRow property
Get the actual bottom row.
Type: int
TextBox.RelativeToOriginalPictureSize property
Indicates whether shape is relative to original picture size.
Type: boolean
TextBox.LinkedCell property
Gets or sets the worksheet range linked to the control’s value.
Type: String
TextBox.InputRange property
Gets or sets the worksheet range used to fill the specified combo box.
Type: String
TextBox.TextShapeType property
Gets and sets the preset text shape type. The value of the property is AutoShapeType integer constant.
Type: int
TextBox.TextBody property
Gets and sets the setting of the shape’s text.
Type: FontSettingCollection
TextBox.Font property
Represents the font of shape.
Type: Font
TextBox.TextOptions property
Represents the text options of the shape.
Type: TextOptions
TextBox.Text property
Gets and sets the text of this shape.
Type: String
TextBox.IsRichText property
Whether or not the text is rich text.
Type: boolean
TextBox.HtmlText property
Gets and sets the html string which contains data and some formats in this textbox.
Type: String
TextBox.TextVerticalOverflow property
Gets and sets the text vertical overflow type of the shape which contains text. The value of the property is TextOverflowType integer constant.
Type: int
TextBox.TextHorizontalOverflow property
Gets and sets the text horizontal overflow type of the shape which contains text. The value of the property is TextOverflowType integer constant.
Type: int
TextBox.IsTextWrapped property
Gets and sets the text wrapped type of the shape which contains text.
Type: boolean
TextBox.TextOrientationType property
Gets and sets the text orientation type of the shape. The value of the property is TextOrientationType integer constant.
Type: int
TextBox.TextHorizontalAlignment property
Gets and sets the text horizontal alignment type of the shape. The value of the property is TextAlignmentType integer constant.
Type: int
TextBox.TextVerticalAlignment property
Gets and sets the text vertical alignment type of the shape. The value of the property is TextAlignmentType integer constant.
Type: int
TextBox.TextDirection property
Gets/Sets the direction of the text flow for this object. The value of the property is TextDirectionType integer constant.
Type: int
TextBox.TextBoxOptions property
Type: TextBoxOptions
TextBox.ControlData property
Gets the data of control.
Type: byte[]
TextBox.Paths property
Gets the paths of a custom geometric shape.
Type: ShapePathCollection
TextBox.Geometry property
Gets the geometry
Type: Geometry
TextBox.CreateId property
Gets and sets create id for this shape.
Type: UUID
TextBox.IsDecorative property
Indicates whether the object is decorative.
Type: boolean
getEquationParagraph(index) (1 of 2)
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.
| Parameter | Type | Description |
|---|---|---|
| index | int | The position index of the math paragraph, starting from 0. |
Returns: Returns the math paragraph specified by index.
getEquationParagraph() (2 of 2)
Gets the first math paragraph from the TextBody property of the TextBox object.
Returns: If there has math paragraph, returns the first one, otherwise returns null.
getLinkedCell(isR1C1, isLocal)
Gets the range linked to the control’s value.
| 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(formula, isR1C1, isLocal)
Sets the range linked to the control’s value.
| 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(isR1C1, isLocal)
Gets the range used to fill the control.
| 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(formula, isR1C1, isLocal)
Sets the range used to fill the control.
| 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.
calculateTextSize()
Recalculate the text area
Returns: Text’s Size in an array(width and height).
formatCharacters(startIndex, length, font, flag)
Formats some characters with the font setting.
| Parameter | Type | Description |
|---|---|---|
| startIndex | int | The start index. |
| length | int | The length. |
| font | Font | The font setting. |
| flag | StyleFlag | The flag of the font setting. |
characters(startIndex, length)
Returns a Characters object that represents a range of characters within the text.
This method only works on shape with title.
| Parameter | Type | Description |
|---|---|---|
| startIndex | int | The index of the start of the character. |
| length | int | The number of characters. |
Returns: Characters object.
getCharacters()
Returns all Characters objects that represents a range of characters within the text .
NOTE: This method is now obsolete. Instead, please use Shape.GetRichFormattings() method. This method will be removed 12 months later since November 2023. Aspose apologizes for any inconvenience you may have experienced.
Returns: All Characters objects
getRichFormattings()
Returns all Characters objects that represents a range of characters within the text .
Returns: All Characters objects
removeActiveXControl()
Remove activeX control.
isSameSetting(obj)
Returns whether the shape is same.
| Parameter | Type | Description |
|---|---|---|
| obj | Object |
getActualBox()
Get the actual position and size of the shape (after applying rotation, flip, etc.)
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.
Returns: Return the position and size in the order of x, y, w, h
fitToTextSize()
getConnectionPoints()
Get the connection points
Returns: [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
toImage(imageFile, options)
Saves the shape to a file.
getResultOfSmartArt()
Converting smart art to grouped shapes.
toFrontOrBack(orders)
Brings the shape to the front or sends the shape to back.
| Parameter | Type | Description |
|---|---|---|
| orders | int | If it’s less than zero, sets the shape to back. If it’s greater than zero, brings the shape to front. |
getLockedProperty(type)
Gets the value of locked property.
| Parameter | Type | Description |
|---|---|---|
| type | int | A ShapeLockType value. The type of the shape locked property. |
Returns: Returns the value of locked property.
setLockedProperty(type, value)
Set the locked property.
| Parameter | Type | Description |
|---|---|---|
| type | int | A ShapeLockType value. The locked type. |
| value | boolean | The value of the property. |
addHyperlink(address)
Adds a hyperlink to the shape.
| Parameter | Type | Description |
|---|---|---|
| address | String | Address of the hyperlink. |
Returns: Return the new hyperlink object.
removeHyperlink()
Removes the hyperlink of the shape.
moveToRange(topRow, leftColumn, bottomRow, rightColumn)
Moves the shape to a specified range.
| Parameter | Type | Description |
|---|---|---|
| upperLeftRow | Upper left row index. | |
| upperLeftColumn | Upper left column index. | |
| lowerRightRow | Lower right row index | |
| lowerRightColumn | Lower right column index |
alignTopRightCorner(topRow, rightColumn)
Moves the picture to the top-right corner.
| Parameter | Type | Description |
|---|---|---|
| topRow | int | the row index. |
| rightColumn | int | the column index. |