com.aspose.cells
Class OleObject

java.lang.Object
  Shape
      com.aspose.cells.OleObject

public class OleObject 
extends Shape

//Instantiate a new Workbook.
Workbook workbook = new Workbook();
//Get the first worksheet. 
Worksheet sheet = workbook.getWorksheets().get(0);
//Define a string variable to store the image path.
String ImageUrl = "school.jpg";
//Get the picture into the streams.
FileInputStream fs = new FileInputStream(ImageUrl);
//Define a byte array.
byte[] imageData = new byte[fs.available()];
//Obtain the picture into the array of bytes from streams.
fs.read(imageData, 0, imageData.length);
//Close the stream.
fs.close();
//Get an excel file path in a variable.
String path = "Book1.xls";
//Get the file into the streams.
fs = new FileInputStream(path);
//Define an array of bytes. 
byte[] objectData = new byte[fs.available()];
//Store the file from streams.
fs.read(objectData, 0, objectData.length);
//Close the stream.
fs.close();
//Add an Ole object into the worksheet with the image
//shown in MS Excel.
sheet.getOleObjects().add(14, 3, 200, 220, imageData);
//Set embedded ole object data.     
sheet.getOleObjects().get(0).setObjectData(objectData);
//Save the excel file
workbook.save("C:\\oleobjects.xls");

public boolean isAutoSize() / public void setAutoSize(boolean value)

True indicates that the size of the ole object will be auto changed as the size of snapshot of the embedded content when the ole object is activated.

public boolean isLink() / public void setLink(boolean value)

Returns true if the OleObject links to the file.

public boolean getDisplayAsIcon() / public void setDisplayAsIcon(boolean value)

True if the specified object is displayed as an icon and the image will not be auto changed.

public byte[] getImageData() / public void setImageData(byte[] value)

Represents image of ole object as byte array.

public byte[] getObjectData() / public void setObjectData(byte[] value)

Represents embedded ole object data as byte array.

public byte[] getFullObjectBin()

Gets the full embedded ole object binary data in the template file.

public java.lang.String getImageSourceFullName() / public void setImageSourceFullName(java.lang.String value)

Gets or sets the path and name of the source file for the linked image.

The default value is an empty string. If SourceFullName is not an empty string, the image is linked. If SourceFullName is not an empty string, but Data is null, then the image is linked and not stored in the file.

public java.lang.String getProgID() / public void setProgID(java.lang.String value)

Gets or sets the ProgID of the OLE object.

public int getFileFormatType() / public void setFileFormatType(int value)

Gets and sets the file type of the embedded ole object data The value of the property is FileFormatType integer constant.

public java.lang.String getObjectSourceFullName() / public void setObjectSourceFullName(java.lang.String value)

Returns the source full name of the source file for the linked OLE object.

Only supports setting the source full name when the file type is OleFileType.Unknown. Such as wav file ,avi file..etc..

public java.lang.String getLabel() / public void setLabel(java.lang.String value)

Gets and sets the display label of the linked ole object.

public java.lang.String getSourceFullName() / public void setSourceFullName(java.lang.String value)

Returns the source full name of the source file for the linked OLE object.

NOTE: This member is now obsolete. Instead, please use OleObject.ObjectSourceFullName property. This property will be removed 12 months later since November 2013. Aspose apologizes for any inconvenience you may have experienced.

public boolean getAutoUpdate() / public void setAutoUpdate(boolean value)

Specifies whether the link to the OleObject is automatically updated or not.

public boolean getAutoLoad() / public void setAutoLoad(boolean value)

Specifies whether the host application for the embedded object shall be called to load the object data automatically when the parent workbook is opened.

public byte[] getClassIdentifier() / public void setClassIdentifier(byte[] value)

Gets and sets the class identifier of the embedded object. It means which application opens the embedded file.

public int getImageType()

Gets the image format of the ole object. The value of the property is ImageType integer constant.

public java.lang.String getMacroName() / public void setMacroName(java.lang.String value)

Gets and sets the name of macro.

Example:

//Sets the name of macro.
shape.setMacroName("DoWork()");

public boolean isEquation()

Indicates whether the shape only contains an equation.

Example:

//If true,the shape only contains an equation.
if(shape.isEquation())
{
    //The shape contains only an equation
}

