com.aspose.words

Class SdtListItemCollection

java.lang.Object

com.aspose.words.SdtListItemCollection

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable

public class SdtListItemCollection
extends java.lang.Object
implements java.lang.Cloneable, java.lang.Iterable

Provides access to SdtListItem elements of a structured document tag.

To learn more, visit the Structured Document Tags or Content Control documentation article.

Method Summary

Modifier and Type	Method and Description
void	add(SdtListItem item) Adds an item to this collection.
void	clear() Clears all items from this collection.
SdtListItem	get(int index) Returns a SdtListItem object given its zero-based index in the collection.
int	getCount() Gets number of items in the collection.
SdtListItem	getSelectedValue() Specifies currently selected value in this list.
java.util.Iterator	iterator() Returns an iterator object that can be used to iterate over all items in the collection.
protected java.lang.Object	memberwiseClone()
void	removeAt(int index) Removes a list item at the specified index.
void	setSelectedValue(SdtListItem value) Specifies currently selected value in this list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

iterator

public java.util.Iterator iterator()

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

Specified by:

iterator in interface java.lang.Iterable

add

public void add(SdtListItem item)

Adds an item to this collection.

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.

clear

public void clear()

Clears all items from this collection.

getSelectedValue

public SdtListItem getSelectedValue()

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

Returns:

The corresponding SdtListItem value.

setSelectedValue

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.

Parameters:

value - The corresponding SdtListItem value.

get

public SdtListItem get(int index)

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

Returns:

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

getCount

public int getCount()

Gets number of items in the collection.

Returns:

Number of items in the collection.

memberwiseClone

protected java.lang.Object memberwiseClone()