class ChoiceOptions in Tinman.AddOns.GUI.Components

sealed class

ChoiceOptions

extends

VectorConstBase<ChoiceOption>

Public / Attributes

Count

The number of elements in this collection.

public override property	Count { get }
type	int32
value	[>=0]	The number of elements.
implements	BagConstBase.Count

Public / Constructors

ChoiceOptions

public constructor

ChoiceOptions ()

Public / Methods

Add

Adds a choice option.

public method	Add (ChoiceOption option)
type	ChoiceOptions
params	option	[not-null]	The choice option to add.
returns		[not-null]	this

---

Adds a choice option.

public method	Add (string text, object data = null, bool enabled = true)
type	ChoiceOptions
params	text		The option text.
	data		Optional data object of option. Defaults to null.
	enabled		Is the option enabled? Defaults to true.
returns		[not-null]	this

Clear

Removes all choice options.

public method	Clear ()
type	ChoiceOptions
returns		[not-null]	this

Contains

Returns if this collection contains the given element.

[Pure]
public override method	Contains (T element)
type	bool
params	element		The element.
returns			true if element is contained in this collection, false if not.
inherited	VectorConstBase.Contains

ContainsAll

Returns if this collection contains all given elements.

public method	ContainsAll (IEnumerable<T> elements)
type	bool
params	elements	[not-null]	The elements.
returns			true if all elements are contained in this collection, false if not.
inherited	BagConstBase.ContainsAll

Equals

Compares this object with the given one.

[Pure]
public method	Equals (IVectorConst<T> other)
type	bool
params	other		The object to compare to.
returns			true if this object is equal to other, false if not.
inherited	VectorConstBase.Equals

First

Returns the first enumerated value.

[Pure]
public override method	First ()
type	T
returns			The first enumerated value.
inherited	VectorConstBase.First

Exceptions:

• TinmanException:
  If the enumeration is empty.

GetAt

Returns the element at the given list index.

[Pure]
public override method	GetAt (int32 index)
type	ChoiceOption
params	index	[0..Count-1]	The list index.
returns			The element.
implements	VectorConstBase.GetAt

GetEnumerator

public override method	GetEnumerator ()
type	IEnumerator<ChoiceOption>
implements	EnumerableBase.GetEnumerator

IndexOf

Returns the list index of the given element.

[Pure]
public override method	IndexOf (ChoiceOption element)
type	int32
params	element		The element.
returns			The list index or -1 if the element is not contained in the list.
implements	VectorConstBase.IndexOf

Last

Returns the last enumerated value.

[Pure]
public override method	Last ()
type	T
returns			The last enumerated value.
inherited	VectorConstBase.Last

Exceptions:

• TinmanException:
  If the enumeration is empty.

Remove

Remove a choice option.

public method	Remove (ChoiceOption option)
type	ChoiceOptions
params	option	[not-null]	The option to remove.
returns		[not-null]	this

ToArray

Returns the elements of this enumerable object as a fresh array.

[Pure]
public method	ToArray ()
type	T[]
returns		[not-null]	The array of elements.
inherited	BagConstBase.ToArray

ToArrayCopy

Returns the elements of this collection as an array.

public override method	ToArrayCopy (T[] array, int32 offset = 0)
type	T[]
params	array	[not-null]	The output array.
	offset	[>=0]	Offset into array. Defaults to 0.
returns		[not-null]	The filled array.
inherited	VectorConstBase.ToArrayCopy

Remarks:

The elements in this collection will be copied into the given array, starting at the array index specified by offset.

ToArrayList

Returns the elements of this enumerable object as a list.

[Pure]
public virtual method	ToArrayList ()
type	IArrayVector<T>
returns		[not-null]	The list of elements.
inherited	BagConstBase.ToArrayList

ToList

Returns the elements of this enumerable object as a list.

[Pure]
public override method	ToList ()
type	IVectorConst<T>
returns		[not-null]	The list of elements.
inherited	VectorConstBase.ToList