|
| | Property () |
| | Parameterless construction. The Name and Value fields must be filled at some point.
Will set default values:
UIImportance = 0;
ValueType = ValueTypes.StringType;
ServerValidation = false;
SortKey = 100;
|
| |
| | Property (string key, string name, string value) |
| | Construction with minimal content, but with a unique key.
|
| |
| | Property (string key, string name, string[] valueArray) |
| | Construction with minimal content, but with a unique key.
|
| |
| | Property (string name, string value) |
| | Construction with minimal content.
|
| |
| | Property (string name, string[] valueArray) |
| | Construction with minimal content, but with a value array.
|
| |
|
| string | DisplayName [get, set] |
| | The default English display name.
|
| |
| bool | IsSettable [get, set] |
| | Defines if this field can be updated. For most fields this will be true, but for e.g. a GUID it will be false.
|
| |
| bool | ItemReference [get, set] |
| | Defines if this value field is the ID of another ConfigurationItem (The Path to it).
|
| |
| string | Key [get, set] |
| | A unique key to this property, e.g. "Guid".
|
| |
| String | SelectedValueTypeInfoName [get, set] |
| | When a enum is defined in the ValueType, the currently selected ValueTypeInfo is referenced by having this field set to the valueTypeInfo.Name, and the Value of this class to the actual displayed value.
|
| |
| bool | ServerValidation [get, set] |
| | When the property has been modified, this field defines if the server will need to receive the entire ConfigurationItem for inter-field validation.
|
| |
| int | SortKey [get, set] |
| | Identifies the order in which to show this Property compared to the other ItemPropertyInfos. When properties have same values the properties will be sorted by their display name.
|
| |
| String | ToolTipTranslationId [get, set] |
| | When translating to any language this Id is used to make the lookup in the Dictionary returned by the GetTranslations method.
When no Id is provided there is no tool tip.
|
| |
| String | TranslationId [get, set] |
| | When translating to any language this Id is used to make the lookup in the Dictionary returned by the GetTranslations method.
When no Id is provided the string in the Name field is displayed as label.
|
| |
| int | UIImportance [get, set] |
| | Tells how the property should be showed. E.g. GUIDs should not be shown. The values are: 0 - default, show normally 1 - hidden, should not normally be shown e.g. Guids 2 - most used field, a field that should be used when making summary pages 3 - Disabled field 4 - Password field.
|
| |
| string | Value [get, set] |
| | The current value to this property.
This property is only set, if Property.ValueType is not ValueTypes.Array.
|
| |
| string[] | ValueArray [get, set] |
| | The current value to this property if the value is an array.
This property is only set, if Property.ValueType is set to ValueTypes.Array.
|
| |
| String | ValueType [get, set] |
| | Defines the content type of the value, values can be (Defined in class ValueTypes):
String = any content (No content in ValueTypeInfos)
Int = an integer, the ValueTypeInfos is used if a "MinValue" and "MaxValue"
Double = a double, the ValueTypeInfos is used if a "MinValue" and "MaxValue"
Tick = a tickmark or no tickmark. value can be 1 or 0, or true or false (ValueTypeInfos is used to define which to use, with key "BoolValue" the content is "truefalse" to identify values of either "true" or "false" )
Enum = Display a list of options, the ValueTypeInfos contains a set of Strings to display.
When a value is selected, the content of the ValueTypeInfo's Name is stored in the SelectedValueInfoTypeName,
and the ValueTypeInfo's value is stored in this class' Value field.
Path = ValueTypeInfos need to define what type of path to select. E.g. with Name=ValueTypeInfoNames.PathItemType, Value = ItemTypes.Role - if the path is for selecting a role.
Slider = an integer, the ValueTypeInfos is used for "MinValue" and "MaxValue"
These are defined as constants under the ValueTypes class. E.g. ValueTypes.StringType.
|
| |
| ValueTypeInfo[] | ValueTypeInfos [get, set] |
| | One or more ValueTypeInfo as defined by the ValueType - and assists the validation of the Value field.
For some ValueType's it contains a MinValue and MaxValue, and for Enum's it contains a list of values to choose from.
|
| |
All properties are stored on the ConfigurationItem.Properties array in the format of this class.
| String VideoOS.ConfigurationAPI.Property.ValueType |
|
getset |
Defines the content type of the value, values can be (Defined in class ValueTypes):
String = any content (No content in ValueTypeInfos)
Int = an integer, the ValueTypeInfos is used if a "MinValue" and "MaxValue"
Double = a double, the ValueTypeInfos is used if a "MinValue" and "MaxValue"
Tick = a tickmark or no tickmark. value can be 1 or 0, or true or false (ValueTypeInfos is used to define which to use, with key "BoolValue" the content is "truefalse" to identify values of either "true" or "false" )
Enum = Display a list of options, the ValueTypeInfos contains a set of Strings to display.
When a value is selected, the content of the ValueTypeInfo's Name is stored in the SelectedValueInfoTypeName,
and the ValueTypeInfo's value is stored in this class' Value field.
Path = ValueTypeInfos need to define what type of path to select. E.g. with Name=ValueTypeInfoNames.PathItemType, Value = ItemTypes.Role - if the path is for selecting a role.
Slider = an integer, the ValueTypeInfos is used for "MinValue" and "MaxValue"
These are defined as constants under the ValueTypes class. E.g. ValueTypes.StringType.