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

AF SDK Reference

AFTimeRule Methods

  • Last UpdatedNov 18, 2025
  • 5 minute read
AFTimeRule Methods

The AFTimeRule type exposes the following members.

Methods

  NameDescription
Public method
CompareTo(Object)
Compares this instance with a specified Object.
(Inherited from AFObject.)
Public method
CompareTo(AFObject)
Compares this instance with a specified AFObject.
(Inherited from AFObject.)
Public method
DefaultSaveConfigChanges
Called by the protected SaveConfigChanges method to perform the default actions to save the configuration changes.
Public method
Equals(Object)
Determines whether the specified Object is equal to the current object.
(Inherited from AFObject.)
Public method
Equals(AFObject)
Indicates whether the current object is equal to another object of the same type.
(Inherited from AFObject.)
Public method
ErrorToLocalizedString
Translates error code to a localized string.
Public methodStatic member
FindTimeRule(AFAnalysis, Guid)
Retrieves the AFTimeRule object from the AFAnalysis with the specified unique identifier.
Public methodStatic member
FindTimeRule(AFAnalysisTemplate, Guid)
Retrieves the AFTimeRule object from the AFAnalysisTemplate with the specified unique identifier.
Public method
GetEditorT
Returns an instance of an editor of the specified type.
Public method
GetEvents
Returns all pending AFTimeRuleEvent objects.
Public method
GetEvents(AFTimeRange)
Returns all AFTimeRuleEvent objects for a given time range.
Public method
GetHashCode
Gets the hash code for this instance of the object which is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from AFObject.)
Public method
GetNextEvent
Returns the next AFTimeRuleEvent that occurs relative to Now or the previous event.
Public method
GetNextEvent(AFTime)
Returns the next AFTimeRuleEvent that occurs at the specified time start time.
Public method
GetNextEvent(AFTimeRuleEvent)
Returns the next AFTimeRuleEvent that occurs after the previously specified event.
Public method
GetPath
Returns the full path to the object, using just the names.
(Inherited from AFObject.)
Public method
GetPath(AFObject)
Returns the path to the object relative from another object.
(Inherited from AFObject.)
Public method
GetPath(AFEncodeType, AFObject)
Returns the path to the object relative from another object, using the name and/or id as specified by encodeType.
(Inherited from AFObject.)
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method
IsTraced
Indicates if a specified level is being traced.
Public method
Pause
Pause the time rule until it is started again.
Public method
Pause(TimeSpan)
Pause the time rule for a specified amount of time.
Public method
Persist
This method returns the persistence string for the object.
(Inherited from AFObject.)
Public method
RefreshConfiguration
Refresh the configuration of the AFTimeRule.
Public method
Reset
Clear the previous time rule event.
Public method
SetSaveConfigChangesHandler
Set the handler used for saving ConfigString changes.
Public method
Start
Start the time rule
Public method
Stop
Stop the time rule; the previous rule event is cleared.
Public methodStatic member
SupportsChildTimeRule Obsolete.
Determines if the specified AFPlugIn supports adding child time rules.
Public method
ToString
Returns a String that represents the current object.
(Overrides AFObjectToString.)
Public method
TraceData
Output a data trace event.
Public method
TraceDetail
Output a detail trace event.
Public method
TraceError
Output an error trace event.
Public method
TraceEvent(AFTraceSwitchLevel, String)
Output a trace event with a message.
Public method
TraceEvent(AFTraceSwitchLevel, String, Int32)
Output a trace event with a message and a duration.
Public method
TraceEvent(AFTraceSwitchLevel, String, Object)
Output a trace event as a formatted message with a variable number of arguments.
Public method
TraceInformation
Output an information trace event.
Public method
TraceSummary
Output a summary trace event.
Public method
TraceWarning
Output a warning trace event.

See Also

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