public boolean isSmartArt()

Indicates whether the shape is smart art.

Only for ooxml file.

Example:

//if true,the shape is smart art.
if(shape.isSmartArt())
{
    //The shape is SmartArt object.
}

public int getZOrderPosition() / public void setZOrderPosition(int value)

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

Example:

shape.setZOrderPosition(3);

public java.lang.String getName() / public void setName(java.lang.String value)

Gets and sets the name of the shape.

Example:

shape.setName("shape1");

public java.lang.String getAlternativeText() / public void setAlternativeText(java.lang.String value)

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

Example:

shape.setAlternativeText("a rectangle");

public java.lang.String getTitle() / public void setTitle(java.lang.String value)

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

Example:

shape.setTitle("title1");

public MsoLineFormat getLineFormat()

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.

public MsoFillFormat getFillFormat()

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.

public ShapeFormat getFormat()

Represents the setting of the shape's formatting.

NOTE: This member is now obsolete. Instead, please use Shape.Fill and Shape.Line properties. This property will be removed 6 months later since August 2016. Aspose apologizes for any inconvenience you may have experienced.

public LineFormat getLine()

Gets line style

Example:

LineFormat lineFmt = shape.getLine();

public FillFormat getFill()

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

Example:

FillFormat fillFmt = shape.getFill();

public ShadowEffect getShadowEffect()

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

Example:

ShadowEffect shadowEffect = shape.getShadowEffect();

See Also:

ShadowEffect

public ReflectionEffect getReflection()

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

Example:

ReflectionEffect reflectionEffect = shape.getReflection();

See Also:

ReflectionEffect

public GlowEffect getGlow()

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

Example:

GlowEffect glowEffect = shape.getGlow();

See Also:

GlowEffect

public double getSoftEdges() / public void setSoftEdges(double value)

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

Example:

shape.setSoftEdges(0.5d);

public ThreeDFormat getThreeDFormat()

Gets and sets 3d format of the shape.

Example:

ThreeDFormat threeDFormat = shape.getThreeDFormat();

public MsoTextFrame getTextFrame()

Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.

NOTE: This member is now obsolete. Instead, please use Shape.TextBody.TextAlignment property. This property will be removed 12 months later since May 2016. Aspose apologizes for any inconvenience you may have experienced.

public MsoFormatPicture getFormatPicture()

Gets and sets the options of the picture format.

Example:

MsoFormatPicture msoFormatPicture = shape.getFormatPicture();

public boolean isHidden() / public void setHidden(boolean value)

Indicates whether the object is visible.

Example:

shape.setHidden(false);

public boolean isLockAspectRatio() / public void setLockAspectRatio(boolean value)

True means that don't allow changes in aspect ratio.

Example:

shape.setLockAspectRatio(false);

public double getRotationAngle() / public void setRotationAngle(double value)

Gets and sets the rotation of the shape.

Example:

if(shape.getRotationAngle() == 45)
    shape.setRotationAngle(60);

public Hyperlink getHyperlink()

Gets the hyperlink of the shape.

Example:

Hyperlink hyperlink = shape.getHyperlink();

public int getId()

Gets the identifier of this shape.

Example:

int id = shape.getId();

public java.lang.String getSpid()

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

Example:

String spid = shape.getSpid();

public int getSpt()

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

Example:

int spt = shape.getSpt();

public Worksheet getWorksheet()

Gets the Worksheet object which contains this shape.

Example:

Worksheet worksheet = shape.getWorksheet();

public boolean isGroup()

Indicates whether the shape is a group.

Example:

if(shape.isGroup())
{
    //This shape is a group.
}

public boolean isInGroup()

Indicates whether the shape is grouped.

public boolean isWordArt()

Indicates whether this shape is a word art.

Only for the Legacy Shape of xls file.

Example:

if(shape.isWordArt())
{
    //This shape is a WordArt object.
}

public TextEffectFormat getTextEffect()

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

Example:

TextEffectFormat textEffectFormat = shape.getTextEffect();

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.

Example:

if(shape.isLocked())
    shape.setLocked(false);

public boolean isPrintable() / public void setPrintable(boolean value)

True if the object is printable

Example:

if(shape.isPrintable())
    shape.setPrintable(false);

public int getMsoDrawingType()

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

