Interface ICollectionVariableRoot<TKey, TElement, TValidationResult>
Represents a generic collection variable of VariableNode elements that listens to its children's events and propagates them.
public interface ICollectionVariableRoot<TKey, TElement, TValidationResult> : IReadOnlyCollectionVariableRoot<TKey, TElement, TValidationResult>, IReadOnlyCollectionVariableRoot<TKey, TElement>, IReadOnlyCollectionVariableRoot, IVariableNode where TKey : notnull where TElement : VariableNode
Type Parameters
TKeyKey type.
TElementElement type.
TValidationResultValidation result type.
- Inherited Members
- Extension Methods
Methods
Add(IEnumerable<TElement>)
Adds a collection of elements to this collection.
VariableChangeResult Add(IEnumerable<TElement> elements)
Parameters
elementsIEnumerable<TElement>Collection of elements to add.
Returns
- VariableChangeResult
Result of this change attempt.
Add(TElement)
Adds an element to this collection.
VariableChangeResult Add(TElement element)
Parameters
elementTElementElement to add.
Returns
- VariableChangeResult
Result of this change attempt.
Change(CollectionVariableRootChanges<TKey, TElement>)
Changes the Elements.
VariableChangeResult Change(CollectionVariableRootChanges<TKey, TElement> changes)
Parameters
changesCollectionVariableRootChanges<TKey, TElement>Changes to make to Elements.
Returns
- VariableChangeResult
Result of this change attempt.
Clear()
Removes all elements from this collection.
VariableChangeResult Clear()
Returns
- VariableChangeResult
Result of this change attempt.
ClearValidation()
Removes all errors and warnings from this variable.
void ClearValidation()
Refresh()
Refreshes this variable.
void Refresh()
RefreshValidation()
Refreshes this variable's validation.
void RefreshValidation()
Remove(IEnumerable<TKey>)
Removes elements associated with the provided collection of keys.
VariableChangeResult Remove(IEnumerable<TKey> keys)
Parameters
keysIEnumerable<TKey>Collection of keys to remove.
Returns
- VariableChangeResult
Result of this change attempt.
Remove(TKey)
Removes an element associated with the provided key.
VariableChangeResult Remove(TKey key)
Parameters
keyTKeyKey to remove.
Returns
- VariableChangeResult
Result of this change attempt.
Restore(IEnumerable<TKey>)
Restores removed elements associated with the provided collection of keys.
VariableChangeResult Restore(IEnumerable<TKey> keys)
Parameters
keysIEnumerable<TKey>Collection of keys to restore.
Returns
- VariableChangeResult
Result of this change attempt.
Restore(TKey)
Restores a removed element associated with the provided key.
VariableChangeResult Restore(TKey key)
Parameters
keyTKeyKey to restore.
Returns
- VariableChangeResult
Result of this change attempt.