Click or drag to resize

XlsButtonShape Class

Represents a button shape within an Excel worksheet, allowing for interactive elements like clickable buttons.
Inheritance Hierarchy
System Object
Spire.Xls.Core.Spreadsheet XlsObject
Spire.Xls.Core.Spreadsheet.Shapes XlsShape
Spire.Xls.Core.Spreadsheet.Shapes XlsButtonShape

Namespace: Spire.Xls.Core.Spreadsheet.Shapes
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
Copy 
public class XlsButtonShape : XlsShape, 
	IButtonShape, IShape, IExcelApplication, ITextBox

The XlsButtonShape type exposes the following members.

Properties
Name Description
Public property AlternativeText
Returns or sets the descriptive (alternative) text string for a Shape object when the object is saved to a Web page. Read/write String
(Inherited from XlsShape .)
Public property AlternativeTextTitle
Returns or sets the descriptive (alternative) text title string for a Shape object when the object is saved to a Web page. Read/write String
(Inherited from XlsShape .)
Public property AutoSize
True if the size of the specified object is changed automatically to fit text within its boundaries.
(Inherited from XlsShape .)
Public property BottomRow
Bottom row.
(Inherited from XlsShape .)
Public property BottomRowOffset
Bottom row offset.
(Inherited from XlsShape .)
Public property Fill
Represents fill properties.
(Inherited from XlsShape .)
Public property Glow
Gets the glow properties.
(Inherited from XlsShape .)
Public property HAlignment
Gets or sets the horizontal alignment of the comment text.
Public property HasFill
Indicates whether XlsFill item was created. Read-only.
(Inherited from XlsShape .)
Public property HasLineFormat
Indicates whether line item was created. Read-only.
(Inherited from XlsShape .)
Public property Height
Height of object.
(Inherited from XlsShape .)
Public property HtmlString
Gets and sets the html string which contains data and some formattings in this shape.
(Inherited from XlsShape .)
Public property ID
ID of object.
(Inherited from XlsShape .)
Public property Instance Obsolete.
Returns instance value. Read-only.
(Inherited from XlsShape .)
Public property IsFlipH
Returns or sets if the shape flips Horizontal.false is default;
(Inherited from XlsShape .)
Public property IsFlipV
Returns or sets if the shape flips Vertical.false is default;
(Inherited from XlsShape .)
Public property IsGroup
This shape is group shape.
(Inherited from XlsShape .)
Public property IsInGroup
This shape is child shape of group shape.
(Inherited from XlsShape .)
Public property IsLockAspectRatio
True means that don't allow changes in aspect ratio.
(Inherited from XlsShape .)
Public property IsLocked
Gets or sets a value indicating whether the shape is locked.
(Inherited from XlsShape .)
Protected property IsMoveWithCell
Determines whether the object moves with the cell it is associated with.
(Inherited from XlsShape .)
Public property IsPrintable
Gets or sets a value indicating whether the shape is printable.
(Inherited from XlsShape .)
Public property IsRelative
Gets or sets a value indicating whether the shape is relative.
(Inherited from XlsShape .)
Public property IsRelativeResize
True means that is relative to original size of picture.
(Inherited from XlsShape .)
Public property IsShortVersion Obsolete.
Indiicates whether it is short version of the shape (without obj and maybe some other properties).
(Inherited from XlsShape .)
Protected property IsSizeWithCell
Determines whether the size is calculated based on the cell dimensions.
(Inherited from XlsShape .)
Public property IsSmartArt
Determines whether the shape is a SmartArt graphic based on the presence of a linked drawing.
(Inherited from XlsShape .)
Public property IsTextLocked
Gets or sets a value indicating whether the text of the shape is locked.
Public property Left
X of object
(Inherited from XlsShape .)
Public property LeftColumn
Left column.
(Inherited from XlsShape .)
Public property LeftColumnOffset
Left column offset. 1024 means whole column offset
(Inherited from XlsShape .)
Public property Line
Represents line format properties. Read only.
(Inherited from XlsShape .)
Public property LinkedCell
Gets or sets the linked cell for the shape.
(Inherited from XlsShape .)
Public property Name
Name of object.
(Inherited from XlsShape .)
Public property OnAction
Gets or sets macro-command that is called when action happens.
(Inherited from XlsShape .)
Public property Parent
Reference to Parent object. Read-only.
(Inherited from XlsObject .)
Protected property ReferenceCount
Get quantity of instance references.
(Inherited from XlsObject .)
Public property Reflection
Gets the reflection effect applied to the shape.
(Inherited from XlsShape .)
Public property ResizeBehave
Specifies all possible settings for how drawing object shall be resized when the rows and columns between its start and ending anchor are resized or inserted(ComboBoxShape and CheckBoxShape and RadioButtonShape set MoveAndResize type value is invalid)
(Inherited from XlsShape .)
Public property RichText
Gets the rich text string associated with the current instance. If the rich text string is not already initialized, it creates a new instance of RichTextShape.
Public property RightColumn
Right column.
(Inherited from XlsShape .)
Public property RightColumnOffset
Right column offset.
(Inherited from XlsShape .)
Public property Rotation
Returns or sets the rotation of the shape, in degrees.
(Inherited from XlsShape .)
Public property Shadow
Gets the shadow properties.
(Inherited from XlsShape .)
Public property ShapeCount Obsolete.
Returns number of shapes contained by this shape (1 means no sub shapes). Read-only.
(Inherited from XlsShape .)
Public property ShapeId
Gets / sets shape id.
(Inherited from XlsShape .)
Public property ShapeType
Gets the type of the Excel shape, which is always a Button.
Public property Text
Gets or sets the text of the shape.
Public property TextFrame
Gets the text frame associated with the shape.
(Inherited from XlsShape .)
Public property TextRotation
Gets or sets the rotation type of the text.
Public property TextVerticalAlignment
Get or set Text Vertical Alignment in shape.
(Inherited from XlsShape .)
Public property ThreeD
Gets the chart3 D properties.
(Inherited from XlsShape .)
Public property Top
Top of object.
(Inherited from XlsShape .)
Public property TopRow
Top row.
(Inherited from XlsShape .)
Public property TopRowOffset
Top row offset.256 means whole row offset
(Inherited from XlsShape .)
Public property UpdatePositions
Indicates whether we have to update absolute positions after setting TopRow, BottomRow, LeftColumn, RightColumn.
(Inherited from XlsShape .)
Public property VAlignment
Gets or sets the vertical alignment of the comment.
Public property Visible
Gets or sets the visibility of the shape. When set to true, the shape is visible; when set to false, the shape is hidden.
(Inherited from XlsShape .)
Public property VmlShape
Indicates whether this is vml shape or not.
(Inherited from XlsShape .)
Public property Width
Width of object.
(Inherited from XlsShape .)
Top
Methods
Name Description
Protected method AddReference
Increase the quantity of reference. User must use this method when new wrapper on object is created or reference on object stored.
(Inherited from XlsObject .)
Public method ChangeLayer
Changes the layer position of a shape within a group based on the specified change type.
(Inherited from XlsShape .)
Protected method CheckDisposed
Checks whether object was disposed and throws exception if it was.
(Inherited from XlsObject .)
Public method Clone(Object)
Creates a clone of the current shape.
(Inherited from XlsShape .)
Public method Clone(Object, Dictionary String, String , Dictionary Int32, Int32 , Boolean) (Overrides XlsShape Clone(Object, Dictionary String, String , Dictionary Int32, Int32 , Boolean) .)
Public method Dispose
Dispose object and free resources.
(Inherited from XlsObject .)
Public method Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object .)
Protected method Finalize
Destructor. Call dispose method of current object.
(Inherited from XlsObject .)
Protected method FindParent(Type)
This method is used to find parent with specific type.
(Inherited from XlsObject .)
Protected method FindParent( Type )
Find parent of object.
(Inherited from XlsObject .)
Protected method FindParent(Type, Boolean)
This method is used to find parent with specific type.
(Inherited from XlsObject .)
Protected method FindParents
Finds parent objects.
(Inherited from XlsObject .)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object .)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Protected method MemberwiseClone
Creates a shallow copy of the current Object .
(Inherited from Object .)
Protected method OnDispose
Method which can be overriden by users to take any specific actions when object is disposed.
(Inherited from XlsObject .)
Protected method ReleaseReference
Decrease quantity of Reference. User must call this method when freeing resources.
(Inherited from XlsObject .)
Public method Remove
Removes object.
(Inherited from XlsShape .)
Public method SaveToImage
Save shape to image.
(Inherited from XlsShape .)
Public method SaveToImage(Stream)
Save shape to image.
(Inherited from XlsShape .)
Public method SaveToImage(String)
Save shape to image.
(Inherited from XlsShape .)
Public method SaveToImage(Stream, ImageFormat)
Save shape to image.
(Inherited from XlsShape .)
Public method SaveToImage(String, ImageFormat)
Save shape to image.
(Inherited from XlsShape .)
Public method Scale
Scales the shape.
(Inherited from XlsShape .)
Public method SetName
Sets object name
(Inherited from XlsShape .)
Protected method SetParent
Sets parent of the object.
(Inherited from XlsObject .)
Protected method SetParents
Sets the parent shapes collection for the current object by searching for a parent of type XlsShapesCollection. Throws an ArgumentNullException if the parent collection is not found.
(Inherited from XlsShape .)
Public method SetTextEffect
Sets the text effect and updates the text for a shape.
(Inherited from XlsShape .)
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)
Top
Fields
Name Description
Protected field m_bIsDisposed
Flag which indicates if the object was disposed or not.
(Inherited from XlsObject .)
Top
See Also