ConditionalAttribute ConditionalAttribute ConditionalAttribute ConditionalAttribute Class

Definición

Indica a los compiladores que se debe omitir una llamada al método o un atributo a menos que se defina un símbolo de compilación condicional especificado.Indicates to compilers that a method call or attribute should be ignored unless a specified conditional compilation symbol is defined.

public ref class ConditionalAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=true)]
[System.Runtime.InteropServices.ComVisible(true)]
[System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=true)]
[System.Serializable]
public sealed class ConditionalAttribute : Attribute
type ConditionalAttribute = class
    inherit Attribute
Public NotInheritable Class ConditionalAttribute
Inherits Attribute
Herencia
ConditionalAttributeConditionalAttributeConditionalAttributeConditionalAttribute
Atributos

Ejemplos

El siguiente ejemplo muestra el uso de ConditionalAttribute.The following example demonstrates the use of ConditionalAttribute. El ejemplo se supone que la condición se define con el / define opción del compilador.The example assumes that the condition is defined with the /define compiler option. Puede obtener resultados diferentes si cambia la opción del compilador.You can obtain different results by changing the compiler option. Opcionalmente, puede definir las condiciones mediante el uso de directivas pragma en el código de ejemplo en lugar de que los identifica como opciones del compilador.You can optionally define the conditions by using pragmas in the sample code instead of identifying them as compiler options.

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

Comentarios

Puede aplicar el ConditionalAttribute a métodos y clases de atributo.You can apply the ConditionalAttribute attribute to methods and classes. Sin embargo, su uso en las clases solo es válido para los tipos derivados de Attribute.However, its use on classes is valid only for types that are derived from Attribute. ConditionalAttribute se omitirán o se producirá una advertencia del compilador o un mensaje de error si se aplica a cualquier otro tipo.ConditionalAttribute either will be ignored or will produce a compiler warning or error message if you apply it to any other type.

Aplicar ConditionalAttribute a un método indica a los compiladores que una llamada al método no se debe compilar en lenguaje intermedio (MSIL) a menos que la compilación condicional de símbolos que está asociado con el Microsoft ConditionalAttribute está definido.Applying ConditionalAttribute to a method indicates to compilers that a call to the method should not be compiled into Microsoft intermediate language (MSIL) unless the conditional compilation symbol that is associated with ConditionalAttribute is defined. Si aplica este atributo a un método que no devuelve void, obtendrá un error de compilación en Visual Studio.You will get a compilation error in Visual Studio if you apply this attribute to a method that does not return void. Aplicar ConditionalAttribute a un atributo, indica que el atributo no debe emitir metadatos a menos que se define el símbolo de compilación condicional.Applying ConditionalAttribute to an attribute indicates that the attribute should not be emitted to metadata unless the conditional compilation symbol is defined. Los argumentos pasados al método o atributo son todavía tipos comprobados por el compilador.Any arguments passed to the method or attribute are still type-checked by the compiler.

Puede usar las técnicas siguientes para definir símbolos de compilación condicional:You can use the following techniques to define conditional compilation symbols:

  • Utilice las opciones del compilador de línea de comandos; Por ejemplo, / define: DEBUG.Use compiler command-line options; for example, /define:DEBUG.

  • Usar variables de entorno en el shell de sistema operativo; Por ejemplo, establezca DEBUG = 1.Use environment variables in the operating system shell; for example, set DEBUG=1.

  • Usar directivas pragma en el código fuente; Por ejemplo, defina la variable de compilación como sigue:Use pragmas in the source code; for example, define the compilation variable as follows:

    #define DEBUG  
    
    #Const DEBUG=True  
    

    Para anular la definición de la variable, use lo siguiente:To undefine the variable, use the following:

    #undef DEBUG  
    
    #Const DEBUG=False  
    

Se permiten los compiladores que cumplen con Common Language Specification (CLS) para pasar por alto ConditionalAttribute.Compilers that comply with the Common Language Specification (CLS) are permitted to ignore ConditionalAttribute. Los compiladores de C#, Visual Basic y C++ admiten ConditionalAttribute; el compilador de JScript no admite el atributo.The C#, Visual Basic, and C++ compilers support ConditionalAttribute; the JScript compiler does not support the attribute.

Nota

En Visual Basic, el AddressOf operador no se ve afectado por este atributo.In Visual Basic, the AddressOf operator is not affected by this attribute. Por ejemplo, Call CType(AddressOf delegate, Action) siempre invoca delegate, aunque Call delegate() es posible que no.For example, Call CType(AddressOf delegate, Action) always invokes delegate, although Call delegate() might not.

ConditionalAttribute se aplica a los métodos que se definen en el Debug y Trace clases.ConditionalAttribute is applied to the methods that are defined in the Debug and Trace classes.

Para obtener más información acerca de cómo utilizar los atributos, vea atributos.For more information about how to use attributes, see Attributes.

Constructores

ConditionalAttribute(String) ConditionalAttribute(String) ConditionalAttribute(String) ConditionalAttribute(String)

Inicializa una nueva instancia de la clase ConditionalAttribute.Initializes a new instance of the ConditionalAttribute class.

Propiedades

ConditionString ConditionString ConditionString ConditionString

Obtiene el símbolo de compilación condicional asociado al atributo ConditionalAttribute.Gets the conditional compilation symbol that is associated with the ConditionalAttribute attribute.

TypeId TypeId TypeId TypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Métodos

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Devuelve un valor que indica si esta instancia es igual que un objeto especificado.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Devuelve el código hash de esta instancia.Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object) Match(Object) Match(Object) Match(Object)

Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(Inherited from Object)

Implementaciones de interfaz explícitas

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Proporciona acceso a las propiedades y los métodos expuestos por un objeto.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Se aplica a