ShapeCollection

Inheritance: java.lang.Object, com.aspose.slides.DomObject

All Implemented Interfaces: com.aspose.slides.IShapeCollection

public final class ShapeCollection extends DomObject<GroupShape> implements IShapeCollection

Represents a collection of a shapes.

Methods

MethodDescription
size()Gets the number of elements actually contained in the collection.
get_Item(int index)Gets the element at the specified index.
addChart(int type, float x, float y, float width, float height)Creates a new Chart, initialize it with sample series data and settings and adds it to the end of the collection.
addChart(int type, float x, float y, float width, float height, boolean initWithSample)Creates a new Chart and adds it to the end of the collection.
addSmartArt(float x, float y, float width, float height, int layoutType)Add SmartArt diagram.
insertChart(int type, float x, float y, float width, float height, int index)Creates a new Chart, initialize it with sample series data and settings and inserts it to the specified position in the collection.
insertChart(int type, float x, float y, float width, float height, int index, boolean initWithSample)Creates a new Chart and inserts it to the specified position in the collection.
addZoomFrame(float x, float y, float width, float height, ISlide slide)Adds a new Zoom object to the end of a collection.
addZoomFrame(float x, float y, float width, float height, ISlide slide, IPPImage image)Adds a new Zoom object to the end of a collection.
insertZoomFrame(int index, float x, float y, float width, float height, ISlide slide)Creates a new Zoom object and inserts it to a collection at the specified index.
insertZoomFrame(int index, float x, float y, float width, float height, ISlide slide, IPPImage image)Creates a new Zoom object and inserts it to a collection at the specified index.
addSectionZoomFrame(float x, float y, float width, float height, ISection section)Adds a new Section Zoom object to the end of a collection.
addSectionZoomFrame(float x, float y, float width, float height, ISection section, IPPImage image)Adds a new Section Zoom object to the end of a collection with a predefined image.
insertSectionZoomFrame(int index, float x, float y, float width, float height, ISection section)Creates a new Section Zoom object and inserts into to a collection at the specified index.
insertSectionZoomFrame(int index, float x, float y, float width, float height, ISection section, IPPImage image)Creates a new Section Zoom object and inserts it to a collection at the specified index.
addSummaryZoomFrame(float x, float y, float width, float height)Adds a new Summary Zoom object to the end of a collection.
insertSummaryZoomFrame(int index, float x, float y, float width, float height)Creates a new Summary Zoom object and inserts it to a collection at the specified index.
addOleObjectFrame(float x, float y, float width, float height, IOleEmbeddedDataInfo dataInfo)Adds a new OLE object to the end of a collection.
addOleObjectFrame(float x, float y, float width, float height, String className, String path)Adds a new OLE object to the end of a collection.
insertOleObjectFrame(int index, float x, float y, float width, float height, IOleEmbeddedDataInfo dataInfo)Creates a new OLE object and inserts it to a collection at the specified index.
insertOleObjectFrame(int index, float x, float y, float width, float height, String className, String path)Creates a new OLE object and inserts it to a collection at the specified index.
addVideoFrame(float x, float y, float width, float height, String fname)Adds a new video frame to the end of a collection.
addVideoFrame(float x, float y, float width, float height, IVideo video)Adds a new video frame to the end of a collection.
insertVideoFrame(int index, float x, float y, float width, float height, String fname)Creates a new video frame and inserts it to a collection at the specified index.
addAudioFrameCD(float x, float y, float width, float height)Adds an AudioFrame with CD to the end of collection.
insertAudioFrameCD(int index, float x, float y, float width, float height)Insert an AudioFrame with CD.
addAudioFrameLinked(float x, float y, float width, float height, String fname)Adds a new audio frame with linked audio file to the end of a collection.
insertAudioFrameLinked(int index, float x, float y, float width, float height, String fname)Creates a new audio frame with linked audio file and inserts it to a collection at the specified index.
addAudioFrameEmbedded(float x, float y, float width, float height, InputStream audio_stream)Adds a new audio frame with embedded audio file to the end of a collection.
insertAudioFrameEmbedded(int index, float x, float y, float width, float height, InputStream audio_stream)Insert an AudioFrame with embedded audio file.
addAudioFrameEmbedded(float x, float y, float width, float height, IAudio audio)Adds a new audio frame with embedded audio file to the end of a collection.
insertAudioFrameEmbedded(int index, float x, float y, float width, float height, IAudio audio)Insert an AudioFrame with embedded audio file.
indexOf(IShape shape)Returns the zero-based index of the first occurrence of a shape in the collection.
toArray()Creates and returns an array with all shapse in it.
toArray(int startIndex, int count)Creates and returns an array with all shapes from the specified range in it.
reorder(int index, IShape shape)Moves a shape from the collection to the specified position.
reorder(int index, IShape[] shapes)Moves shapes from the collection to the specified position.
addAutoShape(int shapeType, float x, float y, float width, float height)Creates a new AutoShape, tunes it from default template and adds it to the end of the collection.
addAutoShape(int shapeType, float x, float y, float width, float height, boolean createFromTemplate)Creates a new AutoShape and adds it to the end of the collection.
addMathShape(float x, float y, float width, float height)Creates a new Autoshape tuned from default template to math content and adds it to the end of the collection.
insertAutoShape(int index, int shapeType, float x, float y, float width, float height)Creates a new AutoShape, tunes it from default template and inserts it to the collection at the specified index.
insertAutoShape(int index, int shapeType, float x, float y, float width, float height, boolean createFromTemplate)Creates a new AutoShape and inserts it to the collection at the specified index.
addGroupShape()Creates a new GroupShape and adds it to the end of the collection.
addGroupShape(ISvgImage svgImage, float x, float y, float width, float height)Creates a new GroupShape, fills it with converted shapes from SVG and adds it to the end of the collection.
insertGroupShape(int index)Creates a new GroupShape and inserts it to the collection at the specified index.
addConnector(int shapeType, float x, float y, float width, float height)Creates a new Connector, tunes it from default template and adds it to the end of the collection.
addConnector(int shapeType, float x, float y, float width, float height, boolean createFromTemplate)Creates a new Connector and adds it to the end of the collection.
insertConnector(int index, int shapeType, float x, float y, float width, float height)Creates a new Connector, tunes it from default template and inserts it to the collection at the specified index.
insertConnector(int index, int shapeType, float x, float y, float width, float height, boolean createFromTemplate)Creates a new Connector and inserts it to the collection at the specified index.
addPictureFrame(int shapeType, float x, float y, float width, float height, IPPImage image)Creates a new PictureFrame and adds it to the end of the collection.
insertPictureFrame(int index, int shapeType, float x, float y, float width, float height, IPPImage image)Creates a new PictureFrame and inserts it to the collection at the specified index.
addTable(float x, float y, double[] columnWidths, double[] rowHeights)Creates a new Table and adds it to the end of the collection.
insertTable(int index, float x, float y, double[] columnWidths, double[] rowHeights)Creates a new Table and inserts it to the collection at the specified index.
removeAt(int index)Removes the element at the specified index of the collection.
remove(IShape shape)Removes the first occurrence of a specific shape from the collection.
clear()Removes all shapes from the collection.
iterator()Returns an enumerator that iterates through the collection.
iteratorJava()Returns a java iterator for the entire collection.
getParentGroup()Returns parent GroupShape object for a shapes collection.
addClone(IShape sourceShape, float x, float y, float width, float height)Adds a copy of a specified shape to the end of the collection.
addClone(IShape sourceShape, float x, float y)Adds a copy of a specified shape to the end of the collection.
addClone(IShape sourceShape)Adds a copy of a specified shape to the end of the collection.
insertClone(int index, IShape sourceShape, float x, float y, float width, float height)Inserts a copy of a specified shape to specified position of the collection.
insertClone(int index, IShape sourceShape, float x, float y)Inserts a copy of a specified shape to specified position of the collection.
insertClone(int index, IShape sourceShape)Inserts a copy of a specified shape to specified position of the collection.
copyTo(System.Array array, int index)Copies all elements from the collection to the specified array.
isSynchronized()Returns a value indicating whether access to the collection is synchronized (thread-safe).
getSyncRoot()Returns a synchronization root.