Example:

/*Aspose.Cells.Drawing.MsoDrawingType*/int msoDrawingType = shape.getMsoDrawingType();

public int getAutoShapeType() / public void setAutoShapeType(int value)

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

Example:

if (shape.getAutoShapeType() == com.aspose.cells.AutoShapeType.UNKNOWN)
    shape.setAutoShapeType(com.aspose.cells.AutoShapeType.RECTANGLE);

public int getAnchorType() / public void setAnchorType(int value)

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

Example:

if (shape.getAnchorType() == ShapeAnchorType.ONE_CELL_ANCHOR)
    shape.setAnchorType(ShapeAnchorType.TWO_CELL_ANCHOR);

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.

Example:

if (shape.getPlacement() == PlacementType.MOVE)
    shape.setPlacement(PlacementType.MOVE_AND_SIZE);

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.

Example:

if (shape.getUpperLeftRow() == 3)
    shape.setUpperLeftRow(1);

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.

Example:

if (shape.getUpperDeltaY() == 3)
    shape.setUpperDeltaY(1);

public int getUpperLeftColumn() / public void setUpperLeftColumn(int value)

Represents upper left corner column index.

Example:

if (shape.getUpperLeftColumn() == 3)
    shape.setUpperLeftColumn(1);

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.

Example:

if (shape.getUpperDeltaX() == 3)
    shape.setUpperDeltaX(1);

public int getLowerRightRow() / public void setLowerRightRow(int value)

Represents lower right corner row index.

Example:

if (shape.getLowerRightRow() == 3)
    shape.setLowerRightRow(1);

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.

Example:

if (shape.getLowerDeltaY() == 3)
    shape.setLowerDeltaY(1);

public int getLowerRightColumn() / public void setLowerRightColumn(int value)

Represents lower right corner column index.

Example:

if (shape.getLowerRightColumn() == 3)
    shape.setLowerRightColumn(1);

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.

Example:

if (shape.getLowerDeltaX() == 3)
    shape.setLowerDeltaX(1);

public int getRight() / public void setRight(int value)

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

Example:

if (shape.getRight() == 3)
    shape.setRight(1);

public int getBottom() / public void setBottom(int value)

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

Example:

if (shape.getBottom() == 3)
    shape.setBottom(1);

public int getWidth() / public void setWidth(int value)

Represents the width of shape, in unit of pixels.

Example:

if (shape.getWidth() == 3)
    shape.setWidth(1);

public double getWidthInch() / public void setWidthInch(double value)

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

Example:

if (shape.getWidthInch() == 3)
    shape.setWidthInch(1);

public double getWidthPt() / public void setWidthPt(double value)

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

Example:

if (shape.getWidthPt() == 3)
    shape.setWidthPt(1);

public double getWidthCM() / public void setWidthCM(double value)

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

Example:

if (shape.getWidthCM() == 3)
    shape.setWidthCM(1);

public int getHeight() / public void setHeight(int value)

Represents the height of shape, in unit of pixel.

Example:

if (shape.getHeight() == 3)
    shape.setHeight(1);

public double getHeightInch() / public void setHeightInch(double value)

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

Example:

if (shape.getHeightInch() == 3)
    shape.setHeightInch(1);

public double getHeightPt() / public void setHeightPt(double value)

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

Example:

if (shape.getHeightPt() == 3)
    shape.setHeightPt(1);

public double getHeightCM() / public void setHeightCM(double value)

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

Example:

if (shape.getHeightCM() == 3)
    shape.setHeightCM(1);

public int getLeft() / public void setLeft(int value)

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

Example:

if (shape.getLeft() == 3)
    shape.setLeft(1);

public double getLeftInch() / public void setLeftInch(double value)

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

Example:

if (shape.getLeftInch() == 3)
    shape.setLeftInch(1);

public double getLeftCM() / public void setLeftCM(double value)

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

Example:

if (shape.getLeftCM() == 3)
    shape.setLeftCM(1);

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.

Example:

if (shape.getTop() == 3)
    shape.setTop(1);

public double getTopInch() / public void setTopInch(double value)

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

Example:

if (shape.getTopInch() == 3)
    shape.setTopInch(1);

public double getTopCM() / public void setTopCM(double value)

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

Example:

