Share via


Rule Members

Include Protected Members
Include Inherited Members

Holds the detailed information about a rule.

The Rule type exposes the following members.

Constructors

 

Name

Description

Protected method

Rule

Overloaded. Initializes a new instance of the Rule class.

Top

Methods

 

Name

Description

Public method

Analyze

Public method

Equals

Determines whether the specified Object is equal to the current Object. (Inherited from Object.)

Protected method

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)

Public method

GetHashCode

Serves as a hash function for a particular type. (Inherited from Object.)

Public method

GetType

Gets the type of the current instance. (Inherited from Object.)

Public method

IsSupported

Returns whether a model element should be analyzed by the current rule.

Protected method

MemberwiseClone

Creates a shallow copy of the current Object. (Inherited from Object.)

Public method

ToString

Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

 

Name

Description

Public property

Description

Gets or sets a longer description of the rule, localized using the current thread locale. The description is used to educate the user on what the rule will check and why.

Public property

FullId

Gets the full ID of the rule.

Public property

HelpKeyword

Gets or sets the F1 Help keyword to the help page for the rule.

Public property

HelpUrl

Gets or sets the MSHelp or the URL of the help page for the rule.

Public property

Id

Gets or sets the short ID of the rule, which is primarily used for easy reference in the user interface when horizontal screen real estate is limited.

Public property

Name

Gets or sets the user-friendly name of the rule, localized by using the current thread locale.

Public property

Namespace

Gets or sets the prefix of the full ID of the rule.

Top

See Also

Reference

Rule Class

Microsoft.Data.Schema.StaticCodeAnalysis Namespace