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

AF SDK Reference

AFAnalysisRule Properties

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

The AFAnalysisRule type exposes the following members.

Properties

  NameDescription
Public property
Analysis
This property returns the analysis that owns this object.
Public property
AnalysisRules
This read-only property returns the child analysis rules.
Public property
AnalysisTemplate
This property returns the analysis template that owns this object.
Public property
ConfigString
This property represents the current configuration of the Analysis Rule as a string suitable for displaying to an end-user and/or setting its configuration.
Public property
CurrentCase
This property returns the current case associated with the AnalysisRule.
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 AFAnalysisRule for display purposes.
Public property
EditorType
This method returns the Type of the editor that is used to configure this analysis rule.
Public property
HasChildren
This read-only property returns if the analysis rule has child analysis 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 analysis 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 AFAnalysisRule is in the process of being initialized.
Public property
Name
Read-only property that identifies the name of the object.
Public property
Parent
Returns the parent analysis rule which owns this analysis 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 Analysis Rule that is easier for users to edit and that does not contain redundant information (e.g. IDs for resolution).
Public property
SimplifiedVariableMapping
This property represents a simplified view of the current variable mapping for the Analysis Rule. Setting this property will update the VariableMapping string with updated IDs.
Public property
SupportedBehaviors
Defines the behavior supported by this analysis rule. If the analysis rule supports child analysis rules, their supported behavior is accounted for.
Public property
UniqueID
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.)
Public property
VariableMap
A collection of AFVariableMappingDatas defined for this AFAnalysisRule. Modifying this collection is preferred to editing the VariableMapping string directly.
Public property
VariableMapping
This property represents the current variable mapping for the Analysis Rule.

See Also

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