com.aspose.cells
Class Shape

java.lang.Object
    extended by com.aspose.cells.Shape
Direct Known Subclasses:
ArcShape, Button, CellsDrawing, ChartShape, CheckBox, ComboBox, CommentShape, GroupBox, GroupShape, Label, LineShape, ListBox, OleObject, Oval, Picture, RadioButton, RectangleShape, ScrollBar, Spinner, TextBox

public class Shape 
extends java.lang.Object

Represents the msodrawing object.

Property Getters/Setters Summary
intgetActualLowerRightRow()
           Get the actual bottom row.
java.lang.StringgetAlternativeText()
voidsetAlternativeText(java.lang.String value)
           Returns or sets the descriptive (alternative) text string of the Shape object.
intgetAutoShapeType()
voidsetAutoShapeType(int value)
           Gets the auto shape type. The value of the property is AutoShapeType integer constant.
intgetBottom()
           Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
FillFormatgetFill()
           Returns a FillFormat object that contains fill formatting properties for the specified shape.
MsoFillFormatgetFillFormat()
           Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
FontgetFont()
voidsetFont(Font value)
           Represents the font of textbox.
MsoFormatPicturegetFormatPicture()
           Gets and sets the options of the picture format.
GroupShapegetGroup()
           Gets the group shape which contains this shape.
booleanhasLine()
voidsetHasLine(boolean value)
           Gets and sets the line border of the shape is visible.
intgetHeight()
voidsetHeight(int value)
           Represents the height of shape, in unit of pixel.
doublegetHeightCM()
voidsetHeightCM(double value)
           Represents the height of the shape, in unit of inches.
doublegetHeightInch()
voidsetHeightInch(double value)
           Represents the height of the shape, in unit of inches.
