NotificationClass.ContentFormatter Property

  • Article

Gets or sets content formatter used by the notification class.

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

Syntax

'Declaration
Public Property ContentFormatter As ContentFormatter

public ContentFormatter ContentFormatter { get; set; }

public:
property ContentFormatter^ ContentFormatter {
    ContentFormatter^ get ();
    void set (ContentFormatter^ value);
}

/** @property */
public ContentFormatter get_ContentFormatter ()

/** @property */
public void set_ContentFormatter (ContentFormatter value)

public function get ContentFormatter () : ContentFormatter

public function set ContentFormatter (value : ContentFormatter)

Property Value

A ContentFormatter object representing the content formatter for the notification class.

Remarks

Each notification class has one content formatter. The content formatter can perform different formatting based on notification field values.

The built-in Extensible Stylesheet Language Transform (XSLT) content formatter can use different XSLT files based on the notification's subscriber device and locale. For more information about the standard XSLT content formatter, see XSLT Content Formatter.

Example

The following examples show how to define an XSLT content formatter and add it to a notification class:

// Add the XSLT content formatter to the notification class
ContentFormatter contentFormatter = 
    new ContentFormatter(flightNotifications, "XsltFormatter");

// Define content formatter arguments
ContentFormatterArgument contentFormatterArgument1 = 
    new ContentFormatterArgument(
    contentFormatter, "XsltBaseDirectoryPath");
contentFormatterArgument1.Value = @"C:\NS\Full\XSLFiles";
ContentFormatterArgument contentFormatterArgument2 = 
    new ContentFormatterArgument(contentFormatter, "XsltFileName");
contentFormatterArgument2.Value = "NoOp.xslt";

// Add arguments to content formatter
contentFormatter.ContentFormatterArguments.Add(
    contentFormatterArgument1);
contentFormatter.ContentFormatterArguments.Add(
    contentFormatterArgument2);

// Assign the content formatter to the notification class
flightNotifications.ContentFormatter = contentFormatter;

' Add the XSLT content formatter to the notification class
Dim contentFormatter As ContentFormatter = _
    New ContentFormatter(flightNotifications, "XsltFormatter")

' Define content formatter arguments
Dim contentFormatterArgument1 As ContentFormatterArgument = _
    New ContentFormatterArgument(contentFormatter, _
    "XsltBaseDirectoryPath")
contentFormatterArgument1.Value = "C:\NS\Full\XSLFiles"
Dim contentFormatterArgument2 As ContentFormatterArgument = _
    New ContentFormatterArgument(contentFormatter, _
    "XsltFileName")
contentFormatterArgument2.Value = "NoOp.xslt"

' Add arguments to content formatter
contentFormatter.ContentFormatterArguments.Add( _
    contentFormatterArgument1)
contentFormatter.ContentFormatterArguments.Add( _
    contentFormatterArgument2)

' Assign the content formatter to the notification class
flightNotifications.ContentFormatter = contentFormatter

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
Configuring Content Formatters
ContentFormatter Element (ADF)