Class CustomTask
- Namespace
- ArcanaDevelopment.adTempus.Client
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
public sealed class CustomTask : Task, ICustomObject
- Inheritance
-
objectCustomTask
- Implements
Properties
CID
The Class ID for the object
[IgnoreDataMember]
public override ClassID CID { get; }
Property Value
Remarks
Obsolete. Use ClassID instead.
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.
CustomObjectDefinition
Gets or sets the ICustomObjectSettings, which contains the settings for the task.
public ICustomObjectSettings CustomObjectDefinition { get; set; }
Property Value
Remarks
The Get throws an exception if the custom object settings cannot be deserialized. Use TryGetCustomObjectDefinition(out ICustomObjectSettings) to avoid the exception.
CustomObjectDescription
Gets a description of the custom object.
public string CustomObjectDescription { get; set; }
Property Value
- string
CustomObjectTypeID
Gets the unique identification string for this class.
public string CustomObjectTypeID { get; }
Property Value
- string
CustomObjectVersion
Gets the version of the object.
public int CustomObjectVersion { get; }
Property Value
- int
Remarks
The version is stored by adTempus and passed in to the object when deserializing.
IsDependent
[IgnoreDataMember]
public override bool IsDependent { get; }
Property Value
- bool
SupportedResponseEvents
Gets a list of the events that are supported for Responses associated with this task.
public override ReadOnlyCollection<SupportedResponseEvent> SupportedResponseEvents { get; }
Property Value
- ReadOnlyCollection<SupportedResponseEvent>
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
TryGetCustomObjectDefinition(out ICustomObjectSettings)
Attempts to get the custom data definition for the custom object.
public bool TryGetCustomObjectDefinition(out ICustomObjectSettings taskDefinition)
Parameters
| Name | Type | Description |
|---|---|---|
taskDefinition |
ICustomObjectSettings |
Returns
- bool
True if the definition was successfully returned, False otherwise.
Remarks
The data definition is stored by adTempus in serialized form. When you request it using by reading the CustomObjectDefinition property, adTempus loads the add-in defind for the object, deserializes the data, and returns the add-in object. If the add-in cannot be loaded, or the data cannot be deserialized, this method returns False.
- See Also
WriteToConfigurationReport(IADTObjectConfigurationReportWriter)
public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)
Parameters
| Name | Type | Description |
|---|---|---|
reportBuilder |
IADTObjectConfigurationReportWriter |
Inherited Members
- Task.UserInterfaceExtensionID
- Task.UserInterfaceExtensionData
- Task.DescriptionOverride
- ADTObject.LastModified
- ADTObject.CreationTimestamp
- ADTObject.FromMaster
- ADTObject.OID
- ADTObject.ClassID
- ADTObject.BindingDescription
- ADTObject.ToString()
- ADTObject.ParentObject
- ADTObject.CanPerform(SecurityPermission)
- ADTObject.Duplicate()
- ADTObject.DataContext
- ADTObject.AccessMask
- ADTObject.Validate(MessageCollection)
- ADTObject.SupportedSecurityActions
- ADTObject.SupportedSecurityInheritanceOptions
- ADTObject.GetTopLevelOwner()
- ADTObject.GetConfigurationReport()
- ADTObject.GetConfigurationReport(bool)
- ADTObject.ExtendedDescription
- ADTObject.IsReadOnly
- ObjectBase.IsDirty
- ObjectBase.IsNew
- ObjectBase.IsStub
- ObjectBase.ClassName
- ObjectBase.GetDescription()
- ObjectBase.BeginEdit()
- ObjectBase.BeginEdit(UndoLevelAction)
- ObjectBase.CommitEdit(Guid)
- ObjectBase.CommitEdit()
- ObjectBase.UndoEdit()
- ObjectBase.UndoEdit(Guid)