intgetHeightInChart()
voidsetHeightInChart(int 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..
intgetHeightInShape()
voidsetHeightInShape(int 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..
doublegetHeightPt()
voidsetHeightPt(double value)
           Represents the height of the shape, in unit of points.
intgetHeightScale()
voidsetHeightScale(int 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;
java.lang.StringgetHtmlText()
voidsetHtmlText(java.lang.String value)
           Gets and sets the html string which contains data and some formattings in this textbox.
HyperlinkgetHyperlink()
           Gets the hyperlink of the shape.
booleanisFilled()
voidsetFilled(boolean value)
           Indicates whether the fill format is visible.
booleanisFlippedHorizontally()
voidsetFlippedHorizontally(boolean value)
           Gets and sets whether shape is horizontally flipped .
booleanisFlippedVertically()
voidsetFlippedVertically(boolean value)
           Gets and sets whether shape is vertically flipped .
booleanisGroup()
           Indicates whether the shape is a group.
booleanisHidden()
voidsetHidden(boolean value)
           Indicates whether the object is visible.
booleanisLockAspectRatio()
voidsetLockAspectRatio(boolean value)
           True means that don't allow changes in aspect ratio.
booleanisLocked()
voidsetLocked(boolean value)
           True if the object is locked, False if the object can be modified when the sheet is protected.
booleanisPrintable()
voidsetPrintable(boolean value)
           True if the object is printable
booleanisPrinted()
voidsetPrinted(boolean value)
           True if the object is printable
booleanisTextWrapped()
voidsetTextWrapped(boolean value)
           Gets and sets the text wrapped type of the shape which contains text.
booleanisWordArt()
           Indicates whether this shape is a word art.
intgetLeft()
voidsetLeft(int value)
           Represents the horizontal offset of shape from its left column, in unit of pixels.
doublegetLeftCM()
voidsetLeftCM(double value)
           Represents the horizontal offset of shape from its left column, in unit of centimeters.
doublegetLeftInch()
voidsetLeftInch(double value)
           Represents the horizontal offset of shape from its left column, in unit of inches.
intgetLeftInChart()
voidsetLeftInChart(int value)
           Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
intgetLeftInShape()
voidsetLeftInShape(int 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.
MsoLineFormatgetLineFormat()
           Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
java.lang.StringgetLinkedCell()
voidsetLinkedCell(java.lang.String value)
           Gets or sets the worksheet range linked to the control's value.
intgetLowerDeltaX()
voidsetLowerDeltaX(int value)
           Gets or sets the shape's horizontal offset from its lower right corner column. The range of value is 0 to 1024.
intgetLowerDeltaY()
voidsetLowerDeltaY(int value)
           Gets or sets the shape's vertical offset from its lower right corner row. The range of value is 0 to 256.
intgetLowerRightColumn()
voidsetLowerRightColumn(int value)
           Represents lower right corner column index.
intgetLowerRightRow()
voidsetLowerRightRow(int value)
           Represents lower right corner row index.
intgetMsoDrawingType()
           Gets and sets mso drawing type. The value of the property is MsoDrawingType integer constant.
java.lang.StringgetName()
voidsetName(java.lang.String value)
           Gets and sets the name of the shape.
GeomPathsInfogetPathsInfo()
           Gets path collection information when shape is a NotPrimitive autoshape
intgetPlacement()
voidsetPlacement(int 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.
intgetPositionX()
voidsetPositionX(int value)
           Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
intgetPositionY()
voidsetPositionY(int value)
           Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
booleangetRelativeToOriginalPictureSize()
voidsetRelativeToOriginalPictureSize(boolean value)
           Indicates whether shape is relative to original picture size.
intgetRight()
           Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
intgetRotation()
voidsetRotation(int value)
           Gets and sets the rotation of the shape.
doublegetRotationAngle()
voidsetRotationAngle(double value)
           Gets and sets the rotation of the shape.
java.lang.StringgetText()
voidsetText(java.lang.String value)
           Represents the string in this TextBox object.
TextEffectFormatgetTextEffect()
           Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape. Applies to Shape objects that represent WordArt.
MsoTextFramegetTextFrame()
           Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
intgetTextHorizontalAlignment()
voidsetTextHorizontalAlignment(int value)
           Gets and sets the text horizontal alignment type of the shape. The value of the property is TextAlignmentType integer constant.
intgetTextHorizontalOverflow()
voidsetTextHorizontalOverflow(int value)
           Gets and sets the text horizontal overflow type of the shape which contains text. The value of the property is TextOverflowType integer constant.
intgetTextOrientationType()
voidsetTextOrientationType(int value)
           Gets and sets the text orientation type of the shape. The value of the property is TextOrientationType integer constant.
intgetTextVerticalAlignment()
voidsetTextVerticalAlignment(int value)
           Gets and sets the text vertical alignment type of the shape. The value of the property is TextAlignmentType integer constant.
intgetTextVerticalOverflow()
voidsetTextVerticalOverflow(int value)
           Gets and sets the text vertical overflow type of the shape which contains text. The value of the property is TextOverflowType integer constant.
java.lang.StringgetTitle()
voidsetTitle(java.lang.String value)
           Specifies the title (caption) of the current shape object.
intgetTop()
voidsetTop(int value)
           Represents the vertical offset of shape from its top row, in unit of pixels.
doublegetTopCM()
voidsetTopCM(double value)
           Represents the vertical offset of shape from its top row, in unit of centimeters.
doublegetTopInch()
voidsetTopInch(double value)
           Represents the vertical offset of shape from its top row, in unit of inches.
intgetTopInChart()
voidsetTopInChart(int 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.
intgetTopInShape()
voidsetTopInShape(int 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.
intgetType()
           Gets the auto shape type. The value of the property is AutoShapeType integer constant.
intgetUpperDeltaX()
voidsetUpperDeltaX(int value)
           Gets or sets the shape's horizontal offset from its upper left corner column. The range of value is 0 to 1024.
intgetUpperDeltaY()
voidsetUpperDeltaY(int value)
           Gets or sets the shape's vertical offset from its upper left corner row. The range of value is 0 to 256.
intgetUpperLeftColumn()
voidsetUpperLeftColumn(int value)
           Represents upper left corner column index.
intgetUpperLeftRow()
voidsetUpperLeftRow(int value)
           Represents upper left corner row index.
intgetWidth()
voidsetWidth(int value)
           Represents the width of shape, in unit of pixels.
doublegetWidthCM()
voidsetWidthCM(double value)
           Represents the width of the shape, in unit of centimeters.
doublegetWidthInch()
voidsetWidthInch(double value)
           Represents the width of the shape, in unit of inch.
intgetWidthInChart()
voidsetWidthInChart(int value)
           Represents the width of the shape, in unit of 1/4000 of the parent shape.
intgetWidthInShape()
voidsetWidthInShape(int value)
           Represents the width of the shape, in unit of 1/4000 of the parent shape.
doublegetWidthPt()
voidsetWidthPt(double value)
           Represents the width of the shape, in unit of point.
intgetWidthScale()
voidsetWidthScale(int 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;
intgetX()
voidsetX(int value)
           Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
intgetY()
voidsetY(int value)
           Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
intgetZOrderPosition()
voidsetZOrderPosition(int value)
           Returns the position of a shape in the z-order.
 
Method Summary
HyperlinkaddHyperlink(java.lang.String address)
           Adds a hyperlink to the shape.
FontSettingcharacters(int startIndex, int length)
           Returns a Characters object that represents a range of characters within the text.
voidformatCharacters(int startIndex, int length, Font font)
           Format some chararcters with the font setting.
java.util.ArrayListgetCharacters()
           Returns all Characters objects that represents a range of characters within the text .
voidmoveToRange(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn)
           Moves the shape to a specified range.
voidremoveHyperlink()
           Remove the hyperlink of the shape.
voidtoImage(java.io.OutputStream stream, ImageFormat imageFormat)
           Creates the shape image and saves it to a stream in the specified format.
voidtoImage(java.io.OutputStream stream, ImageOrPrintOptions options)
           Saves the shape to a stream.
voidtoImage(java.lang.String imageFile, ImageOrPrintOptions options)
           Saves the shape to a file.
voidupdateSelectedValue()
           Update the selected value by the value of the linked cell.
 

Property Getters/Setters Detail

getZOrderPosition/setZOrderPosition

public int getZOrderPosition() / public void setZOrderPosition(int value)
Returns the position of a shape in the z-order.

getName/setName

public java.lang.String getName() / public void setName(java.lang.String value)
Gets and sets the name of the shape.

getAlternativeText/setAlternativeText

public java.lang.String getAlternativeText() / public void setAlternativeText(java.lang.String value)
Returns or sets the descriptive (alternative) text string of the Shape object.

getTitle/setTitle

public java.lang.String getTitle() / public void setTitle(java.lang.String value)
Specifies the title (caption) of the current shape object.

getLineFormat

public MsoLineFormat getLineFormat()
Returns a MsoLineFormat object that contains line formatting properties for the specified shape.

getFillFormat

public MsoFillFormat getFillFormat()
Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.

getFill

public FillFormat getFill()
Returns a FillFormat object that contains fill formatting properties for the specified shape.

getTextFrame

public MsoTextFrame getTextFrame()
Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.

getFormatPicture

public MsoFormatPicture getFormatPicture()
Gets and sets the options of the picture format.

isHidden/setHidden

public boolean isHidden() / public void setHidden(boolean value)
Indicates whether the object is visible.

isLockAspectRatio/setLockAspectRatio

public boolean isLockAspectRatio() / public void setLockAspectRatio(boolean value)
True means that don't allow changes in aspect ratio.

getRotation/setRotation

public int getRotation() / public void setRotation(int value)
Gets and sets the rotation of the shape. NOTE: This member is now obsolete. Instead, please use Shape.RotationAngle property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.

getRotationAngle/setRotationAngle

public double getRotationAngle() / public void setRotationAngle(double value)
Gets and sets the rotation of the shape.

getHyperlink

public Hyperlink getHyperlink()
Gets the hyperlink of the shape.

isGroup

public boolean isGroup()
Indicates whether the shape is a group.

isWordArt

public boolean isWordArt()
Indicates whether this shape is a word art.

getTextEffect

public TextEffectFormat getTextEffect()
Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape. Applies to Shape objects that represent WordArt.

isLocked/setLocked

public boolean isLocked() / public void setLocked(boolean value)
True if the object is locked, False if the object can be modified when the sheet is protected.

isPrintable/setPrintable

public boolean isPrintable() / public void setPrintable(boolean value)
True if the object is printable

isPrinted/setPrinted

public boolean isPrinted() / public void setPrinted(boolean value)
True if the object is printable NOTE: This member is now obsolete. Instead, please use Shape.IsPrintable property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.

getMsoDrawingType

public int getMsoDrawingType()
Gets and sets mso drawing type. The value of the property is MsoDrawingType integer constant.

getAutoShapeType/setAutoShapeType

public int getAutoShapeType() / public void setAutoShapeType(int value)
Gets the auto shape type. The value of the property is AutoShapeType integer constant.

getPlacement/setPlacement

public int getPlacement() / public void setPlacement(int 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.

getUpperLeftRow/setUpperLeftRow

public int getUpperLeftRow() / public void setUpperLeftRow(int value)
Represents upper left corner row index. If the shape is in the shape or in the group , UpperLeftRow will be ignored.

getUpperDeltaY/setUpperDeltaY

public int getUpperDeltaY() / public void setUpperDeltaY(int value)
Gets or sets the shape's vertical offset from its upper left corner row. The range of value is 0 to 256.

getUpperLeftColumn/setUpperLeftColumn

public int getUpperLeftColumn() / public void setUpperLeftColumn(int value)
Represents upper left corner column index.

getUpperDeltaX/setUpperDeltaX

public int getUpperDeltaX() / public void setUpperDeltaX(int value)
Gets or sets the shape's horizontal offset from its upper left corner column. The range of value is 0 to 1024.

getActualLowerRightRow

public int getActualLowerRightRow()
Get the actual bottom row.

getLowerRightRow/setLowerRightRow

public int getLowerRightRow() / public void setLowerRightRow(int value)
Represents lower right corner row index.

getLowerDeltaY/setLowerDeltaY

public int getLowerDeltaY() / public void setLowerDeltaY(int value)
Gets or sets the shape's vertical offset from its lower right corner row. The range of value is 0 to 256.

getLowerRightColumn/setLowerRightColumn

public int getLowerRightColumn() / public void setLowerRightColumn(int value)
Represents lower right corner column index.

getLowerDeltaX/setLowerDeltaX

public int getLowerDeltaX() / public void setLowerDeltaX(int value)
Gets or sets the shape's horizontal offset from its lower right corner column. The range of value is 0 to 1024.

getRight

public int getRight()
Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.

getBottom

public int getBottom()
Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.

getWidth/setWidth

public int getWidth() / public void setWidth(int value)
Represents the width of shape, in unit of pixels.

getWidthInch/setWidthInch

public double getWidthInch() / public void setWidthInch(double value)
Represents the width of the shape, in unit of inch.

getWidthPt/setWidthPt

public double getWidthPt() / public void setWidthPt(double value)
Represents the width of the shape, in unit of point.

getWidthCM/setWidthCM

public double getWidthCM() / public void setWidthCM(double value)
Represents the width of the shape, in unit of centimeters.

getHeight/setHeight

public int getHeight() / public void setHeight(int value)
Represents the height of shape, in unit of pixel.

getHeightInch/setHeightInch

public double getHeightInch() / public void setHeightInch(double value)
Represents the height of the shape, in unit of inches.

getHeightPt/setHeightPt

public double getHeightPt() / public void setHeightPt(double value)
Represents the height of the shape, in unit of points.

getHeightCM/setHeightCM

public double getHeightCM() / public void setHeightCM(double value)
Represents the height of the shape, in unit of inches.

getLeft/setLeft

public int getLeft() / public void setLeft(int value)
Represents the horizontal offset of shape from its left column, in unit of pixels.

getLeftInch/setLeftInch

public double getLeftInch() / public void setLeftInch(double value)
Represents the horizontal offset of shape from its left column, in unit of inches.

getLeftCM/setLeftCM

public double getLeftCM() / public void setLeftCM(double value)
Represents the horizontal offset of shape from its left column, in unit of centimeters.

getTop/setTop

public int getTop() / public void setTop(int value)
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.

getTopInch/setTopInch

public double getTopInch() / public void setTopInch(double value)
Represents the vertical offset of shape from its top row, in unit of inches.

getTopCM/setTopCM

public double getTopCM() / public void setTopCM(double value)
Represents the vertical offset of shape from its top row, in unit of centimeters.

getX/setX

public int getX() / public void setX(int value)
Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.

getY/setY

public int getY() / public void setY(int value)
Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.

getWidthScale/setWidthScale

public int getWidthScale() / public void setWidthScale(int 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;

getHeightScale/setHeightScale

public int getHeightScale() / public void setHeightScale(int 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;

getTopInShape/setTopInShape

public int getTopInShape() / public void setTopInShape(int 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. Only Applies when this shape in the group or chart.

getLeftInShape/setLeftInShape

public int getLeftInShape() / public void setLeftInShape(int 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. Only Applies when this shape in the group or chart.

getWidthInShape/setWidthInShape

public int getWidthInShape() / public void setWidthInShape(int value)
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.

getHeightInShape/setHeightInShape

public int getHeightInShape() / public void setHeightInShape(int 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.. Only Applies when this shape in the group or chart.

getHeightInChart/setHeightInChart

public int getHeightInChart() / public void setHeightInChart(int 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.. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.HeightInShape property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

getLeftInChart/setLeftInChart

public int getLeftInChart() / public void setLeftInChart(int value)
Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.LeftInShape property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

getTopInChart/setTopInChart

public int getTopInChart() / public void setTopInChart(int 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. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.TopInShape property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

getWidthInChart/setWidthInChart

public int getWidthInChart() / public void setWidthInChart(int value)
Represents the width of the shape, in unit of 1/4000 of the parent shape. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.WidthInShape property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

getPositionX/setPositionX

public int getPositionX() / public void setPositionX(int value)
Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.X property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

getPositionY/setPositionY

public int getPositionY() / public void setPositionY(int value)
Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.Y property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

getGroup

public GroupShape getGroup()
Gets the group shape which contains this shape.

getType

public int getType()
Gets the auto shape type. The value of the property is AutoShapeType integer constant.

hasLine/setHasLine

public boolean hasLine() / public void setHasLine(boolean value)
Gets and sets the line border of the shape is visible.

isFilled/setFilled

public boolean isFilled() / public void setFilled(boolean value)
Indicates whether the fill format is visible.

isFlippedHorizontally/setFlippedHorizontally

public boolean isFlippedHorizontally() / public void setFlippedHorizontally(boolean value)
Gets and sets whether shape is horizontally flipped .

isFlippedVertically/setFlippedVertically

public boolean isFlippedVertically() / public void setFlippedVertically(boolean value)
Gets and sets whether shape is vertically flipped .

getRelativeToOriginalPictureSize/setRelativeToOriginalPictureSize

public boolean getRelativeToOriginalPictureSize() / public void setRelativeToOriginalPictureSize(boolean value)
Indicates whether shape is relative to original picture size.

getLinkedCell/setLinkedCell

public java.lang.String getLinkedCell() / public void setLinkedCell(java.lang.String value)
Gets or sets the worksheet range linked to the control's value.

getFont/setFont

public Font getFont() / public void setFont(Font value)
Represents the font of textbox.

getText/setText

public java.lang.String getText() / public void setText(java.lang.String value)
Represents the string in this TextBox object.

getHtmlText/setHtmlText

public java.lang.String getHtmlText() / public void setHtmlText(java.lang.String value)
Gets and sets the html string which contains data and some formattings in this textbox.

getTextVerticalOverflow/setTextVerticalOverflow

public int getTextVerticalOverflow() / public void setTextVerticalOverflow(int value)
Gets and sets the text vertical overflow type of the shape which contains text. The value of the property is TextOverflowType integer constant.

getTextHorizontalOverflow/setTextHorizontalOverflow

public int getTextHorizontalOverflow() / public void setTextHorizontalOverflow(int value)
Gets and sets the text horizontal overflow type of the shape which contains text. The value of the property is TextOverflowType integer constant.

isTextWrapped/setTextWrapped

public boolean isTextWrapped() / public void setTextWrapped(boolean value)
Gets and sets the text wrapped type of the shape which contains text.

getTextOrientationType/setTextOrientationType

public int getTextOrientationType() / public void setTextOrientationType(int value)
Gets and sets the text orientation type of the shape. The value of the property is TextOrientationType integer constant.

getTextHorizontalAlignment/setTextHorizontalAlignment

public int getTextHorizontalAlignment() / public void setTextHorizontalAlignment(int value)
Gets and sets the text horizontal alignment type of the shape. The value of the property is TextAlignmentType integer constant.

getTextVerticalAlignment/setTextVerticalAlignment

public int getTextVerticalAlignment() / public void setTextVerticalAlignment(int value)
Gets and sets the text vertical alignment type of the shape. The value of the property is TextAlignmentType integer constant.

getPathsInfo

public GeomPathsInfo getPathsInfo()
Gets path collection information when shape is a NotPrimitive autoshape

Method Detail

toImage

public void toImage(java.io.OutputStream stream, ImageFormat imageFormat)
            throws java.lang.Exception
Creates the shape image and saves it to a stream in the specified format.

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

Parameters:
stream - The output stream.
imageFormat - The format in which to save the image.

toImage

public void toImage(java.lang.String imageFile, ImageOrPrintOptions options)
            throws java.lang.Exception
Saves the shape to a file.

toImage

public void toImage(java.io.OutputStream stream, ImageOrPrintOptions options)
            throws java.lang.Exception
Saves the shape to a stream.

updateSelectedValue

public void updateSelectedValue()
                        throws java.lang.Exception
Update the selected value by the value of the linked cell.

formatCharacters

public void formatCharacters(int startIndex, int length, Font font)
Format some chararcters with the font setting.
Parameters:
startIndex - The start index.
length - The the length.
font - The font setting.

characters

public FontSetting characters(int startIndex, int length)
Returns a Characters object that represents a range of characters within the text. This method only works on shape with title.
Parameters:
startIndex - The index of the start of the character.
length - The number of characters.
Returns:
Characters object.

getCharacters

public java.util.ArrayList getCharacters()
Returns all Characters objects that represents a range of characters within the text .
Returns:
All Characters objects

addHyperlink

public Hyperlink addHyperlink(java.lang.String address)
Adds a hyperlink to the shape.
Parameters:
address - Address of the hyperlink.
Returns:
Return the new hyperlink object.

removeHyperlink

public void removeHyperlink()
Remove the hyperlink of the shape.

moveToRange

public void moveToRange(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn)
Moves the shape to a specified range.
Parameters:
upperLeftRow - Upper left row index.
upperLeftColumn - Upper left column index.
lowerRightRow - Lower right row index
lowerRightColumn - Lower right column index

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.