com.aspose.words

Property Getters/Setters Detail

• getCount

  public int getCount()
  

  Gets number of items in the collection.

  Example:

  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<SdtListItem> 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());

• getSelectedValue/setSelectedValue

  public SdtListItem getSelectedValue() / public void setSelectedValue(SdtListItem value)
  

  Specifies currently selected value in this list. Null value allowed, meaning that no currently selected entry is associated with this list item collection.

  Example:

  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<SdtListItem> 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());

• get

  public SdtListItem get(int index)
  

  Returns a SdtListItem object given its zero-based index in the collection.

  Example:

  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<SdtListItem> 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());

Method Detail

• add

  public void add(SdtListItem item)

  Adds an item to this collection.

  Example:

  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<SdtListItem> 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());

• clear

  public void clear()

  Clears all items from this collection.

  Example:

  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<SdtListItem> 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());

• iterator

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

  Returns an iterator object that can be used to iterate over all items in the collection.

  Example:

  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<SdtListItem> 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());

• removeAt

  public void removeAt(int index)

  Removes a list item at the specified index.

  Parameters:

  index - The zero-based index of the item to remove.

  Example:

  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<SdtListItem> 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());