AFNotificationTemplate Properties
- Last UpdatedNov 18, 2025
- 7 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFNotificationTemplate type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| AllowElementToExtend |
This read/write property determines if additional attributes or ports can be added to
instances of AFBaseElement objects.
(Inherited from AFElementTemplate.) | |
| AnalysisTemplate |
The AFAnalysisTemplate used to create the AFAnalysis
for the AFNotification created from this template.
| |
| AnalysisTemplates |
This is a collection of analysis templates that target this element template.
(Inherited from AFElementTemplate.) | |
| AttributeTemplates |
Gets the collection of AFAttributeTemplate objects
that are owned by this template.
(Inherited from AFElementTemplate.) | |
| AutoCreate |
This property specifies the option for automatically creating an AFNotification
for an AFElement.
| |
| BaseTemplate |
This property returns the AFElementTemplate which this template inherits from.
(Inherited from AFElementTemplate.) | |
| BaseTemplateOnly |
This read/write property determines if instances of this AFBaseElement object
are allowed to be created. This is typically a BaseTemplate that contains some core
functionality for other derived templates.
(Inherited from AFElementTemplate.) | |
| CanBeAcknowledged |
This property is the default value for the CanBeAcknowledged
property of any new AFEventFrame created from this template.
(Inherited from AFElementTemplate.) | |
| Categories |
This is a user-defined collection of categories for the object that can be used for
querying and/or reporting purposes.
(Inherited from AFElementTemplate.) | |
| CategoriesString |
This read-only property returns the list of categories in a string separated by semicolons.
(Inherited from AFElementTemplate.) | |
| ChangeOnly |
A flag to indicate that only change notifications should be sent for the notification created from this template.
| |
| CheckOutInfo |
This read-only property returns the checked out status information for the object.
(Inherited from AFElementTemplate.) | |
| ChildReferenceTypes |
This is a read-only collection of all AFReferenceType objects that can be used to create
a child reference to an AFElement created from this template.
(Inherited from AFElementTemplate.) | |
| Contents |
The collection of contents used to create the AFNotificationContents
for the AFNotification created from this template.
| |
| Database |
This read-only property returns the AFDatabase where this object is defined.
(Inherited from AFElementTemplate.) | |
| DefaultAttribute |
The AFAttributeTemplate associated with the default
AFAttribute for the AFBaseElement created from
this template.
(Inherited from AFElementTemplate.) | |
| DefaultInputPort |
The default input AFPort for the AFBaseElement
created from this template.
(Inherited from AFElementTemplate.) | |
| DefaultOutputPort |
The default output AFPort for the AFBaseElement
created from this template.
(Inherited from AFElementTemplate.) | |
| DefaultUndirectedPort |
The default undirected AFPort for the AFBaseElement
created from this template.
(Inherited from AFElementTemplate.) | |
| Description |
Read/write property that provides a more detailed description of the object.
(Inherited from AFElementTemplate.) | |
| ExpirationPeriod |
Expiration period for the notification created from this template.
| |
| ExtendedProperties |
A dictionary of extended properties that can be used to store application specific information.
(Inherited from AFElementTemplate.) | |
| FallingBehindOption |
Falling behind option for the notification created from this template.
| |
| HasAnalyses |
This read-only property returns if there are any
AFAnalysisTemplate objects that target this element template.
(Inherited from AFElementTemplate.) | |
| HasNotifications |
This read-only property returns if there are any
AFNotificationTemplate objects that target this element template.
(Inherited from AFElementTemplate.) | |
| 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.) | |
| Identity |
This read-only property contains identity of the object.
(Inherited from AFObject.) | |
| InstanceType |
Specifies the System.Type used when creating
AFBaseElement objects from this template.
(Inherited from AFElementTemplate.) | |
| IsDeleted |
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.) | |
| IsDirty |
This read-only property indicates whether the object has been modified since the
last save to the PI AF Server.
(Inherited from AFElementTemplate.) | |
| IsNew |
This read-only property indicates whether the object is new and has never been saved
to the PI AF Server.
(Inherited from AFElementTemplate.) | |
| MinimumAcknowledgements |
The minimum number of acknowledgments for the notification created from this template.
| |
| Name |
Read/write property that identifies the name of the object.
(Inherited from AFElementTemplate.) | |
| NamingPattern |
The naming pattern used when creating elements from this template.
(Inherited from AFElementTemplate.) | |
| NonrepetitionInterval |
Non-repetition interval for the notification created from this template.
| |
| NotificationContacts |
The collection of AFNotificationContact objects used to create the
AFNotificationContacts for the AFNotification created from
this template.
| |
| NotificationRuleTemplates |
This is a collection of AFNotificationRuleTemplate objects that target this element template.
(Inherited from AFElementTemplate.) | |
| ParentReferenceTypes |
This is a read-only collection of all AFReferenceType objects that can be used to create
a parent reference to an AFElement created from this template.
(Inherited from AFElementTemplate.) | |
| PISystem |
This read-only property allows access to the PISystem associated with this
object.
(Inherited from AFObject.) | |
| Ports |
This is a collection of AFPort objects representing the possible connection ports
for elements created from this template.
Ports are used in a AFModel to define an AFConnection
between AFBaseElement object.
(Inherited from AFElementTemplate.) | |
| Priority |
The priority of the AFNotification created from this template.
| |
| ResendInterval |
The interval for resending the notification created from this template.
| |
| Security |
This read-only property returns the AFSecurity information for the object.
(Inherited from AFElementTemplate.) | |
| Severity |
This property is the default value for the Severity
property of any new AFEventFrame created from this template.
(Inherited from AFElementTemplate.) | |
| Target |
The target of the AFAnalysisTemplate associated with this notification template.
| |
| Type |
This property specifies the base type of the element created from this template.
(Inherited from AFElementTemplate.) | |
| UniqueID |
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.) |