StandardAlertTemplate Class
The StandardAlertTemplate class represents the standard alert template. This template supports text restrictions and an action type restriction, such as whether an item is new or modified. Derive from this class to create new templates for alerts.
System.Object
Microsoft.SharePoint.Portal.Alerts.AlertTemplate
Microsoft.SharePoint.Portal.Alerts.StandardAlertTemplate
Public Constructors
The following table shows the constructors of the StandardAlertTemplate class and a brief description of each.
| Name | Description |
|---|---|
| StandardAlertTemplate | Initializes a new instance of the StandardAlertTemplate class. This constructor is protected. |
| StandardAlertTemplate(Microsoft.SharePoint.Portal.Alerts.Alert) | Initializes a new instance of the StandardAlertTemplate class. This constructor is protected. |
Public Methods
The following table shows the public methods of the StandardAlertTemplate class and a brief description of each.
| Name | Description |
|---|---|
| ApplyTemplate(Microsoft.SharePoint.Portal.Alerts.Alert) | Applies the current template settings to the specified alert object. |
Protected Methods
The following table shows the protected methods of the StandardAlertTemplate class and a brief description of each.
| Name | Description |
|---|---|
| UpdateApplicationData(System.Xml.XmlDocument) | Generates XML needed to populate fields in this template. |
Public Properties
The following table shows the public properties of the StandardAlertTemplate class, the data type of each property, and a brief description of each.
| Name | Data type | Description |
|---|---|---|
| ActionRestriction | Microsoft.SharePoint.Portal.Alerts.ActionRestriction | Gets or sets the action restriction on alerts to which this template is applied. |
| ActionRestrictionConditionText | String | Gets a user-friendly description of the restriction applied in the ActionRestriction property. |
| ConditionText | String | Gets a user-friendly description of the query that describes alerts created with this template. |
| ExternalRestriction | String | Gets or sets additional text restrictions that are applied in this template. |
| FullTextRestriction | Microsoft.SharePoint.Portal.Alerts.SimpleTextRestriction | Gets a text filter that applies restrictions on the alert text. If the property is null, no restriction is applied |
Thread Safety
Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread safe.
Remarks
Requirements
Namespace: Microsoft.SharePoint.Portal.Alerts
Platforms: Microsoft Windows Server 2003
Assembly: Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)
Security: Code Access Security