if (shape.getTopCM() == 3)
    shape.setTopCM(1);

public int getTopToCorner() / public void setTopToCorner(int value)

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

Example:

if (shape.getTopToCorner() == 3)
    shape.setTopToCorner(1);

public int getLeftToCorner() / public void setLeftToCorner(int value)

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

Example:

if (shape.getLeftToCorner() == 3)
    shape.setLeftToCorner(1);

public int getX() / public void setX(int value)

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

Example:

if (shape.getX() == 3)
    shape.setX(1);

public int getY() / public void setY(int value)

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

Example:

if (shape.getY() == 3)
    shape.setY(1);

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;

Example:

if (shape.getWidthScale() == 3)
    shape.setWidthScale(1);

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;

Example:

if (shape.getHeightScale() == 3)
    shape.setHeightScale(1);

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.

Example:

if (shape.getTopInShape() == 8000)
    shape.setTopInShape(4000);

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.

Example:

if (shape.getUpperDeltaY() == 2000)
    shape.setUpperDeltaY(4000);

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.

Example:

if (shape.getUpperDeltaY() == 2000)
    shape.setUpperDeltaY(4000);

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.

Example:

if (shape.getUpperDeltaY() == 4000)
    shape.setUpperDeltaY(2000);

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.

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.

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.

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.

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.

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.

public GroupShape getGroup()

Gets the group shape which contains this shape.

Example:

GroupShape groupShape = shape.getGroup();

public int getType()

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

Example:

/*Aspose.Cells.Drawing.AutoShapeType*/int autoShapeType = shape.getType();

public boolean hasLine() / public void setHasLine(boolean value)

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

Example:

if(shape.hasLine() == false)
    shape.setHasLine(true);

public boolean isFilled() / public void setFilled(boolean value)

Indicates whether the fill format is visible.

Example:

if(shape.isFilled() == false)
    shape.setFilled(true);

public boolean isFlippedHorizontally() / public void setFlippedHorizontally(boolean value)

Gets and sets whether shape is horizontally flipped .

Example:

if(shape.isFlippedHorizontally() == false)
    shape.setFlippedHorizontally(true);

public boolean isFlippedVertically() / public void setFlippedVertically(boolean value)

Gets and sets whether shape is vertically flipped .

Example:

if(shape.isFlippedVertically() == false)
    shape.setFlippedVertically(true);

public int getActualLowerRightRow()

Get the actual bottom row.

Example:

int rRow = shape.getActualLowerRightRow();

public java.awt.geom.Point2D.Float[] getConnectionPoints()

Get the connection points

NOTE: This member is now obsolete. Instead, please use GetConnectionPoints() method. This method will be removed 12 months later since April 2022. Aspose apologizes for any inconvenience you may have experienced.

public boolean getRelativeToOriginalPictureSize() / public void setRelativeToOriginalPictureSize(boolean value)

Indicates whether shape is relative to original picture size.

Example:

if(shape.getRelativeToOriginalPictureSize())
    shape.setRelativeToOriginalPictureSize(false);

public java.lang.String getLinkedCell() / public void setLinkedCell(java.lang.String value)

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

Example:

if (shape.getLinkedCell().equals("$B$6"))
    shape.setLinkedCell("A1");

public java.lang.String getInputRange() / public void setInputRange(java.lang.String value)

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

Example:

if (shape.getInputRange().equals("$B$6:$B10"))
    shape.setInputRange("$A$1:$A$5");

public int getTextShapeType() / public void setTextShapeType(int value)

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

Example:

if (shape.getTextShapeType() == com.aspose.cells.AutoShapeType.UNKNOWN)
    shape.setTextShapeType(com.aspose.cells.AutoShapeType.RECTANGLE);

public FontSettingCollection getTextBody()

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

Example:

FontSettingCollection fontSettingCollection = shape.getTextBody();
fontSettingCollection.setText("This is a test.");

public Font getFont() / public void setFont(Font value)

Represents the font of shape.

Example:

Font font = shape.getFont();
font.setName("Arial");
font.setSize(12);
font.setColor(Color.getRed());

public TextOptions getTextOptions() / public void setTextOptions(TextOptions value)

Represents the text options of the shape.

Example:

TextOptions opt = shape.getTextOptions();
opt.setColor(Color.getBlue());
opt.setSize(8);

