Interface IValuesListSelectionEdit

Allows the selected values and "other" text for a given record's Values List field to be modified.

Inherited Members
Namespace: Estrelica.Archer.Content
Assembly: Estrelica.Interfaces.dll
Syntax
[StayPublic]
[DoNotObfuscateType]
public interface IValuesListSelectionEdit : IValuesListBaseSelectionEdit, IEditableField, IEditable, IClearable

Properties

ValueIds

Returns the integer value Ids for all selected Values List Values

Declaration
IEnumerable<int> ValueIds { get; set; }
Property Value
IEnumerable<int>

Values

Returns the IArcherValuesListValue references for all selected Values List Values

Declaration
IEnumerable<IArcherValuesListValue> Values { get; set; }
Property Value
IEnumerable<IArcherValuesListValue>

Methods

Add(IArcherValuesListValue)

Adds the specified IArcherValuesListValue reference to the current selection

Declaration
bool Add(IArcherValuesListValue value)
Parameters
IArcherValuesListValue value

Returns
bool

Add(int)

Adds the IArcherValuesListValue from the related Values List having the specified integer Id

Declaration
bool Add(int valueId)
Parameters
int valueId

Returns
bool

True if the add was successful, false if not (i.e. if the value already exists on the field)

Add(string, bool, bool)

Adds the IArcherValuesListValue from the related Values List having the specified name

Declaration
bool Add(string name, bool ignoreCase = true, bool addUnknownValues = false)
Parameters
string name

bool ignoreCase

If false, the name must match exactly. If true (the default) a case-insensitive match will be used.
bool addUnknownValues

If false, valueNames which don't already exist in the Values List will raise an exception. If true, they will be added to the Values List (behaving similar to the "Add unknown source values to the target values list" option in the Data Feed Manager).
Returns
bool

True if the add was successful, false if not (i.e. if the value already exists on the field)
Remarks

Archer values must be unique, regardless of case, within their parent list. Therefore, if addUnknownValues = true, case will be ignored during the name resolution regardless of what is passed in ignoreCase.

Remove(IArcherValuesListValue)

Removes the specified IArcherValuesListValue from the selection

Declaration
bool Remove(IArcherValuesListValue value)
Parameters
IArcherValuesListValue value

Returns
bool

True if the removal was successful, false if not (i.e. if the value did not already exist on the field)

Remove(int)

Removes the IArcherValuesListValue having the specified integer Id from the selection

Declaration
bool Remove(int valueId)
Parameters
int valueId

Returns
bool

True if the removal was successful, false if not (i.e. if the value did not already exist on the field)

Remove(string, bool)

Removes the IArcherValuesListValue having the specified name from the selection

Declaration
bool Remove(string name, bool ignoreCase = true)
Parameters
string name

bool ignoreCase

If false, the name must match exactly. If true (the default) a case-insensitive match will be used.
Returns
bool

True if the removal was successful, false if not (i.e. if the value did not already exist on the field)

Set(IArcherValuesListValue)

Sets the selection to a single IArcherValuesListValue reference

Declaration
void Set(IArcherValuesListValue value)
Parameters
IArcherValuesListValue value

Set(params IArcherValuesListValue[])

Sets the selection to one or more IArcherValuesListValue references as a params array

Declaration
void Set(params IArcherValuesListValue[] values)
Parameters
IArcherValuesListValue[] values

Set(IEnumerable<IArcherValuesListValue>)

Sets the selection to an enumerable of IArcherValuesListValue references

Declaration
void Set(IEnumerable<IArcherValuesListValue> values)
Parameters
IEnumerable<IArcherValuesListValue> values

Set(IEnumerable<int>)

Sets the selection to the values in the related Values List having the specified integer Ids in the IEnumerable<int> parameter.

Declaration
void Set(IEnumerable<int> valueIds)
Parameters
IEnumerable<int> valueIds

Set(IEnumerable<string>, bool, bool)

Sets the selection to the values in the related Values List having the specified names.

Declaration
void Set(IEnumerable<string> valueNames, bool ignoreCase = true, bool addUnknownValues = false)
Parameters
IEnumerable<string> valueNames

The names of the values to be selected
bool ignoreCase

If false, the value names must match the case of the valueNames values exactly. If true (the default) case-insensitive matching will be applied.
bool addUnknownValues

If false, valueNames which don't already exist in the Values List will raise an exception. If true, they will be added to the Values List (behaving similar to the "Add unknown source values to the target values list" option in the Data Feed Manager).
Remarks

Archer values must be unique, regardless of case, within their parent list. Therefore, if addUnknownValues = true, case will be ignored during the name resolution regardless of what is passed in ignoreCase.

Set(int)

Sets the selection to the single value in the related Values List having the specified integer Id

Declaration
void Set(int valueId)
Parameters
int valueId

Set(params int[])

Sets the selection to the values in the related Values List having the specified integer Ids in the int[] params array.

Declaration
void Set(params int[] valueIds)
Parameters
int[] valueIds

Set(string, bool, bool)

Sets the selection to a single value in the related Values List having the specified name.

Declaration
void Set(string valueName, bool ignoreCase = true, bool addUnknownValues = false)
Parameters
string valueName

The name of the value to be selected
bool ignoreCase

If false, the value names must match the case of the valueNames values exactly. If true (the default) case-insensitive matching will be applied.
bool addUnknownValues

If false, valueNames which don't already exist in the Values List will raise an exception. If true, they will be added to the Values List (behaving similar to the "Add unknown source values to the target values list" option in the Data Feed Manager).
Remarks

Archer values must be unique, regardless of case, within their parent list. Therefore, if addUnknownValues = true, case will be ignored during the name resolution regardless of what is passed in ignoreCase.

Set(params string[])

Sets the selection to the values in the related Values List having the names specified in the string params array

Declaration
void Set(params string[] valueNames)
Parameters
string[] valueNames

Remarks

The names will be resolved in a case-insensitive manner, and any unresolved names will result in an exception. If you need case sensistivity or the automatic addition of unknown values, use one of the overrides with ignoreCase = false or addUnknownValues = true

Extension Methods