com.aspose.words
Class CustomXmlPropertyCollection

java.lang.Object
    extended by com.aspose.words.CustomXmlPropertyCollection
All Implemented Interfaces:
java.lang.Iterable

public class CustomXmlPropertyCollection 
extends java.lang.Object

Represents a collection of custom XML attributes or smart tag properties.

Items are CustomXmlProperty objects.


Property Getters/Setters Summary
intgetCount()
           Gets the number of elements contained in the collection.
CustomXmlPropertyget(int index)
           Gets a property at the specified index.
CustomXmlPropertyget(java.lang.String name)
           Gets a property with the specified name.
 
Method Summary
voidadd(CustomXmlProperty property)
           Adds a property to the collection.
voidclear()
           Removes all elements from the collection.
booleancontains(java.lang.String name)
           Determines whether the collection contains a property with the given name.
intindexOfKey(java.lang.String name)
           Returns the zero-based index of the specified property in the collection.
java.util.Iteratoriterator()
           Returns an iterator object that can be used to iterate over all items in the collection.
voidremove(java.lang.String name)
           Removes a property with the specified name from the collection.
voidremoveAt(int index)
           Removes a property at the specified index.
 

Property Getters/Setters Detail

getCount

public int getCount()
Gets the number of elements contained in the collection.

get

public CustomXmlProperty get(int index)
Gets a property at the specified index.
Parameters:
index - Zero-based index of the property.

get

public CustomXmlProperty get(java.lang.String name)
Gets a property with the specified name.
Parameters:
name - Case-sensitive name of the property to locate.

Method Detail

add

public void add(CustomXmlProperty property)
Adds a property to the collection.
Parameters:
property - The property to add.

clear

public void clear()
Removes all elements from the collection.

contains

public boolean contains(java.lang.String name)
Determines whether the collection contains a property with the given name.
Parameters:
name - Case-sensitive name of the property to locate.
Returns:
True if the item is found in the collection; otherwise, false.

indexOfKey

public int indexOfKey(java.lang.String name)
Returns the zero-based index of the specified property in the collection.
Parameters:
name - The case-sensitive name of the property.
Returns:
The zero based index. Negative value if not found.

iterator

public java.util.Iterator iterator()
Returns an iterator object that can be used to iterate over all items in the collection.

remove

public void remove(java.lang.String name)
Removes a property with the specified name from the collection.
Parameters:
name - The case-sensitive name of the property.

removeAt

public void removeAt(int index)
Removes a property at the specified index.
Parameters:
index - The zero based index.

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.