ConditionalAttribute ConditionalAttribute ConditionalAttribute ConditionalAttribute Class

Definicja

Wskazuje kompilatorom, że wywołanie metody lub atrybut należy zignorować, chyba że zdefiniowany jest określony symbol kompilacji warunkowej.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
Dziedziczenie
ConditionalAttributeConditionalAttributeConditionalAttributeConditionalAttribute
Atrybuty

Przykłady

Poniższy przykład ilustruje użycie ConditionalAttribute.The following example demonstrates the use of ConditionalAttribute. W przykładzie przyjęto założenie, że warunek jest zdefiniowany przy użyciu opcji kompilatora /define .The example assumes that the condition is defined with the /define compiler option. Możesz uzyskać różne wyniki, zmieniając opcję kompilatora.You can obtain different results by changing the compiler option. Opcjonalnie można zdefiniować warunki przy użyciu pragm w przykładowym kodzie zamiast identyfikować je jako opcje kompilatora.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

Uwagi

Można zastosować ConditionalAttribute atrybut do metod i klas.You can apply the ConditionalAttribute attribute to methods and classes. Jednak jego użycie w klasach jest prawidłowe tylko dla typów, które są wyprowadzane z Attribute.However, its use on classes is valid only for types that are derived from Attribute. ConditionalAttributezostanie zignorowane lub zostanie wygenerowane Ostrzeżenie kompilatora lub komunikat o błędzie, jeśli zostanie on zastosowany do dowolnego innego typu.ConditionalAttribute either will be ignored or will produce a compiler warning or error message if you apply it to any other type.

Zastosowanie ConditionalAttribute do metody wskazuje kompilatorom, że wywołanie metody nie powinno być kompilowane do języka pośredniego firmy Microsoft (MSIL), chyba że jest zdefiniowany warunkowy symbol kompilacji, ConditionalAttribute który jest skojarzony z.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. Po zastosowaniu tego atrybutu do metody, która nie zwraca typu void, zostanie wyświetlony błąd kompilacji w programie Visual Studio.You will get a compilation error in Visual Studio if you apply this attribute to a method that does not return void. Zastosowanie ConditionalAttribute do atrybutu wskazuje, że atrybut nie powinien być emitowany do metadanych, chyba że jest zdefiniowany symbol kompilacji warunkowej.Applying ConditionalAttribute to an attribute indicates that the attribute should not be emitted to metadata unless the conditional compilation symbol is defined. Wszystkie argumenty przekazane do metody lub atrybutu są nadal sprawdzane przez kompilator.Any arguments passed to the method or attribute are still type-checked by the compiler.

Za pomocą następujących technik można definiować symbole kompilacji warunkowej:You can use the following techniques to define conditional compilation symbols:

  • Użyj opcji wiersza polecenia kompilatora; na przykład /define: Debug.Use compiler command-line options; for example, /define:DEBUG.

  • Użyj zmiennych środowiskowych w powłoce systemu operacyjnego; na przykład Ustaw wartość Debuguj = 1.Use environment variables in the operating system shell; for example, set DEBUG=1.

  • Użyj pragm w kodzie źródłowym; na przykład Zdefiniuj zmienną kompilacja w następujący sposób:Use pragmas in the source code; for example, define the compilation variable as follows:

    #define DEBUG  
    
    #Const DEBUG=True  
    

    Aby wydefiniować zmienną, użyj następujących:To undefine the variable, use the following:

    #undef DEBUG  
    
    #Const DEBUG=False  
    

Kompilatory, które są zgodne z Common Language Specification (CLS), mogą być ignorowane ConditionalAttribute.Compilers that comply with the Common Language Specification (CLS) are permitted to ignore ConditionalAttribute. C# C++ Obsługa ,ConditionalAttributeVisual Basic i kompilatory; kompilator języka JScript nie obsługuje atrybutu.The C#, Visual Basic, and C++ compilers support ConditionalAttribute; the JScript compiler does not support the attribute.

Uwaga

W Visual Basic ten atrybut AddressOf nie ma wpływ na operatora.In Visual Basic, the AddressOf operator is not affected by this attribute. Na przykład Call CType(AddressOf delegate, Action) zawsze wywołuje delegate, chociaż Call delegate() może nie.For example, Call CType(AddressOf delegate, Action) always invokes delegate, although Call delegate() might not.

ConditionalAttributestosuje się do metod, które są zdefiniowane w Debug klasach i. TraceConditionalAttribute is applied to the methods that are defined in the Debug and Trace classes.

Aby uzyskać więcej informacji na temat używania atrybutów, zobacz atrybuty.For more information about how to use attributes, see Attributes.

Konstruktory

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

Inicjuje nowe wystąpienie klasy ConditionalAttribute klasy.Initializes a new instance of the ConditionalAttribute class.

Właściwości

ConditionString ConditionString ConditionString ConditionString

Pobiera symbol kompilacji warunkowej, który jest skojarzony z ConditionalAttribute atrybutem.Gets the conditional compilation symbol that is associated with the ConditionalAttribute attribute.

TypeId TypeId TypeId TypeId

Po zaimplementowaniu w klasie pochodnej pobiera unikatowy identyfikator dla tego Attributeelementu.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Metody

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

Zwraca wartość wskazującą, czy to wystąpienie jest równe podanemu obiektowi.Returns a value that indicates whether this instance is equal to a specified object.

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

Zwraca kod skrótu dla tego wystąpienia.Returns the hash code for this instance.

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

Type Pobiera bieżące wystąpienie.Gets the Type of the current instance.

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

Gdy jest zastępowany w klasie pochodnej, wskazuje, czy wartość tego wystąpienia jest wartością domyślną klasy pochodnej.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)

Gdy jest zastępowany w klasie pochodnej, zwraca wartość wskazującą, czy to wystąpienie jest zgodne z określonym obiektem.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()

Tworzy skróconą kopię bieżącego Objectelementu.Creates a shallow copy of the current Object.

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

Zwraca ciąg, który reprezentuje bieżący obiekt.Returns a string that represents the current object.

(Inherited from Object)

Jawne implementacje interfejsu

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

Zestaw nazw jest mapowany na odpowiedni zestaw identyfikatorów wysyłania.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)

Pobiera informacje o typie dla obiektu, którego można użyć do uzyskania informacji o typie dla interfejsu.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)

Pobiera informację o liczbie typów interfejsów, jakie zawiera obiekt (0 lub 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)

Umożliwia dostęp do właściwości i metod udostępnianych przez obiekt.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Dotyczy