size()

public final int size()

Gets the number of elements actually contained in the collection. Read-only int .

Returns: int

get_Item(int index)

public final IShape get_Item(int index)

Gets the element at the specified index. Read-only IShape.

Parameters:

ParameterTypeDescription
indexint

Returns: IShape

addChart(int type, float x, float y, float width, float height)

public final IChart addChart(int type, float x, float y, float width, float height)

Creates a new Chart, initialize it with sample series data and settings and adds it to the end of the collection.


The following example shows how to create Chart in PowerPoint Presentation.
 
 // Instantiates the Presentation class that represents a PPTX file
 Presentation pres = new Presentation();
 try {
     // Accesses the first slide
     ISlide sld = pres.getSlides().get_Item(0);
     // Adds a chart with its default data
     IChart chart = sld.getShapes().addChart(ChartType.ClusteredColumn, 0, 0, 500, 500);
     // Sets the chart title
     chart.getChartTitle().addTextFrameForOverriding("Sample Title");
     chart.getChartTitle().getTextFrameForOverriding().getTextFrameFormat().setCenterText(NullableBool.True);
     chart.getChartTitle().setHeight(20);
     chart.setTitle(true);
     // Sets the first series to show values
     chart.getChartData().getSeries().get_Item(0).getLabels().getDefaultDataLabelFormat().setShowValue(true);
     // Sets the index for the chart data sheet
     int defaultWorksheetIndex = 0;
     // Gets the chart data worksheet
     IChartDataWorkbook fact = chart.getChartData().getChartDataWorkbook();
     // Deletes the default generated series and categories
     chart.getChartData().getSeries().clear();
     chart.getChartData().getCategories().clear();
     // Adds new series
     chart.getChartData().getSeries().add(fact.getCell(defaultWorksheetIndex, 0, 1, "Series 1"), chart.getType());
     chart.getChartData().getSeries().add(fact.getCell(defaultWorksheetIndex, 0, 2, "Series 2"), chart.getType());
     // Adds new categories
     chart.getChartData().getCategories().add(fact.getCell(defaultWorksheetIndex, 1, 0, "Caetegoty 1"));
     chart.getChartData().getCategories().add(fact.getCell(defaultWorksheetIndex, 2, 0, "Caetegoty 2"));
     chart.getChartData().getCategories().add(fact.getCell(defaultWorksheetIndex, 3, 0, "Caetegoty 3"));
     // Takes the first chart series
     IChartSeries series = chart.getChartData().getSeries().get_Item(0);
     // Populates series data
     series.getDataPoints().addDataPointForBarSeries(fact.getCell(defaultWorksheetIndex, 1, 1, 20));
     series.getDataPoints().addDataPointForBarSeries(fact.getCell(defaultWorksheetIndex, 2, 1, 50));
     series.getDataPoints().addDataPointForBarSeries(fact.getCell(defaultWorksheetIndex, 3, 1, 30));
     // Sets the fill color for the series
     series.getFormat().getFill().setFillType(FillType.Solid);
     series.getFormat().getFill().getSolidFillColor().setColor(Color.RED);
     // Takes the second chart series
     series = chart.getChartData().getSeries().get_Item(1);
     // Populates series data
     series.getDataPoints().addDataPointForBarSeries(fact.getCell(defaultWorksheetIndex, 1, 2, 30));
     series.getDataPoints().addDataPointForBarSeries(fact.getCell(defaultWorksheetIndex, 2, 2, 10));
     series.getDataPoints().addDataPointForBarSeries(fact.getCell(defaultWorksheetIndex, 3, 2, 60));
     // Sets the fill color for series
     series.getFormat().getFill().setFillType(FillType.Solid);
     series.getFormat().getFill().getSolidFillColor().setColor(Color.GREEN);
     // Sets the first label to show Category name
     IDataLabel lbl = series.getDataPoints().get_Item(0).getLabel();
     lbl.getDataLabelFormat().setShowCategoryName(true);
     lbl = series.getDataPoints().get_Item(1).getLabel();
     lbl.getDataLabelFormat().setShowSeriesName(true);
     // Sets the series to show the value for the third label
     lbl = series.getDataPoints().get_Item(2).getLabel();
     lbl.getDataLabelFormat().setShowValue(true);
     lbl.getDataLabelFormat().setShowSeriesName(true);
     lbl.getDataLabelFormat().setSeparator("/");
     // Saves the PPTX file to disk
     pres.save("AsposeChart_out.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

ParameterTypeDescription
typeintType of chart.
xfloatX coordinate of a new chart.
yfloatY coordinate of a new chart.
widthfloatChart’s width.
heightfloatChart’s height.

Returns: IChart - Created chart.

addChart(int type, float x, float y, float width, float height, boolean initWithSample)

public final IChart addChart(int type, float x, float y, float width, float height, boolean initWithSample)

Creates a new Chart and adds it to the end of the collection.

Parameters:

ParameterTypeDescription
typeintType of chart.
xfloatX coordinate of a new chart.
yfloatY coordinate of a new chart.
widthfloatChart’s width.
heightfloatChart’s height.
initWithSamplebooleanIf true then new chart will be initialized with sample series data and settings. If false then new chart will have no series and minimum settings. In this case chart creation will be more fast.

Returns: IChart - Created chart.

addSmartArt(float x, float y, float width, float height, int layoutType)

public final ISmartArt addSmartArt(float x, float y, float width, float height, int layoutType)

Add SmartArt diagram.


The following example shows how to add smart shape in PowerPoint Presentation.
 
 Presentation pres = new Presentation();
 try {
     ISlide slide = pres.getSlides().get_Item(0);
     ISmartArt smart = slide.getShapes().addSmartArt(0, 0, 400, 400, SmartArtLayoutType.BasicBlockList);
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

ParameterTypeDescription
xfloatThe X-coordinate for a left side of diagram’s frame.
yfloatThe Y-coordinate for a left side of diagram’s frame.
widthfloatThe width of diagram’s frame.
heightfloatThe height of diagram’s frame.
layoutTypeintThe type of SmartArt diagram

Returns: ISmartArt - Create SmartArt diagram

insertChart(int type, float x, float y, float width, float height, int index)

public final IChart insertChart(int type, float x, float y, float width, float height, int index)

Creates a new Chart, initialize it with sample series data and settings and inserts it to the specified position in the collection.

Parameters:

ParameterTypeDescription
typeintType of chart.
xfloatX coordinate of a new chart.
yfloatY coordinate of a new chart.
widthfloatChart’s width.
heightfloatChart’s height.
indexintChart’s position in the collection.

Returns: IChart - Created chart.

insertChart(int type, float x, float y, float width, float height, int index, boolean initWithSample)

public final IChart insertChart(int type, float x, float y, float width, float height, int index, boolean initWithSample)

Creates a new Chart and inserts it to the specified position in the collection.

Parameters:

ParameterTypeDescription
typeintType of chart.
xfloatX coordinate of a new chart.
yfloatY coordinate of a new chart.
widthfloatChart’s width.
heightfloatChart’s height.
indexintChart’s position in the collection.
initWithSamplebooleanIf true then new chart will be initialized with sample series data and settings. If false then new chart will have no series and minimum settings. In this case chart creation will be more fast.

Returns: IChart - Created chart.

addZoomFrame(float x, float y, float width, float height, ISlide slide)

public final IZoomFrame addZoomFrame(float x, float y, float width, float height, ISlide slide)

Adds a new Zoom object to the end of a collection.


This example demonstrates adding a Zoom object to the end of a collection
 (assume that there are at least two slides in the "Presentation.pptx" presentation):
 
 Presentation pres = new Presentation("Presentation.pptx");
 try {
     IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addZoomFrame(150, 20, 50, 50, pres.getSlides().get_Item(1));
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

ParameterTypeDescription
xfloatX coordinate of a new Zoom frame float .
yfloatY coordinate of a new Zoom frame float .
widthfloatWidth of a new Zoom frame float .
heightfloatHeight of a new Zoom frame float .
slideISlideThe slide object referenced by the Zoom frame ISlide.

Returns: IZoomFrame - Created Zoom object IZoomFrame.

addZoomFrame(float x, float y, float width, float height, ISlide slide, IPPImage image)

public final IZoomFrame addZoomFrame(float x, float y, float width, float height, ISlide slide, IPPImage image)

Adds a new Zoom object to the end of a collection.


This example demonstrates adding a Zoom object to the end of a collection
 (assume that there are at least two slides in the "Presentation.pptx" presentation):
 
 Presentation pres = new Presentation("Presentation.pptx");
 try {
     IPPImage image = pres.getImages().addImage(imageBytes);
     IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addZoomFrame(150, 20, 50, 50, pres.getSlides().get_Item(1), image);
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

ParameterTypeDescription
xfloatX coordinate of a new Zoom frame float .
yfloatY coordinate of a new Zoom frame float .
widthfloatWidth of a new Zoom frame float .
heightfloatHeight of a new Zoom frame float .
slideISlideThe slide object referenced by the Zoom frame ISlide.
imageIPPImageThe image for the referenced slide IPPImage

Returns: IZoomFrame - Created Zoom object IZoomFrame.

insertZoomFrame(int index, float x, float y, float width, float height, ISlide slide)

public final IZoomFrame insertZoomFrame(int index, float x, float y, float width, float height, ISlide slide)

Creates a new Zoom object and inserts it to a collection at the specified index.


This example demonstrates creation and inserting a Zoom object at the specified index of a collection
 (assume that there are at least two slides in the "Presentation.pptx" presentation):
 
 Presentation pres = new Presentation("Presentation.pptx");
 try {
     IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().insertZoomFrame(2, 150, 20, 50, 50, pres.getSlides().get_Item(1));
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

ParameterTypeDescription
indexintThe zero-based index at which Zoom frame should be inserted.
xfloatX coordinate of a new Zoom frame float .
yfloatY coordinate of a new Zoom frame float .
widthfloatWidth of a new Zoom frame float .
heightfloatHeight of a new Zoom frame float .
slideISlideThe slide object referenced by the Zoom frame ISlide.

Returns: IZoomFrame - Created Zoom object IZoomFrame.

insertZoomFrame(int index, float x, float y, float width, float height, ISlide slide, IPPImage image)

public final IZoomFrame insertZoomFrame(int index, float x, float y, float width, float height, ISlide slide, IPPImage image)

Creates a new Zoom object and inserts it to a collection at the specified index.


This example demonstrates creation and inserting a Zoom object at the specified index of a collection
 (assume that there are at least two slides in the "Presentation.pptx" presentation):
 
 Presentation pres = new Presentation("Presentation.pptx");
 try {
     IPPImage image = pres.getImages().addImage(imageBytes);
     IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().insertZoomFrame(2, 150, 20, 50, 50, pres.getSlides().get_Item(1), image);
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

ParameterTypeDescription
indexintThe zero-based index at which Zoom frame should be inserted.
xfloatX coordinate of a new Zoom frame float .
yfloatY coordinate of a new Zoom frame float .
widthfloatWidth of a new Zoom frame float .
heightfloatHeight of a new Zoom frame float .
slideISlideThe slide object referenced by the Zoom frame ISlide.
imageIPPImageThe image for the referenced slide IPPImage

Returns: IZoomFrame - Created Zoom object IZoomFrame.

addSectionZoomFrame(float x, float y, float width, float height, ISection section)

public final ISectionZoomFrame addSectionZoomFrame(float x, float y, float width, float height, ISection section)

Adds a new Section Zoom object to the end of a collection.


This example demonstrates adding a Section Zoom object to the end of a collection
 (assume that there are at least two sections in the "Presentation.pptx" presentation):
 
 Presentation pres = new Presentation("Presentation.pptx");
 try {
     ISectionZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addSectionZoomFrame(150, 20, 50, 50, pres.getSections().get_Item(1));
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

ParameterTypeDescription
xfloatX coordinate of a new Section Zoom frame float .
yfloatY coordinate of a new Section Zoom frame float .
widthfloatWidth of a new Section Zoom frame float .
heightfloatHeight of a new Section Zoom frame float .
sectionISectionThe section object referenced by the Section Zoom frame ISection.

Returns: ISectionZoomFrame - Created Section Zoom object ISectionZoomFrame.

addSectionZoomFrame(float x, float y, float width, float height, ISection section, IPPImage image)

public final ISectionZoomFrame addSectionZoomFrame(float x, float y, float width, float height, ISection section, IPPImage image)

Adds a new Section Zoom object to the end of a collection with a predefined image.


This example demonstrates adding a Section Zoom object to the end of a collection
 (assume that there are at least two sections in the "Presentation.pptx" presentation):
 
 Presentation pres = new Presentation("Presentation.pptx");
 try {
     FileInputStream fos = null;
     try {
         fos = new FileInputStream("image.png");
         IPPImage image = pres.getImages().addImage(fos);
         ISectionZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addSectionZoomFrame(150, 20, 50, 50, pres.getSections().get_Item(1), image);
     } finally {
         if (fos != null) fos.close();
     }
 } catch (IOException e) {
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

ParameterTypeDescription
xfloatX coordinate of a new Section Zoom frame float .
yfloatY coordinate of a new Section Zoom frame float .
widthfloatWidth of a new Section Zoom frame float .
heightfloatHeight of a new Section Zoom frame float .
sectionISectionThe section object referenced by the Section Zoom frame ISection.
imageIPPImageThe image for the referenced slide IPPImage

Returns: ISectionZoomFrame - Created Section Zoom object ISectionZoomFrame.

insertSectionZoomFrame(int index, float x, float y, float width, float height, ISection section)

public final ISectionZoomFrame insertSectionZoomFrame(int index, float x, float y, float width, float height, ISection section)

Creates a new Section Zoom object and inserts into to a collection at the specified index.


This example demonstrates the creation and inserting a Section Zoom object at the specified index of a collection
 (assume that there are at least two sections in the "Presentation.pptx" presentation):
 
 Presentation pres = new Presentation("Presentation.pptx");
 try {
     ISectionZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().insertSectionZoomFrame(2, 150, 20, 50, 50, pres.getSections().get_Item(1));
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

ParameterTypeDescription
indexintThe zero-based index at which Section Zoom frame should be inserted.
xfloatX coordinate of a new Section Zoom frame float .
yfloatY coordinate of a new Section Zoom frame float .
widthfloatWidth of a new Section Zoom frame float .
heightfloatHeight of a new Section Zoom frame float .
sectionISectionThe slide object referenced by the Section Zoom frame ISection.

Returns: ISectionZoomFrame - Created Section Zoom object ISectionZoomFrame.

insertSectionZoomFrame(int index, float x, float y, float width, float height, ISection section, IPPImage image)

public final ISectionZoomFrame insertSectionZoomFrame(int index, float x, float y, float width, float height, ISection section, IPPImage image)

Creates a new Section Zoom object and inserts it to a collection at the specified index.


This example demonstrates the creation and inserting a Section Zoom object at the specified index of a collection
 (assume that there are at least two sections in the "Presentation.pptx" presentation):
 
 Presentation pres = new Presentation("Presentation.pptx");
 try {
     FileInputStream fos = null;
     try {
         fos = new FileInputStream("image.png");
         IPPImage image = pres.getImages().addImage(fos);
         ISectionZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().insertSectionZoomFrame(2, 150, 20, 50, 50, pres.getSections().get_Item(1), image);
     } finally {
         if (fos != null) fos.close();
     }
 } catch (IOException e) {
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

ParameterTypeDescription
indexintThe zero-based index at which Section Zoom frame should be inserted.
xfloatX coordinate of a new Section Zoom frame float .
yfloatY coordinate of a new Section Zoom frame float .
widthfloatWidth of a new Section Zoom frame float .
heightfloatHeight of a new Section Zoom frame float .
sectionISectionThe slide object referenced by the Section Zoom frame ISection.
imageIPPImageThe image for the referenced slide IPPImage

Returns: ISectionZoomFrame - Created Section Zoom object ISectionZoomFrame.

addSummaryZoomFrame(float x, float y, float width, float height)

public final ISummaryZoomFrame addSummaryZoomFrame(float x, float y, float width, float height)

Adds a new Summary Zoom object to the end of a collection.


This example demonstrates adding a Summary Zoom object to the end of a collection
 (assume that there are at least two sections in the "Presentation.pptx" presentation):
 
 Presentation pres = new Presentation("Presentation.pptx");
 try {
     ISummaryZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addSummaryZoomFrame(150, 20, 500, 250);
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

ParameterTypeDescription
xfloatX coordinate of a new Section Zoom frame float .
yfloatY coordinate of a new Section Zoom frame float .
widthfloatWidth of a new Section Zoom frame float .
heightfloatHeight of a new Section Zoom frame float .

This method creates a new Summary Zoom and puts a collection of objects into it for all the sections in this presentation. |

Returns: ISummaryZoomFrame - Created Summary Zoom object ISummaryZoomFrame.

insertSummaryZoomFrame(int index, float x, float y, float width, float height)

public final ISummaryZoomFrame insertSummaryZoomFrame(int index, float x, float y, float width, float height)

Creates a new Summary Zoom object and inserts it to a collection at the specified index.


This example demonstrates creation and inserting a Summary Zoom object at the specified index of a collection
 (assume that there are at least two sections in the "Presentation.pptx" presentation):
 
 Presentation pres = new Presentation("Presentation.pptx");
 try {
     ISummaryZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().insertSummaryZoomFrame(2, 150, 20, 50, 50);
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

ParameterTypeDescription
indexintThe zero-based index at which Section Zoom frame should be inserted.
xfloatX coordinate of a new Section Zoom frame float .
yfloatY coordinate of a new Section Zoom frame float .
widthfloatWidth of a new Section Zoom frame float .
heightfloatHeight of a new Section Zoom frame float .

This method creates a new Summary Zoom and puts a collection of objects into it for all the sections in this presentation. |

Returns: ISummaryZoomFrame - Created Summary Zoom object ISummaryZoomFrame.

addOleObjectFrame(float x, float y, float width, float height, IOleEmbeddedDataInfo dataInfo)

public final IOleObjectFrame addOleObjectFrame(float x, float y, float width, float height, IOleEmbeddedDataInfo dataInfo)

Adds a new OLE object to the end of a collection.


The following examples shows how to adding OLE Object Frames to Slides of PowerPoint Presentation.
 
 // Instantiate Presentation class that represents the PPTX
 Presentation pres = new Presentation();
 try
 {
     // Access the first slide
     ISlide sld = pres.getSlides().get_Item(0);

     // Load an cel file to stream
     FileInputStream fs = new FileInputStream("book1.xlsx");
     ByteArrayOutputStream mstream = new ByteArrayOutputStream();
     byte[] buf = new byte[4096];

     while (true)
     {
         int bytesRead = fs.read(buf, 0, buf.length);
         if (bytesRead <= 0)
             break;
         mstream.write(buf, 0, bytesRead);
     }
     // Create data object for embedding
     IOleEmbeddedDataInfo dataInfo = new OleEmbeddedDataInfo(mstream.toByteArray(), "xlsx");

     // Add an Ole Object Frame shape
     IOleObjectFrame oleObjectFrame = sld.getShapes().addOleObjectFrame(0, 0, (float)pres.getSlideSize().getSize().getWidth(),
             (float)pres.getSlideSize().getSize().getHeight(), dataInfo);

     //Write the PPTX to disk
     pres.save("OleEmbed_out.pptx", SaveFormat.Pptx);
 }
 catch (IOException e) { }
 finally
 {
     if (pres != null) pres.dispose();
 }

Parameters:

ParameterTypeDescription
xfloatX coordinate of a new OLE frame.
yfloatY coordinate of a new OLE frame.
widthfloatWidth of a new OLE frame.
heightfloatHeight of a new OLE frame.
dataInfoIOleEmbeddedDataInfoEmbedded data info IOleEmbeddedDataInfo.

Returns: IOleObjectFrame - Created OLE object.

addOleObjectFrame(float x, float y, float width, float height, String className, String path)

public final IOleObjectFrame addOleObjectFrame(float x, float y, float width, float height, String className, String path)

Adds a new OLE object to the end of a collection.

Parameters:

ParameterTypeDescription
xfloatX coordinate of a new OLE frame.
yfloatY coordinate of a new OLE frame.
widthfloatWidth of a new OLE frame.
heightfloatHeight of a new OLE frame.
classNamejava.lang.StringName of an OLE class.
pathjava.lang.StringPath to the linked file.

The path is stored in the presentation as is. If a relative path is specified the corresponding file will be inaccessible when opening the presentation from a different directory. |

Returns: IOleObjectFrame - Created OLE object.

insertOleObjectFrame(int index, float x, float y, float width, float height, IOleEmbeddedDataInfo dataInfo)

public final IOleObjectFrame insertOleObjectFrame(int index, float x, float y, float width, float height, IOleEmbeddedDataInfo dataInfo)

Creates a new OLE object and inserts it to a collection at the specified index.


This example demonstrates inserting an OLE object at the second index:
 
 byte[] fileData = ... // "test.zip"
 IOleDataInfo dataInfo = new OleDataInfo(fileData, "zip");
 IOleObjectFrame oleObjectFrame = slides.getShapes().addOleObjectFrame(2, 150, 20, 50, 50, dataInfo);

Parameters:

ParameterTypeDescription
indexintThe zero-based index at which OLE object should be inserted.
xfloatX coordinate of a new OLE frame.
yfloatY coordinate of a new OLE frame.
widthfloatWidth of a new OLE frame.
heightfloatHeight of a new OLE frame.
dataInfoIOleEmbeddedDataInfoEmbedded data info IOleEmbeddedDataInfo.

Returns: IOleObjectFrame - Created OLE object.

insertOleObjectFrame(int index, float x, float y, float width, float height, String className, String path)

public final IOleObjectFrame insertOleObjectFrame(int index, float x, float y, float width, float height, String className, String path)

Creates a new OLE object and inserts it to a collection at the specified index.

Parameters:

ParameterTypeDescription
indexintThe zero-based index at which OLE object should be inserted.
xfloatX coordinate of a new OLE frame.
yfloatY coordinate of a new OLE frame.
widthfloatWidth of a new OLE frame.
heightfloatHeight of a new OLE frame.
classNamejava.lang.StringName of an OLE class.
pathjava.lang.StringPath to the linked file.

Returns: IOleObjectFrame - Created OLE object.

addVideoFrame(float x, float y, float width, float height, String fname)

public final IVideoFrame addVideoFrame(float x, float y, float width, float height, String fname)

Adds a new video frame to the end of a collection.

Parameters:

ParameterTypeDescription
xfloatX coordinate of a new video frame.
yfloatY coordinate of a new video frame.
widthfloatWidth of a new video frame.
heightfloatHeight of a new video frame.
fnamejava.lang.StringVideo file name.

Returns: IVideoFrame - Created VideoFrame object.

addVideoFrame(float x, float y, float width, float height, IVideo video)

public final IVideoFrame addVideoFrame(float x, float y, float width, float height, IVideo video)

Adds a new video frame to the end of a collection.

Parameters:

ParameterTypeDescription
xfloatX coordinate of a new video frame.
yfloatY coordinate of a new video frame.
widthfloatWidth of a new video frame.
heightfloatHeight of a new video frame.
videoIVideoVideo to add.

Returns: IVideoFrame - Created VideoFrame object.

insertVideoFrame(int index, float x, float y, float width, float height, String fname)

public final IVideoFrame insertVideoFrame(int index, float x, float y, float width, float height, String fname)

Creates a new video frame and inserts it to a collection at the specified index.

Parameters:

ParameterTypeDescription
indexintThe zero-based index at which video frame should be inserted.
xfloatX coordinate of a new video frame.
yfloatY coordinate of a new video frame.
widthfloatWidth of a new video frame.
heightfloatHeight of a new video frame.
fnamejava.lang.StringVideo file name.

Returns: IVideoFrame - Created VideoFrame object.

addAudioFrameCD(float x, float y, float width, float height)

public final IAudioFrame addAudioFrameCD(float x, float y, float width, float height)

Adds an AudioFrame with CD to the end of collection.

Parameters:

ParameterTypeDescription
xfloatX coordinate of a new audio frame.
yfloatY coordinate of a new audio frame.
widthfloatWidth of a new audio frame.
heightfloatHeight of a new audio frame.

Returns: IAudioFrame - Created AudioFrame object.

insertAudioFrameCD(int index, float x, float y, float width, float height)

public final IAudioFrame insertAudioFrameCD(int index, float x, float y, float width, float height)

Insert an AudioFrame with CD.

Parameters:

ParameterTypeDescription
indexintThe zero-based index at which video frame should be inserted.
xfloatX coordinate of a new audio frame.
yfloatY coordinate of a new audio frame.
widthfloatWidth of a new audio frame.
heightfloatHeight of a new audio frame.

Returns: IAudioFrame - Created AudioFrame object.

addAudioFrameLinked(float x, float y, float width, float height, String fname)

public final IAudioFrame addAudioFrameLinked(float x, float y, float width, float height, String fname)

Adds a new audio frame with linked audio file to the end of a collection.

Parameters:

ParameterTypeDescription
xfloatX coordinate of a new audio frame.
yfloatY coordinate of a new audio frame.
widthfloatWidth of a new audio frame.
heightfloatHeight of a new audio frame.
fnamejava.lang.StringAudio file name.

Returns: IAudioFrame - Created AudioFrame object.

insertAudioFrameLinked(int index, float x, float y, float width, float height, String fname)

public final IAudioFrame insertAudioFrameLinked(int index, float x, float y, float width, float height, String fname)

Creates a new audio frame with linked audio file and inserts it to a collection at the specified index.

Parameters:

ParameterTypeDescription
indexintThe zero-based index at which audio frame should be inserted.
xfloatX coordinate of a new audio frame.
yfloatY coordinate of a new audio frame.
widthfloatWidth of a new audio frame.
heightfloatHeight of a new audio frame.
fnamejava.lang.StringAudio file name.

Returns: IAudioFrame - Created AudioFrame object.

addAudioFrameEmbedded(float x, float y, float width, float height, InputStream audio_stream)

public final IAudioFrame addAudioFrameEmbedded(float x, float y, float width, float height, InputStream audio_stream)

Adds a new audio frame with embedded audio file to the end of a collection. Embedded audio file can be a WAV only. It adds new audio into Presentation.Audios list.


The following examples shows how to create Audio Frame.
 
 // Instantiates a presentation class that represents a presentation file
 Presentation pres = new Presentation();
 try {
     // Gets the first slide
     ISlide sld = pres.getSlides().get_Item(0);
     // Loads the the wav sound file to stream
     FileInputStream fstr = new FileInputStream("sampleaudio.wav");
     try {
         // Adds the Audio Frame
         IAudioFrame audioFrame = sld.getShapes().addAudioFrameEmbedded(50, 150, 100, 100, fstr);
         // Sets the Play Mode and Volume of the Audio
         audioFrame.setPlayMode(AudioPlayModePreset.Auto);
         audioFrame.setVolume(AudioVolumeMode.Loud);
     } finally {
         if (fstr != null) fstr.close();
     }
     // Writes the PowerPoint file to disk
     pres.save("AudioFrameEmbed_out.pptx", SaveFormat.Pptx);
 } catch(IOException e) {
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

ParameterTypeDescription
xfloatX coordinate of a new audio frame.
yfloatY coordinate of a new audio frame.
widthfloatWidth of a new audio frame.
heightfloatHeight of a new audio frame.
audio_streamjava.io.InputStreamInout stream with audio data.

Returns: IAudioFrame - Created AudioFrame object.

insertAudioFrameEmbedded(int index, float x, float y, float width, float height, InputStream audio_stream)

public final IAudioFrame insertAudioFrameEmbedded(int index, float x, float y, float width, float height, InputStream audio_stream)

Insert an AudioFrame with embedded audio file. Embedded audio file sound can be a WAV only.

Parameters:

ParameterTypeDescription
indexintThe zero-based index at which value should be inserted.
xfloatX coordinate of a new audio frame.
yfloatY coordinate of a new audio frame.
widthfloatWidth of a new audio frame.
heightfloatHeight of a new audio frame.
audio_streamjava.io.InputStreamAudio stream.

Returns: IAudioFrame - Created AudioFrame object.

addAudioFrameEmbedded(float x, float y, float width, float height, IAudio audio)

public final IAudioFrame addAudioFrameEmbedded(float x, float y, float width, float height, IAudio audio)

Adds a new audio frame with embedded audio file to the end of a collection. It uses audio file from Presentation.Audios list.

Parameters:

ParameterTypeDescription
xfloatX coordinate of a new audio frame.
yfloatY coordinate of a new audio frame.
widthfloatWidth of a new audio frame.
heightfloatHeight of a new audio frame.
audioIAudioAudio from Presentation.Audios list.

Returns: IAudioFrame - Created AudioFrame object.

insertAudioFrameEmbedded(int index, float x, float y, float width, float height, IAudio audio)

public final IAudioFrame insertAudioFrameEmbedded(int index, float x, float y, float width, float height, IAudio audio)

Insert an AudioFrame with embedded audio file. It uses audio file from Presentation.Audios list.

Parameters:

ParameterTypeDescription
indexintThe zero-based index at which value should be inserted.
xfloatX coordinate of a new audio frame.
yfloatY coordinate of a new audio frame.
widthfloatWidth of a new audio frame.
heightfloatHeight of a new audio frame.
audioIAudioAudio from Presentation.Audios list.

Returns: IAudioFrame - Created AudioFrame object.

indexOf(IShape shape)

public final int indexOf(IShape shape)

Returns the zero-based index of the first occurrence of a shape in the collection.

Parameters:

ParameterTypeDescription
shapeIShapeThe shape to locate in the collection.

Returns: int - The zero-based index of the first occurrence of shape within the collection, if found; otherwise, -1.

toArray()

public final IShape[] toArray()

Creates and returns an array with all shapse in it.

Returns: com.aspose.slides.IShape[] - Array of Shape

toArray(int startIndex, int count)

public final IShape[] toArray(int startIndex, int count)

Creates and returns an array with all shapes from the specified range in it.

Parameters:

ParameterTypeDescription
startIndexintAn index of a first shape to return.
countintA number of shapes to return.

Returns: com.aspose.slides.IShape[] - Array of Shape

reorder(int index, IShape shape)

public final void reorder(int index, IShape shape)

Moves a shape from the collection to the specified position.

Parameters:

ParameterTypeDescription
indexintTarget index.
shapeIShapeShape to move.

reorder(int index, IShape[] shapes)

public final void reorder(int index, IShape[] shapes)

Moves shapes from the collection to the specified position. Shapes will be placed starting from index in order they appear in list.

Parameters:

ParameterTypeDescription
indexintTarget index.
shapesIShape[]Shapes to move.

addAutoShape(int shapeType, float x, float y, float width, float height)

public final IAutoShape addAutoShape(int shapeType, float x, float y, float width, float height)

Creates a new AutoShape, tunes it from default template and adds it to the end of the collection.

Parameters:

ParameterTypeDescription
shapeTypeintThe ShapeType of shape.
xfloatThe X-coordinate for a left side of shape’s frame.
yfloatThe Y-coordinate for a top side of shape’s frame.
widthfloatThe width of shape’s frame.
heightfloatThe height of shape’s frame.

Returns: IAutoShape - Created AutoShape object.

addAutoShape(int shapeType, float x, float y, float width, float height, boolean createFromTemplate)

public final IAutoShape addAutoShape(int shapeType, float x, float y, float width, float height, boolean createFromTemplate)

Creates a new AutoShape and adds it to the end of the collection.

Parameters:

ParameterTypeDescription
shapeTypeintThe ShapeType of shape.
xfloatThe X-coordinate for a left side of shape’s frame.
yfloatThe Y-coordinate for a top side of shape’s frame.
widthfloatThe width of shape’s frame.
heightfloatThe height of shape’s frame.
createFromTemplatebooleanIf true then new shape will be tuned from default template. Not empty name, simple style, text centered will be assined to the new shape. If false then all values of the properties of the new shape will have default values.

Returns: IAutoShape - Created AutoShape object.

addMathShape(float x, float y, float width, float height)

public final IAutoShape addMathShape(float x, float y, float width, float height)

Creates a new Autoshape tuned from default template to math content and adds it to the end of the collection.


The following example shows how to add Mathematical Equation in PowerPoint Presentation.
 
 Presentation pres = new Presentation();
 try {
     IAutoShape mathShape = pres.getSlides().get_Item(0).getShapes().addMathShape(0, 0, 720, 150);
     IMathParagraph mathParagraph = ((MathPortion)mathShape.getTextFrame().getParagraphs().get_Item(0).getPortions().get_Item(0)).getMathParagraph();
     IMathFraction fraction = new MathematicalText("x").divide("y");
     mathParagraph.add(new MathBlock(fraction));
     IMathBlock mathBlock = new MathematicalText("c")
         .setSuperscript("2")
         .join("=")
         .join(new MathematicalText("a").setSuperscript("2"))
         .join("+")
         .join(new MathematicalText("b").setSuperscript("2"));
     mathParagraph.add(mathBlock);
     pres.save("math.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

ParameterTypeDescription
xfloatThe X-coordinate for a left side of shape’s frame.
yfloatThe Y-coordinate for a top side of shape’s frame.
widthfloatThe width of shape’s frame.
heightfloatThe height of shape’s frame.

Returns: IAutoShape - Created AutoShape object.

insertAutoShape(int index, int shapeType, float x, float y, float width, float height)

public final IAutoShape insertAutoShape(int index, int shapeType, float x, float y, float width, float height)

Creates a new AutoShape, tunes it from default template and inserts it to the collection at the specified index. Note: the type of the shape will be determined by the shapeType parameter.

Parameters:

ParameterTypeDescription
indexintThe zero-based index at which value should be inserted.
shapeTypeintAn ShapeType of shape.
xfloatThe X-coordinate for a left side of shape’s frame.
yfloatThe Y-coordinate for a top side of shape’s frame.
widthfloatThe width of shape’s frame.
heightfloatThe height of shape’s frame.

Returns: IAutoShape - Created AutoShape object.

insertAutoShape(int index, int shapeType, float x, float y, float width, float height, boolean createFromTemplate)

public final IAutoShape insertAutoShape(int index, int shapeType, float x, float y, float width, float height, boolean createFromTemplate)

Creates a new AutoShape and inserts it to the collection at the specified index. Note: the type of the shape will be determined by the shapeType parameter.

Parameters:

ParameterTypeDescription
indexintThe zero-based index at which value should be inserted.
shapeTypeintAn ShapeType of shape.
xfloatThe X-coordinate for a left side of shape’s frame.
yfloatThe Y-coordinate for a top side of shape’s frame.
widthfloatThe width of shape’s frame.
heightfloatThe height of shape’s frame.
createFromTemplatebooleanIf true then new shape will be tuned from default template. Not empty name, simple style, text centered will be assined to the new shape. If false then all values of the properties of the new shape will have default values.

Returns: IAutoShape - Created AutoShape object.

addGroupShape()

public final IGroupShape addGroupShape()

Creates a new GroupShape and adds it to the end of the collection. GroupShape frame size and position will be fitted to content when new shape will be added into the GroupShape.


The following example shows how to add a group shape to a slide of PowerPoint Presentation.
 
 // Instantiate Presentation class
 Presentation pres = new Presentation();
 try {
     // Get the first slide
     ISlide sld = pres.getSlides().get_Item(0);
     // Accessing the shape collection of slides
     IShapeCollection slideShapes = sld.getShapes();
     // Adding a group shape to the slide
     IGroupShape groupShape = slideShapes.addGroupShape();
     // Adding shapes inside added group shape
     groupShape.getShapes().addAutoShape(ShapeType.Rectangle, 300, 100, 100, 100);
     groupShape.getShapes().addAutoShape(ShapeType.Rectangle, 500, 100, 100, 100);
     groupShape.getShapes().addAutoShape(ShapeType.Rectangle, 300, 300, 100, 100);
     groupShape.getShapes().addAutoShape(ShapeType.Rectangle, 500, 300, 100, 100);
     // Adding group shape frame
     groupShape.setFrame(new ShapeFrame(100, 300, 500, 40, NullableBool.False, NullableBool.False, 0));
     // Write the PPTX file to disk
     pres.save("GroupShape_out.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }

Returns: IGroupShape - Created GroupShape object.

addGroupShape(ISvgImage svgImage, float x, float y, float width, float height)

public final IGroupShape addGroupShape(ISvgImage svgImage, float x, float y, float width, float height)

Creates a new GroupShape, fills it with converted shapes from SVG and adds it to the end of the collection.

Parameters:

ParameterTypeDescription
svgImageISvgImageSvg image object ISvgImage
xfloatThe X coordinate for the left side of the shape group frame.
yfloatThe Y coordinate for the top side of the shape group frame.
widthfloatThe width of the group of the shape group frame.
heightfloatThe height of a group of the shape group frame.

Returns: IGroupShape - Created GroupShape object.

insertGroupShape(int index)

public final IGroupShape insertGroupShape(int index)

Creates a new GroupShape and inserts it to the collection at the specified index. GroupShape frame size and position will be fitted to content when new shape will be added into the GroupShape.

Parameters:

ParameterTypeDescription
indexintThe zero-based index at which value should be inserted.

Returns: IGroupShape - Created GroupShape object.

addConnector(int shapeType, float x, float y, float width, float height)

public final IConnector addConnector(int shapeType, float x, float y, float width, float height)

Creates a new Connector, tunes it from default template and adds it to the end of the collection.


The following example shows how to add a connector (a bent connector) between two shapes (an ellipse and rectangle) in PowerPoint Presentation.
 
 // Instantiates a presentation class that represents a PPTX file
 Presentation pres = new Presentation();
 try {
     // Accesses the shapes collection for a specific slide
     IShapeCollection shapes = pres.getSlides().get_Item(0).getShapes();
     // Adds an Ellipse autoshape
     IAutoShape ellipse = shapes.addAutoShape(ShapeType.Ellipse, 0, 100, 100, 100);
     // Adds a Rectangle autoshape
     IAutoShape rectangle = shapes.addAutoShape(ShapeType.Rectangle, 100, 300, 100, 100);
     // Adds a connector shape to the slide shape collection
     IConnector connector = shapes.addConnector(ShapeType.BentConnector2, 0, 0, 10, 10);
     // Connects the shapes using the connector
     connector.setStartShapeConnectedTo(ellipse);
     connector.setEndShapeConnectedTo(rectangle);
     // Calls reroute that sets the automatic shortest path between shapes
     connector.reroute();
     // Saves the presentation
     pres.save("Shapes-connector.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

ParameterTypeDescription
shapeTypeintThe ShapeType of shape.
xfloatThe X-coordinate for a left side of shape’s frame.
yfloatThe Y-coordinate for a top side of shape’s frame.
widthfloatThe width of shape’s frame.
heightfloatThe height of shape’s frame.

Returns: IConnector - The zero-based index of the created shape.

addConnector(int shapeType, float x, float y, float width, float height, boolean createFromTemplate)

public final IConnector addConnector(int shapeType, float x, float y, float width, float height, boolean createFromTemplate)

Creates a new Connector and adds it to the end of the collection.

Parameters:

ParameterTypeDescription
shapeTypeintThe ShapeType of shape.
xfloatThe X-coordinate for a left side of shape’s frame.
yfloatThe Y-coordinate for a top side of shape’s frame.
widthfloatThe width of shape’s frame.
heightfloatThe height of shape’s frame.
createFromTemplatebooleanIf true then new shape will be tuned from default template. Not empty name, simple style, text centered will be assined to the new shape. If false then all values of the properties of the new shape will have default values.

Returns: IConnector - The zero-based index of the created shape.

insertConnector(int index, int shapeType, float x, float y, float width, float height)

public final IConnector insertConnector(int index, int shapeType, float x, float y, float width, float height)

Creates a new Connector, tunes it from default template and inserts it to the collection at the specified index.

Parameters:

ParameterTypeDescription
indexintThe zero-based index at which value should be inserted.
shapeTypeintAn ShapeType of shape.
xfloatThe X-coordinate for a left side of shape’s frame.
yfloatThe Y-coordinate for a top side of shape’s frame.
widthfloatThe width of shape’s frame.
heightfloatThe height of shape’s frame.

Returns: IConnector - Created Connector object.

insertConnector(int index, int shapeType, float x, float y, float width, float height, boolean createFromTemplate)

public final IConnector insertConnector(int index, int shapeType, float x, float y, float width, float height, boolean createFromTemplate)

Creates a new Connector and inserts it to the collection at the specified index.

Parameters:

ParameterTypeDescription
indexintThe zero-based index at which value should be inserted.
shapeTypeintAn ShapeType of shape.
xfloatThe X-coordinate for a left side of shape’s frame.
yfloatThe Y-coordinate for a top side of shape’s frame.
widthfloatThe width of shape’s frame.
heightfloatThe height of shape’s frame.
createFromTemplatebooleanIf true then new shape will be tuned from default template. Not empty name, simple style, text centered will be assined to the new shape. If false then all values of the properties of the new shape will have default values.

Returns: IConnector - Created Connector object.

addPictureFrame(int shapeType, float x, float y, float width, float height, IPPImage image)

public final IPictureFrame addPictureFrame(int shapeType, float x, float y, float width, float height, IPPImage image)

Creates a new PictureFrame and adds it to the end of the collection.

Parameters:

ParameterTypeDescription
shapeTypeintThe shape contained in the set ShapeType of shapes, except all sorts of lines:

ShapeType.Line,

ShapeType.StraightConnector1,

ShapeType.BentConnector2,

ShapeType.BentConnector3,

ShapeType.BentConnector4,

ShapeType.BentConnector5,

ShapeType.CurvedConnector2,

ShapeType.CurvedConnector3,

ShapeType.CurvedConnector4,

ShapeType.CurvedConnector5. | | x | float | The X-coordinate for a left side of shape’s frame. | | y | float | The Y-coordinate for a top side of shape’s frame. | | width | float | The width of shape’s frame. | | height | float | The height of shape’s frame. | | image | IPPImage | The image of picture frame. |

Returns: IPictureFrame - Created PictureFrame object.

insertPictureFrame(int index, int shapeType, float x, float y, float width, float height, IPPImage image)

public final IPictureFrame insertPictureFrame(int index, int shapeType, float x, float y, float width, float height, IPPImage image)

Creates a new PictureFrame and inserts it to the collection at the specified index.

Parameters:

ParameterTypeDescription
indexintThe zero-based index at which value should be inserted.
shapeTypeintThe shape contained in the set ShapeType of shapes, except all sorts of lines:

ShapeType.Line,

ShapeType.StraightConnector1,

ShapeType.BentConnector2,

ShapeType.BentConnector3,

ShapeType.BentConnector4,

ShapeType.BentConnector5,

ShapeType.CurvedConnector2,

ShapeType.CurvedConnector3,

ShapeType.CurvedConnector4,

ShapeType.CurvedConnector5. | | x | float | The X-coordinate for a left side of shape’s frame. | | y | float | The Y-coordinate for a top side of shape’s frame. | | width | float | The width of shape’s frame. | | height | float | The height of shape’s frame. | | image | IPPImage | The image of picture frame. |

Returns: IPictureFrame - Created PictureFrame object.

addTable(float x, float y, double[] columnWidths, double[] rowHeights)

public final ITable addTable(float x, float y, double[] columnWidths, double[] rowHeights)

Creates a new Table and adds it to the end of the collection.


The following examples shows how to add table in PowerPoint Presentation.
 
 // Instantiate Presentation class that represents PPTX file
 Presentation pres = new Presentation();
 try
 {
     // Access first slide
     ISlide sld = pres.getSlides().get_Item(0);

     // Define columns with widths and rows with heights
     double[] dblCols = {50, 50, 50};
     double[] dblRows = {50, 30, 30, 30, 30};

     // Add table shape to slide
     ITable tbl = sld.getShapes().addTable(100, 50, dblCols, dblRows);

     // Set border format for each cell
     for (int row = 0; row < tbl.getRows().size(); row++)
     {
         for (int cell = 0; cell < tbl.getRows().get_Item(row).size(); cell++)
         {
             tbl.get_Item(cell, row).getCellFormat().getBorderTop().getFillFormat().setFillType(FillType.Solid);
             tbl.get_Item(cell, row).getCellFormat().getBorderTop().getFillFormat().getSolidFillColor().setColor(Color.RED);
             tbl.get_Item(cell, row).getCellFormat().getBorderTop().setWidth(5);

             tbl.get_Item(cell, row).getCellFormat().getBorderBottom().getFillFormat().setFillType((FillType.Solid));
             tbl.get_Item(cell, row).getCellFormat().getBorderBottom().getFillFormat().getSolidFillColor().setColor(Color.RED);
             tbl.get_Item(cell, row).getCellFormat().getBorderBottom().setWidth(5);

             tbl.get_Item(cell, row).getCellFormat().getBorderLeft().getFillFormat().setFillType(FillType.Solid);
             tbl.get_Item(cell, row).getCellFormat().getBorderLeft().getFillFormat().getSolidFillColor().setColor(Color.RED);
             tbl.get_Item(cell, row).getCellFormat().getBorderLeft().setWidth(5);

             tbl.get_Item(cell, row).getCellFormat().getBorderRight().getFillFormat().setFillType(FillType.Solid);
             tbl.get_Item(cell, row).getCellFormat().getBorderRight().getFillFormat().getSolidFillColor().setColor(Color.RED);
             tbl.get_Item(cell, row).getCellFormat().getBorderRight().setWidth(5);
         }
     }
     // Merge cells 1 & 2 of row 1
     tbl.mergeCells(tbl.get_Item(0, 0), tbl.get_Item(1, 1), false);

     // Add text to the merged cell
     tbl.get_Item(0, 0).getTextFrame().setText("Merged Cells");

     // Save PPTX to Disk
     pres.save("table.pptx", SaveFormat.Pptx);
 }
 finally
 {
     if (pres != null) pres.dispose();
 }

Parameters:

ParameterTypeDescription
xfloatThe X-coordinate for a left side of shape’s frame.
yfloatThe Y-coordinate for a top side of shape’s frame.
columnWidthsdouble[]Array of doubles which represents widths of columns in the table.
rowHeightsdouble[]Array of doubles which represents heights of rows in the table.

Returns: ITable - Created Table object.

insertTable(int index, float x, float y, double[] columnWidths, double[] rowHeights)

public final ITable insertTable(int index, float x, float y, double[] columnWidths, double[] rowHeights)

Creates a new Table and inserts it to the collection at the specified index.

Parameters:

ParameterTypeDescription
indexintThe zero-based index at which value should be inserted.
xfloatThe X-coordinate for a left side of shape’s frame.
yfloatThe Y-coordinate for a top side of shape’s frame.
columnWidthsdouble[]Array of doubles which represents widths of columns in the table.
rowHeightsdouble[]Array of doubles which represents heights of rows in the table.

Returns: ITable - Created Table object.

removeAt(int index)

public final void removeAt(int index)

Removes the element at the specified index of the collection.

Parameters:

ParameterTypeDescription
indexintThe zero-based index of the element to remove.

remove(IShape shape)

public final void remove(IShape shape)

Removes the first occurrence of a specific shape from the collection.

Parameters:

ParameterTypeDescription
shapeIShapeThe shape to remove from the collection.

clear()

public final void clear()

Removes all shapes from the collection.

iterator()

public final System.Collections.Generic.IGenericEnumerator<IShape> iterator()

Returns an enumerator that iterates through the collection.

Returns: com.aspose.ms.System.Collections.Generic.IGenericEnumerator<com.aspose.slides.IShape> - A IGenericEnumerator that can be used to iterate through the collection.

iteratorJava()

public final System.Collections.Generic.IGenericEnumerator<IShape> iteratorJava()

Returns a java iterator for the entire collection.

Returns: com.aspose.ms.System.Collections.Generic.IGenericEnumerator<com.aspose.slides.IShape> - An java.util.Iterator for the entire collection.

getParentGroup()

public final IGroupShape getParentGroup()

Returns parent GroupShape object for a shapes collection. Read-only IGroupShape.

Returns: IGroupShape

addClone(IShape sourceShape, float x, float y, float width, float height)

public final IShape addClone(IShape sourceShape, float x, float y, float width, float height)

Adds a copy of a specified shape to the end of the collection.

Parameters:

ParameterTypeDescription
sourceShapeIShapeShape to clone.
xfloatX coordinate of a new shape.
yfloatY coordinate of a new shape.
widthfloatWidth of a new shape.
heightfloatHeight of a new shape.

Returns: IShape - New shape.

addClone(IShape sourceShape, float x, float y)

public final IShape addClone(IShape sourceShape, float x, float y)

Adds a copy of a specified shape to the end of the collection. Width and Height of the new shape are equal to Width and Height of the source Shape.

Parameters:

ParameterTypeDescription
sourceShapeIShapeShape to clone.
xfloatX coordinate of a new shape.
yfloatY coordinate of a new shape.

Returns: IShape - New shape.

addClone(IShape sourceShape)

public final IShape addClone(IShape sourceShape)

Adds a copy of a specified shape to the end of the collection. X, Y, Width and Height of the new shape are equal to X, Y, Width and Height of the source Shape.

Parameters:

ParameterTypeDescription
sourceShapeIShapeShape to clone.

Returns: IShape - New shape.

insertClone(int index, IShape sourceShape, float x, float y, float width, float height)

public final IShape insertClone(int index, IShape sourceShape, float x, float y, float width, float height)

Inserts a copy of a specified shape to specified position of the collection.

Parameters:

ParameterTypeDescription
indexintIndex of new shape.
sourceShapeIShapeShape to clone.
xfloatX coordinate of a new shape.
yfloatY coordinate of a new shape.
widthfloatWidth of a new shape.
heightfloatHeight of a new shape.

Returns: IShape - Inserted shape.

insertClone(int index, IShape sourceShape, float x, float y)

public final IShape insertClone(int index, IShape sourceShape, float x, float y)

Inserts a copy of a specified shape to specified position of the collection. Width and Height of the new shape are equal to Width and Height of the source Shape.

Parameters:

ParameterTypeDescription
indexintIndex of new shape.
sourceShapeIShapeShape to clone.
xfloatX coordinate of a new shape.
yfloatY coordinate of a new shape.

Returns: IShape - Inserted shape.

insertClone(int index, IShape sourceShape)

public final IShape insertClone(int index, IShape sourceShape)

Inserts a copy of a specified shape to specified position of the collection. X, Y, Width and Height of the new shape are equal to X, Y, Width and Height of the source Shape.

Parameters:

ParameterTypeDescription
indexintIndex of new shape.
sourceShapeIShapeShape to clone.

Returns: IShape - Inserted shape.

copyTo(System.Array array, int index)

public final void copyTo(System.Array array, int index)

Copies all elements from the collection to the specified array.

Parameters:

ParameterTypeDescription
arraycom.aspose.ms.System.ArrayTarget array.
indexintStarting index in the target array.

isSynchronized()

public final boolean isSynchronized()

Returns a value indicating whether access to the collection is synchronized (thread-safe). Read-only boolean .

Returns: boolean

getSyncRoot()

public final Object getSyncRoot()

Returns a synchronization root. Read-only Object .

Returns: java.lang.Object