com.aspose.words
Class DropDownItemCollection

java.lang.Object
    extended by com.aspose.words.DropDownItemCollection
All Implemented Interfaces:
java.lang.Iterable

public class DropDownItemCollection 
extends java.lang.Object

A collection of strings that represent all the items in a drop-down form field.

Example:

Shows how to insert a combo box field and manipulate the elements in its item collection.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Use a document builder to create and populate a combo box
String[] items = {"One", "Two", "Three"};
FormField comboBoxField = builder.insertComboBox("DropDown", items, 0);

// Get the list of drop down items
DropDownItemCollection dropDownItems = comboBoxField.getDropDownItems();

Assert.assertEquals(dropDownItems.getCount(), 3);
Assert.assertEquals(dropDownItems.get(0), "One");
Assert.assertEquals(dropDownItems.indexOf("Two"), 1);
Assert.assertTrue(dropDownItems.contains("Three"));

// We can add an item to the end of the collection or insert it at a desired index
dropDownItems.add("Four");
dropDownItems.insert(3, "Three and a half");
Assert.assertEquals(dropDownItems.getCount(), 5);

// Iterate over the collection and print every element
Iterator<String> dropDownCollectionEnumerator = dropDownItems.iterator();
try {
    while (dropDownCollectionEnumerator.hasNext()) {
        String currentItem = dropDownCollectionEnumerator.next();
        System.out.println(currentItem);
    }
} finally {
    if (dropDownCollectionEnumerator != null) {
        dropDownCollectionEnumerator.remove();
    }
}

// We can remove elements in the same way we added them
dropDownItems.remove("Four");
dropDownItems.removeAt(3);
Assert.assertFalse(dropDownItems.contains("Three and a half"));
Assert.assertFalse(dropDownItems.contains("Four"));

doc.save(getArtifactsDir() + "Field.DropDownItemCollection.docx");
See Also:
FormField, FormField.DropDownItems

Property Getters/Setters Summary
intgetCount()
           Gets the number of elements contained in the collection.
java.lang.Stringget(int index)
voidset(int index, java.lang.String value)
           Gets or sets the element at the specified index.
 
Method Summary
booleanadd(java.lang.String s)
           Adds a string to the end of the collection.
voidclear()
           Removes all elements from the collection.
booleancontains(java.lang.String value)
           Determines whether the collection contains the specified value.
intindexOf(java.lang.String value)
           Returns the zero-based index of the specified value in the collection.
voidinsert(int index, java.lang.String value)
           Inserts a string into the collection at the specified index.
java.util.Iterator<java.lang.String>iterator()
           Returns an iterator object that can be used to iterate over all items in the collection.
voidremove(java.lang.String name)
           Removes the specified value from the collection.
voidremoveAt(int index)
           Removes a value at the specified index.
 

Property Getters/Setters Detail

getCount

public int getCount()
Gets the number of elements contained in the collection.

Example:

Shows how to insert a combo box field and manipulate the elements in its item collection.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Use a document builder to create and populate a combo box
String[] items = {"One", "Two", "Three"};
FormField comboBoxField = builder.insertComboBox("DropDown", items, 0);

// Get the list of drop down items
DropDownItemCollection dropDownItems = comboBoxField.getDropDownItems();

Assert.assertEquals(dropDownItems.getCount(), 3);
Assert.assertEquals(dropDownItems.get(0), "One");
Assert.assertEquals(dropDownItems.indexOf("Two"), 1);
Assert.assertTrue(dropDownItems.contains("Three"));

// We can add an item to the end of the collection or insert it at a desired index
dropDownItems.add("Four");
dropDownItems.insert(3, "Three and a half");
Assert.assertEquals(dropDownItems.getCount(), 5);

// Iterate over the collection and print every element
Iterator<String> dropDownCollectionEnumerator = dropDownItems.iterator();
try {
    while (dropDownCollectionEnumerator.hasNext()) {
        String currentItem = dropDownCollectionEnumerator.next();
        System.out.println(currentItem);
    }
} finally {
    if (dropDownCollectionEnumerator != null) {
        dropDownCollectionEnumerator.remove();
    }
}

