java.lang.ObjectCollectionBase
com.aspose.cells.ShapeCollection
public class ShapeCollection
Property Getters/Setters Summary | ||
---|---|---|
int | getCount() | → inherited from com.aspose.cells.CollectionBase |
Shape | get(int index) | |
Gets the shape object at the specific index. | ||
Shape | get(java.lang.String name) | |
Gets the shape object by the shape image |
Method Summary | ||
---|---|---|
int | add(java.lang.Object value) | → inherited from com.aspose.cells.CollectionBase |
Reserved for internal use. | ||
Shape | addAutoShape(int type, int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width) | |
Adds a AutoShape to the worksheet. | ||
Shape | addAutoShapeInChart(int type, int top, int left, int height, int width) | |
Adds a AutoShape to the chart. | ||
Shape | addCopy(Shape sourceShape, int upperLeftRow, int top, int upperLeftColumn, int left) | |
Adds and copy a shape to the worksheet.. | ||
Shape | addFreeFloatingShape(int type, int top, int left, int height, int width, byte[] imageData, boolean isOriginalSize) | |
Adds a free floating shape to the worksheet.Only applies for line/image shape. | ||
Label | addLabelInChart(int top, int left, int height, int width) | |
Adds a label to the chart. | ||
Picture | addLinkedPicture(int upperLeftRow, int upperLeftColumn, int height, int width, java.lang.String sourceFullName) | |
Add a linked picture. | ||
OleObject | addOleObject(int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width, byte[] imageData) | |
OleObject | addOleObjectWithLinkedImage(int upperLeftRow, int upperLeftColumn, int height, int width, java.lang.String sourceFullName) | |
Add a linked picture. | ||
Picture | addPicture(int upperLeftRow, int upperLeftColumn, java.io.InputStream stream, int widthScale, int heightScale) | |
Adds a picture to the collection. | ||
Picture | addPictureInChart(int top, int left, java.io.InputStream stream, int widthScale, int heightScale) | |
Adds a picture to the chart. | ||
Shape | addShape(int type, int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width) | |
Adds a Shape to the worksheet. | ||
Shape | addShapeInChart(int type, int placement, int left, int top, int right, int bottom) | |
Add a shape to chart .All unit is 1/4000 of chart area. | ||
Shape | addShapeInChart1(int type, int placement, int left, int top, int right, int bottom, byte[] imageData) | |
Add a shape to chart .All unit is 1/4000 of chart area. | ||
TextBox | addTextBoxInChart(int top, int left, int height, int width) | |
Adds a textbox to the chart. | ||
Shape | addTextEffect(int effect, java.lang.String text, java.lang.String fontName, int size, boolean fontBold, boolean fontItalic, int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width) | |
Inserts a WordArt object. | ||
Shape | addTextEffectInChart(int effect, java.lang.String text, java.lang.String fontName, int size, boolean fontBold, boolean fontItalic, int top, int left, int height, int width) | |
Inserts a WordArt object to the chart | ||
void | clear() | → inherited from com.aspose.cells.CollectionBase |
boolean | contains(java.lang.Object value) | → inherited from com.aspose.cells.CollectionBase |
Reserved for internal use. | ||
void | copyCommentsInRange(ShapeCollection shapes, CellArea ca, int destRow, int destColumn) | |
Copy all comments in the range. | ||
void | copyInRange(ShapeCollection sourceShapes, CellArea ca, int destRow, int destColumn, boolean isContained) | |
Copy shapes in the range to destination range. | ||
void | deleteInRange(CellArea ca) | |
Delete shapes in the range.Comment shapes will not be deleted. | ||
void | deleteShape(Shape shape) | |
Delete a shape. If the shape is in the group or is a comment shape, it will not be deleted. | ||
java.lang.Object | get(int index) | → inherited from com.aspose.cells.CollectionBase |
Reserved for internal use. | ||
GroupShape | group(com.aspose.cells.Shape[] groupItems) | |
Group the shapes. | ||
int | indexOf(java.lang.Object value) | → inherited from com.aspose.cells.CollectionBase |
Reserved for internal use. | ||
java.util.Iterator | iterator() | → inherited from com.aspose.cells.CollectionBase |
void | remove(Shape shape) | |
Remove the shape. | ||
void | removeAt(int index) | |
Remove the shape. | ||
void | ungroup(GroupShape group) | |
Ungroups the shape items. | ||
void | updateSelectedValue() | |
Update the selected value by the value of the linked cell of the shapes. |
Property Getters/Setters Detail |
---|
getCount | → inherited from com.aspose.cells.CollectionBase |
public int getCount() |
get | |
public Shape get(int index) |
index
- get | |
public Shape get(java.lang.String name) |
name
- Method Detail |
---|
addCopy | |
public Shape addCopy(Shape sourceShape, int upperLeftRow, int top, int upperLeftColumn, int left) |
sourceShape
- Source shape.upperLeftRow
- Upper left row index.top
- Represents the vertical offset of checkbox from its left row, in unit of pixel. upperLeftColumn
- Upper left column index.left
- Represents the horizontal offset of textbox from its left column, in unit of pixel. addLabelInChart | |
public Label addLabelInChart(int top, int left, int height, int width) |
top
- Represents the vertical offset of label from the upper left corner in units of 1/4000 of the chart area. left
- Represents the vertical offset of label from the upper left corner in units of 1/4000 of the chart area.height
- Represents the height of label, in units of 1/4000 of the chart area.width
- Represents the width of label, in units of 1/4000 of the chart area.addTextBoxInChart | |
public TextBox addTextBoxInChart(int top, int left, int height, int width) |
top
- Represents the vertical offset of textbox from the upper left corner in units of 1/4000 of the chart area. left
- Represents the vertical offset of textbox from the upper left corner in units of 1/4000 of the chart area.height
- Represents the height of textbox, in units of 1/4000 of the chart area.width
- Represents the width of textbox, in units of 1/4000 of the chart area.addTextEffectInChart | |
public Shape addTextEffectInChart(int effect, java.lang.String text, java.lang.String fontName, int size, boolean fontBold, boolean fontItalic, int top, int left, int height, int width) |
effect
- A text
- The WordArt text.fontName
- The font name.size
- The font sizefontBold
- Indicates whether font is bold.fontItalic
- Indicates whether font is italic.top
- Represents the vertical offset of shape from the upper left corner in units of 1/4000 of the chart area. left
- Represents the vertical offset of shape from the upper left corner in units of 1/4000 of the chart area.height
- Represents the height of shape, in units of 1/4000 of the chart area.width
- Represents the width of shape, in units of 1/4000 of the chart area.addTextEffect | |
public Shape addTextEffect(int effect, java.lang.String text, java.lang.String fontName, int size, boolean fontBold, boolean fontItalic, int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width) |
effect
- A text
- The WordArt text.fontName
- The font name.size
- The font sizefontBold
- Indicates whether font is bold.fontItalic
- Indicates whether font is italic.upperLeftRow
- Upper left row index.top
- Represents the vertical offset of shape from its left row, in unit of pixel. upperLeftColumn
- Upper left column index.left
- Represents the horizontal offset of shape from its left column, in unit of pixel. height
- Represents the height of shape, in unit of pixel. width
- Represents the width of shape, in unit of pixel. addFreeFloatingShape | |
public Shape addFreeFloatingShape(int type, int top, int left, int height, int width, byte[] imageData, boolean isOriginalSize) throws java.lang.Exception |
type
- A top
- Represents the vertical offset of shape from the worksheet's top row, in unit of pixel.left
- Represents the horizontal offset of shape from the worksheet's left column, in unit of pixel.height
- Represents the height of LineShape, in unit of pixel. width
- Represents the width of LineShape, in unit of pixel. imageData
- The image data,only applies for the picture.isOriginalSize
- Whether the shape use original size if the shape is image.addShapeInChart1 | |
public Shape addShapeInChart1(int type, int placement, int left, int top, int right, int bottom, byte[] imageData) throws java.lang.Exception |
type
- A placement
- A left
- In unit of 1/4000 chart area width.top
- In unit of 1/4000 chart area height.right
- In unit of 1/4000 chart area width.bottom
- In unit of 1/4000 chart area height.imageData
- If the shape is not a picture or ole object,imageData should be null.addShapeInChart | |
public Shape addShapeInChart(int type, int placement, int left, int top, int right, int bottom) |
type
- A placement
- A left
- In unit of 1/4000 chart area width.top
- In unit of 1/4000 chart area height.right
- In unit of 1/4000 chart area width.bottom
- In unit of 1/4000 chart area height.addShape | |
public Shape addShape(int type, int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width) |
type
- A upperLeftRow
- Upper left row index.top
- Represents the vertical offset of Shape from its left row, in unit of pixel. upperLeftColumn
- Upper left column index.left
- Represents the horizontal offset of Shape from its left column, in unit of pixel. height
- Represents the height of Shape, in unit of pixel. width
- Represents the width of Shape, in unit of pixel. addAutoShape | |
public Shape addAutoShape(int type, int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width) |
type
- A upperLeftRow
- Upper left row index.top
- Represents the vertical offset of Shape from its left row, in unit of pixel. upperLeftColumn
- Upper left column index.left
- Represents the horizontal offset of Shape from its left column, in unit of pixel. height
- Represents the height of Shape, in unit of pixel. width
- Represents the width of Shape, in unit of pixel. addAutoShapeInChart | |
public Shape addAutoShapeInChart(int type, int top, int left, int height, int width) |
type
- A top
- Represents the vertical offset of textbox from the upper left corner in units of 1/4000 of the chart area. left
- Represents the vertical offset of textbox from the upper left corner in units of 1/4000 of the chart area.height
- Represents the height of textbox, in units of 1/4000 of the chart area.width
- Represents the width of textbox, in units of 1/4000 of the chart area.addPicture | |
public Picture addPicture(int upperLeftRow, int upperLeftColumn, java.io.InputStream stream, int widthScale, int heightScale) throws java.lang.Exception |
upperLeftRow
- Upper left row index.upperLeftColumn
- Upper left column index.stream
- Stream object which contains the image data.widthScale
- Scale of image width, a percentage.heightScale
- Scale of image width, a percentage.addLinkedPicture | |
public Picture addLinkedPicture(int upperLeftRow, int upperLeftColumn, int height, int width, java.lang.String sourceFullName) |
upperLeftRow
- Upper left row index.upperLeftColumn
- Upper left column index.height
- The height of the shape. In unit of pixelswidth
- The width of the shape. In unit of pixelssourceFullName
-
The path and name of the source file for the linked imageaddOleObjectWithLinkedImage | |
public OleObject addOleObjectWithLinkedImage(int upperLeftRow, int upperLeftColumn, int height, int width, java.lang.String sourceFullName) |
upperLeftRow
- Upper left row index.upperLeftColumn
- Upper left column index.height
- The height of the shape. In unit of pixelswidth
- The width of the shape. In unit of pixelssourceFullName
-
The path and name of the source file for the linked imageaddPictureInChart | |
public Picture addPictureInChart(int top, int left, java.io.InputStream stream, int widthScale, int heightScale) throws java.lang.Exception |
top
- Represents the vertical offset of shape from the upper left corner in units of 1/4000 of the chart area. left
- Represents the vertical offset of shape from the upper left corner in units of 1/4000 of the chart area.stream
- Stream object which contains the image data.widthScale
- Scale of image width, a percentage.heightScale
- Scale of image width, a percentage.addOleObject | |
public OleObject addOleObject(int upperLeftRow, int top, int upperLeftColumn, int left, int height, int width, byte[] imageData) throws java.lang.Exception |
upperLeftRow
- top
- upperLeftColumn
- left
- height
- width
- imageData
- copyCommentsInRange | |
public void copyCommentsInRange(ShapeCollection shapes, CellArea ca, int destRow, int destColumn) |
shapes
- The source shapes.ca
- The source range.destRow
- The dest range start row.destColumn
- The dest range start column.copyInRange | |
public void copyInRange(ShapeCollection sourceShapes, CellArea ca, int destRow, int destColumn, boolean isContained) |
sourceShapes
- Source shapes.ca
- The source range.destRow
- The dest row index of the dest range.destColumn
- The dest column of the dest range.isContained
- Whether only copy the shapes which are contained in the range.
If true,only copies the shapes in the range.
Otherwise,it works as MS Office.deleteInRange | |
public void deleteInRange(CellArea ca) |
ca
- The range.If the shapes are contained in the range, they will be removed.deleteShape | |
public void deleteShape(Shape shape) |
shape
- group | |
public GroupShape group(com.aspose.cells.Shape[] groupItems) |
groupItems
- the group items.ungroup | |
public void ungroup(GroupShape group) |
group
- The group shape.removeAt | |
public void removeAt(int index) |
index
- The index of the shape.remove | |
public void remove(Shape shape) |
shape
- updateSelectedValue | |
public void updateSelectedValue() throws java.lang.Exception |
clear | → inherited from com.aspose.cells.CollectionBase |
public void clear() |
iterator | → inherited from com.aspose.cells.CollectionBase |
public java.util.Iterator iterator() |
get | → inherited from com.aspose.cells.CollectionBase |
public java.lang.Object get(int index) |
contains | → inherited from com.aspose.cells.CollectionBase |
public boolean contains(java.lang.Object value) |
add | → inherited from com.aspose.cells.CollectionBase |
public int add(java.lang.Object value) |
indexOf | → inherited from com.aspose.cells.CollectionBase |
public int indexOf(java.lang.Object value) |