ConditionalAttribute Classe

Définition

public ref class ConditionalAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=true)]
public sealed class ConditionalAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=true)]
[System.Serializable]
public sealed class ConditionalAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=true)]
[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
public sealed class ConditionalAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=true)>]
type ConditionalAttribute = class
    inherit Attribute

[<System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=true)>]
[<System.Serializable>]
type ConditionalAttribute = class
    inherit Attribute

[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=true)>]
[<System.Serializable>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type ConditionalAttribute = class
    inherit Attribute

Public NotInheritable Class ConditionalAttribute
Inherits Attribute

Héritage

Object

Attribute

ConditionalAttribute

Attributs

AttributeUsageAttribute SerializableAttribute ComVisibleAttribute

Exemples

L’exemple suivant illustre l’utilisation de ConditionalAttribute. L’exemple suppose que la condition est définie avec l’option /define compiler. Vous pouvez obtenir différents résultats en modifiant l’option du compilateur. Vous pouvez éventuellement définir les conditions à l’aide de pragmas dans l’exemple de code au lieu de les identifier comme options du compilateur.

#define CONDITION1
#define CONDITION2
using System;
using System.Diagnostics;

class Test
{
    static void Main()
    {
        Console.WriteLine("Calling Method1");
        Method1(3);
        Console.WriteLine("Calling Method2");
        Method2();

        Console.WriteLine("Using the Debug class");
        Debug.Listeners.Add(new ConsoleTraceListener());
        Debug.WriteLine("DEBUG is defined");
    }

    [Conditional("CONDITION1")]
    public static void Method1(int x)
    {
        Console.WriteLine("CONDITION1 is defined");
    }

    [Conditional("CONDITION1"), Conditional("CONDITION2")]
    public static void Method2()
    {
        Console.WriteLine("CONDITION1 or CONDITION2 is defined");
    }
}

/*
When compiled as shown, the application (named ConsoleApp)
produces the following output.

Calling Method1
CONDITION1 is defined
Calling Method2
CONDITION1 or CONDITION2 is defined
Using the Debug class
DEBUG is defined
*/

#Const CONDITION1 = True
#Const CONDITION2 = True
Imports System.Diagnostics

Class Test

    Shared Sub Main()
        Console.WriteLine("Calling Method1")
        Method1(3)
        Console.WriteLine("Calling Method2")
        Method2()
        
        Console.WriteLine("Using the Debug class")
        Debug.Listeners.Add(New ConsoleTraceListener())
        Debug.WriteLine("DEBUG is defined")
    End Sub
       
    <ConditionalAttribute("CONDITION1")> _
    Shared Sub Method1(x As Integer)
        Console.WriteLine("CONDITION1 is defined")
    End Sub
    
    <ConditionalAttribute("CONDITION1"), ConditionalAttribute("CONDITION2")> _
    Shared Sub Method2()
        Console.WriteLine("CONDITION1 or CONDITIOIN2 is defined")
    End Sub
    
End Class


' When compiled as shown, the application (named ConsoleApp) 
' produces the following output.

'Calling Method1
'CONDITION1 is defined
'Calling Method2
'CONDITION1 or CONDITION2 is defined
'Using the Debug class
'DEBUG is defined

Remarques

Vous pouvez appliquer l’attribut ConditionalAttribute aux méthodes et aux classes. Toutefois, son utilisation sur les classes est valide uniquement pour les types dérivés de Attribute. ConditionalAttribute soit sera ignoré, soit génère un message d’avertissement ou d’erreur du compilateur si vous l’appliquez à un autre type.

L’application de ConditionalAttribute à une méthode indique aux compilateurs qu’un appel à la méthode ne doit pas être compilé dans Microsoft langage intermédiaire (MSIL), sauf si le symbole de compilation conditionnelle associé à ConditionalAttribute est défini. Vous obtiendrez une erreur de compilation dans Visual Studio si vous appliquez cet attribut à une méthode qui ne retourne pas void. L’application ConditionalAttribute à un attribut indique que l’attribut ne doit pas être émis dans les métadonnées, sauf si le symbole de compilation conditionnelle est défini. Tous les arguments passés à la méthode ou à l’attribut sont toujours vérifiés par le compilateur.

Vous pouvez utiliser les techniques suivantes pour définir des symboles de compilation conditionnelle :

• Utiliser les options de ligne de commande du compilateur ; par exemple, /define :DEBUG.

• Utilisez des variables d’environnement dans l’interpréteur de commandes du système d’exploitation ; par exemple, définissez DEBUG=1.

• Utilisez des pragmas dans le code source ; par exemple, définissez la variable de compilation comme suit :

  #define DEBUG
  

  #Const DEBUG=True
  

  Pour annuler la définition de la variable, utilisez les éléments suivants :

  #undef DEBUG
  

  #Const DEBUG=False
  

Les compilateurs qui respectent la spécification clS (Common Language Specification) sont autorisés à ignorer ConditionalAttribute. Les compilateurs C#, F#, Visual Basic et C++ prennent en charge ConditionalAttribute ; le compilateur JScript ne prend pas en charge l’attribut.

ConditionalAttribute est appliqué aux méthodes définies dans les Debug classes et Trace les classes.

Pour plus d’informations sur l’utilisation des attributs, consultez Attributs.