Shape

Shape class

Represents the msodrawing object.

Properties

NameTypeDescription
MacroNameStringGets and sets the name of macro.
IsEquationbooleanIndicates whether the shape only contains an equation.
IsSmartArtbooleanIndicates whether the shape is a smart art. Only for ooxml file.
ZOrderPositionintReturns the position of a shape in the z-order.
NameStringGets and sets the name of the shape.
AlternativeTextStringReturns or sets the descriptive (alternative) text string of the Shape object.
TitleStringSpecifies the title (caption) of the current shape object.
LineFormatMsoLineFormatReturns a MsoLineFormat object that contains line formatting properties for the specified shape. NOTE: This member is no
FillFormatMsoFillFormatReturns a MsoFillFormat object that contains fill formatting properties for the specified shape. NOTE: This member is no
LineLineFormatGets line style
FillFillFormatReturns a FillFormat object that contains fill formatting properties for the specified shape.
ShadowEffectShadowEffectRepresents a ShadowEffect object that specifies shadow effect for the chart element or shape.
ReflectionReflectionEffectRepresents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
GlowGlowEffectRepresents a GlowEffect object that specifies glow effect for the chart element or shape.
SoftEdgesfloatGets and sets the radius of blur to apply to the edges, in unit of points.
ThreeDFormatThreeDFormatGets and sets 3d format of the shape.
FormatPictureMsoFormatPictureGets and sets the options of the picture format.
IsHiddenbooleanIndicates whether the object is visible.
IsLockAspectRatiobooleanTrue means that aspect ratio of the shape is locked. Only for pictures and Ole Objects. NOTE: This member is now obsolet
IsAspectRatioLockedbooleanTrue means that aspect ratio of the shape is locked. Only for pictures and Ole Objects.
RotationAnglefloatGets and sets the rotation of the shape.
HyperlinkHyperlinkGets the hyperlink of the shape.
IdintGets the identifier of this shape.
SpidStringSpecifies an optional string identifier that an application can use to identify the particular shape.
SptintSpecifies an optional number that an application can use to associate the particular shape with a defined shape type.
WorksheetWorksheetGets the Worksheet object which contains this shape.
IsGroupbooleanIndicates whether this shape is a group shape.
IsInGroupbooleanIndicates whether the shape is grouped.
IsWordArtbooleanIndicates whether this shape is a word art. Only for the Legacy Shape of xls file.
TextEffectTextEffectFormatReturns a TextEffectFormat object that contains text-effect formatting properties for the specified shape. Applies to Sh
IsLockedbooleanTrue means the object can not be modified when the sheet is protected. Note that this value is meaningful only if the wo
IsPrintablebooleanIndicates whether the object is printable. If False, this shape will not be printed when printing.
MsoDrawingTypeintGets drawing type. The value of the property is MsoDrawingType integer constant.
AutoShapeTypeintGets and sets the auto shape type. The value of the property is AutoShapeType integer constant.
AnchorTypeintGets and set the type of the shape anchor placeholder. The value of the property is ShapeAnchorType integer constant.
PlacementintRepresents the way the drawing object is attached to the cells below it. The property controls the placement of an objec
UpperLeftRowintRepresents the top row index. If the shape is in the shape or in the group , UpperLeftRow will be ignored.
UpperDeltaYintGets or sets the shape’s vertical offset from its upper left corner row. The range of value is 0 to 256.
UpperLeftColumnintRepresents upper left corner column index.
UpperDeltaXintGets or sets the shape’s horizontal offset from its upper left corner column. The range of value is 0 to 1024.
LowerRightRowintRepresents lower right corner row index.
LowerDeltaYintGets or sets the shape’s vertical offset from its lower right corner row. The range of value is 0 to 256.
LowerRightColumnintRepresents lower right corner column index.
LowerDeltaXintGets or sets the shape’s horizontal offset from its lower right corner column. The range of value is 0 to 1024.
RightintRepresents the width of the shape’s horizontal offset from its lower right corner column, in unit of pixels.
BottomintRepresents the width of the shape’s vertical offset from its lower bottom corner row, in unit of pixels.
WidthintRepresents the width of shape, in unit of pixels.
WidthInchfloatRepresents the width of the shape, in unit of inch.
WidthPtfloatRepresents the width of the shape, in unit of point.
WidthCMfloatRepresents the width of the shape, in unit of centimeters.
HeightintRepresents the height of shape, in unit of pixel.
HeightInchfloatRepresents the height of the shape, in unit of inches.
HeightPtfloatRepresents the height of the shape, in unit of points.
HeightCMfloatRepresents the height of the shape, in unit of centimeters.
LeftintRepresents the horizontal offset of shape from its left column, in unit of pixels.
LeftInchfloatRepresents the horizontal offset of shape from its left column, in unit of inches.
LeftCMfloatRepresents the horizontal offset of shape from its left column, in unit of centimeters.
TopintRepresents the vertical offset of shape from its top row, in unit of pixels. If the shape is in the chart, represents th
TopInchfloatRepresents the vertical offset of shape from its top row, in unit of inches.
TopCMfloatRepresents the vertical offset of shape from its top row, in unit of centimeters.
TopToCornerintGets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
LeftToCornerintGets and sets the horizonal offset of shape from worksheet left border.
XintGets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
YintGets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
WidthScaleintGets and sets the width scale, in unit of percent of the original picture width. If the shape is not picture ,the WidthS
HeightScaleintGets and sets the height scale,in unit of percent of the original picture height. If the shape is not picture ,the Heigh
TopInShapeintRepresents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the pare
LeftInShapeintRepresents the horizontal offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the pa
WidthInShapeintRepresents the width of the shape, in unit of 1/4000 of the parent shape. Only Applies when this shape in the group or c
HeightInShapeintRepresents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the pare
GroupGroupShapeGets the group shape which contains this shape.
TypeintGets the auto shape type. The value of the property is AutoShapeType integer constant.
HasLinebooleanGets and sets the line border of the shape is visible.
IsFilledbooleanIndicates whether the fill format is visible.
IsFlippedHorizontallybooleanGets and sets whether shape is horizontally flipped .
IsFlippedVerticallybooleanGets and sets whether shape is vertically flipped .
ActualLowerRightRowintGet the actual bottom row.
RelativeToOriginalPictureSizebooleanIndicates whether shape is relative to original picture size.
LinkedCellStringGets or sets the worksheet range linked to the control’s value.
InputRangeStringGets or sets the worksheet range used to fill the specified combo box.
TextShapeTypeintGets and sets the preset text shape type. The value of the property is AutoShapeType integer constant.
TextBodyFontSettingCollectionGets and sets the setting of the shape’s text.
FontFontRepresents the font of shape.
TextOptionsTextOptionsRepresents the text options of the shape.
TextStringGets and sets the text of this shape.
IsRichTextbooleanWhether or not the text is rich text.
HtmlTextStringGets and sets the html string which contains data and some formats in this textbox.
TextVerticalOverflowintGets and sets the text vertical overflow type of the shape which contains text. The value of the property is TextOverflo
TextHorizontalOverflowintGets and sets the text horizontal overflow type of the shape which contains text. The value of the property is TextOverf
IsTextWrappedbooleanGets and sets the text wrapped type of the shape which contains text.
TextOrientationTypeintGets and sets the text orientation type of the shape. The value of the property is TextOrientationType integer constant.
TextHorizontalAlignmentintGets and sets the text horizontal alignment type of the shape. The value of the property is TextAlignmentType integer co
TextVerticalAlignmentintGets and sets the text vertical alignment type of the shape. The value of the property is TextAlignmentType integer cons
TextDirectionintGets/Sets the direction of the text flow for this object. The value of the property is TextDirectionType integer constan
TextBoxOptionsTextBoxOptions
ControlDatabyte[]Gets the data of control.
PathsShapePathCollectionGets the paths of a custom geometric shape.
GeometryGeometryGets the geometry
CreateIdUUIDGets and sets create id for this shape.
IsDecorativebooleanIndicates whether the object is decorative.