public java.lang.String getText() / public void setText(java.lang.String value)

Represents the string in this TextBox object.

Example:

if(shape.getText() == null)
    shape.setText("This is a test.");

public boolean isRichText()

Whether or not the text is rich text.

Example:

if(shape.isRichText())
    System.out.println("The text is rich text.");

public java.lang.String getHtmlText() / public void setHtmlText(java.lang.String value)

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

Example:

if(shape.getHtmlText() == null || "".equals(shape.getHtmlText()))
    shape.setHtmlText("<Font Style=&quot;FONT-FAMILY: Calibri;FONT-SIZE: 11pt;COLOR: #0000ff;TEXT-ALIGN: left;&quot;>This is a <b>test</b>.</Font>");

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.

Example:

if (shape.getTextVerticalOverflow() == com.aspose.cells.TextOverflowType.CLIP)
    shape.setTextVerticalOverflow(com.aspose.cells.TextOverflowType.OVERFLOW);

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.

Example:

if (shape.getTextHorizontalOverflow() == com.aspose.cells.TextOverflowType.CLIP)
    shape.setTextHorizontalOverflow(com.aspose.cells.TextOverflowType.OVERFLOW);

public boolean isTextWrapped() / public void setTextWrapped(boolean value)

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

Example:

if (shape.isTextWrapped())
    shape.setTextWrapped(!shape.isTextWrapped());

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.

Example:

if (shape.getTextOrientationType() == com.aspose.cells.TextOrientationType.NO_ROTATION)
    shape.setTextOrientationType(com.aspose.cells.TextOrientationType.TOP_TO_BOTTOM);

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.

Example:

if (shape.getTextHorizontalAlignment() == com.aspose.cells.TextAlignmentType.BOTTOM)
    shape.setTextHorizontalAlignment(com.aspose.cells.TextAlignmentType.CENTER);

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.

Example:

if (shape.getTextVerticalAlignment() == com.aspose.cells.TextAlignmentType.BOTTOM)
    shape.setTextVerticalAlignment(com.aspose.cells.TextAlignmentType.CENTER);

public int getTextDirection() / public void setTextDirection(int value)

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

Example:

if (shape.getTextDirection() == com.aspose.cells.TextDirectionType.CONTEXT)
    shape.setTextDirection(com.aspose.cells.TextDirectionType.LEFT_TO_RIGHT);

public byte[] getControlData()

Gets the data of control.

Example:

if(shape.getControlData() == null)
    System.out.println("No data.");

public ActiveXControl getActiveXControl()

Gets the ActiveX control.

Example:

CheckBoxActiveXControl checkBox1 = (CheckBoxActiveXControl)shape.getActiveXControl();
//The font name of CheckBox
String fontName = checkBox1.getFont().getName();

public ShapePathCollection getPaths()

Gets the paths of a custom geometric shape.

Example:

//Returns non-null if there is a path to the custom geometry
if(shape.getPaths() == null)
    System.out.println("No custom geometry path.");

public Geometry getGeometry()

Gets the geometry

Example:

if (shape.getGeometry().getShapeAdjustValues().getCount() == 0)
    System.out.println("No geometry path.");

public java.util.UUID getCreateId()

Gets and sets create id for this shape.

public void setEmbeddedObject(boolean linkToFile, byte[] objectData, java.lang.String sourceFileName, boolean displayAsIcon, java.lang.String label)
                      throws java.lang.Exception

Sets embedded object data.

Parameters:

linkToFile - Indicates whether the object links to the file. If true, the parameter objectData is ignored.

objectData - The embedded object data.

sourceFileName - The file name.

displayAsIcon - Indicates whether diplaying object as an icon. If true, the orginal image data will be covered by icon.

label - The icon label. Only works when displayAsIcon as true.

public void setEmbeddedObject(boolean linkToFile, byte[] objectData, java.lang.String sourceFileName, boolean displayAsIcon, java.lang.String label, boolean updateIcon)
                      throws java.lang.Exception

Sets embedded object data.

As Aspose can update embedd all file icons, so it's better that you can add correct icon with updateIcon as false.

Parameters:

linkToFile - Indicates whether the object links to the file. If true, the parameter objectData is ignored.

objectData - The embedded object data.

sourceFileName - The file name.

