com.aspose.slides
Interface ICommentCollection

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

public interface ICommentCollection
extends IGenericCollection<IComment>

Represents a collection of comments of one author.


Method Summary
 IComment addComment(java.lang.String text, ISlide slide, java.awt.geom.Point2D.Float position, java.util.Date creationTime)
           Add new comment at the end of a collection.
 void clear()
           Removes all comments from a collection.
 IComment get_Item(int index)
           Gets the element at the specified index.
 IComment insertComment(int index, java.lang.String text, ISlide slide, java.awt.geom.Point2D.Float position, java.util.Date creationTime)
           Insert new comment to a collection at the specified index.
 void remove(IComment comment)
           Removes the first occurrence of the specified comment in a collection.
 void removeAt(int index)
           Removes the element at the specified index in a collection.
 IComment[] toArray()
           Creates and returns an array with all comments.
 IComment[] toArray(int startIndex, int count)
           Creates and returns an array with all comments from the specified range.
 
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

IComment get_Item(int index)

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


addComment

IComment addComment(java.lang.String text,
                    ISlide slide,
                    java.awt.geom.Point2D.Float position,
                    java.util.Date creationTime)

Add new comment at the end of a collection.

Parameters:
text - Plain text of a new comment.
slide - Slide in a presentation where to add a new comment.
position - Position on a slide where to add a new comment.
creationTime - Time of a comment creation.
Returns:
Added comment.

insertComment

IComment insertComment(int index,
                       java.lang.String text,
                       ISlide slide,
                       java.awt.geom.Point2D.Float position,
                       java.util.Date creationTime)

Insert new comment to a collection at the specified index.

Parameters:
index - Index of the element in a collection at which comment should be inserted.
text - Plain text of a new comment.
slide - Slide in a presentation where to add a new comment.
position - Position on a slide where to add a new comment.
creationTime - Time of a comment creation.
Returns:
Inserted comment.

toArray

IComment[] toArray()

Creates and returns an array with all comments.

Returns:
Array of CommentEx.

toArray

IComment[] toArray(int startIndex,
                   int count)

Creates and returns an array with all comments from the specified range.

Parameters:
startIndex - An index of a first comment to return.
count - A number of comments to return.

Returns:
Array of CommentEx.

removeAt

void removeAt(int index)

Removes the element at the specified index in a 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 comment is already removed.

remove

void remove(IComment comment)

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

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

clear

void clear()

Removes all comments from a collection.



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