Methods

NameDescription
getLinkedCellGets the range linked to the control’s value.
setLinkedCellSets the range linked to the control’s value.
getInputRangeGets the range used to fill the control.
setInputRangeSets the range used to fill the control.
updateSelectedValueUpdate the selected value by the value of the linked cell.
calculateTextSizeRecalculate the text area
formatCharactersFormats some characters with the font setting.
charactersReturns 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. | | toImageBytes | Saves the shape to a byte array. |

Shape.MacroName property

Gets and sets the name of macro.

Type: String

Shape.IsEquation property

Indicates whether the shape only contains an equation.

Type: boolean

Shape.IsSmartArt property

Indicates whether the shape is a smart art. Only for ooxml file.

Type: boolean

Shape.ZOrderPosition property

Returns the position of a shape in the z-order.

Type: int

Shape.Name property

Gets and sets the name of the shape.

Type: String

Shape.AlternativeText property

Returns or sets the descriptive (alternative) text string of the Shape object.

Type: String

Shape.Title property

Specifies the title (caption) of the current shape object.

Type: String

Shape.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

Shape.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

Shape.Line property

Gets line style

Type: LineFormat

Shape.Fill property

Returns a FillFormat object that contains fill formatting properties for the specified shape.

Type: FillFormat

Shape.ShadowEffect property

Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.

