com.aspose.slides
Interface ICommentAuthorCollection

All Superinterfaces:
com.aspose.ms.System.Collections.IEnumerable<ICommentAuthor>, IGenericCollection<ICommentAuthor>, com.aspose.ms.System.Collections.Generic.IGenericEnumerable<ICommentAuthor>, java.lang.Iterable<ICommentAuthor>
All Known Implementing Classes:
CommentAuthorCollection

public interface ICommentAuthorCollection
extends IGenericCollection<ICommentAuthor>

Represents a collection of comment authors.


Method Summary
 ICommentAuthor addAuthor(java.lang.String name, java.lang.String initials)
           Add new author at the end of a collection.
 void clear()
           Removes all authors from a collection.
 ICommentAuthor[] findByName(java.lang.String name)
           Find author in a collection by name.
 ICommentAuthor[] findByNameAndInitials(java.lang.String name, java.lang.String initials)
           Find author in a collection by name and initials.
 ICommentAuthor get_Item(int index)
           Gets the element at the specified index.
 void remove(ICommentAuthor author)
           Removes the first occurrence of the specified author in a collection.
 void removeAt(int index)
           Removes the author at the specified index of the collection.
 ICommentAuthor[] toArray()
           Creates and returns an array with all authors.
 
Methods inherited from interface com.aspose.slides.IGenericCollection
copyTo, getSyncRoot, isSynchronized, size
 
Methods inherited from interface com.aspose.ms.System.Collections.Generic.IGenericEnumerable
iterator
 

Method Detail

get_Item

ICommentAuthor get_Item(int index)

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


addAuthor

ICommentAuthor addAuthor(java.lang.String name,
                         java.lang.String initials)

Add new author at the end of a collection.

Parameters:
name - Name of a new author.
initials - Initials of a new author.

toArray

ICommentAuthor[] toArray()

Creates and returns an array with all authors.

Returns:
Array of ICommentAuthor

findByName

ICommentAuthor[] findByName(java.lang.String name)

Find author in a collection by name.

Parameters:
name - Name of an author to find.
Returns:
Author or null.

findByNameAndInitials

ICommentAuthor[] findByNameAndInitials(java.lang.String name,
                                       java.lang.String initials)

Find author in a collection by name and initials.

Parameters:
name - Name of an author to find.
initials - Initials of an author to find.
Returns:
Author or null.

removeAt

void removeAt(int index)

Removes the author at the specified index of the collection.

Parameters:
index - The zero-based index of the element to remove.
Throws:
com.aspose.ms.System.ArgumentOutOfRangeException - Index is less than 0 or index is equal or greater than Count
PptxEditException - Thrown if author is already removed.

remove

void remove(ICommentAuthor author)

Removes the first occurrence of the specified author in a collection.

Parameters:
author - The author to remove from a collection.
Throws:
com.aspose.ms.System.ArgumentNullException - Author is null
PptxEditException - Thrown if author is already removed.

clear

void clear()

Removes all authors from a collection.



Copyright © Copyright 2004-2016 Aspose Pty Ltd. All Rights Reserved.