| Options Class |
The Options class provides a convenient method of specifying where Editor
should get the list of options for a `select`, `radio` or `checkbox` field.
This is normally from a table that is _left joined_ to the main table being
edited, and a list of the values available from the joined table is shown to
the end user to let them select from.
`Options` instances are used with the `Field.Options()` method.
Inheritance HierarchyNamespace: DataTables
Assembly: DataTables (in DataTables.dll) Version: 1.6.5.0 (1.6.5.0)
SyntaxC#
public class Options
The Options type exposes the following members.
ConstructorsMethods| Name | Description | |
|---|---|---|
 | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Label |
Get the column name(s) for the options label
|
| Label(IEnumerableString) |
Set multiple column names for the options label
|
| Label(String) |
Set the column name for the options label
|
| Limit |
Get the current limit
|
| Limit(Int32) |
Set the limit for the number of options returned. NOTE if you are using
SQL Server, make sure you also set an `Order` option.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Order |
Get the order by clause for the options
|
| Order(String) |
Set the order by clause for the options
|
| Render |
Get the rendering function
|
| Render(FuncDictionaryString, Object, String) |
Set the rendering function for the option labels
|
| Table |
Get the table configured to read the options from
|
| Table(String) |
Set the table to read the options from
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Value |
Get the value column name
|
| Value(String) |
Set the value column name
|
| Where |
Get the WHERE function used to apply conditions to the options select
|
| Where(ActionQuery) |
Set a function that will be used to apply conditions to the options select
|
See Also