Class ConfigPropertyDef
Describes a configuration property definition.
A configuration property definition contains only metadata, such as display information, security requirements, value type, and default value. Actual values are stored separately and may exist at different scopes (System, Company, User).
Examples: * Trade.DefaultPaymentMethodId * Trade.DefaultPaymentTermId * Ui.Theme * Sales.LineGridLayout
public class ConfigPropertyDef : BaseDef, IDef, IJsonLoadable, INotifyPropertyChanged
- Inheritance
-
ConfigPropertyDef
- Implements
- Inherited Members
- Extension Methods
Properties
ApplyValueFunc
Gets or sets a callback that is invoked when a value is applied to this property.
public Action<ConfigPropertyDef, string> ApplyValueFunc { get; set; }
Property Value
DefaultValue
Gets or sets the default value used when no stored value exists.
public string DefaultValue { get; set; }
Property Value
EditorClassName
Gets or sets the class name of a desktop editor used for complex configuration values.
public string EditorClassName { get; set; }
Property Value
GroupName
Gets or sets the UI group name used when displaying configuration properties in configuration dialogs.
public string GroupName { get; set; }
Property Value
Kind
Gets or sets the value kind of the property. Determines how the value is edited, validated, serialized and displayed.
public ConfigValueKind Kind { get; set; }
Property Value
Scopes
Gets or sets the configuration scopes where this property is visible and editable.
public ConfigScopeFlags Scopes { get; set; }
Property Value
SecurityLevel
Gets or sets the minimum user level required to view or modify this configuration property.
public UserLevel SecurityLevel { get; set; }
Property Value
TypeName
Gets or sets an optional type name mapping descriptor based on property classification rules.
Usage depends on the Kind: * Lookup: Lookup source name. * Enum: Enum lookup name or enum type name. * Object: CLR type name or serializer key. Ignored for simple scalar value kinds.
public string TypeName { get; set; }
Property Value
Methods
SupportsScope(ConfigScope)
Returns true when this definition supports the specified configuration scope.
public bool SupportsScope(ConfigScope Scope)
Parameters
ScopeConfigScope