SuppressMessageAttribute Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Suppresses reporting of a specific static analysis tool rule violation, allowing multiple suppressions on a single code artifact.

Inheritance Hierarchy

System..::.Object
System..::.Attribute
System.Diagnostics.CodeAnalysis..::.SuppressMessageAttribute

Namespace: System.Diagnostics.CodeAnalysis
Assembly: mscorlib (in mscorlib.dll)

Syntax

<AttributeUsageAttribute(AttributeTargets.All, Inherited := False, AllowMultiple := True)> _
<ConditionalAttribute("CODE_ANALYSIS")> _
Public NotInheritable Class SuppressMessageAttribute _
    Inherits Attribute
[AttributeUsageAttribute(AttributeTargets.All, Inherited = false, AllowMultiple = true)]
[ConditionalAttribute("CODE_ANALYSIS")]
public sealed class SuppressMessageAttribute : Attribute

The SuppressMessageAttribute type exposes the following members.

Constructors

Name Description
SuppressMessageAttribute Initializes a new instance of the SuppressMessageAttribute class, specifying the category of the static analysis tool and the identifier for an analysis rule.

Top

Properties

Name Description
Category Gets the category that identifies the classification of the attribute.
CheckId Gets the identifier of the static analysis tool rule to be suppressed.
Justification Gets or sets the justification for suppressing the code analysis message.
MessageId Gets or sets an optional argument that expands on exclusion criteria.
Scope Gets or sets the scope of the code that is relevant for the attribute.
Target Gets or sets a fully qualified path that represents the target of the attribute.

Top

Methods

Name Description
Equals Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
GetHashCode Returns the hash code for this instance. (Inherited from Attribute.)
GetType Gets the Type of the current instance. (Inherited from Object.)
Match When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

This attribute can be applied to any application element.

Note

The ConditionalAttribute is applied to this class, specifying the preprocessing symbol "CODE_ANALYSIS" as the conditional symbol that determines whether the attribute call is included or omitted. If the symbol is defined, the attribute call is included; otherwise, the call is omitted.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

System.Diagnostics.CodeAnalysis Namespace