// We can remove elements in the same way we added them
dropDownItems.remove("Four");
dropDownItems.removeAt(3);
Assert.assertFalse(dropDownItems.contains("Three and a half"));
Assert.assertFalse(dropDownItems.contains("Four"));

doc.save(getArtifactsDir() + "Field.DropDownItemCollection.docx");

get/set

public java.lang.String get(int index) / public void set(int index, java.lang.String value)
Gets or sets the element at the specified index.

Example:

Shows how to insert a combo box field and manipulate the elements in its item collection.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Use a document builder to create and populate a combo box
String[] items = {"One", "Two", "Three"};
FormField comboBoxField = builder.insertComboBox("DropDown", items, 0);

// Get the list of drop down items
DropDownItemCollection dropDownItems = comboBoxField.getDropDownItems();

Assert.assertEquals(dropDownItems.getCount(), 3);
Assert.assertEquals(dropDownItems.get(0), "One");
Assert.assertEquals(dropDownItems.indexOf("Two"), 1);
Assert.assertTrue(dropDownItems.contains("Three"));

// We can add an item to the end of the collection or insert it at a desired index
dropDownItems.add("Four");
dropDownItems.insert(3, "Three and a half");
Assert.assertEquals(dropDownItems.getCount(), 5);

// Iterate over the collection and print every element
Iterator<String> dropDownCollectionEnumerator = dropDownItems.iterator();
try {
    while (dropDownCollectionEnumerator.hasNext()) {
        String currentItem = dropDownCollectionEnumerator.next();
        System.out.println(currentItem);
    }
} finally {
    if (dropDownCollectionEnumerator != null) {
        dropDownCollectionEnumerator.remove();
    }
}

// We can remove elements in the same way we added them
dropDownItems.remove("Four");
dropDownItems.removeAt(3);
Assert.assertFalse(dropDownItems.contains("Three and a half"));
Assert.assertFalse(dropDownItems.contains("Four"));

doc.save(getArtifactsDir() + "Field.DropDownItemCollection.docx");

Method Detail

add

public boolean add(java.lang.String s)
Adds a string to the end of the collection.
Parameters:
value - The string to add to the end of the collection.
Returns:
true (as per the general contract of Collection.add).

Example:

Shows how to insert a combo box field and manipulate the elements in its item collection.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Use a document builder to create and populate a combo box
String[] items = {"One", "Two", "Three"};
FormField comboBoxField = builder.insertComboBox("DropDown", items, 0);

// Get the list of drop down items
DropDownItemCollection dropDownItems = comboBoxField.getDropDownItems();

Assert.assertEquals(dropDownItems.getCount(), 3);
Assert.assertEquals(dropDownItems.get(0), "One");
Assert.assertEquals(dropDownItems.indexOf("Two"), 1);
Assert.assertTrue(dropDownItems.contains("Three"));

// We can add an item to the end of the collection or insert it at a desired index
dropDownItems.add("Four");
dropDownItems.insert(3, "Three and a half");
Assert.assertEquals(dropDownItems.getCount(), 5);

// Iterate over the collection and print every element
Iterator<String> dropDownCollectionEnumerator = dropDownItems.iterator();
try {
    while (dropDownCollectionEnumerator.hasNext()) {
        String currentItem = dropDownCollectionEnumerator.next();
        System.out.println(currentItem);
    }
} finally {
    if (dropDownCollectionEnumerator != null) {
        dropDownCollectionEnumerator.remove();
    }
}

// We can remove elements in the same way we added them
dropDownItems.remove("Four");
dropDownItems.removeAt(3);
Assert.assertFalse(dropDownItems.contains("Three and a half"));
Assert.assertFalse(dropDownItems.contains("Four"));

doc.save(getArtifactsDir() + "Field.DropDownItemCollection.docx");

clear

public void clear()
Removes all elements from the collection.

