ConditionalAttribute Classe

Definição

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

Herança

Object

Attribute

ConditionalAttribute

Atributos

AttributeUsageAttribute SerializableAttribute ComVisibleAttribute

Exemplos

O exemplo a seguir demonstra o uso de ConditionalAttribute. O exemplo pressupõe que a condição seja definida com a opção /definir compilador. Você pode obter resultados diferentes alterando a opção do compilador. Opcionalmente, você pode definir as condições usando pragmas no código de exemplo em vez de identificá-las como opções do 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
*/

#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. No entanto, seu uso em classes é válido apenas para tipos derivados de Attribute. ConditionalAttribute serão ignorados ou produzirão um aviso do compilador ou uma mensagem de erro se você a aplicar a qualquer outro tipo.

A aplicação ConditionalAttribute a um método indica aos compiladores que uma chamada ao método não deve ser compilada em Microsoft MSIL (linguagem intermediária), a menos que o símbolo de compilação condicional associado a ConditionalAttribute seja definido. Você receberá um erro de compilação em Visual Studio se aplicar esse atributo a um método que não retorna nulo. ConditionalAttribute Aplicar 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. Todos os argumentos passados para o método ou atributo ainda são verificados por tipo pelo compilador.

Você pode usar as seguintes técnicas para definir símbolos de compilação condicional:

• Usar opções de linha de comando do compilador; por exemplo, /define:DEBUG.

• Usar variáveis de ambiente no shell do sistema operacional; por exemplo, defina DEBUG=1.

• Usar pragmas no código-fonte; por exemplo, defina a variável de compilação da seguinte maneira:

  #define DEBUG
  

  #Const DEBUG=True
  

  Para definir a variável, use o seguinte:

  #undef DEBUG
  

  #Const DEBUG=False
  

Os compiladores que estão em conformidade com a CLS (Common Language Specification) têm permissão para ignorar ConditionalAttribute. Os compiladores C#, F#, Visual Basic e C++ dão suporte a ConditionalAttribute; o compilador JScript não dá suporte ao atributo.

ConditionalAttributeé aplicado aos métodos definidos nas classes e Trace nas Debug classes.

Para obter mais informações sobre como usar atributos, consulte Atributos.