XlsShape module

class XlsShape.XlsShape

Bases: XlsObject, IShape, ICloneParent, INamedObject

property AlternativeText: str

<summary>: Returns or sets the descriptive (alternative) text string for a Shape object when the object is saved to a Web page. Read/write String

</summary>

property AlternativeTextTitle: str

<summary>: 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

</summary>

property AutoSize: bool

property BottomRow: int

<summary>: Bottom row.

</summary>

property BottomRowOffset: int

<summary>: Bottom row offset.

</summary>

ChangeLayer(changeType: ShapeLayerChangeType)

Clone

<summary>: Creates a clone of the current shape.

</summary> <param name=”parent”>New parent for the shape object.</param> <returns>A copy of the current shape.</returns>

property Fill: IShapeFill

<summary>: Represents fill properties.

</summary>

property Glow: IGlow

property HasFill: bool

property HasLineFormat: bool

property Height: int

<summary>: Height of object.

</summary>

property HtmlString: str

<summary>: Gets and sets the html string which contains data and some formattings in this shape.

</summary>

property ID: int

property Instance: int

property IsFlipH: bool

<summary>: Returns or sets if the shape flips Horizontal.false is default;

</summary>

property IsFlipV: bool

<summary>: Returns or sets if the shape flips Vertical.false is default;

</summary>

property IsGroup: bool

<summary>: This shape is group shape.

</summary>

property IsInGroup: bool

<summary>: This shape is child shape of group shape.

</summary>

property IsLockAspectRatio: bool

property IsLocked: bool

property IsPrintable: bool

property IsRelative: bool

property IsRelativeResize: bool

<summary>: True means that is relative to original size of picture.

</summary>

property IsShortVersion: bool

property IsSmartArt: bool

property Left: int

property LeftColumn: int

<summary>: Left column.

</summary>

property LeftColumnOffset: int

<summary>: Left column offset. 1024 means whole column offset

</summary>

property Line: IShapeLineFormat

property LinkedCell: IXLSRange

property Name: str

property OnAction: str

property Reflection: IReflectionEffect

Remove

<summary>: Removes object.

</summary>

property ResizeBehave: ResizeBehaveType

<summary>: 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)

</summary>

property RichText: IRichTextString

property RightColumn: int

<summary>: Right column.

</summary>

property RightColumnOffset: int

<summary>: Right column offset.

</summary>

property Rotation: int

<summary>: Returns or sets the rotation of the shape, in degrees.

</summary>

SaveToImage

<summary>: Save shape to image.

</summary> <param name=”fileStream”>Output stream. It is ignored if null.</param>

Scale(scaleWidth: int, scaleHeight: int)

<summary>: Scales the shape.

</summary> <param name=”scaleWidth”>Width scale in percent.</param> <param name=”scaleHeight”>Height scale in percent.</param>

SetName(name: str)

SetTextEffect(effect: PresetTextEffect, text: str)

property Shadow: IShadow

property ShapeCount: int

property ShapeId: int

property ShapeType: ExcelShapeType

<summary>: Type of shape , Read Only.

</summary>

property TextFrame: ITextFrame

property TextVerticalAlignment: ExcelVerticalAlignment

property ThreeD: IFormat3D

property Top: int

property TopRow: int

<summary>: Top row.

</summary>

property TopRowOffset: int

<summary>: Top row offset.256 means whole row offset

</summary>

property UpdatePositions: bool

property Visible: bool

property VmlShape: bool

property Width: int

<summary>: Width of object.

</summary>