Example:

Shows how to insert a combo box field and manipulate the elements in its item collection.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Use a document builder to create and populate a combo box
String[] items = {"One", "Two", "Three"};
FormField comboBoxField = builder.insertComboBox("DropDown", items, 0);

// Get the list of drop down items
DropDownItemCollection dropDownItems = comboBoxField.getDropDownItems();

Assert.assertEquals(dropDownItems.getCount(), 3);
Assert.assertEquals(dropDownItems.get(0), "One");
Assert.assertEquals(dropDownItems.indexOf("Two"), 1);
Assert.assertTrue(dropDownItems.contains("Three"));

// We can add an item to the end of the collection or insert it at a desired index
dropDownItems.add("Four");
dropDownItems.insert(3, "Three and a half");
Assert.assertEquals(dropDownItems.getCount(), 5);

// Iterate over the collection and print every element
Iterator<String> dropDownCollectionEnumerator = dropDownItems.iterator();
try {
    while (dropDownCollectionEnumerator.hasNext()) {
        String currentItem = dropDownCollectionEnumerator.next();
        System.out.println(currentItem);
    }
} finally {
    if (dropDownCollectionEnumerator != null) {
        dropDownCollectionEnumerator.remove();
    }
}

// We can remove elements in the same way we added them
dropDownItems.remove("Four");
dropDownItems.removeAt(3);
Assert.assertFalse(dropDownItems.contains("Three and a half"));
Assert.assertFalse(dropDownItems.contains("Four"));

doc.save(getArtifactsDir() + "Field.DropDownItemCollection.docx");

contains

public boolean contains(java.lang.String value)
Determines whether the collection contains the specified value.
Parameters:
value - Case-sensitive value to locate.
Returns:
True if the item is found in the collection; otherwise, false.

Example:

Shows how to insert a combo box field and manipulate the elements in its item collection.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Use a document builder to create and populate a combo box
String[] items = {"One", "Two", "Three"};
FormField comboBoxField = builder.insertComboBox("DropDown", items, 0);

// Get the list of drop down items
DropDownItemCollection dropDownItems = comboBoxField.getDropDownItems();

Assert.assertEquals(dropDownItems.getCount(), 3);
Assert.assertEquals(dropDownItems.get(0), "One");
Assert.assertEquals(dropDownItems.indexOf("Two"), 1);
Assert.assertTrue(dropDownItems.contains("Three"));

// We can add an item to the end of the collection or insert it at a desired index
dropDownItems.add("Four");
dropDownItems.insert(3, "Three and a half");
Assert.assertEquals(dropDownItems.getCount(), 5);

// Iterate over the collection and print every element
Iterator<String> dropDownCollectionEnumerator = dropDownItems.iterator();
try {
    while (dropDownCollectionEnumerator.hasNext()) {
        String currentItem = dropDownCollectionEnumerator.next();
        System.out.println(currentItem);
    }
} finally {
    if (dropDownCollectionEnumerator != null) {
        dropDownCollectionEnumerator.remove();
    }
}

// We can remove elements in the same way we added them
dropDownItems.remove("Four");
dropDownItems.removeAt(3);
Assert.assertFalse(dropDownItems.contains("Three and a half"));
Assert.assertFalse(dropDownItems.contains("Four"));

doc.save(getArtifactsDir() + "Field.DropDownItemCollection.docx");

indexOf

public int indexOf(java.lang.String value)
Returns the zero-based index of the specified value in the collection.
Parameters:
value - The case-sensitive value to locate.
Returns:
The zero based index. Negative value if not found.

Example:

Shows how to insert a combo box field and manipulate the elements in its item collection.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Use a document builder to create and populate a combo box
String[] items = {"One", "Two", "Three"};
FormField comboBoxField = builder.insertComboBox("DropDown", items, 0);

// Get the list of drop down items
DropDownItemCollection dropDownItems = comboBoxField.getDropDownItems();

