SummaryZoomSectionCollection

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

All Implemented Interfaces: com.aspose.slides.ISummaryZoomSectionCollection

public final class SummaryZoomSectionCollection extends DomObject<SummaryZoomFrame> implements ISummaryZoomSectionCollection

Represents a collection of Summary Zoom Section objects.

Methods

Method Description
get_Item(int index) Gets the element at the specified index.
addSummaryZoomSection(ISection section) Creates new Summary Zoom Section object and add it to the collection
size() Gets the number of elements actually contained in the collection.
indexOf(ISummaryZoomSection summaryZoomSection) Returns an index of the specified SummaryZoomSection object.
removeSummaryZoomSection(ISection section) Remove Summary Zoom Section object from the collection.
getSummarySection(ISection section) Returns Summary Zoom Section element for the given section.
clear() Removes all SummaryZoomSection objects from the collection.
copyTo(System.Array array, int index) Copies the entire collection to the specified array.
isSynchronized() Returns a value indicating whether access to the collection is synchronized (thread-safe).
getSyncRoot() Returns a synchronization root.
iterator() Returns an enumerator that iterates through the collection.
iteratorJava() Returns a java iterator for the entire collection.

get_Item(int index)

public final ISummaryZoomSection get_Item(int index)

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


The example demonstrates getting Summary Zoom Section element by index:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
      ISummaryZoomFrame zoomFrame = (ISummaryZoomFrame)pres.getSlides().get_Item(1).getShapes().get_Item(0);
      ISummaryZoomSectionCollection collection = zoomFrame.getSummaryZoomCollection();
      ISummaryZoomSection zoomSection = collection.get_Item(1);
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

Parameter Type Description
index int

Returns: ISummaryZoomSection

addSummaryZoomSection(ISection section)

public final ISummaryZoomSection addSummaryZoomSection(ISection section)

Creates new Summary Zoom Section object and add it to the collection


The example demonstrates getting Summary Zoom Section element by index:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
      ISummaryZoomFrame zoomFrame = (ISummaryZoomFrame)pres.getSlides().get_Item(1).getShapes().get_Item(0);
      ISummaryZoomSectionCollection collection = zoomFrame.getSummaryZoomCollection();
      ISummaryZoomSection newZoomSection = collection.addSummaryZoomSection(pres.getSections().get_Item(3));
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

Parameter Type Description
section ISection Section for a new Summary Zoom Section element ISection

If an element for this section already exists in the collection, the existing element is returned. |

Returns: ISummaryZoomSection - Added ISummaryZoomFrame element

size()

public final int size()

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

Returns: int

indexOf(ISummaryZoomSection summaryZoomSection)

public final int indexOf(ISummaryZoomSection summaryZoomSection)

Returns an index of the specified SummaryZoomSection object.


The example demonstrates getting Summary Zoom Section element by index:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
      ISummaryZoomFrame zoomFrame = (ISummaryZoomFrame)pres.getSlides().get_Item(1).getShapes().get_Item(0);
      ISummaryZoomSectionCollection collection = zoomFrame.getSummaryZoomCollection();
      ISummaryZoomSection selectedObject = collection.getSummarySection(pres.getSections().get_Item(2));
      int idx = collection.indexOf(selectedObject);
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

Parameter Type Description
summaryZoomSection ISummaryZoomSection SummaryZoomSection object to find ISummaryZoomSection.

Returns: int - Index of a SummaryZoomSection object or -1 if SummaryZoomSection object not from this collection.

removeSummaryZoomSection(ISection section)

public final void removeSummaryZoomSection(ISection section)

Remove Summary Zoom Section object from the collection.


The example demonstrates getting Summary Zoom Section element by index:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
      ISummaryZoomFrame zoomFrame = (ISummaryZoomFrame)pres.getSlides().get_Item(1).getShapes().get_Item(0);
      ISummaryZoomSectionCollection collection = zoomFrame.getSummaryZoomCollection();
      collection.removeSummaryZoomSection(pres.getSections().get_Item(1));
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

Parameter Type Description
section ISection Section for which the Summary Zoom Section element is to be removed ISection.

getSummarySection(ISection section)

public final ISummaryZoomSection getSummarySection(ISection section)

Returns Summary Zoom Section element for the given section.


The example demonstrates getting Summary Zoom Section element by index:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
      ISummaryZoomFrame zoomFrame = (ISummaryZoomFrame)pres.getSlides().get_Item(1).getShapes().get_Item(0);
      ISummaryZoomSectionCollection collection = zoomFrame.getSummaryZoomCollection();
      ISummaryZoomSection selectedObject = collection.getSummarySection(pres.getSections().get_Item(2));
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

Parameter Type Description
section ISection Section to find ISection

Returns: ISummaryZoomSection - ISummaryZoomSection or null if collection does not contains element for the section.

clear()

public final void clear()

Removes all SummaryZoomSection objects from the collection.


The example demonstrates getting Summary Zoom Section element by index:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
      ISummaryZoomFrame zoomFrame = (ISummaryZoomFrame)pres.getSlides().get_Item(1).getShapes().get_Item(0);
      ISummaryZoomSectionCollection collection = zoomFrame.getSummaryZoomCollection();
      collection.clear();
 } finally {
     if (pres != null) pres.dispose();
 }

copyTo(System.Array array, int index)

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

Copies the entire collection to the specified array.

Parameters:

Parameter Type Description
array com.aspose.ms.System.Array Target array
index int 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

iterator()

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

Returns an enumerator that iterates through the collection.

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

iteratorJava()

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

Returns a java iterator for the entire collection.

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