Property Getters/Setters Summary | ||
---|---|---|
function | getActualLowerRightRow() | |
Get the actual bottom row.
|
||
function | getAlternativeText() | |
function | setAlternativeText(value) | |
Returns or sets the descriptive (alternative) text string of the |
||
function | getAnchorType() | |
function | setAnchorType(value) | |
Gets and set the type of the shape anchor placeholder. The value of the property is ShapeAnchorType integer constant. | ||
function | getAutoShapeType() | |
function | setAutoShapeType(value) | |
Gets and sets the auto shape type. The value of the property is AutoShapeType integer constant. | ||
function | getBottom() | |
function | setBottom(value) | |
Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels. | ||
function | getControlData() | |
Gets the data of control.
|
||
function | getCreateId() | |
function | setCreateId(value) | |
Gets and sets create id for this shape. | ||
function | getCurrentValue() | |
function | setCurrentValue(value) | |
Gets or sets the current value. | ||
function | getFill() | |
Returns a |
||
function | getFillFormat() | |
Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
|
||
function | getFont() | |
function | setFont(value) | |
Represents the font of shape. | ||
function | getFormatPicture() | |
Gets and sets the options of the picture format.
|
||
function | getGeometry() | |
Gets the geometry
|
||
function | getGlow() | |
Represents a |
||
function | getGroup() | |
Gets the group shape which contains this shape.
|
||
function | hasLine() | |
function | setHasLine(value) | |
Gets and sets the line border of the shape is visible. | ||
function | getHeight() | |
function | setHeight(value) | |
Represents the height of shape, in unit of pixel. | ||
function | getHeightCM() | |
function | setHeightCM(value) | |
Represents the height of the shape, in unit of centimeters. | ||
function | getHeightInch() | |
function | setHeightInch(value) | |
Represents the height of the shape, in unit of inches. | ||
function | getHeightInShape() | |
function | setHeightInShape(value) | |
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.. | ||
function | getHeightPt() | |
function | setHeightPt(value) | |
Represents the height of the shape, in unit of points. | ||
function | getHeightScale() | |
function | setHeightScale(value) | |
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; | ||
function | getHtmlText() | |
function | setHtmlText(value) | |
Gets and sets the html string which contains data and some formats in this textbox. | ||
function | getHyperlink() | |
Gets the hyperlink of the shape.
|
||
function | getId() | |
Gets the identifier of this shape.
|
||
function | getIncrementalChange() | |
function | setIncrementalChange(value) | |
Gets or sets the amount that the scroll bar or spinner is incremented a line scroll. | ||
function | getInputRange() | |
function | setInputRange(value) | |
Gets or sets the worksheet range used to fill the specified combo box. | ||
function | isAspectRatioLocked() | |
function | setAspectRatioLocked(value) | |
True means that aspect ratio of the shape is locked. | ||
function | isEquation() | |
Indicates whether the shape only contains an equation.
|
||
function | isFilled() | |
function | setFilled(value) | |
Indicates whether the fill format is visible. | ||
function | isFlippedHorizontally() | |
function | setFlippedHorizontally(value) | |
Gets and sets whether shape is horizontally flipped . | ||
function | isFlippedVertically() | |
function | setFlippedVertically(value) | |
Gets and sets whether shape is vertically flipped . | ||
function | isGroup() | |
Indicates whether this shape is a group shape.
|
||
function | isHidden() | |
function | setHidden(value) | |
Indicates whether the object is visible. | ||
function | isHorizontal() | |
function | setHorizontal(value) | |
Indicates whether this is a horizontal scroll bar. | ||
function | isInGroup() | |
Indicates whether the shape is grouped.
|
||
function | isLockAspectRatio() | |
function | setLockAspectRatio(value) | |
True means that aspect ratio of the shape is locked. | ||
function | isLocked() | |
function | setLocked(value) | |
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. | ||
function | isPrintable() | |
function | setPrintable(value) | |
Indicates whether the object is printable. If False, this shape will not be printed when printing. | ||
function | isRichText() | |
Whether or not the text is rich text.
|
||
function | isSmartArt() | |
Indicates whether the shape is a smart art.
|
||
function | isTextWrapped() | |
function | setTextWrapped(value) | |
Gets and sets the text wrapped type of the shape which contains text. | ||
function | isWordArt() | |
Indicates whether this shape is a word art.
|
||
function | getLeft() | |
function | setLeft(value) | |
Represents the horizontal offset of shape from its left column, in unit of pixels. | ||
function | getLeftCM() | |
function | setLeftCM(value) | |
Represents the horizontal offset of shape from its left column, in unit of centimeters. | ||
function | getLeftInch() | |
function | setLeftInch(value) | |
Represents the horizontal offset of shape from its left column, in unit of inches. | ||
function | getLeftInShape() | |
function | setLeftInShape(value) | |
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. | ||
function | getLeftToCorner() | |
function | setLeftToCorner(value) | |
Gets and sets the horizonal offset of shape from worksheet left border. | ||
function | getLine() | |
Gets line style
|
||
function | getLineFormat() | |
Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
|
||
function | getLinkedCell() | |
function | setLinkedCell(value) | |
Gets or sets the worksheet range linked to the control's value. | ||
function | getLowerDeltaX() | |
function | setLowerDeltaX(value) | |
Gets or sets the shape's horizontal offset from its lower right corner column. | ||
function | getLowerDeltaY() | |
function | setLowerDeltaY(value) | |
Gets or sets the shape's vertical offset from its lower right corner row. | ||
function | getLowerRightColumn() | |
function | setLowerRightColumn(value) | |
Represents lower right corner column index. | ||
function | getLowerRightRow() | |
function | setLowerRightRow(value) | |
Represents lower right corner row index. | ||
function | getMacroName() | |
function | setMacroName(value) | |
Gets and sets the name of macro. | ||
function | getMax() | |
function | setMax(value) | |
Gets or sets the maximum value of a scroll bar or spinner range. | ||
function | getMin() | |
function | setMin(value) | |
Gets or sets the minimum value of a scroll bar or spinner range. | ||
function | getMsoDrawingType() | |
Gets drawing type.
The value of the property is MsoDrawingType integer constant. |
||
function | getName() | |
function | setName(value) | |
Gets and sets the name of the shape. | ||
function | getPageChange() | |
function | setPageChange(value) | |
Gets or sets page change | ||
function | getPaths() | |
Gets the paths of a custom geometric shape.
|
||
function | getPlacement() | |
function | setPlacement(value) | |
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. | ||
function | getReflection() | |
Represents a |
||
function | getRelativeToOriginalPictureSize() | |
function | ||
Indicates whether shape is relative to original picture size. | ||
function | getRight() | |
function | setRight(value) | |
Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels. | ||
function | getRotationAngle() | |
function | setRotationAngle(value) | |
Gets and sets the rotation of the shape. | ||
function | getShadow() | |
function | setShadow(value) | |
Indicates whether the shape has 3-D shading. | ||
function | getShadowEffect() | |
Represents a |
||
function | getSoftEdges() | |
function | setSoftEdges(value) | |
Gets and sets the radius of blur to apply to the edges, in unit of points. | ||
function | getSpid() | |
Specifies an optional string identifier that an application can use to identify the particular shape.
|
||
function | getSpt() | |
Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
|
||
function | getText() | |
function | setText(value) | |
Gets and sets the text of this shape. | ||
function | getTextBody() | |
Gets and sets the setting of the shape's text.
|
||
function | getTextDirection() | |
function | setTextDirection(value) | |
Gets/Sets the direction of the text flow for this object. The value of the property is TextDirectionType integer constant. | ||
function | getTextEffect() | |
Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
Applies to Shape objects that represent WordArt.
|
||
function | getTextHorizontalAlignment() | |
function | setTextHorizontalAlignment(value) | |
Gets and sets the text horizontal alignment type of the shape. The value of the property is TextAlignmentType integer constant. | ||
function | getTextHorizontalOverflow() | |
function | setTextHorizontalOverflow(value) | |
Gets and sets the text horizontal overflow type of the shape which contains text. The value of the property is TextOverflowType integer constant. | ||
function | getTextOptions() | |
function | setTextOptions(value) | |
Represents the text options of the shape. | ||
function | getTextOrientationType() | |
function | setTextOrientationType(value) | |
Gets and sets the text orientation type of the shape. The value of the property is TextOrientationType integer constant. | ||
function | getTextShapeType() | |
function | setTextShapeType(value) | |
Gets and sets the preset text shape type. The value of the property is AutoShapeType integer constant. | ||
function | getTextVerticalAlignment() | |
function | setTextVerticalAlignment(value) | |
Gets and sets the text vertical alignment type of the shape. The value of the property is TextAlignmentType integer constant. | ||
function | getTextVerticalOverflow() | |
function | setTextVerticalOverflow(value) | |
Gets and sets the text vertical overflow type of the shape which contains text. The value of the property is TextOverflowType integer constant. | ||
function | getThreeDFormat() | |
Gets and sets 3d format of the shape.
|
||
function | getTitle() | |
function | setTitle(value) | |
Specifies the title (caption) of the current shape object. | ||
function | getTop() | |
function | setTop(value) | |
Represents the vertical offset of shape from its top row, in unit of pixels. | ||
function | getTopCM() | |
function | setTopCM(value) | |
Represents the vertical offset of shape from its top row, in unit of centimeters. | ||
function | getTopInch() | |
function | setTopInch(value) | |
Represents the vertical offset of shape from its top row, in unit of inches. | ||
function | getTopInShape() | |
function | setTopInShape(value) | |
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. | ||
function | getTopToCorner() | |
function | setTopToCorner(value) | |
Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels. | ||
function | getType() | |
Gets the auto shape type.
The value of the property is AutoShapeType integer constant. |
||
function | getUpperDeltaX() | |
function | setUpperDeltaX(value) | |
Gets or sets the shape's horizontal offset from its upper left corner column. | ||
function | getUpperDeltaY() | |
function | setUpperDeltaY(value) | |
Gets or sets the shape's vertical offset from its upper left corner row. | ||
function | getUpperLeftColumn() | |
function | setUpperLeftColumn(value) | |
Represents upper left corner column index. | ||
function | getUpperLeftRow() | |
function | setUpperLeftRow(value) | |
Represents the top row index. | ||
function | getWidth() | |
function | setWidth(value) | |
Represents the width of shape, in unit of pixels. | ||
function | getWidthCM() | |
function | setWidthCM(value) | |
Represents the width of the shape, in unit of centimeters. | ||
function | getWidthInch() | |
function | setWidthInch(value) | |
Represents the width of the shape, in unit of inch. | ||
function | getWidthInShape() | |
function | setWidthInShape(value) | |
Represents the width of the shape, in unit of 1/4000 of the parent shape. | ||
function | getWidthPt() | |
function | setWidthPt(value) | |
Represents the width of the shape, in unit of point. | ||
function | getWidthScale() | |
function | setWidthScale(value) | |
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; | ||
function | getWorksheet() | |
Gets the |
||
function | getX() | |
function | setX(value) | |
Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels. | ||
function | getY() | |
function | setY(value) | |
Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels. | ||
function | getZOrderPosition() | |
function | setZOrderPosition(value) | |
Returns the position of a shape in the z-order. |
Method Summary | ||
---|---|---|
function | addHyperlink(address) | |
Adds a hyperlink to the shape.
|
||
function | alignTopRightCorner(topRow, rightColumn) | |
Moves the picture to the top-right corner.
|
||
function | calculateTextSize() | |
Recalculate the text area
|
||
function | characters(startIndex, length) | |
Returns a Characters object that represents a range of characters within the text.
|
||
function | formatCharacters(startIndex, length, font, flag) | |
Formats some characters with the font setting.
|
||
function | getActualBox() | |
Get the actual position and size of the shape (after applying rotation, flip, etc.)
|
||
function | getCharacters() | |
Returns all Characters objects
that represents a range of characters within the text .
|
||
function | getConnectionPoints() | |
Get the connection points
|
||
function | getInputRange(isR1C1, isLocal) | |
Gets the range used to fill the control.
|
||
function | getLinkedCell(isR1C1, isLocal) | |
Gets the range linked to the control's value.
|
||
function | getLockedProperty(type) | |
Gets the value of locked property.
|
||
function | getResultOfSmartArt() | |
Converting smart art to grouped shapes.
|
||
function | getRichFormattings() | |
Returns all Characters objects
that represents a range of characters within the text .
|
||
function | isSameSetting(obj) | |
Returns whether the shape is same.
|
||
function | moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) | |
Moves the shape to a specified range.
|
||
function | removeActiveXControl() | |
Remove activeX control.
|
||
function | removeHyperlink() | |
Removes the hyperlink of the shape.
|
||
function | setInputRange(formula, isR1C1, isLocal) | |
Sets the range used to fill the control.
|
||
function | setLinkedCell(formula, isR1C1, isLocal) | |
Sets the range linked to the control's value.
|
||
function | setLockedProperty(type, value) | |
Set the locked property.
|
||
function | toFrontOrBack(orders) | |
Brings the shape to the front or sends the shape to back.
|
||
function | toImage(imageFile, options) | |
Saves the shape to a file.
|
||
function | updateSelectedValue() | |
Update the selected value by the value of the linked cell.
|
function getCurrentValue() / function setCurrentValue(value)
function getMin() / function setMin(value)
function getMax() / function setMax(value)
function getIncrementalChange() / function setIncrementalChange(value)
function getPageChange() / function setPageChange(value)
function getShadow() / function setShadow(value)
function isHorizontal() / function setHorizontal(value)
function getMacroName() / function setMacroName(value)
function isEquation()
function isSmartArt()
function getZOrderPosition() / function setZOrderPosition(value)
function getName() / function setName(value)
function getAlternativeText() / function setAlternativeText(value)
function getTitle() / function setTitle(value)
function getLineFormat()
function getFillFormat()
function getLine()
function getFill()
function getShadowEffect()
function getReflection()
function getGlow()
function getSoftEdges() / function setSoftEdges(value)
function getThreeDFormat()
function getFormatPicture()
function isHidden() / function setHidden(value)
function isLockAspectRatio() / function setLockAspectRatio(value)
function isAspectRatioLocked() / function setAspectRatioLocked(value)
function getRotationAngle() / function setRotationAngle(value)
function getHyperlink()
function getId()
function getSpid()
function getSpt()
function getWorksheet()
function isGroup()
function isInGroup()
function isWordArt()
function getTextEffect()
function isLocked() / function setLocked(value)
function isPrintable() / function setPrintable(value)
function getMsoDrawingType()
function getAutoShapeType() / function setAutoShapeType(value)
function getAnchorType() / function setAnchorType(value)
function getPlacement() / function setPlacement(value)
function getUpperLeftRow() / function setUpperLeftRow(value)
function getUpperDeltaY() / function setUpperDeltaY(value)
function getUpperLeftColumn() / function setUpperLeftColumn(value)
function getUpperDeltaX() / function setUpperDeltaX(value)
function getLowerRightRow() / function setLowerRightRow(value)
function getLowerDeltaY() / function setLowerDeltaY(value)
function getLowerRightColumn() / function setLowerRightColumn(value)
function getLowerDeltaX() / function setLowerDeltaX(value)
function getRight() / function setRight(value)
function getBottom() / function setBottom(value)
function getWidth() / function setWidth(value)
function getWidthInch() / function setWidthInch(value)
function getWidthPt() / function setWidthPt(value)
function getWidthCM() / function setWidthCM(value)
function getHeight() / function setHeight(value)
function getHeightInch() / function setHeightInch(value)
function getHeightPt() / function setHeightPt(value)
function getHeightCM() / function setHeightCM(value)
function getLeft() / function setLeft(value)
function getLeftInch() / function setLeftInch(value)
function getLeftCM() / function setLeftCM(value)
function getTop() / function setTop(value)
function getTopInch() / function setTopInch(value)
function getTopCM() / function setTopCM(value)
function getTopToCorner() / function setTopToCorner(value)
function getLeftToCorner() / function setLeftToCorner(value)
function getX() / function setX(value)
function getY() / function setY(value)
function getWidthScale() / function setWidthScale(value)
function getHeightScale() / function setHeightScale(value)
function getTopInShape() / function setTopInShape(value)
function getLeftInShape() / function setLeftInShape(value)
function getWidthInShape() / function setWidthInShape(value)
function getHeightInShape() / function setHeightInShape(value)
function getGroup()
function getType()
function hasLine() / function setHasLine(value)
function isFilled() / function setFilled(value)
function isFlippedHorizontally() / function setFlippedHorizontally(value)
function isFlippedVertically() / function setFlippedVertically(value)
function getActualLowerRightRow()
function getRelativeToOriginalPictureSize() / function setRelativeToOriginalPictureSize(value)
function getLinkedCell() / function setLinkedCell(value)
function getInputRange() / function setInputRange(value)
function getTextShapeType() / function setTextShapeType(value)
function getTextBody()
function getFont() / function setFont(value)
function getTextOptions() / function setTextOptions(value)
function getText() / function setText(value)
function isRichText()
function getHtmlText() / function setHtmlText(value)
function getTextVerticalOverflow() / function setTextVerticalOverflow(value)
function getTextHorizontalOverflow() / function setTextHorizontalOverflow(value)
function isTextWrapped() / function setTextWrapped(value)
function getTextOrientationType() / function setTextOrientationType(value)
function getTextHorizontalAlignment() / function setTextHorizontalAlignment(value)
function getTextVerticalAlignment() / function setTextVerticalAlignment(value)
function getTextDirection() / function setTextDirection(value)
function getControlData()
function getPaths()
function getGeometry()
function getCreateId() / function setCreateId(value)
function getLinkedCell(isR1C1, isLocal)
isR1C1: boolean
- Whether the formula needs to be formatted as R1C1.isLocal: boolean
- Whether the formula needs to be formatted by locale.function setLinkedCell(formula, isR1C1, isLocal)
formula: String
- The range linked to the control's value.isR1C1: boolean
- Whether the formula needs to be formatted as R1C1.isLocal: boolean
- Whether the formula needs to be formatted by locale.function getInputRange(isR1C1, isLocal)
isR1C1: boolean
- Whether the formula needs to be formatted as R1C1.isLocal: boolean
- Whether the formula needs to be formatted by locale.function setInputRange(formula, isR1C1, isLocal)
formula: String
- The range used to fill the control.isR1C1: boolean
- Whether the formula needs to be formatted as R1C1.isLocal: boolean
- Whether the formula needs to be formatted by locale.function updateSelectedValue()
function calculateTextSize()
function formatCharacters(startIndex, length, font, flag)
startIndex: Number
- The start index.length: Number
- The length.font: Font
- The font setting.flag: StyleFlag
- The flag of the font setting.function characters(startIndex, length)
startIndex: Number
- The index of the start of the character.length: Number
- The number of characters.function getCharacters()
function getRichFormattings()
function removeActiveXControl()
function isSameSetting(obj)
obj: Object
- function getActualBox()
function getConnectionPoints()
function toImage(imageFile, options)
function getResultOfSmartArt()
function toFrontOrBack(orders)
orders: Number
-
If it's less than zero, sets the shape to back.
If it's greater than zero, brings the shape to front.
function getLockedProperty(type)
type: Number
- A function setLockedProperty(type, value)
type: Number
- A value: boolean
- The value of the property.function addHyperlink(address)
address: String
- Address of the hyperlink.function removeHyperlink()
function moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn)
upperLeftRow: Number
- Upper left row index.upperLeftColumn: Number
- Upper left column index.lowerRightRow: Number
- Lower right row indexlowerRightColumn: Number
- Lower right column indexfunction alignTopRightCorner(topRow, rightColumn)
topRow: Number
- the row index.rightColumn: Number
- the column index.