Table of Contents

Class Trigger

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll
public abstract class Trigger : ADTObject
Inheritance
object
Trigger
Derived

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.

Description

public string Description { get; set; }

Property Value

string

DescriptionOverride

public string DescriptionOverride { get; set; }

Property Value

string

Enabled

public bool Enabled { get; set; }

Property Value

bool

ExtendedDescription

public override string ExtendedDescription { get; }

Property Value

string

JobVariables

public JobVariableCollection JobVariables { get; }

Property Value

JobVariableCollection

MinimumInterval

The minimum interval (in seconds) between triggers.

public int MinimumInterval { get; set; }

Property Value

int

Remarks

If this value is set, then the trigger will ignore any events that occur within MinimumInterval seconds after the last time this trigger fired.

Name

public string Name { get; set; }

Property Value

string

SelectionScript

public Script SelectionScript { get; set; }

Property Value

Script

UserInterfaceExtensionData

public string UserInterfaceExtensionData { get; set; }

Property Value

string

UserInterfaceExtensionID

public string UserInterfaceExtensionID { get; set; }

Property Value

string

Methods

FindOwningObject()

Get the owner of this object based on relationships.

protected override ADTObject FindOwningObject()

Returns

ADTObject

The owning object, or null if the object is not owned by another object or the owner has not been set.

GetInheritedVariables(bool)

public JobVariableCollection GetInheritedVariables(bool includeSelf)

Parameters

NameTypeDescription
includeSelf bool

Returns

JobVariableCollection

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

GetTriggerDescription()

protected abstract string GetTriggerDescription()

Returns

string

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

Inherited Members