API Reference
Class
FormValues
The values of a form by field name: typed access (FormValues.Get), multi-selections as lists, and only the fields that are visible in FormValues.Visible.
Inheritance
- Object
- FormValues
Usage
Explore 21 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 21
- Property ChoiceField.Loader
- Property ChoiceField.Validator
- Property ChoiceField.VisibleWhen
- Property Field.Validator
- Property Field.VisibleWhen
- Method Form.GetValues
- Property FormResult.Values
- Property MenuContext.Values
- Property NumberField.Validator
- Property NumberField.VisibleWhen
- Property PathField.Validator
- Property PathField.VisibleWhen
- Property RunContext.Values
- Property SecretField.Validator
- Property SecretField.VisibleWhen
- Property TextAreaField.Validator
- Property TextAreaField.VisibleWhen
- Property TextField.Validator
- Property TextField.VisibleWhen
- Property ToggleField.Validator
- Property ToggleField.VisibleWhen
Constructors
public FormValues() #Methods
public Boolean Contains(String name) #Returns:
BooleanWhether a field exists.
Parameters
- name System.String
- The field name.
Returns
True when it exists.
public IEnumerator<KeyValuePair<String, Object?>> GetEnumerator() #Returns:
IEnumerator<KeyValuePair<String, Object?>>Returns an enumerator that iterates through the collection.
Returns
An enumerator that can be used to iterate through the collection.
public IReadOnlyList<TItem?> GetList<TItem>(String name) #Returns:
IReadOnlyList<TItem?>A multi-selection (or a single value) as a typed list.
Type Parameters
- TItem
- The item type.
Parameters
- name System.String
- The field name.
Returns
The items that have the type.
public T? Get<T>(String name, T? fallback = null) #Returns:
T?The value converted to T (lists for multi-selections), or the default.
Type Parameters
- T
- The type.
Parameters
- name System.String
- The field name.
- fallback T? = null
- Returned when the field is empty.
Returns
The value.
public Boolean IsVisible(String name) #Returns:
BooleanWhether a field is currently shown (its condition holds).
Parameters
- name System.String
- The field name.
Returns
True when visible.
public Dictionary<String, Object?> ToDictionary() #Returns:
Dictionary<String, Object?>A plain dictionary of the visible values.
Returns
The dictionary.
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?