|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.aspose.slides.CommentCollection
public final class CommentCollection
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. |
void |
copyTo(IComment[] array,
int index)
Copies all elements from the collection to the specified array. |
IComment |
get_Item(int index)
Gets the element at the specified index. |
com.aspose.slides.IDOMObject |
getParent_Immediate()
Returns Parent_Immediate object. |
java.lang.Object |
getSyncRoot()
Returns a synchronization root. |
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. |
boolean |
isSynchronized()
Returns a value indicating whether access to the collection is synchronized (thread-safe). |
com.aspose.ms.System.Collections.Generic.IGenericEnumerator<IComment> |
iterator()
Returns an enumerator that iterates through the collection. |
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. |
int |
size()
Gets the number of elements actually contained in the 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 class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public int size()
Gets the number of elements actually contained in the collection.
Read-only int
.
size
in interface IGenericCollection<IComment>
public IComment get_Item(int index)
Gets the element at the specified index.
Read-only Comment
.
get_Item
in interface ICommentCollection
public 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.
addComment
in interface ICommentCollection
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.
public 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.
insertComment
in interface ICommentCollection
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.
public IComment[] toArray()
Creates and returns an array with all comments.
toArray
in interface ICommentCollection
Comment
.public IComment[] toArray(int startIndex, int count)
Creates and returns an array with all comments from the specified range.
toArray
in interface ICommentCollection
startIndex
- An index of a first comment to return.count
- A number of comments to return.
Comment
.public void removeAt(int index)
Removes the element at the specified index in a collection.
removeAt
in interface ICommentCollection
index
- The zero-based index of the element to remove.
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.public void remove(IComment comment)
Removes the first occurrence of the specified comment in a collection.
remove
in interface ICommentCollection
comment
- The comment to remove from a collection.
com.aspose.ms.System.ArgumentNullException
- If comment is null
PptxEditException
- Thrown if comment is already removed.public void clear()
Removes all comments from a collection.
clear
in interface ICommentCollection
public com.aspose.ms.System.Collections.Generic.IGenericEnumerator<IComment> iterator()
Returns an enumerator that iterates through the collection.
iterator
in interface com.aspose.ms.System.Collections.Generic.IGenericEnumerable<IComment>
iterator
in interface com.aspose.ms.System.Collections.IEnumerable<IComment>
iterator
in interface java.lang.Iterable<IComment>
T:System.Collections.Generic.IEnumerator`1
that can be used to iterate through the collection.public void copyTo(IComment[] array, int index)
Copies all elements from the collection to the specified array.
copyTo
in interface IGenericCollection<IComment>
array
- Target array.index
- Starting index in the target array.public boolean isSynchronized()
Returns a value indicating whether access to the collection is synchronized (thread-safe).
Read-only boolean
.
isSynchronized
in interface IGenericCollection<IComment>
public java.lang.Object getSyncRoot()
Returns a synchronization root.
Read-only Object
.
getSyncRoot
in interface IGenericCollection<IComment>
public com.aspose.slides.IDOMObject getParent_Immediate()
Returns Parent_Immediate object.
Read-only IDOMObject
.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |