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

public int getCount()

Returns the number of structured document tags in the collection.

public IStructuredDocumentTag get(int index)

Returns the structured document tag at the specified index.

Parameters:

index - An index into the collection.

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.

Example:

Shows how to get structured document tag.

Document doc = new Document(getMyDir() + "Structured document tags by id.docx");

// Get the structured document tag by Id.
IStructuredDocumentTag sdt = doc.getRange().getStructuredDocumentTags().getById(1160505028);
System.out.println(sdt.isRanged());
System.out.println(sdt.getTitle());

// Get the structured document tag or ranged tag by Title.
sdt = doc.getRange().getStructuredDocumentTags().getByTitle("Alias4");
System.out.println(sdt.getId());

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.

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.

Example:

Shows how to get structured document tag.

Document doc = new Document(getMyDir() + "Structured document tags by id.docx");

// Get the structured document tag by Id.
IStructuredDocumentTag sdt = doc.getRange().getStructuredDocumentTags().getById(1160505028);
System.out.println(sdt.isRanged());
System.out.println(sdt.getTitle());

// Get the structured document tag or ranged tag by Title.
sdt = doc.getRange().getStructuredDocumentTags().getByTitle("Alias4");
System.out.println(sdt.getId());

public java.util.Iterator<IStructuredDocumentTag> iterator()

Returns an enumerator object.

public void remove(int id)

Removes the structured document tag with the specified identifier.

Parameters:

id - The structured document tag identifier.

Example:

Shows how to remove structured document tag.

Document doc = new Document(getMyDir() + "Structured document tags.docx");

StructuredDocumentTagCollection structuredDocumentTags = doc.getRange().getStructuredDocumentTags();
IStructuredDocumentTag sdt;
for (int i = 0; i < structuredDocumentTags.getCount(); i++)
{
    sdt = structuredDocumentTags.get(i);
    System.out.println(sdt.getTitle());
}

sdt = structuredDocumentTags.getById(1691867797);
Assert.assertEquals(1691867797, sdt.getId());

Assert.assertEquals(5, structuredDocumentTags.getCount());
// Remove the structured document tag by Id.
structuredDocumentTags.remove(1691867797);
// Remove the structured document tag at position 0.
structuredDocumentTags.removeAt(0);
Assert.assertEquals(3, structuredDocumentTags.getCount());

public void removeAt(int index)

Removes a structured document tag at the specified index.

Parameters:

index - An index into the collection.

Example:

Shows how to remove structured document tag.

Document doc = new Document(getMyDir() + "Structured document tags.docx");

StructuredDocumentTagCollection structuredDocumentTags = doc.getRange().getStructuredDocumentTags();
IStructuredDocumentTag sdt;
for (int i = 0; i < structuredDocumentTags.getCount(); i++)
{
    sdt = structuredDocumentTags.get(i);
    System.out.println(sdt.getTitle());
}

sdt = structuredDocumentTags.getById(1691867797);
Assert.assertEquals(1691867797, sdt.getId());

Assert.assertEquals(5, structuredDocumentTags.getCount());
// Remove the structured document tag by Id.
structuredDocumentTags.remove(1691867797);
// Remove the structured document tag at position 0.
structuredDocumentTags.removeAt(0);
Assert.assertEquals(3, structuredDocumentTags.getCount());