Click or drag to resize

XlsShape Class

Represents an Excel shape.
Inheritance Hierarchy
System Object
Spire.Xls.Core.Spreadsheet XlsObject
Spire.Xls.Core.Spreadsheet.Shapes XlsShape
More...

Namespace: Spire.Xls.Core.Spreadsheet.Shapes
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
public class XlsShape : XlsObject, IShape, 
	IExcelApplication, IDisposable, ICloneParent, INamedObject

The XlsShape 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
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
Public property AutoSize
True if the size of the specified object is changed automatically to fit text within its boundaries.
Public property BottomRow
Bottom row.
Public property BottomRowOffset
Bottom row offset.
Public property Fill
Represents fill properties.
Public property Glow
Gets the glow properties.
Public property HasFill
Indicates whether XlsFill item was created. Read-only.
Public property HasLineFormat
Indicates whether line item was created. Read-only.
Public property Height
Height of object.
Public property HtmlString
Gets and sets the html string which contains data and some formattings in this shape.
Public property ID
ID of object.
Public property Instance Obsolete.
Returns instance value. Read-only.
Public property IsFlipH
Returns or sets if the shape flips Horizontal.false is default;
Public property IsFlipV
Returns or sets if the shape flips Vertical.false is default;
Public property IsGroup
This shape is group shape.
Public property IsInGroup
This shape is child shape of group shape.
Public property IsLockAspectRatio
True means that don't allow changes in aspect ratio.
Public property IsLocked
Gets or sets a value indicating whether the shape is locked.
Protected property IsMoveWithCell
Determines whether the object moves with the cell it is associated with.
Public property IsPrintable
Gets or sets a value indicating whether the shape is printable.
Public property IsRelative
Gets or sets a value indicating whether the shape is relative.
Public property IsRelativeResize
True means that is relative to original size of picture.
Public property IsShortVersion Obsolete.
Indiicates whether it is short version of the shape (without obj and maybe some other properties).
Protected property IsSizeWithCell
Determines whether the size is calculated based on the cell dimensions.
Public property IsSmartArt
Determines whether the shape is a SmartArt graphic based on the presence of a linked drawing.
Public property Left
X of object
Public property LeftColumn
Left column.
Public property LeftColumnOffset
Left column offset. 1024 means whole column offset
Public property Line
Represents line format properties. Read only.
Public property LinkedCell
Gets or sets the linked cell for the shape.
Public property Name
Name of object.
Public property OnAction
Gets or sets macro-command that is called when action happens.
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.
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)
Public property RichText
Gets the rich text string associated with the current object. If the rich text string has not been initialized, it creates a new instance of RichTextShape.
Public property RightColumn
Right column.
Public property RightColumnOffset
Right column offset.
Public property Rotation
Returns or sets the rotation of the shape, in degrees.
Public property Shadow
Gets the shadow properties.
Public property ShapeCount Obsolete.
Returns number of shapes contained by this shape (1 means no sub shapes). Read-only.
Public property ShapeId
Gets / sets shape id.
Public property ShapeType
Type of shape , Read Only.
Public property TextFrame
Gets the text frame associated with the shape.
Public property TextVerticalAlignment
Get or set Text Vertical Alignment in shape.
Public property ThreeD
Gets the chart3 D properties.
Public property Top
Top of object.
Public property TopRow
Top row.
Public property TopRowOffset
Top row offset.256 means whole row offset
Public property UpdatePositions
Indicates whether we have to update absolute positions after setting TopRow, BottomRow, LeftColumn, RightColumn.
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.
Public property VmlShape
Indicates whether this is vml shape or not.
Public property Width
Width of object.
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.
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.
Public method Clone(Object, Dictionary String, String , Dictionary Int32, Int32 , Boolean)
Creates a clone of the current shape.
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.
Public method SaveToImage
Save shape to image.
Public method SaveToImage(Stream)
Save shape to image.
Public method SaveToImage(String)
Save shape to image.
Public method SaveToImage(Stream, ImageFormat)
Save shape to image.
Public method SaveToImage(String, ImageFormat)
Save shape to image.
Public method Scale
Scales the shape.
Public method SetName
Sets object name
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.
Public method SetTextEffect
Sets the text effect and updates the text for a shape.
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
Inheritance Hierarchy
System Object
Spire.Xls.Core.Spreadsheet XlsObject
Spire.Xls.Core.Spreadsheet.Shapes XlsShape
Spire.Xls.Core.MergeSpreadsheet GroupShape
Spire.Xls.Core.Spreadsheet.Shapes XlsBitmapShape
Spire.Xls.Core.Spreadsheet.Shapes XlsButtonShape
Spire.Xls.Core.Spreadsheet.Shapes XlsChartShape
Spire.Xls.Core.Spreadsheet.Shapes XlsCheckBoxShape
Spire.Xls.Core.Spreadsheet.Shapes XlsComboBoxShape
Spire.Xls.Core.Spreadsheet.Shapes XlsComment
Spire.Xls.Core.Spreadsheet.Shapes XlsGroupBoxShape
Spire.Xls.Core.Spreadsheet.Shapes XlsLabelShape
Spire.Xls.Core.Spreadsheet.Shapes XlsListBoxShape
Spire.Xls.Core.Spreadsheet.Shapes XlsOvalShape
Spire.Xls.Core.Spreadsheet.Shapes XlsPrstGeomShape
Spire.Xls.Core.Spreadsheet.Shapes XlsRadioButtonShape
Spire.Xls.Core.Spreadsheet.Shapes XlsScrollBarShape
Spire.Xls.Core.Spreadsheet.Shapes XlsSpinnerShape
Spire.Xls.Core.Spreadsheet.Shapes XlsTextBoxShape