ConditionalAttribute ConditionalAttribute ConditionalAttribute ConditionalAttribute Class

Definição

Indica a compiladores que um atributo ou chamada de método deve ser ignorado a menos que um símbolo de compilação condicional especificado seja definido.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
Herança
ConditionalAttributeConditionalAttributeConditionalAttributeConditionalAttribute
Atributos

Exemplos

O exemplo a seguir demonstra o uso de ConditionalAttribute.The following example demonstrates the use of ConditionalAttribute. O exemplo supõe que a condição seja definida com a opção de compilador /define .The example assumes that the condition is defined with the /define compiler option. Você pode obter resultados diferentes alterando a opção do compilador.You can obtain different results by changing the compiler option. Opcionalmente, você pode definir as condições usando pragmas no código de exemplo em vez de identificá-las como opções do 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.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

Comentários

Você pode aplicar o ConditionalAttribute atributo a métodos e classes.You can apply the ConditionalAttribute attribute to methods and classes. No entanto, seu uso em classes é válido somente para tipos derivados de Attribute.However, its use on classes is valid only for types that are derived from Attribute. ConditionalAttributeserá ignorado ou produzirá um aviso do compilador ou uma mensagem de erro se você aplicá-lo a qualquer outro tipo.ConditionalAttribute either will be ignored or will produce a compiler warning or error message if you apply it to any other type.

A ConditionalAttribute aplicação a um método indica aos compiladores que uma chamada para o método não deve ser compilada na MSIL (Microsoft Intermediate Language), a menos que o ConditionalAttribute símbolo de compilação condicional associado a esteja 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. Você receberá um erro de compilação no Visual Studio se aplicar esse atributo a um método que não retorna void.You will get a compilation error in Visual Studio if you apply this attribute to a method that does not return void. A ConditionalAttribute aplicação a um atributo indica que o atributo não deve ser emitido para metadados, a menos que o símbolo de compilação condicional seja definido.Applying ConditionalAttribute to an attribute indicates that the attribute should not be emitted to metadata unless the conditional compilation symbol is defined. Todos os argumentos passados para o método ou atributo ainda são de tipo verificado pelo compilador.Any arguments passed to the method or attribute are still type-checked by the compiler.

Você pode usar as seguintes técnicas para definir símbolos de compilação condicional:You can use the following techniques to define conditional compilation symbols:

  • Usar opções de linha de comando do compilador; por exemplo, /define: debug.Use compiler command-line options; for example, /define:DEBUG.

  • Usar variáveis de ambiente no Shell do sistema operacional; por exemplo, defina Debug = 1.Use environment variables in the operating system shell; for example, set DEBUG=1.

  • Use pragmas no código-fonte; por exemplo, defina a variável de compilação da seguinte maneira:Use pragmas in the source code; for example, define the compilation variable as follows:

    #define DEBUG  
    
    #Const DEBUG=True  
    

    Para desdefinir a variável, use o seguinte:To undefine the variable, use the following:

    #undef DEBUG  
    
    #Const DEBUG=False  
    

Os compiladores que estão em conformidade com o Common Language Specification (CLS) têm permissão ConditionalAttributepara serem ignorados.Compilers that comply with the Common Language Specification (CLS) are permitted to ignore ConditionalAttribute. O C#, Visual Basic e C++ compiladores dão suporte ConditionalAttribute; o compilador do JScript não oferece suporte ao atributo.The C#, Visual Basic, and C++ compilers support ConditionalAttribute; the JScript compiler does not support the attribute.

Observação

No Visual Basic, o AddressOf operador não é afetado por esse atributo.In Visual Basic, the AddressOf operator is not affected by this attribute. Por exemplo, Call CType(AddressOf delegate, Action) sempre delegateinvoca, embora Call delegate() possa não.For example, Call CType(AddressOf delegate, Action) always invokes delegate, although Call delegate() might not.

ConditionalAttributeé aplicado aos métodos que são definidos nas Debug classes e. TraceConditionalAttribute is applied to the methods that are defined in the Debug and Trace classes.

Para obter mais informações sobre como usar atributos, consulte atributos.For more information about how to use attributes, see Attributes.

Construtores

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

Inicializa uma nova instância da classe ConditionalAttribute.Initializes a new instance of the ConditionalAttribute class.

Propriedades

ConditionString ConditionString ConditionString ConditionString

Obtém o símbolo de compilação condicional que está associado ao atributo ConditionalAttribute.Gets the conditional compilation symbol that is associated with the ConditionalAttribute attribute.

TypeId TypeId TypeId TypeId

Quando implementado em uma classe derivada, obtém um identificador exclusivo 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)

Retorna um valor que indica se essa instância é igual a um objeto especificado.Returns a value that indicates whether this instance is equal to a specified object.

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

Retorna o código hash para essa instância.Returns the hash code for this instance.

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

Obtém o Type da instância atual.Gets the Type of the current instance.

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

Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe 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)

Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um 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()

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

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

Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object.

(Inherited from Object)

Implantações explícitas de interface

_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)

Mapeia um conjunto de nomes para um conjunto correspondente de identificadores de expediçã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)

Recupera as informações de tipo para um objeto, que pode ser usado para obter as informações de tipo para uma interface.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)

Retorna o número de interfaces de informações do tipo que um objeto fornece (0 ou 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)

Fornece acesso a propriedades e métodos expostos por um objeto.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Aplica-se a