OptionCollection

Inheritance: java.lang.Object

All Implemented Interfaces: java.lang.Iterable

public final class OptionCollection implements Iterable<Option>

Class representing collection of options of the choice field.

Methods

MethodDescription
isSynchronized()Returns true of object is synchronized.
isReadOnly()Gets a value indicating if collection is readonly.
getSyncRoot()Synchronization object of the collection.
size()Gets number of options.
iterator_Rename_Namesake()Returns enumerator for options in collection.
iterator()Returns enumerator for options in collection.
get(int index)Gets option by index.
get(String name)Gets option from colleciton by option name.
get_Item(int index)Gets option by index.
get_Item(String name)Gets option by its name.
deleteOption(String name)Deletes option by its name.
add(Option item)Adds item in collection, throws .
clear()Removes all items from collection.
contains(Option item)Checks if item exists in collection, throws .
remove(Option item)Removes item from collection, throws .

isSynchronized()

public boolean isSynchronized()

Returns true of object is synchronized.

Returns: boolean - boolean value

isReadOnly()

public boolean isReadOnly()

Gets a value indicating if collection is readonly.

Returns: boolean - boolean value

getSyncRoot()

public Object getSyncRoot()

Synchronization object of the collection.

Returns: java.lang.Object - Object element

size()

public int size()

Gets number of options.

Returns: int - int value

iterator_Rename_Namesake()

public System.Collections.IEnumerator iterator_Rename_Namesake()

Returns enumerator for options in collection.

Returns: com.aspose.ms.System.Collections.IEnumerator - Options enumerator.

iterator()

public System.Collections.IEnumerator<Option> iterator()

Returns enumerator for options in collection.

Returns: com.aspose.ms.System.Collections.IEnumerator<com.aspose.pdf.Option> - Options enumerator.

get(int index)

public Option get(int index)

Gets option by index.

Parameters:

ParameterTypeDescription
indexintOption index. Index should be in range [1..n] where n is options count.

Returns: Option - Retreived option.

get(String name)

public Option get(String name)

Gets option from colleciton by option name.

Parameters:

ParameterTypeDescription
namejava.lang.StringOption name.

Returns: Option - Retreived option.

get_Item(int index)

public Option get_Item(int index)

Gets option by index.

Parameters:

ParameterTypeDescription
indexintIndex of the option.

Returns: Option - Option on the specified index.

get_Item(String name)

public Option get_Item(String name)

Gets option by its name.

Parameters:

ParameterTypeDescription
namejava.lang.StringName of the option.

Returns: Option - Found option.

deleteOption(String name)

public void deleteOption(String name)

Deletes option by its name.

Parameters:

ParameterTypeDescription
namejava.lang.StringName of the option to delete.

add(Option item)

public void add(Option item)

Adds item in collection, throws .

Not implemented yet.

Parameters:

ParameterTypeDescription
itemOptionOption instance

clear()

public void clear()

Removes all items from collection.

contains(Option item)

public boolean contains(Option item)

Checks if item exists in collection, throws .

Not implemented yet.

Parameters:

ParameterTypeDescription
itemOptionOption instance

Returns: boolean - boolean value

remove(Option item)

public boolean remove(Option item)

Removes item from collection, throws .

Not implemented yet.

Parameters:

ParameterTypeDescription
itemOptionOption instance

Returns: boolean - boolean value