Assert.assertEquals(dropDownItems.getCount(), 3);
Assert.assertEquals(dropDownItems.get(0), "One");
Assert.assertEquals(dropDownItems.indexOf("Two"), 1);
Assert.assertTrue(dropDownItems.contains("Three"));

// We can add an item to the end of the collection or insert it at a desired index
dropDownItems.add("Four");
dropDownItems.insert(3, "Three and a half");
Assert.assertEquals(dropDownItems.getCount(), 5);

// Iterate over the collection and print every element
Iterator<String> dropDownCollectionEnumerator = dropDownItems.iterator();
try {
    while (dropDownCollectionEnumerator.hasNext()) {
        String currentItem = dropDownCollectionEnumerator.next();
        System.out.println(currentItem);
    }
} finally {
    if (dropDownCollectionEnumerator != null) {
        dropDownCollectionEnumerator.remove();
    }
}

// We can remove elements in the same way we added them
dropDownItems.remove("Four");
dropDownItems.removeAt(3);
Assert.assertFalse(dropDownItems.contains("Three and a half"));
Assert.assertFalse(dropDownItems.contains("Four"));

doc.save(getArtifactsDir() + "Field.DropDownItemCollection.docx");

insert

public void insert(int index, java.lang.String value)
Inserts a string into the collection at the specified index.
Parameters:
index - The zero-based index at which value is inserted.
value - The string to insert.

Example:

Shows how to insert a combo box field and manipulate the elements in its item collection.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Use a document builder to create and populate a combo box
String[] items = {"One", "Two", "Three"};
FormField comboBoxField = builder.insertComboBox("DropDown", items, 0);

// Get the list of drop down items
DropDownItemCollection dropDownItems = comboBoxField.getDropDownItems();

Assert.assertEquals(dropDownItems.getCount(), 3);
Assert.assertEquals(dropDownItems.get(0), "One");
Assert.assertEquals(dropDownItems.indexOf("Two"), 1);
Assert.assertTrue(dropDownItems.contains("Three"));

// We can add an item to the end of the collection or insert it at a desired index
dropDownItems.add("Four");
dropDownItems.insert(3, "Three and a half");
Assert.assertEquals(dropDownItems.getCount(), 5);

// Iterate over the collection and print every element
Iterator<String> dropDownCollectionEnumerator = dropDownItems.iterator();
try {
    while (dropDownCollectionEnumerator.hasNext()) {
        String currentItem = dropDownCollectionEnumerator.next();
        System.out.println(currentItem);
    }
} finally {
    if (dropDownCollectionEnumerator != null) {
        dropDownCollectionEnumerator.remove();
    }
}

// We can remove elements in the same way we added them
dropDownItems.remove("Four");
dropDownItems.removeAt(3);
Assert.assertFalse(dropDownItems.contains("Three and a half"));
Assert.assertFalse(dropDownItems.contains("Four"));

doc.save(getArtifactsDir() + "Field.DropDownItemCollection.docx");

iterator

public java.util.Iterator<java.lang.String> iterator()
Returns an iterator object that can be used to iterate over all items in the collection.

Example:

Shows how to insert a combo box field and manipulate the elements in its item collection.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Use a document builder to create and populate a combo box
String[] items = {"One", "Two", "Three"};
FormField comboBoxField = builder.insertComboBox("DropDown", items, 0);

// Get the list of drop down items
DropDownItemCollection dropDownItems = comboBoxField.getDropDownItems();

Assert.assertEquals(dropDownItems.getCount(), 3);
Assert.assertEquals(dropDownItems.get(0), "One");
Assert.assertEquals(dropDownItems.indexOf("Two"), 1);
Assert.assertTrue(dropDownItems.contains("Three"));

// We can add an item to the end of the collection or insert it at a desired index
dropDownItems.add("Four");
dropDownItems.insert(3, "Three and a half");
Assert.assertEquals(dropDownItems.getCount(), 5);

