ConditionalAttribute Класс

Определение

Указывает компиляторам, что вызов метода или атрибут следует игнорировать, если не определен заданный символ условной компиляции.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
Наследование
ConditionalAttribute
Атрибуты

Примеры

В следующем примере показано использование функции ConditionalAttribute.The following example demonstrates the use of ConditionalAttribute. В примере предполагается, что условие определяется с помощью параметра компилятора /define .The example assumes that the condition is defined with the /define compiler option. Можно получить различные результаты, изменив параметр компилятора.You can obtain different results by changing the compiler option. При необходимости можно определить условия с помощью прагма в образце кода вместо того, чтобы определять их как параметры компилятора.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

Комментарии

ConditionalAttribute Атрибут можно применить к методам и классам.You can apply the ConditionalAttribute attribute to methods and classes. Однако его использование в классах допустимо только для типов, производных от Attribute.However, its use on classes is valid only for types that are derived from Attribute. ConditionalAttributeлибо будет пропущен, либо будет выдавать предупреждение компилятора или сообщение об ошибке, если оно применяется к любому другому типу.ConditionalAttribute either will be ignored or will produce a compiler warning or error message if you apply it to any other type.

Применение ConditionalAttribute к методу указывает компиляторам, что вызов метода не должен компилироваться в промежуточный язык MSIL, если не определен символ условной компиляции, связанный с ConditionalAttribute .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. При применении этого атрибута к методу, который не возвращает значение void, вы получите ошибку компиляции в Visual Studio.You will get a compilation error in Visual Studio if you apply this attribute to a method that does not return void. Применение ConditionalAttribute к атрибуту указывает, что атрибут не должен передаваться в метаданные, если не определен символ условной компиляции.Applying ConditionalAttribute to an attribute indicates that the attribute should not be emitted to metadata unless the conditional compilation symbol is defined. Компилятор проверяет тип всех аргументов, передаваемых в метод или атрибут.Any arguments passed to the method or attribute are still type-checked by the compiler.

Для определения символов условной компиляции можно использовать следующие методы:You can use the following techniques to define conditional compilation symbols:

  • Использование параметров командной строки компилятора; Например, /define: Debug.Use compiler command-line options; for example, /define:DEBUG.

  • Использование переменных среды в оболочке операционной системы; Например, Задайте значение Debug = 1.Use environment variables in the operating system shell; for example, set DEBUG=1.

  • Используйте прагмы в исходном коде. Например, определите переменную компиляции следующим образом:Use pragmas in the source code; for example, define the compilation variable as follows:

    #define DEBUG  
    
    #Const DEBUG=True  
    

    Чтобы отменить определение переменной, используйте следующую команду:To undefine the variable, use the following:

    #undef DEBUG  
    
    #Const DEBUG=False  
    

Компиляторы, которые соответствуют спецификации CLS, могут пропускать игнорирование ConditionalAttribute.Compilers that comply with the Common Language Specification (CLS) are permitted to ignore ConditionalAttribute. Поддерживаются C# ConditionalAttributeкомпиляторы, C++ Visual Basic и. компилятор JScript не поддерживает этот атрибут.The C#, Visual Basic, and C++ compilers support ConditionalAttribute; the JScript compiler does not support the attribute.

Примечание

В Visual Basic AddressOf оператор не влияет на этот атрибут.In Visual Basic, the AddressOf operator is not affected by this attribute. Например, Call CType(AddressOf delegate, Action) всегда delegateвызывает метод, хотя Call delegate() может и не.For example, Call CType(AddressOf delegate, Action) always invokes delegate, although Call delegate() might not.

ConditionalAttributeприменяется к методам, определенным в Debug классах и. TraceConditionalAttribute is applied to the methods that are defined in the Debug and Trace classes.

Дополнительные сведения об использовании атрибутов см. в разделе атрибуты.For more information about how to use attributes, see Attributes.

Конструкторы

ConditionalAttribute(String)

Инициализирует новый экземпляр класса ConditionalAttribute.Initializes a new instance of the ConditionalAttribute class.

Свойства

ConditionString

Возвращает символ условной компиляции, связанный с атрибутом ConditionalAttribute.Gets the conditional compilation symbol that is associated with the ConditionalAttribute attribute.

TypeId

При реализации в производном классе возвращает уникальный идентификатор для этого Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Унаследовано от Attribute)

Методы

Equals(Object)

Возвращает значение, показывающее, равен ли экземпляр указанному объекту.Returns a value that indicates whether this instance is equal to a specified object.

(Унаследовано от Attribute)
GetHashCode()

Возвращает хэш-код данного экземпляра.Returns the hash code for this instance.

(Унаследовано от Attribute)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
IsDefaultAttribute()

При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Унаследовано от Attribute)
Match(Object)

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Унаследовано от Attribute)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

Явные реализации интерфейса

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

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.Maps a set of names to a corresponding set of dispatch identifiers.

(Унаследовано от Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Возвращает сведения о типе объекта, которые можно использовать для получения сведений о типе интерфейса.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Унаследовано от Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Унаследовано от Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Предоставляет доступ к открытым свойствам и методам объекта.Provides access to properties and methods exposed by an object.

(Унаследовано от Attribute)

Применяется к