Share via


SPHealthAnalysisRule.Explanation property

Gets a detailed description of the problem detected by the rule.

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

Syntax

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

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

Property value

Type: System.String
A string that contains the text of the explanation.

Remarks

The text that is returned by this property is displayed by a form that is available from the SharePoint Health Analyzer Reports list when a problem is detected by the rule. The same form also displays the values of the Summary, ErrorLevel, Category, Remedy, and KnowledgeBaseArticleId properties.

See also

Reference

SPHealthAnalysisRule class

SPHealthAnalysisRule members

Microsoft.SharePoint.Administration.Health namespace