Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFTimeRule Properties

  • Last UpdatedNov 18, 2025
  • 4 minute read
AFTimeRule Properties

The AFTimeRule type exposes the following members.

Properties

  NameDescription
Public property
AdditionalInfo
This property represents the additional information associated with the event.
Public property
Analysis
This property returns the analysis that owns this object.
Public property
AnalysisTemplate
This property returns the analysis template that owns this object.
Public property
ConfigString
This property represents the current configuration of the Time Rule as a string suitable for displaying to an end-user and/or setting its configuration.
Public property
ConfigStringStored
Returns the currently stored configuration string.
Public property
Database
This read-only property returns the AFDatabase where this object is defined.
Public property
Description
Read-only property that provides more detailed description of the object.
Public property
DisplayString
Returns the configuration of the AFTimeRule for display purposes.
Public property
EditorType
This method returns the Type of the editor that is used to configure this time rule.
Public property
HasChildren Obsolete.
This read-only property returns if the time rule has child time rules.
Public property
ID
Read-only property that provides a unique identifier for the object to be used for quick access that is not dependent upon the index.
(Inherited from AFObject.)
Public property
Identity
This read-only property contains identity of the object.
(Inherited from AFObject.)
Public property
IsConfigured
This method returns if the time rule instance is properly configured.
Public property
IsDeleted
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.)
Public property
IsInitializing
Indicates that the AFTimeRule is in the process of being initialized.
Public property
MergeDuplicatedItems
When the same event is generated by multiple time rules, should we merge them? An event is considered the same if its start and end times are the same.
Public property
Name
Read-only property that identifies the name of the object.
Public property
Parent Obsolete.
Returns the parent time rule which owns this time rule.
Public property
PISystem
This read-only property allows access to the PISystem associated with this object.
(Inherited from AFObject.)
Public property
PlugIn
This read-only property returns the AFPlugIn used to create this instance of the plugin.
Public property
SimplifiedConfigString
This property presents a simplified view of the current configuration of the Time Rule that is easier for users to edit and that does not contain redundant information (e.g. IDs for resolution).
Public property
TimeRules Obsolete.
This read-only property returns the child time rules.
Public property
UniqueID
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.)

See Also

TitleResults for “How to create a CRG?”Also Available in