com.aspose.words

Class StructuredDocumentTagCollection

  • java.lang.Object
    • 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 index)
Returns the structured document tag at the specified index.
 
Method Summary
IStructuredDocumentTaggetById(int id)
Returns the structured document tag by identifier.
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.
voidremoveAt(int index)
Removes a structured document tag at the specified index.
 

    • Property Getters/Setters Detail

      • getCount

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

        public IStructuredDocumentTag get(int index)
        
        Returns the structured document tag at the specified index.
        Parameters:
        index - An index into the collection.
    • Method Detail

      • getById

        public IStructuredDocumentTag getById(int id)
        Returns the structured document tag by identifier.

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

        Parameters:
        id - The structured document tag identifier.
      • 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.
      • remove

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

        public void removeAt(int index)
        Removes a structured document tag at the specified index.
        Parameters:
        index - An index into the collection.