Share via


SPHealthAnalysisRule.Summary property

Gets a brief description of the problem detected by this rule.

Namespace:  Microsoft.SharePoint.Administration.Health
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Public MustOverride ReadOnly Property Summary As String
    Get
'Usage
Dim instance As SPHealthAnalysisRule
Dim value As String

value = instance.Summary
public abstract string Summary { get; }

Property value

Type: System.String
A string that contains a one-sentence description of the problem.

Remarks

The value of this property provides the text that displays as the title of the list item in the Health Rules list and Health Reports list. Standard practice is to phrase the summary as a statement of fact: “Outbound e-mail has not been configured.”

See also

Reference

SPHealthAnalysisRule class

SPHealthAnalysisRule members

Microsoft.SharePoint.Administration.Health namespace