ArcShape

ArcShape class

Represents the arc shape.

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.
ZOrderPositionNumberReturns 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.
SoftEdgesNumberGets 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.
RotationAngleNumberGets and sets the rotation of the shape.
HyperlinkHyperlinkGets the hyperlink of the shape.
IdNumberGets the identifier of this shape.
SpidStringSpecifies an optional string identifier that an application can use to identify the particular shape.
SptNumberSpecifies 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.
MsoDrawingTypeNumberGets drawing type. The value of the property is MsoDrawingType integer constant.
AutoShapeTypeNumberGets and sets the auto shape type. The value of the property is AutoShapeType integer constant.
AnchorTypeNumberGets and set the type of the shape anchor placeholder. The value of the property is ShapeAnchorType integer constant.
PlacementNumberRepresents the way the drawing object is attached to the cells below it. The property controls the placement of an objec
UpperLeftRowNumberRepresents the top row index. If the shape is in the shape or in the group , UpperLeftRow will be ignored.
UpperDeltaYNumberGets or sets the shape’s vertical offset from its upper left corner row. The range of value is 0 to 256.
UpperLeftColumnNumberRepresents upper left corner column index.
UpperDeltaXNumberGets or sets the shape’s horizontal offset from its upper left corner column. The range of value is 0 to 1024.
LowerRightRowNumberRepresents lower right corner row index.
LowerDeltaYNumberGets or sets the shape’s vertical offset from its lower right corner row. The range of value is 0 to 256.
LowerRightColumnNumberRepresents lower right corner column index.
LowerDeltaXNumberGets or sets the shape’s horizontal offset from its lower right corner column. The range of value is 0 to 1024.
RightNumberRepresents the width of the shape’s horizontal offset from its lower right corner column, in unit of pixels.
BottomNumberRepresents the width of the shape’s vertical offset from its lower bottom corner row, in unit of pixels.
WidthNumberRepresents the width of shape, in unit of pixels.
WidthInchNumberRepresents the width of the shape, in unit of inch.
WidthPtNumberRepresents the width of the shape, in unit of point.
WidthCMNumberRepresents the width of the shape, in unit of centimeters.
HeightNumberRepresents the height of shape, in unit of pixel.
HeightInchNumberRepresents the height of the shape, in unit of inches.
HeightPtNumberRepresents the height of the shape, in unit of points.
HeightCMNumberRepresents the height of the shape, in unit of centimeters.
LeftNumberRepresents the horizontal offset of shape from its left column, in unit of pixels.
LeftInchNumberRepresents the horizontal offset of shape from its left column, in unit of inches.
LeftCMNumberRepresents the horizontal offset of shape from its left column, in unit of centimeters.
TopNumberRepresents the vertical offset of shape from its top row, in unit of pixels. If the shape is in the chart, represents th
TopInchNumberRepresents the vertical offset of shape from its top row, in unit of inches.
TopCMNumberRepresents the vertical offset of shape from its top row, in unit of centimeters.
TopToCornerNumberGets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
LeftToCornerNumberGets and sets the horizonal offset of shape from worksheet left border.
XNumberGets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
YNumberGets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
WidthScaleNumberGets and sets the width scale, in unit of percent of the original picture width. If the shape is not picture ,the WidthS
HeightScaleNumberGets and sets the height scale,in unit of percent of the original picture height. If the shape is not picture ,the Heigh
TopInShapeNumberRepresents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the pare
LeftInShapeNumberRepresents the horizontal offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the pa
WidthInShapeNumberRepresents the width of the shape, in unit of 1/4000 of the parent shape. Only Applies when this shape in the group or c
HeightInShapeNumberRepresents 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.
TypeNumberGets 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 .
ActualLowerRightRowNumberGet 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.
TextShapeTypeNumberGets 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.
TextVerticalOverflowNumberGets and sets the text vertical overflow type of the shape which contains text. The value of the property is TextOverflo
TextHorizontalOverflowNumberGets 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.
TextOrientationTypeNumberGets and sets the text orientation type of the shape. The value of the property is TextOrientationType integer constant.
TextHorizontalAlignmentNumberGets and sets the text horizontal alignment type of the shape. The value of the property is TextAlignmentType integer co
TextVerticalAlignmentNumberGets and sets the text vertical alignment type of the shape. The value of the property is TextAlignmentType integer cons
TextDirectionNumberGets/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. |

ArcShape.MacroName property

Gets and sets the name of macro.

Type: String

ArcShape.IsEquation property

Indicates whether the shape only contains an equation.

Type: boolean

ArcShape.IsSmartArt property

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

Type: boolean

ArcShape.ZOrderPosition property

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

Type: Number

ArcShape.Name property

Gets and sets the name of the shape.

Type: String

ArcShape.AlternativeText property

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

Type: String

ArcShape.Title property

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

Type: String

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

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

ArcShape.Line property

Gets line style

Type: LineFormat

ArcShape.Fill property

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

Type: FillFormat

ArcShape.ShadowEffect property

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

Type: ShadowEffect

ArcShape.Reflection property

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

Type: ReflectionEffect

ArcShape.Glow property

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

Type: GlowEffect

ArcShape.SoftEdges property

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

Type: Number

ArcShape.ThreeDFormat property

Gets and sets 3d format of the shape.

Type: ThreeDFormat

