com.aspose.words
Class StructuredDocumentTagCollection

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

public class StructuredDocumentTagCollection 
extends java.lang.Object

A collection of IStructuredDocumentTag instances that represent the structured document tags in the specified range.

Property Getters/Setters Summary
intgetCount()
           Returns the number of structured document tags in the collection.
IStructuredDocumentTagget(int id)
           Returns the structured document tag by Id.
 
Method Summary
IStructuredDocumentTaggetByTag(java.lang.String tag)
           Returns the first structured document tag encountered in the collection with the specified tag.
IStructuredDocumentTaggetByTitle(java.lang.String title)
           Returns the first structured document tag encountered in the collection with the specified title.
java.util.Iterator<IStructuredDocumentTag>iterator()
           Returns an enumerator object.
voidremove(int id)
           Removes the structured document tag with the specified identifier.
 

Property Getters/Setters Detail

getCount

public int getCount()
Returns the number of structured document tags in the collection.

get

public IStructuredDocumentTag get(int id)
Returns the structured document tag by Id.
Parameters:
id - The structured document tag identifier.

Method Detail

getByTag

public IStructuredDocumentTag getByTag(java.lang.String tag)
Returns the first structured document tag encountered in the collection with the specified tag.

Returns null if the structured document tag with the specified tag cannot be found.

Parameters:
tag - The tag of the structured document tag.

getByTitle

public IStructuredDocumentTag getByTitle(java.lang.String title)
Returns the first structured document tag encountered in the collection with the specified title.

Returns null if the structured document tag with the specified title cannot be found.

Parameters:
title - The title of structured document tag.

iterator

public java.util.Iterator<IStructuredDocumentTagiterator()
Returns an enumerator object.

remove

public void remove(int id)
Removes the structured document tag with the specified identifier.
Parameters:
id - The structured document tag identifier.

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