AFElementTemplate.CanBeAcknowledged Property
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
This property is the default value for the CanBeAcknowledged
property of any new AFEventFrame created from this template.
Namespace: OSIsoft.AF.Asset
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public bool CanBeAcknowledged { get; set; }
Public Property CanBeAcknowledged As Boolean Get Set Dim instance As AFElementTemplate Dim value As Boolean value = instance.CanBeAcknowledged instance.CanBeAcknowledged = value
public: property bool CanBeAcknowledged { bool get (); void set (bool value); }
member CanBeAcknowledged : bool with get, set
Property Value
Type: BooleanThe default value for the CanBeAcknowledged property of the AFEventFrame created from this template. The default value is .
Exceptions
| Exception | Condition |
|---|---|
| NotSupportedException | This exception is thrown when the EventFrameAcknowledgement feature is not enabled on the PI AF Server. |
| InvalidOperationException | This exception is thrown if the InstanceType is not set to AFEventFrame. |
Remarks
When a new AFEventFrame is created from this template, the initial value of its CanBeAcknowledged property will be set to the value of this property. The value can then be changed in each Event Frame instance to indicate whether that event frame can be acknowledged. Future changes to this property value will not affect the setting in existing Event Frames.
 Caution |
|---|
| This property can only be set for an AFEventFrameInstanceType. An InvalidOperationException will be thrown for any other InstanceType. |