XlsShape Class |
Namespace: Spire.Xls.Core.Spreadsheet.Shapes
The XlsShape type exposes the following members.
Name | Description | |
---|---|---|
![]() |
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
|
![]() |
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
|
![]() |
AutoSize |
True if the size of the specified object is changed automatically
to fit text within its boundaries.
|
![]() |
BottomRow |
Bottom row.
|
![]() |
BottomRowOffset |
Bottom row offset.
|
![]() |
Fill |
Represents fill properties.
|
![]() |
Glow |
Gets the glow properties.
|
![]() |
HasFill |
Indicates whether XlsFill item was created. Read-only.
|
![]() |
HasLineFormat |
Indicates whether line item was created. Read-only.
|
![]() |
Height |
Height of object.
|
![]() |
HtmlString |
Gets and sets the html string which contains data and some formattings in this shape.
|
![]() |
ID |
ID of object.
|
![]() |
Instance |
Obsolete.
Returns instance value. Read-only.
|
![]() |
IsFlipH |
Returns or sets if the shape flips Horizontal.false is default;
|
![]() |
IsFlipV |
Returns or sets if the shape flips Vertical.false is default;
|
![]() |
IsGroup |
This shape is group shape.
|
![]() |
IsInGroup |
This shape is child shape of group shape.
|
![]() |
IsLockAspectRatio |
True means that don't allow changes in aspect ratio.
|
![]() |
IsLocked |
Gets or sets a value indicating whether the shape is locked.
|
![]() |
IsMoveWithCell |
Determines whether the object moves with the cell it is associated with.
|
![]() |
IsPrintable |
Gets or sets a value indicating whether the shape is printable.
|
![]() |
IsRelative |
Gets or sets a value indicating whether the shape is relative.
|
![]() |
IsRelativeResize |
True means that is relative to original size of picture.
|
![]() |
IsShortVersion |
Obsolete.
Indiicates whether it is short version of the shape
(without obj and maybe some other properties).
|
![]() |
IsSizeWithCell |
Determines whether the size is calculated based on the cell dimensions.
|
![]() |
IsSmartArt |
Determines whether the shape is a SmartArt graphic based on the presence of a linked drawing.
|
![]() |
Left |
X of object
|
![]() |
LeftColumn |
Left column.
|
![]() |
LeftColumnOffset |
Left column offset. 1024 means whole column offset
|
![]() |
Line |
Represents line format properties. Read only.
|
![]() |
LinkedCell |
Gets or sets the linked cell for the shape.
|
![]() |
Name |
Name of object.
|
![]() |
OnAction |
Gets or sets macro-command that is called when action happens.
|
![]() |
Parent |
Reference to Parent object. Read-only.
(Inherited from
XlsObject
.)
|
![]() |
ReferenceCount |
Get quantity of instance references.
(Inherited from
XlsObject
.)
|
![]() |
Reflection |
Gets the reflection effect applied to the shape.
|
![]() |
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)
|
![]() |
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.
|
![]() |
RightColumn |
Right column.
|
![]() |
RightColumnOffset |
Right column offset.
|
![]() |
Rotation |
Returns or sets the rotation of the shape, in degrees.
|
![]() |
Shadow |
Gets the shadow properties.
|
![]() |
ShapeCount |
Obsolete.
Returns number of shapes contained by this shape (1 means no sub shapes). Read-only.
|
![]() |
ShapeId |
Gets / sets shape id.
|
![]() |
ShapeType |
Type of shape , Read Only.
|
![]() |
TextFrame |
Gets the text frame associated with the shape.
|
![]() |
TextVerticalAlignment |
Get or set Text Vertical Alignment in shape.
|
![]() |
ThreeD |
Gets the chart3 D properties.
|
![]() |
Top |
Top of object.
|
![]() |
TopRow |
Top row.
|
![]() |
TopRowOffset |
Top row offset.256 means whole row offset
|
![]() |
UpdatePositions |
Indicates whether we have to update absolute positions after setting TopRow,
BottomRow, LeftColumn, RightColumn.
|
![]() |
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.
|
![]() |
VmlShape |
Indicates whether this is vml shape or not.
|
![]() |
Width |
Width of object.
|
Name | Description | |
---|---|---|
![]() |
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
.)
|
![]() |
ChangeLayer |
Changes the layer position of a shape within a group based on the specified change type.
|
![]() |
CheckDisposed |
Checks whether object was disposed and throws exception if it was.
(Inherited from
XlsObject
.)
|
![]() |
Clone(Object) |
Creates a clone of the current shape.
|
![]() |
Clone(Object, Dictionary String, String , Dictionary Int32, Int32 , Boolean) |
Creates a clone of the current shape.
|
![]() |
Dispose |
Dispose object and free resources.
(Inherited from
XlsObject
.)
|
![]() |
Equals |
Determines whether the specified object is equal to the current object.
(Inherited from
Object
.)
|
![]() |
Finalize |
Destructor. Call dispose method of current object.
(Inherited from
XlsObject
.)
|
![]() |
FindParent(Type) |
This method is used to find parent with specific type.
(Inherited from
XlsObject
.)
|
![]() |
FindParent( Type ) |
Find parent of object.
(Inherited from
XlsObject
.)
|
![]() |
FindParent(Type, Boolean) |
This method is used to find parent with specific type.
(Inherited from
XlsObject
.)
|
![]() |
FindParents |
Finds parent objects.
(Inherited from
XlsObject
.)
|
![]() |
GetHashCode |
Serves as the default hash function.
(Inherited from
Object
.)
|
![]() |
GetType |
Gets the
Type
of the current instance.
(Inherited from
Object
.)
|
![]() |
MemberwiseClone |
Creates a shallow copy of the current
Object
.
(Inherited from
Object
.)
|
![]() |
OnDispose |
Method which can be overriden by users to take any specific actions when
object is disposed.
(Inherited from
XlsObject
.)
|
![]() |
ReleaseReference |
Decrease quantity of Reference. User must call this method
when freeing resources.
(Inherited from
XlsObject
.)
|
![]() |
Remove |
Removes object.
|
![]() |
SaveToImage |
Save shape to image.
|
![]() |
SaveToImage(Stream) |
Save shape to image.
|
![]() |
SaveToImage(String) |
Save shape to image.
|
![]() |
SaveToImage(Stream, ImageFormat) |
Save shape to image.
|
![]() |
SaveToImage(String, ImageFormat) |
Save shape to image.
|
![]() |
Scale |
Scales the shape.
|
![]() |
SetName |
Sets object name
|
![]() |
SetParent |
Sets parent of the object.
(Inherited from
XlsObject
.)
|
![]() |
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.
|
![]() |
SetTextEffect |
Sets the text effect and updates the text for a shape.
|
![]() |
ToString |
Returns a string that represents the current object.
(Inherited from
Object
.)
|
Name | Description | |
---|---|---|
![]() |
m_bIsDisposed |
Flag which indicates if the object was disposed or not.
(Inherited from
XlsObject
.)
|