displayAsIcon - Indicates whether diplaying object as an icon. If true, the orginal image data will be covered by icon.

label - The icon label. Only works when displayAsIcon as true.

updateIcon - Indicates whether automatically updating icon.

public void setNativeSourceFullName(java.lang.String sourceFullName)
                            throws java.lang.Exception

Sets the ole native source full file name with path.

Parameters:

sourceFullName - the ole native source full file name

public java.lang.String getLinkedCell(boolean isR1C1, boolean isLocal)

Gets the range linked to the control's value.

Parameters:

isR1C1 - Whether the formula needs to be formatted as R1C1.

isLocal - Whether the formula needs to be formatted by locale.

Returns:

The range linked to the control's value.

Example:

//You may get results like '$A$1'
String link = shape.getLinkedCell(false, false);

public void setLinkedCell(java.lang.String formula, boolean isR1C1, boolean isLocal)

Sets the range linked to the control's value.

Parameters:

formula - The range linked to the control's value.

isR1C1 - Whether the formula needs to be formatted as R1C1.

isLocal - Whether the formula needs to be formatted by locale.

Example:

//After executing the code below, a ScrollBar object is created in the generated file. As you drag the slider, the value is displayed in cell A12.

//ActiveX Controls
//Aspose.Cells.Drawing.Shape scrollBar = book.Worksheets[0].Shapes.AddActiveXControl( Aspose.Cells.Drawing.ActiveXControls.ControlType.ScrollBar,2, 0, 2, 0, 30, 130);

//Form Controls
Shape scrollBar = book.getWorksheets().get(0).getShapes().addScrollBar(2, 0, 2, 0, 130, 30);

//Sets the range linked to the control's value.
scrollBar.setLinkedCell("$A$12", false, true);

public java.lang.String getInputRange(boolean isR1C1, boolean isLocal)

Gets the range used to fill the control.

Parameters:

isR1C1 - Whether the formula needs to be formatted as R1C1.

isLocal - Whether the formula needs to be formatted by locale.

Returns:

The range used to fill the control.

Example:

String range = shape.getInputRange(false, true);
//If successful, a value like "$A$1:$A$3" will be returned

public void setInputRange(java.lang.String formula, boolean isR1C1, boolean isLocal)

Sets the range used to fill the control.

Parameters:

formula - The range used to fill the control.

isR1C1 - Whether the formula needs to be formatted as R1C1.

isLocal - Whether the formula needs to be formatted by locale.

Example:

//After executing the code below, a ListBox object is created in the generated file. When the selected option is clicked, the selected value is displayed in cell A12.

//Initialize a new workbook.
//Workbook book = new Workbook();
        
for (int i = 0; i< 10; ++i)
{
    Cell cell = book.getWorksheets().get(0).getCells().get(i, 0);
    cell.setValue(i + 1);
}
   
//Create a ListBox object

//ActiveX Controls
//Aspose.Cells.Drawing.Shape listBox = book.Worksheets[0].Shapes.AddActiveXControl( Aspose.Cells.Drawing.ActiveXControls.ControlType.ListBox,2, 0, 2, 0, 130, 130);

//Form Controls
Shape listBox = book.getWorksheets().get(0).getShapes().addListBox(2, 0, 2, 0, 130, 130);

//Sets the range used to fill the control.
listBox.setInputRange("$A$1:$A$6", false, false);

//Sets the range linked to the control's value.
listBox.setLinkedCell("$A$12", false, true);

public void updateSelectedValue()
                        throws java.lang.Exception

Update the selected value by the value of the linked cell.

Example:

//Initialize a new workbook.
//Workbook book = new Workbook();
        
Cell cell = null;
for (int i = 0; i< 10; ++i)
{
    cell = book.getWorksheets().get(0).getCells().get(i, 0);
    cell.setValue(i + 1);
}
   
//Create a ListBox object

//ActiveX Controls
//Aspose.Cells.Drawing.Shape listBox = book.Worksheets[0].Shapes.AddActiveXControl( Aspose.Cells.Drawing.ActiveXControls.ControlType.ListBox,2, 0, 2, 0, 130, 130);

//Form Controls
Shape listBox = book.getWorksheets().get(0).getShapes().addListBox(2, 0, 2, 0, 130, 130);

