Class Option
- Namespace
- ArcanaDevelopment.adTempus.Client
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
public sealed class Option : ObjectBase
- Inheritance
-
objectOption
Properties
ClassKeyName
The key name for the class.
public override string ClassKeyName { get; }
Property Value
- string
Remarks
This name the name used by adTempus to identify the class and is intended for programmatic use only. Use the ClassName for a user-friendly name.
HasValue
public bool HasValue { get; }
Property Value
- bool
IsReadOnly
Indicates whether this object is read-only.
public override bool IsReadOnly { get; }
Property Value
- bool
Remarks
IsReadOnly is True if the DataContext to which the object belongs is read-only. Attempting to modify or delete an object marked read-only will produce a ReadOnlyException.
OptionName
public string OptionName { get; }
Property Value
- string
OptionType
public OptionType OptionType { get; }
Property Value
OptionValue
public string OptionValue { get; set; }
Property Value
- string
ValueType
public OptionValueType ValueType { get; }
Property Value
Methods
GetObjectDescription()
Gets a description of the object's key settings.
protected override string GetObjectDescription()
Returns
- string
Remarks
This method is called by GetDescription() to get a user-friendly description of the object (such as its key settings) for display to the user. The description should contain enough information to distinguish this object from others of the same class.
- See Also
GetValueAsBool()
public bool? GetValueAsBool()
Returns
- bool?
GetValueAsBool(bool)
public bool GetValueAsBool(bool defaultValue)
Parameters
| Name | Type | Description |
|---|---|---|
defaultValue |
bool |
Returns
- bool
GetValueAsDateTime()
public DateTime? GetValueAsDateTime()
Returns
- DateTime?
GetValueAsInt()
public int? GetValueAsInt()
Returns
- int?
GetValueAsInt(int)
public int GetValueAsInt(int defaultValue)
Parameters
| Name | Type | Description |
|---|---|---|
defaultValue |
int |
Returns
- int
SetValue(bool?)
public void SetValue(bool? value)
Parameters
| Name | Type | Description |
|---|---|---|
value |
bool? |
SetValue(DateTime?)
public void SetValue(DateTime? value)
Parameters
| Name | Type | Description |
|---|---|---|
value |
DateTime? |
SetValue(int?)
public void SetValue(int? value)
Parameters
| Name | Type | Description |
|---|---|---|
value |
int? |
WriteToConfigurationReport(IADTObjectConfigurationReportWriter)
public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)
Parameters
| Name | Type | Description |
|---|---|---|
reportBuilder |
IADTObjectConfigurationReportWriter |
Inherited Members
- ObjectBase.IsDirty
- ObjectBase.IsNew
- ObjectBase.IsStub
- ObjectBase.IsDependent
- ObjectBase.ClassName
- ObjectBase.GetDescription()
- ObjectBase.ParentObject
- ObjectBase.BeginEdit()
- ObjectBase.BeginEdit(UndoLevelAction)
- ObjectBase.CommitEdit(Guid)
- ObjectBase.CommitEdit()
- ObjectBase.UndoEdit()
- ObjectBase.UndoEdit(Guid)