Share via

NotificationClass.NotificationFields Property

  • Article

Gets the collection of regular (noncomputed) notification fields for the notification class.

Namespace: Microsoft.SqlServer.Management.Nmo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)

Syntax

'Declaration
Public ReadOnly Property NotificationFields As NotificationFieldCollection

public NotificationFieldCollection NotificationFields { get; }

public:
property NotificationFieldCollection^ NotificationFields {
    NotificationFieldCollection^ get ();
}

/** @property */
public NotificationFieldCollection get_NotificationFields ()

public function get NotificationFields () : NotificationFieldCollection

Property Value

A NotificationComputedFieldCollection object that represents the collection of noncomputed fields for the notification class.

Remarks

Notification fields define notification data storage for a notification class. The subscription rule that generates notifications inserts notification values into these fields.

Each notification class must have at least one NotificationField in a NotificationFieldCollection.

Example

The following examples show how to use the NotificationFieldCollection to add notification fields to a notification class:

// Define a LeavingFrom notification field and use it for grouping 
// digest messages. Add it to the end of the field collection
NotificationField notificationOrgin = 
    new NotificationField(flightNotifications, "LeavingFrom");
notificationOrgin.Type = "nvarchar(6)";
notificationOrgin.DigestGrouping = true;
flightNotifications.NotificationFields.Add(notificationOrgin);

' Define a LeavingFrom field and use it for grouping
' digest messages. Add it to the end of the collection.
Dim notificationOrgin As NotificationField = _
    New NotificationField(flightNotifications, "LeavingFrom")
notificationOrgin.Type = "nvarchar(6)"
notificationOrgin.DigestGrouping = True
flightNotifications.NotificationFields.Add(notificationOrgin)

You can add fields at a specific position:

// Define a Price field and add it at position 1 in the collection
NotificationField notificationPrice = 
    new NotificationField(flightNotifications, "Price");
notificationPrice.Type = "float";
flightNotifications.NotificationFields.Add(notificationPrice, 1);

' Define a Price field and add it at position 1 
' in the collection.
Dim notificationPrice As NotificationField = _
    New NotificationField(flightNotifications, "Price")
notificationPrice.Type = "float"
flightNotifications.NotificationFields.Add( _
    notificationPrice, 1)

You also can add fields before a specific notification field:

// Define a GoingTo field and add it before the Price field
NotificationField notificationDestination = 
    new NotificationField(flightNotifications, "GoingTo");
notificationDestination.Type = "nvarchar(6)";
flightNotifications.NotificationFields.Add(
    notificationDestination, "Price");

' Define a GoingTo field and add it before the Price field.
Dim notificationDestination As NotificationField = _
    New NotificationField(flightNotifications, "GoingTo")
notificationDestination.Type = "nvarchar(6)"
flightNotifications.NotificationFields.Add( _
    notificationDestination, "Price")

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

NotificationClass Class
NotificationClass Members
Microsoft.SqlServer.Management.Nmo Namespace

Other Resources

Defining Notification Classes
Defining the Notification Schema
Fields Element for Schema (ADF)