ConditionalAttribute (Clase)

El atributo ConditionalAttribute puede aplicarse a métodos y clases. Sin embargo, su uso en clases solo es válido para los tipos derivados de Attribute. ConditionalAttribute se omite o produce una advertencia del compilador o un mensaje de error si se aplica a cualquier otro tipo.

Aplicar ConditionalAttribute a un método indica a los compiladores que una llamada al método no debería compilarse en el lenguaje intermedio de Microsoft (MSIL) a menos que se defina el símbolo de compilación condicional asociado a ConditionalAttribute. Obtendrá un error de compilación en Visual Studio si se aplica este atributo a un método que no devuelve void. Aplicar ConditionalAttribute a un atributo indica que el atributo no debería emitirse a los metadatos a menos que se defina el símbolo de compilación condicional. Aún así, el compilador comprueba los tipos de los argumentos pasados al método o atributo.

Puede utilizar las técnicas siguientes para definir los símbolos de compilación condicional:

• Opciones de la línea de comandos del compilador de uso; por ejemplo, /define:DEBUG.

• Variables de entorno de uso en el shell de sistema operativo; por ejemplo, set DEBUG=1.

• Pragmas de uso en el código fuente; por ejemplo, defina la variable de compilación como sigue:

  C#

  Copiar

  #define DEBUG
  

  Copiar

  #Const DEBUG=True
  

  Para anular la variable, utilice:

  Copiar

  #Undef DEBUG
  

  Copiar

  #Const DEBUG=False
  

Se permite que los compiladores que cumplen con Common Language Specification (CLS) omitan ConditionalAttribute. Los compiladores de C#, Visual Basic, y C++ admiten ConditionalAttribute; el compilador de JScript no admite el atributo.

ConditionalAttribute se aplica a los métodos definidos en las clases Debug y Trace.

Para obtener más información acerca de cómo utilizar los atributos, vea Extender metadatos mediante atributos.

El siguiente ejemplo muestra el uso de ConditionalAttribute. El ejemplo supone que la condición está definida con la opción del compilador /define . Puede obtener resultados diferentes si cambia la opción del compilador. Opcionalmente puede definir las condiciones usando las pragmas en el código muestra en lugar de identificarlos como opciones del compilador.

#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
*/

.NET Framework

.NET Framework Client Profile

Biblioteca de clases portable

.NET para aplicaciones de la Tienda Windows

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (no se admite el rol Server Core), Windows Server 2008 R2 (se admite el rol Server Core con SP1 o versiones posteriores; no se admite Itanium)

Referencia