SdtListItem
Contents
[
Hide
]Inheritance: java.lang.Object
All Implemented Interfaces: java.lang.Cloneable
public class SdtListItem implements Cloneable
This element specifies a single list item within a parent SdtType.COMBO_BOX or SdtType.DROP_DOWN_LIST structured document tag.
To learn more, visit the Structured Document Tags or Content Control documentation article.
Examples:
Shows how to work with drop down-list structured document tags.
Document doc = new Document();
StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.DROP_DOWN_LIST, MarkupLevel.BLOCK);
doc.getFirstSection().getBody().appendChild(tag);
// A drop-down list structured document tag is a form that allows the user to
// select an option from a list by left-clicking and opening the form in Microsoft Word.
// The "ListItems" property contains all list items, and each list item is an "SdtListItem".
SdtListItemCollection listItems = tag.getListItems();
listItems.add(new SdtListItem("Value 1"));
Assert.assertEquals(listItems.get(0).getDisplayText(), listItems.get(0).getValue());
// Add 3 more list items. Initialize these items using a different constructor to the first item
// to display strings that are different from their values.
listItems.add(new SdtListItem("Item 2", "Value 2"));
listItems.add(new SdtListItem("Item 3", "Value 3"));
listItems.add(new SdtListItem("Item 4", "Value 4"));
Assert.assertEquals(4, listItems.getCount());
// The drop-down list is displaying the first item. Assign a different list item to the "SelectedValue" to display it.
listItems.setSelectedValue(listItems.get(3));
Assert.assertEquals(listItems.getSelectedValue().getValue(), "Value 4");
// Enumerate over the collection and print each element.
Iterator enumerator = listItems.iterator();
while (enumerator.hasNext()) {
SdtListItem sdtListItem = enumerator.next();
System.out.println(MessageFormat.format("List item: {0}, value: {1}", sdtListItem.getDisplayText(), sdtListItem.getValue()));
}
// Remove the last list item.
listItems.removeAt(3);
Assert.assertEquals(3, listItems.getCount());
// Since our drop-down control is set to display the removed item by default, give it an item to display which exists.
listItems.setSelectedValue(listItems.get(1));
doc.save(getArtifactsDir() + "StructuredDocumentTag.ListItemCollection.docx");
// Use the "Clear" method to empty the entire drop-down item collection at once.
listItems.clear();
Assert.assertEquals(0, listItems.getCount());
Constructors
| Constructor | Description |
|---|---|
| SdtListItem(String displayText, String value) | Initializes a new instance of this class. |
| SdtListItem(String value) | Initializes a new instance of this class. |
Methods
| Method | Description |
|---|---|
| getDisplayText() | Gets the text to display in the run content in place of the getValue() attribute contents for this list item. |
| getValue() | Gets the value of this list item. |
SdtListItem(String displayText, String value)
public SdtListItem(String displayText, String value)
Initializes a new instance of this class.
Examples:
Shows how to work with drop down-list structured document tags.
Document doc = new Document();
StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.DROP_DOWN_LIST, MarkupLevel.BLOCK);
doc.getFirstSection().getBody().appendChild(tag);
// A drop-down list structured document tag is a form that allows the user to
// select an option from a list by left-clicking and opening the form in Microsoft Word.
// The "ListItems" property contains all list items, and each list item is an "SdtListItem".
SdtListItemCollection listItems = tag.getListItems();
listItems.add(new SdtListItem("Value 1"));
Assert.assertEquals(listItems.get(0).getDisplayText(), listItems.get(0).getValue());
// Add 3 more list items. Initialize these items using a different constructor to the first item
// to display strings that are different from their values.
listItems.add(new SdtListItem("Item 2", "Value 2"));
listItems.add(new SdtListItem("Item 3", "Value 3"));
listItems.add(new SdtListItem("Item 4", "Value 4"));
Assert.assertEquals(4, listItems.getCount());
// The drop-down list is displaying the first item. Assign a different list item to the "SelectedValue" to display it.
listItems.setSelectedValue(listItems.get(3));
Assert.assertEquals(listItems.getSelectedValue().getValue(), "Value 4");
// Enumerate over the collection and print each element.
Iterator enumerator = listItems.iterator();
while (enumerator.hasNext()) {
SdtListItem sdtListItem = enumerator.next();
System.out.println(MessageFormat.format("List item: {0}, value: {1}", sdtListItem.getDisplayText(), sdtListItem.getValue()));
}
// Remove the last list item.
listItems.removeAt(3);
Assert.assertEquals(3, listItems.getCount());
// Since our drop-down control is set to display the removed item by default, give it an item to display which exists.
listItems.setSelectedValue(listItems.get(1));
doc.save(getArtifactsDir() + "StructuredDocumentTag.ListItemCollection.docx");
// Use the "Clear" method to empty the entire drop-down item collection at once.
listItems.clear();
Assert.assertEquals(0, listItems.getCount());
Parameters:
| Parameter | Type | Description |
|---|---|---|
| displayText | java.lang.String | |
| value | java.lang.String |
SdtListItem(String value)
public SdtListItem(String value)
Initializes a new instance of this class.
Examples:
Shows how to work with drop down-list structured document tags.
Document doc = new Document();
StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.DROP_DOWN_LIST, MarkupLevel.BLOCK);
doc.getFirstSection().getBody().appendChild(tag);
// A drop-down list structured document tag is a form that allows the user to
// select an option from a list by left-clicking and opening the form in Microsoft Word.
// The "ListItems" property contains all list items, and each list item is an "SdtListItem".
SdtListItemCollection listItems = tag.getListItems();
listItems.add(new SdtListItem("Value 1"));
Assert.assertEquals(listItems.get(0).getDisplayText(), listItems.get(0).getValue());
// Add 3 more list items. Initialize these items using a different constructor to the first item
// to display strings that are different from their values.
listItems.add(new SdtListItem("Item 2", "Value 2"));
listItems.add(new SdtListItem("Item 3", "Value 3"));
listItems.add(new SdtListItem("Item 4", "Value 4"));
Assert.assertEquals(4, listItems.getCount());
// The drop-down list is displaying the first item. Assign a different list item to the "SelectedValue" to display it.
listItems.setSelectedValue(listItems.get(3));
Assert.assertEquals(listItems.getSelectedValue().getValue(), "Value 4");
// Enumerate over the collection and print each element.
Iterator enumerator = listItems.iterator();
while (enumerator.hasNext()) {
SdtListItem sdtListItem = enumerator.next();
System.out.println(MessageFormat.format("List item: {0}, value: {1}", sdtListItem.getDisplayText(), sdtListItem.getValue()));
}
// Remove the last list item.
listItems.removeAt(3);
Assert.assertEquals(3, listItems.getCount());
// Since our drop-down control is set to display the removed item by default, give it an item to display which exists.
listItems.setSelectedValue(listItems.get(1));
doc.save(getArtifactsDir() + "StructuredDocumentTag.ListItemCollection.docx");
// Use the "Clear" method to empty the entire drop-down item collection at once.
listItems.clear();
Assert.assertEquals(0, listItems.getCount());
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
getDisplayText()
public String getDisplayText()
Gets the text to display in the run content in place of the getValue() attribute contents for this list item.
Remarks:
Cannot be null and cannot be an empty string.
Examples:
Shows how to work with drop down-list structured document tags.
Document doc = new Document();
StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.DROP_DOWN_LIST, MarkupLevel.BLOCK);
doc.getFirstSection().getBody().appendChild(tag);
// A drop-down list structured document tag is a form that allows the user to
// select an option from a list by left-clicking and opening the form in Microsoft Word.
// The "ListItems" property contains all list items, and each list item is an "SdtListItem".
SdtListItemCollection listItems = tag.getListItems();
listItems.add(new SdtListItem("Value 1"));
Assert.assertEquals(listItems.get(0).getDisplayText(), listItems.get(0).getValue());
// Add 3 more list items. Initialize these items using a different constructor to the first item
// to display strings that are different from their values.
listItems.add(new SdtListItem("Item 2", "Value 2"));
listItems.add(new SdtListItem("Item 3", "Value 3"));
listItems.add(new SdtListItem("Item 4", "Value 4"));
Assert.assertEquals(4, listItems.getCount());
// The drop-down list is displaying the first item. Assign a different list item to the "SelectedValue" to display it.
listItems.setSelectedValue(listItems.get(3));
Assert.assertEquals(listItems.getSelectedValue().getValue(), "Value 4");
// Enumerate over the collection and print each element.
Iterator enumerator = listItems.iterator();
while (enumerator.hasNext()) {
SdtListItem sdtListItem = enumerator.next();
System.out.println(MessageFormat.format("List item: {0}, value: {1}", sdtListItem.getDisplayText(), sdtListItem.getValue()));
}
// Remove the last list item.
listItems.removeAt(3);
Assert.assertEquals(3, listItems.getCount());
// Since our drop-down control is set to display the removed item by default, give it an item to display which exists.
listItems.setSelectedValue(listItems.get(1));
doc.save(getArtifactsDir() + "StructuredDocumentTag.ListItemCollection.docx");
// Use the "Clear" method to empty the entire drop-down item collection at once.
listItems.clear();
Assert.assertEquals(0, listItems.getCount());
Returns: java.lang.String - The text to display in the run content in place of the getValue() attribute contents for this list item.
getValue()
public String getValue()
Gets the value of this list item.
Remarks:
Cannot be null and cannot be an empty string.
Examples:
Shows how to work with drop down-list structured document tags.
Document doc = new Document();
StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.DROP_DOWN_LIST, MarkupLevel.BLOCK);
doc.getFirstSection().getBody().appendChild(tag);
// A drop-down list structured document tag is a form that allows the user to
// select an option from a list by left-clicking and opening the form in Microsoft Word.
// The "ListItems" property contains all list items, and each list item is an "SdtListItem".
SdtListItemCollection listItems = tag.getListItems();
listItems.add(new SdtListItem("Value 1"));
Assert.assertEquals(listItems.get(0).getDisplayText(), listItems.get(0).getValue());
// Add 3 more list items. Initialize these items using a different constructor to the first item
// to display strings that are different from their values.
listItems.add(new SdtListItem("Item 2", "Value 2"));
listItems.add(new SdtListItem("Item 3", "Value 3"));
listItems.add(new SdtListItem("Item 4", "Value 4"));
Assert.assertEquals(4, listItems.getCount());
// The drop-down list is displaying the first item. Assign a different list item to the "SelectedValue" to display it.
listItems.setSelectedValue(listItems.get(3));
Assert.assertEquals(listItems.getSelectedValue().getValue(), "Value 4");
// Enumerate over the collection and print each element.
Iterator enumerator = listItems.iterator();
while (enumerator.hasNext()) {
SdtListItem sdtListItem = enumerator.next();
System.out.println(MessageFormat.format("List item: {0}, value: {1}", sdtListItem.getDisplayText(), sdtListItem.getValue()));
}
// Remove the last list item.
listItems.removeAt(3);
Assert.assertEquals(3, listItems.getCount());
// Since our drop-down control is set to display the removed item by default, give it an item to display which exists.
listItems.setSelectedValue(listItems.get(1));
doc.save(getArtifactsDir() + "StructuredDocumentTag.ListItemCollection.docx");
// Use the "Clear" method to empty the entire drop-down item collection at once.
listItems.clear();
Assert.assertEquals(0, listItems.getCount());
Returns: java.lang.String - The value of this list item.
