AFNotificationTemplate Class

<SerializableAttribute>
Public NotInheritable Class AFNotificationTemplate
	Inherits AFElementTemplate
	Implements IComparable(Of AFNotificationTemplate)

Dim instance As AFNotificationTemplate

[SerializableAttribute]
public ref class AFNotificationTemplate sealed : public AFElementTemplate, 
	IComparable<AFNotificationTemplate^>

[<SealedAttribute>]
[<SerializableAttribute>]
type AFNotificationTemplate =  
    class
        inherit AFElementTemplate
        interface IComparable<AFNotificationTemplate>
    end

' This example demonstrates how to create a notification template that
' uses an analysis template, create a notification from the template,
' and displays its information.

' Get the Database
Dim myPISystems As New PISystems
Dim myDB As AFDatabase = myPISystems.DefaultPISystem.Databases.DefaultDatabase

' Create an Element Template, an Analysis Template, and target Element
Dim myElemTemplate As AFElementTemplate = myDB.ElementTemplates.Add("MyTargetTemplate")
Dim myAnalysisTemplate As AFAnalysisTemplate = myDB.AnalysisTemplates.Add("MyAnalysis")
myAnalysisTemplate.Target = myElemTemplate
Dim myTargetElement As AFElement = myDB.Elements.Add("MyTarget", myElemTemplate)

' Create a Notification Template configured to AutoCreate its Target
Dim myNotificationTemplate As AFNotificationTemplate = New AFNotificationTemplate("MyNotificationTemplate")
myNotificationTemplate.Description = "Template used to create my notifications"
myNotificationTemplate.AnalysisTemplate = myAnalysisTemplate
myNotificationTemplate.AutoCreate = AFNotificationTemplate.AutoCreateOption.AutoCreate
myDB.ElementTemplates.Add(myNotificationTemplate)

' Create a Notification from the Notification Template
Dim myNotification As AFNotification = New AFNotification(myDB, "MyNotification", myNotificationTemplate, myTargetElement)
myDB.CheckIn()

' Display the name and description of the Notification Template
Console.WriteLine("Name of Notification Template = {0}", myNotificationTemplate.Name)
Console.WriteLine("Description = {0}", myNotificationTemplate.Description)
Console.WriteLine("UniqueID = {0}", myNotificationTemplate.UniqueID)

' Display the name of all Notifications created from this Notification Template
Dim pageSize As Integer = 100
Dim startIndex As Integer = 0
Dim totalCount As Integer
Dim list As AFNamedCollectionList(Of AFBaseElement)
Do
    list = myNotificationTemplate.FindInstantiatedElements(True, AFSortField.Name, AFSortOrder.Descending, startIndex, pageSize, totalCount)
    Dim CurNotification As AFBaseElement
    For Each CurNotification In list
        Console.WriteLine("Name of Notification created from this template = {0}", CurNotification.Name)
    Next CurNotification

    startIndex = (startIndex + pageSize)    ' Advance to next page
Loop While (startIndex < totalCount)

' Display the names of the auto-created objects
Console.WriteLine("Name of Notification's Analysis = {0}", myNotification.Analysis.Name)
Dim target As AFElement = CType(myNotification.Analysis.Target, AFElement)
Console.WriteLine("Name of Analysis Target = {0}", target.Name)

No code example is currently available or this language may not be supported.

No code example is currently available or this language may not be supported.