ArcShape.FormatPicture property

Gets and sets the options of the picture format.

Type: MsoFormatPicture

ArcShape.IsHidden property

Indicates whether the object is visible.

Type: boolean

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

ArcShape.IsAspectRatioLocked property

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

Type: boolean

ArcShape.RotationAngle property

Gets and sets the rotation of the shape.

Type: Number

Gets the hyperlink of the shape.

Type: Hyperlink

ArcShape.Id property

Gets the identifier of this shape.

Type: Number

ArcShape.Spid property

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

Type: String

ArcShape.Spt property

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

Type: Number

ArcShape.Worksheet property

Gets the Worksheet object which contains this shape.

Type: Worksheet

ArcShape.IsGroup property

Indicates whether this shape is a group shape.

Type: boolean

ArcShape.IsInGroup property

Indicates whether the shape is grouped.

Type: boolean

ArcShape.IsWordArt property

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

Type: boolean

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

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

ArcShape.IsPrintable property

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

Type: boolean

ArcShape.MsoDrawingType property

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

Type: Number

ArcShape.AutoShapeType property

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

Type: Number

ArcShape.AnchorType property

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

Type: Number

ArcShape.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: Number

ArcShape.UpperLeftRow property

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

Type: Number

ArcShape.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: Number

ArcShape.UpperLeftColumn property

Represents upper left corner column index.

Type: Number

ArcShape.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: Number

ArcShape.LowerRightRow property

Represents lower right corner row index.

Type: Number

ArcShape.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: Number

ArcShape.LowerRightColumn property

Represents lower right corner column index.

Type: Number

ArcShape.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: Number

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

Type: Number

ArcShape.Bottom property

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

Type: Number

ArcShape.Width property

Represents the width of shape, in unit of pixels.

Type: Number

ArcShape.WidthInch property

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

Type: Number

ArcShape.WidthPt property

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

Type: Number

ArcShape.WidthCM property

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

Type: Number

ArcShape.Height property

Represents the height of shape, in unit of pixel.

Type: Number

ArcShape.HeightInch property

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

Type: Number

ArcShape.HeightPt property

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

Type: Number

ArcShape.HeightCM property

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

Type: Number

ArcShape.Left property

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

Type: Number

ArcShape.LeftInch property

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

Type: Number

ArcShape.LeftCM property

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

Type: Number

ArcShape.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: Number

ArcShape.TopInch property

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

Type: Number

ArcShape.TopCM property

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

Type: Number

ArcShape.TopToCorner property

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

Type: Number

ArcShape.LeftToCorner property

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

Type: Number

ArcShape.X property

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

Type: Number

ArcShape.Y property

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

Type: Number

ArcShape.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: Number

ArcShape.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: Number

ArcShape.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: Number

ArcShape.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: Number

ArcShape.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: Number

ArcShape.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: Number

ArcShape.Group property

Gets the group shape which contains this shape.

Type: GroupShape

ArcShape.Type property

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

Type: Number

ArcShape.HasLine property

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

Type: boolean

ArcShape.IsFilled property

Indicates whether the fill format is visible.

Type: boolean

ArcShape.IsFlippedHorizontally property

Gets and sets whether shape is horizontally flipped .

Type: boolean

ArcShape.IsFlippedVertically property

Gets and sets whether shape is vertically flipped .

Type: boolean

ArcShape.ActualLowerRightRow property

Get the actual bottom row.

Type: Number

ArcShape.RelativeToOriginalPictureSize property

Indicates whether shape is relative to original picture size.

Type: boolean

ArcShape.LinkedCell property

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

Type: String

ArcShape.InputRange property

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

Type: String

ArcShape.TextShapeType property

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

Type: Number

ArcShape.TextBody property

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

Type: FontSettingCollection

ArcShape.Font property

Represents the font of shape.

Type: Font

ArcShape.TextOptions property

Represents the text options of the shape.

Type: TextOptions

ArcShape.Text property

Gets and sets the text of this shape.

Type: String

ArcShape.IsRichText property

Whether or not the text is rich text.

Type: boolean

ArcShape.HtmlText property

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

Type: String

ArcShape.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: Number

ArcShape.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: Number

ArcShape.IsTextWrapped property

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

Type: boolean

ArcShape.TextOrientationType property

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

Type: Number

ArcShape.TextHorizontalAlignment property

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

Type: Number

ArcShape.TextVerticalAlignment property

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

Type: Number

ArcShape.TextDirection property

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

Type: Number

ArcShape.TextBoxOptions property

Type: TextBoxOptions

ArcShape.ControlData property

Gets the data of control.

Type: byte[]

ArcShape.Paths property

Gets the paths of a custom geometric shape.

Type: ShapePathCollection

ArcShape.Geometry property

Gets the geometry

Type: Geometry

ArcShape.CreateId property

Gets and sets create id for this shape.

Type: UUID

ArcShape.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
startIndexNumberThe start index.
lengthNumberThe 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
startIndexNumberThe index of the start of the character.
lengthNumberThe 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
ordersNumberIf 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
typeNumberA ShapeLockType value. The type of the shape locked property.

Returns: Returns the value of locked property.

setLockedProperty(type, value)

Set the locked property.

ParameterTypeDescription
typeNumberA 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
topRowNumberthe row index.
rightColumnNumberthe column index.