Поделиться через


OptionalAttribute Класс

Определение

Указывает, что параметр является необязательным.

public ref class OptionalAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Parameter, Inherited=false)]
public sealed class OptionalAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Parameter, Inherited=false)]
[System.Runtime.InteropServices.ComVisible(true)]
public sealed class OptionalAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.Parameter, Inherited=false)>]
type OptionalAttribute = class
    inherit Attribute
[<System.AttributeUsage(System.AttributeTargets.Parameter, Inherited=false)>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type OptionalAttribute = class
    inherit Attribute
Public NotInheritable Class OptionalAttribute
Inherits Attribute
Наследование
OptionalAttribute
Атрибуты

Примеры

В следующем примере кода показано, как применить OptionalAttribute атрибут к параметру метода, написанного на C#.

using System;
using System.Runtime.InteropServices;

public class Program
{
    public static void MethodWithOptionalAttribute([Optional] string str)
    {
        Console.WriteLine($"str is null: {str == null}");
    }

    public static void Main()
    {
        MethodWithOptionalAttribute(); // str is null: True
        MethodWithOptionalAttribute("abc"); // str is null: False
    }
}

Комментарии

Этот атрибут можно применить к параметрам.

Необязательные параметры поддерживаются не всеми языками.

OptionalAttribute иногда используется в сочетании с DefaultParameterValueAttribute.

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

OptionalAttribute()

Инициализирует новый экземпляр класса OptionalAttribute со значениями по умолчанию.

Свойства

TypeId

В случае реализации в производном классе возвращает уникальный идентификатор для этого атрибута Attribute.

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

Методы

Equals(Object)

Возвращает значение, показывающее, равен ли экземпляр указанному объекту.

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

Возвращает хэш-код данного экземпляра.

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

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

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

При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса.

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

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.

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

Создает неполную копию текущего объекта Object.

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

Возвращает строку, представляющую текущий объект.

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

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

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

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.

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

Возвращает сведения о типе объекта, которые можно использовать для получения сведений о типе интерфейса.

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

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1).

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

Предоставляет доступ к открытым свойствам и методам объекта.

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

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