Type: ShadowEffect

Shape.Reflection property

Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.

Type: ReflectionEffect

Shape.Glow property

Represents a GlowEffect object that specifies glow effect for the chart element or shape.

Type: GlowEffect

Shape.SoftEdges property

Gets and sets the radius of blur to apply to the edges, in unit of points.

Type: float

Shape.ThreeDFormat property

Gets and sets 3d format of the shape.

Type: ThreeDFormat

Shape.FormatPicture property

Gets and sets the options of the picture format.

Type: MsoFormatPicture

Shape.IsHidden property

Indicates whether the object is visible.

Type: boolean

Shape.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

Shape.IsAspectRatioLocked property

True means that aspect ratio of the shape is locked. Only for pictures and Ole Objects.

Type: boolean

Shape.RotationAngle property

Gets and sets the rotation of the shape.

Type: float

Gets the hyperlink of the shape.

Type: Hyperlink

Shape.Id property

Gets the identifier of this shape.

Type: int

Shape.Spid property

Specifies an optional string identifier that an application can use to identify the particular shape.

Type: String

Shape.Spt property

Specifies an optional number that an application can use to associate the particular shape with a defined shape type.

Type: int

Shape.Worksheet property

Gets the Worksheet object which contains this shape.

Type: Worksheet

Shape.IsGroup property

Indicates whether this shape is a group shape.

Type: boolean

Shape.IsInGroup property

Indicates whether the shape is grouped.

Type: boolean

Shape.IsWordArt property

Indicates whether this shape is a word art. Only for the Legacy Shape of xls file.

Type: boolean

Shape.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

Shape.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

Shape.IsPrintable property

Indicates whether the object is printable. If False, this shape will not be printed when printing.

Type: boolean

Shape.MsoDrawingType property

Gets drawing type. The value of the property is MsoDrawingType integer constant.

Type: int

Shape.AutoShapeType property

Gets and sets the auto shape type. The value of the property is AutoShapeType integer constant.

Type: int

Shape.AnchorType property

Gets and set the type of the shape anchor placeholder. The value of the property is ShapeAnchorType integer constant.

Type: int

Shape.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

Shape.UpperLeftRow property

Represents the top row index. If the shape is in the shape or in the group , UpperLeftRow will be ignored.

Type: int

Shape.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

Shape.UpperLeftColumn property

Represents upper left corner column index.

Type: int

Shape.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

Shape.LowerRightRow property

Represents lower right corner row index.

Type: int

Shape.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

Shape.LowerRightColumn property

Represents lower right corner column index.

Type: int

Shape.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

Represents the width of the shape’s horizontal offset from its lower right corner column, in unit of pixels.