// Iterate over the collection and print every element
Iterator<String> dropDownCollectionEnumerator = dropDownItems.iterator();
try {
    while (dropDownCollectionEnumerator.hasNext()) {
        String currentItem = dropDownCollectionEnumerator.next();
        System.out.println(currentItem);
    }
} finally {
    if (dropDownCollectionEnumerator != null) {
        dropDownCollectionEnumerator.remove();
    }
}

// We can remove elements in the same way we added them
dropDownItems.remove("Four");
dropDownItems.removeAt(3);
Assert.assertFalse(dropDownItems.contains("Three and a half"));
Assert.assertFalse(dropDownItems.contains("Four"));

doc.save(getArtifactsDir() + "Field.DropDownItemCollection.docx");

remove

public void remove(java.lang.String name)
Removes the specified value from the collection.
Parameters:
name - The case-sensitive value to remove.

Example:

Shows how to insert a combo box field and manipulate the elements in its item collection.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Use a document builder to create and populate a combo box
String[] items = {"One", "Two", "Three"};
FormField comboBoxField = builder.insertComboBox("DropDown", items, 0);

// Get the list of drop down items
DropDownItemCollection dropDownItems = comboBoxField.getDropDownItems();

Assert.assertEquals(dropDownItems.getCount(), 3);
Assert.assertEquals(dropDownItems.get(0), "One");
Assert.assertEquals(dropDownItems.indexOf("Two"), 1);
Assert.assertTrue(dropDownItems.contains("Three"));

// We can add an item to the end of the collection or insert it at a desired index
dropDownItems.add("Four");
dropDownItems.insert(3, "Three and a half");
Assert.assertEquals(dropDownItems.getCount(), 5);

// Iterate over the collection and print every element
Iterator<String> dropDownCollectionEnumerator = dropDownItems.iterator();
try {
    while (dropDownCollectionEnumerator.hasNext()) {
        String currentItem = dropDownCollectionEnumerator.next();
        System.out.println(currentItem);
    }
} finally {
    if (dropDownCollectionEnumerator != null) {
        dropDownCollectionEnumerator.remove();
    }
}

// We can remove elements in the same way we added them
dropDownItems.remove("Four");
dropDownItems.removeAt(3);
Assert.assertFalse(dropDownItems.contains("Three and a half"));
Assert.assertFalse(dropDownItems.contains("Four"));

doc.save(getArtifactsDir() + "Field.DropDownItemCollection.docx");

removeAt

public void removeAt(int index)
Removes a value at the specified index.
Parameters:
index - The zero based index.

Example:

Shows how to insert a combo box field and manipulate the elements in its item collection.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Use a document builder to create and populate a combo box
String[] items = {"One", "Two", "Three"};
FormField comboBoxField = builder.insertComboBox("DropDown", items, 0);

// Get the list of drop down items
DropDownItemCollection dropDownItems = comboBoxField.getDropDownItems();

Assert.assertEquals(dropDownItems.getCount(), 3);
Assert.assertEquals(dropDownItems.get(0), "One");
Assert.assertEquals(dropDownItems.indexOf("Two"), 1);
Assert.assertTrue(dropDownItems.contains("Three"));

// We can add an item to the end of the collection or insert it at a desired index
dropDownItems.add("Four");
dropDownItems.insert(3, "Three and a half");
Assert.assertEquals(dropDownItems.getCount(), 5);

// Iterate over the collection and print every element
Iterator<String> dropDownCollectionEnumerator = dropDownItems.iterator();
try {
    while (dropDownCollectionEnumerator.hasNext()) {
        String currentItem = dropDownCollectionEnumerator.next();
        System.out.println(currentItem);
    }
} finally {
    if (dropDownCollectionEnumerator != null) {
        dropDownCollectionEnumerator.remove();
    }
}

// We can remove elements in the same way we added them
dropDownItems.remove("Four");
dropDownItems.removeAt(3);
Assert.assertFalse(dropDownItems.contains("Three and a half"));
Assert.assertFalse(dropDownItems.contains("Four"));

doc.save(getArtifactsDir() + "Field.DropDownItemCollection.docx");

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.