com.aspose.slides
Class TagCollection

java.lang.Object
  extended by com.aspose.slides.TagCollection
All Implemented Interfaces:
com.aspose.ms.System.Collections.Generic.IGenericEnumerable<com.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,java.lang.String>>, com.aspose.ms.System.Collections.IEnumerable<com.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,java.lang.String>>, IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,java.lang.String>>, ITagCollection, java.lang.Iterable<com.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,java.lang.String>>

public final class TagCollection
extends java.lang.Object
implements ITagCollection

Represents the collection of tags (user defined pairs of strings)


Method Summary
 int add(java.lang.String name, java.lang.String value)
           Adds a new tag to collection.
 void clear()
           Removes all tags from the collection.
 boolean contains(java.lang.String name)
           Determines whether the collection contains a specific name.
 void copyTo(com.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,java.lang.String>[] array, int index)
           Copies all elements from the collection into the specified array.
 java.lang.String get_Item(java.lang.String name)
           Returns or sets a key and a value pair of a tag.
 java.lang.String getNameByIndex(int index)
           Returns key of a tag at the specified index.
 java.lang.String[] getNamesOfTags()
           
 java.lang.Object getSyncRoot()
           Returns a synchronization root.
 java.lang.String getValueByIndex(int index)
           Returns value of a tag at the specified index.
 int indexOfName(java.lang.String name)
           Returns the zero-based index of the specified key in the collection.
 boolean isSynchronized()
           Returns a value indicating whether access to the collection is synchronized (thread-safe).
 com.aspose.ms.System.Collections.Generic.IGenericEnumerator<com.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,java.lang.String>> iterator()
           Returns an enumerator that iterates through the collection.
 void remove(java.lang.String name)
           Removes the tag with a specified name from the collection.
 void removeAt(int index)
           Removes the tag at the specified index.
 void set_Item(java.lang.String name, java.lang.String value)
           Returns or sets a key and a value pair of a tag.
 int size()
           Returns a number of tags in the collectoin.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

size

public int size()

Returns a number of tags in the collectoin. Read-only int.

Specified by:
size in interface IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,java.lang.String>>

add

public int add(java.lang.String name,
               java.lang.String value)

Adds a new tag to collection.

Specified by:
add in interface ITagCollection
Parameters:
name - The name of the tag.
value - The value of the tag.
Returns:
The index of the added tag.

remove

public void remove(java.lang.String name)

Removes the tag with a specified name from the collection.

Specified by:
remove in interface ITagCollection
Parameters:
name - The name of tag to remove.

indexOfName

public int indexOfName(java.lang.String name)

Returns the zero-based index of the specified key in the collection.

Specified by:
indexOfName in interface ITagCollection
Parameters:
name - The name to locate in the collection.
Returns:
The zero-based index of key, if key is found in the collection; otherwise, -1.

contains

public boolean contains(java.lang.String name)

Determines whether the collection contains a specific name.

Specified by:
contains in interface ITagCollection
Parameters:
name - The key to locate.
Returns:
True if the collection contains an tag with the specified key; otherwise, false.

removeAt

public void removeAt(int index)

Removes the tag at the specified index.

Specified by:
removeAt in interface ITagCollection
Parameters:
index - The zero-based index of the tag to remove.

clear

public void clear()

Removes all tags from the collection.

Specified by:
clear in interface ITagCollection

getValueByIndex

public java.lang.String getValueByIndex(int index)

Returns value of a tag at the specified index.

Specified by:
getValueByIndex in interface ITagCollection
Parameters:
index - Index of a tag to return.
Returns:
Value of a tag.

getNameByIndex

public java.lang.String getNameByIndex(int index)

Returns key of a tag at the specified index.

Specified by:
getNameByIndex in interface ITagCollection
Parameters:
index - Index of a tag to return.
Returns:
Key of a tag.

getNamesOfTags

public java.lang.String[] getNamesOfTags()
Specified by:
getNamesOfTags in interface ITagCollection

get_Item

public java.lang.String get_Item(java.lang.String name)

Returns or sets a key and a value pair of a tag.

Specified by:
get_Item in interface ITagCollection
Parameters:
name - Key of a tag.
Returns:
Value of a tag.

set_Item

public void set_Item(java.lang.String name,
                     java.lang.String value)

Returns or sets a key and a value pair of a tag.

Specified by:
set_Item in interface ITagCollection
Parameters:
name - Key of a tag.

copyTo

public void copyTo(com.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,java.lang.String>[] array,
                   int index)

Copies all elements from the collection into the specified array.

Specified by:
copyTo in interface IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,java.lang.String>>
Parameters:
array - Array to fill.
index - Starting position in target array.

isSynchronized

public boolean isSynchronized()

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

Specified by:
isSynchronized in interface IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,java.lang.String>>

getSyncRoot

public java.lang.Object getSyncRoot()

Returns a synchronization root. Read-only Object.

Specified by:
getSyncRoot in interface IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,java.lang.String>>

iterator

public com.aspose.ms.System.Collections.Generic.IGenericEnumerator<com.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,java.lang.String>> iterator()

Returns an enumerator that iterates through the collection.

Specified by:
iterator in interface com.aspose.ms.System.Collections.Generic.IGenericEnumerable<com.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,java.lang.String>>
Specified by:
iterator in interface com.aspose.ms.System.Collections.IEnumerable<com.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,java.lang.String>>
Specified by:
iterator in interface java.lang.Iterable<com.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,java.lang.String>>
Returns:
A T:System.Collections.Generic.IEnumerator`1 that can be used to iterate through the collection.


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