Type: int

Shape.Bottom property

Represents the width of the shape’s vertical offset from its lower bottom corner row, in unit of pixels.

Type: int

Shape.Width property

Represents the width of shape, in unit of pixels.

Type: int

Shape.WidthInch property

Represents the width of the shape, in unit of inch.

Type: float

Shape.WidthPt property

Represents the width of the shape, in unit of point.

Type: float

Shape.WidthCM property

Represents the width of the shape, in unit of centimeters.

Type: float

Shape.Height property

Represents the height of shape, in unit of pixel.

Type: int

Shape.HeightInch property

Represents the height of the shape, in unit of inches.

Type: float

Shape.HeightPt property

Represents the height of the shape, in unit of points.

Type: float

Shape.HeightCM property

Represents the height of the shape, in unit of centimeters.

Type: float

Shape.Left property

Represents the horizontal offset of shape from its left column, in unit of pixels.

Type: int

Shape.LeftInch property

Represents the horizontal offset of shape from its left column, in unit of inches.

Type: float

Shape.LeftCM property

Represents the horizontal offset of shape from its left column, in unit of centimeters.

Type: float

Shape.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

Shape.TopInch property

Represents the vertical offset of shape from its top row, in unit of inches.

Type: float

Shape.TopCM property

Represents the vertical offset of shape from its top row, in unit of centimeters.

Type: float

Shape.TopToCorner property

Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.

Type: int

Shape.LeftToCorner property

Gets and sets the horizonal offset of shape from worksheet left border.

Type: int

Shape.X property

Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.

Type: int

Shape.Y property

Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.

Type: int

Shape.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

Shape.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

Shape.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

Shape.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

Shape.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

Shape.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

Shape.Group property

Gets the group shape which contains this shape.

Type: GroupShape

Shape.Type property

Gets the auto shape type. The value of the property is AutoShapeType integer constant.

Type: int

Shape.HasLine property

Gets and sets the line border of the shape is visible.

Type: boolean

Shape.IsFilled property

Indicates whether the fill format is visible.

Type: boolean

Shape.IsFlippedHorizontally property

Gets and sets whether shape is horizontally flipped .

Type: boolean

Shape.IsFlippedVertically property

Gets and sets whether shape is vertically flipped .

Type: boolean

Shape.ActualLowerRightRow property

Get the actual bottom row.

Type: int

Shape.RelativeToOriginalPictureSize property

Indicates whether shape is relative to original picture size.

Type: boolean

Shape.LinkedCell property

Gets or sets the worksheet range linked to the control’s value.

Type: String

Shape.InputRange property

Gets or sets the worksheet range used to fill the specified combo box.

Type: String

Shape.TextShapeType property

Gets and sets the preset text shape type. The value of the property is AutoShapeType integer constant.

Type: int

Shape.TextBody property

Gets and sets the setting of the shape’s text.

Type: FontSettingCollection

Shape.Font property

Represents the font of shape.

Type: Font

Shape.TextOptions property

Represents the text options of the shape.

Type: TextOptions

Shape.Text property

Gets and sets the text of this shape.

Type: String

Shape.IsRichText property

Whether or not the text is rich text.

Type: boolean

Shape.HtmlText property

Gets and sets the html string which contains data and some formats in this textbox.

Type: String

Shape.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

Shape.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

Shape.IsTextWrapped property

Gets and sets the text wrapped type of the shape which contains text.

Type: boolean

Shape.TextOrientationType property

Gets and sets the text orientation type of the shape. The value of the property is TextOrientationType integer constant.

Type: int

Shape.TextHorizontalAlignment property

Gets and sets the text horizontal alignment type of the shape. The value of the property is TextAlignmentType integer constant.

Type: int

Shape.TextVerticalAlignment property

Gets and sets the text vertical alignment type of the shape. The value of the property is TextAlignmentType integer constant.

Type: int

Shape.TextDirection property

Gets/Sets the direction of the text flow for this object. The value of the property is TextDirectionType integer constant.

Type: int

Shape.TextBoxOptions property

Type: TextBoxOptions

Shape.ControlData property

Gets the data of control.

Type: byte[]

Shape.Paths property

Gets the paths of a custom geometric shape.

Type: ShapePathCollection

Shape.Geometry property

Gets the geometry

Type: Geometry

Shape.CreateId property

Gets and sets create id for this shape.

Type: UUID

Shape.IsDecorative property

Indicates whether the object is decorative.

Type: boolean

getLinkedCell(isR1C1, isLocal)

Gets the range linked to the control’s value.

ParameterTypeDescription
isR1C1booleanWhether the formula needs to be formatted as R1C1.
isLocalbooleanWhether 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.

ParameterTypeDescription
formulaStringThe range linked to the control’s value.
isR1C1booleanWhether the formula needs to be formatted as R1C1.
isLocalbooleanWhether the formula needs to be formatted by locale.

getInputRange(isR1C1, isLocal)

Gets the range used to fill the control.

ParameterTypeDescription
isR1C1booleanWhether the formula needs to be formatted as R1C1.
isLocalbooleanWhether 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.

ParameterTypeDescription
formulaStringThe range used to fill the control.
isR1C1booleanWhether the formula needs to be formatted as R1C1.
isLocalbooleanWhether 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.

ParameterTypeDescription
startIndexintThe start index.
lengthintThe length.
fontFontThe font setting.
flagStyleFlagThe 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.

ParameterTypeDescription
startIndexintThe index of the start of the character.
lengthintThe 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.

ParameterTypeDescription
objObject

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.

ParameterTypeDescription
ordersintIf 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.

ParameterTypeDescription
typeintA ShapeLockType value. The type of the shape locked property.

Returns: Returns the value of locked property.

setLockedProperty(type, value)

Set the locked property.

ParameterTypeDescription
typeintA ShapeLockType value. The locked type.
valuebooleanThe value of the property.

Adds a hyperlink to the shape.

ParameterTypeDescription
addressStringAddress of the hyperlink.

Returns: Return the new hyperlink object.

Removes the hyperlink of the shape.

moveToRange(topRow, leftColumn, bottomRow, rightColumn)

Moves the shape to a specified range.

ParameterTypeDescription
upperLeftRowUpper left row index.
upperLeftColumnUpper left column index.
lowerRightRowLower right row index
lowerRightColumnLower right column index

alignTopRightCorner(topRow, rightColumn)

Moves the picture to the top-right corner.

ParameterTypeDescription
topRowintthe row index.
rightColumnintthe column index.

toImageBytes(options) (1 of 2)

Saves the shape to a byte array.

ParameterTypeDescription
optionsImageOrPrintOptionsAddtional image creation options

Returns: A byte array.

Example:

import jpype
import asposecells
jpype.startJVM()
from asposecells.api import *

wb = Workbook("Book2.xlsx")
shape = wb.getWorksheets().get("Shape").getShapes().get(0)
imgOptions = ImageOrPrintOptions()
imgOptions.setHorizontalResolution(200)
imgOptions.setVerticalResolution(300)
imgOptions.setImageFormat(ImageFormat.getJpeg())
with open("shape1.jpeg", "wb") as w:
    content = shape.toImageBytes(imgOptions)
    w.write(content)

jpype.shutdownJVM()

toImageBytes(imageFormat) (2 of 2)

Creates the shape image and saves it to a byte array in the specified format.

The following formats are supported: .bmp, .gif, .jpg, .jpeg, .tiff, .emf.

ParameterTypeDescription
imageFormatImageFormatThe format in which to save the image

Returns: A byte array.

Example:

import jpype
import asposecells
jpype.startJVM()
from asposecells.api import *

wb = Workbook("Book2.xlsx")
imangeFormatJpeg = ImageFormat.getJpeg()
shape = wb.getWorksheets().get("Shape").getShapes().get(1)
with open("shape2.jpeg", "wb") as w:
    content = shape.toImageBytes(imangeFormatJpeg)
    w.write(content)

jpype.shutdownJVM()