//Sets the range used to fill the control.
listBox.setInputRange("$A$1:$A$6", false, false);

//Sets the range linked to the control's value.
listBox.setLinkedCell("$A$12", false, true);

ListBox listbx = (ListBox)listBox;

//Set the value of cell A12
cell = book.getWorksheets().get(0).getCells().get(11, 0);
cell.setValue(3);

//Update the selected value by the value of the linked cell.
listBox.updateSelectedValue();

//-1 default, no option selected
if(listbx.isSelected(2))
{
    //Option 3 of the ListBox is selected
}

//Change the value of a linked cell
cell.setValue(4);

//Update the selected value by the value of the linked cell.
listBox.updateSelectedValue();
if(listbx.isSelected(3))
{
    //Option 4 of the ListBox is selected
}

public int[] calculateTextSize()
                       throws java.lang.Exception

Recalculate the text area

Returns:

Text's Size in an array(width and height).

Example:

//The size of the text area is:w=size[0],h=size[1]
int[] size = shape.calculateTextSize();

public void formatCharacters(int startIndex, int length, Font font, StyleFlag flag)
                     throws java.lang.Exception

Formats some characters with the font setting.

Parameters:

startIndex - The start index.

length - The length.

font - The font setting.

flag - The flag of the font setting.

public void formatCharacters(int startIndex, int length, Font font)

Formats some characters with the font setting.

NOTE: This member is now obsolete. Instead, please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method. This property will be removed 12 months later since March 2016. Aspose apologizes for any inconvenience you may have experienced.

Parameters:

startIndex - The start index.

length - The length.

font - The font setting.

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.

Example:

FontSetting fontSetting = shape.characters(0, 4);

public java.util.ArrayList getCharacters()
                       throws java.lang.Exception

Returns all Characters objects that represents a range of characters within the text .

Returns:

All Characters objects

Example:

ArrayList list = shape.getCharacters();

public void removeActiveXControl()

Remove activeX control.

Example:

shape.removeActiveXControl();

public boolean isSameSetting(java.lang.Object obj)

Returns whether the shape is same.

Parameters:

obj -

Returns:

Example:

if (shape.isSameSetting(shape))
    System.out.println("Two objects the same.");

public float[][] 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.

Example:

float[][] points = shape.getConnectionPoints();

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.

public void toImage(java.lang.String imageFile, ImageOrPrintOptions options)
            throws java.lang.Exception

Saves the shape to a file.

Example:

ImageOrPrintOptions op = new ImageOrPrintOptions();
shape.toImage("exmaple.png", op);

public void toImage(java.io.OutputStream stream, ImageOrPrintOptions options)
            throws java.lang.Exception

Saves the shape to a stream.

public GroupShape getResultOfSmartArt()
                              throws java.lang.Exception

Converting smart art to grouped shapes.

Example:

GroupShape groupShape = shape.getResultOfSmartArt();

public void toFrontOrBack(int orders)

Brings the shape to the front or sends the shape to back.

Parameters:

orders - If it's less than zero, sets the shape to back. If it's greater than zero, brings the shape to front.

Example:

shape.toFrontOrBack(2);
//or shape.ToFrontOrBack(-1);

public boolean getLockedProperty(int type)

Gets the value of locked property.

Parameters:

type - A ShapeLockType value. The type of the shape locked property.

Returns:

Returns the value of locked property.

Example:

int noAdjustHandles = 0;
if (shape.getLockedProperty(ShapeLockType.ADJUST_HANDLES))
    noAdjustHandles = 1;

public void setLockedProperty(int type, boolean value)

Set the locked property.

Parameters:

type - A ShapeLockType value. The locked type.

value - The value of the property.

Example:

shape.setLockedProperty(ShapeLockType.ADJUST_HANDLES, true);

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.

Example:

Hyperlink hyperlink = shape.addHyperlink("https://www.aspose.com/");

public void removeHyperlink()

Remove the hyperlink of the shape.

Example:

shape.removeHyperlink();

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

Example:

shape.moveToRange(12, 3, 13, 5);

public void alignTopRightCorner(int topRow, int rightColumn)

Moves the picture to the top-right corner.

Parameters:

topRow - the row index.

rightColumn - the column index.

Example:

shape.alignTopRightCorner(2, 5);