AFEventFrame Constructor (AFDatabase, String, AFElementTemplate, AFAnalysis, Boolean)
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
Initializes a new instance of the class with the specified name.
Namespace: OSIsoft.AF.EventFrame
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public AFEventFrame( AFDatabase database, string name, AFElementTemplate template, AFAnalysis analysis, bool isTemporary = false )
Public Sub New ( database As AFDatabase, name As String, template As AFElementTemplate, analysis As AFAnalysis, Optional isTemporary As Boolean = false ) Dim database As AFDatabase Dim name As String Dim template As AFElementTemplate Dim analysis As AFAnalysis Dim isTemporary As Boolean Dim instance As New AFEventFrame(database, name, template, analysis, isTemporary)
public: AFEventFrame( AFDatabase^ database, String^ name, AFElementTemplate^ template, AFAnalysis^ analysis, bool isTemporary = false )
new : database : AFDatabase * name : string * template : AFElementTemplate * analysis : AFAnalysis * ?isTemporary : bool (* Defaults: let _isTemporary = defaultArg isTemporary false *) -> AFEventFrame
Parameters
- database
- Type: OSIsoft.AFAFDatabase
The new AFEventFrame is added to the specified AFDatabase. - name
- Type: SystemString
The name of the newly created instance of the class. See the ValidateName(String, String) method for a description of what is valid when setting the name of the object. - template
- Type: OSIsoft.AF.AssetAFElementTemplate
The AFElementTemplate that is to be used to create a new instance of the AFEventFrame object. The template must have its InstanceType set to AFEventFrame. If , then the element is created without a template and properties normally defined by the template will be defined by the element instead. - analysis
- Type: OSIsoft.AF.AnalysisAFAnalysis
The new AFEventFrame was created by the specified AFAnalysis. The Analysis property will be set to this value. If the analysis is not and its Target is set to an AFElement, then the PrimaryReferencedElement will be set to the target element. - isTemporary (Optional)
- Type: SystemBoolean
If , then a temporary AFEventFrame is created. If , then a normal AFEventFrame is created.
Remarks
The instance of the class created using this constructor does not belong
to any collection. To add the object to a collection, use the collection's
Add method.