public class StructuredDocumentTagCollection
extends java.lang.Object
implements java.lang.Iterable
IStructuredDocumentTag instances that represent the structured document tags in the specified range.
To learn more, visit the Structured Document Tags or Content Control documentation article.
Examples:
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.isMultiSection());
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());
| Modifier and Type | Method and Description |
|---|---|
IStructuredDocumentTag |
get(int index)
Returns the structured document tag at the specified index.
|
IStructuredDocumentTag |
getById(int id)
Returns the structured document tag by identifier.
|
IStructuredDocumentTag |
getByTag(java.lang.String tag)
Returns the first structured document tag encountered in the collection with the specified tag.
|
IStructuredDocumentTag |
getByTitle(java.lang.String title)
Returns the first structured document tag encountered in the collection with the specified title.
|
int |
getCount()
Returns the number of structured document tags in the collection.
|
java.util.Iterator |
iterator()
Returns an enumerator object.
|
void |
remove(int id)
Removes the structured document tag with the specified identifier.
|
void |
removeAt(int index)
Removes a structured document tag at the specified index.
|
public IStructuredDocumentTag getById(int id)
Remarks:
Returns null if the structured document tag with the specified identifier cannot be found.
Examples:
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.isMultiSection());
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());
id - The structured document tag identifier.public IStructuredDocumentTag getByTitle(java.lang.String title)
Remarks:
Returns null if the structured document tag with the specified title cannot be found.
Examples:
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.isMultiSection());
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());
title - The title of structured document tag.public IStructuredDocumentTag getByTag(java.lang.String tag)
Remarks:
Returns null if the structured document tag with the specified tag cannot be found.
tag - The tag of the structured document tag.public void remove(int id)
Examples:
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());
id - The structured document tag identifier.public void removeAt(int index)
Examples:
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());
index - An index into the collection.public int getCount()
public IStructuredDocumentTag get(int index)
index - An index into the collection.public java.util.Iterator iterator()
iterator in interface java.lang.Iterable