Class KeyAttribute

Namespace

Nerdbank.MessagePack

Assembly

Nerdbank.MessagePack.dll

Specifies an ordinal key that may be used when the object serializes its properties as an array of values instead of a map of property names to values.

[AttributeUsage(AttributeTargets.Property|AttributeTargets.Field, AllowMultiple = false, Inherited = true)]
public class KeyAttribute : Attribute

Inheritance

object

Attribute

KeyAttribute

Inherited Members

Attribute.Equals(object)

Attribute.GetCustomAttribute(Assembly, Type)

Attribute.GetCustomAttribute(Assembly, Type, bool)

Attribute.GetCustomAttribute(MemberInfo, Type)

Attribute.GetCustomAttribute(MemberInfo, Type, bool)

Attribute.GetCustomAttribute(Module, Type)

Attribute.GetCustomAttribute(Module, Type, bool)

Attribute.GetCustomAttribute(ParameterInfo, Type)

Attribute.GetCustomAttribute(ParameterInfo, Type, bool)

Attribute.GetCustomAttributes(Assembly)

Attribute.GetCustomAttributes(Assembly, bool)

Attribute.GetCustomAttributes(Assembly, Type)

Attribute.GetCustomAttributes(Assembly, Type, bool)

Attribute.GetCustomAttributes(MemberInfo)

Attribute.GetCustomAttributes(MemberInfo, bool)

Attribute.GetCustomAttributes(MemberInfo, Type)

Attribute.GetCustomAttributes(MemberInfo, Type, bool)

Attribute.GetCustomAttributes(Module)

Attribute.GetCustomAttributes(Module, bool)

Attribute.GetCustomAttributes(Module, Type)

Attribute.GetCustomAttributes(Module, Type, bool)

Attribute.GetCustomAttributes(ParameterInfo)

Attribute.GetCustomAttributes(ParameterInfo, bool)

Attribute.GetCustomAttributes(ParameterInfo, Type)

Attribute.GetCustomAttributes(ParameterInfo, Type, bool)

Attribute.GetHashCode()

Attribute.IsDefaultAttribute()

Attribute.IsDefined(Assembly, Type)

Attribute.IsDefined(Assembly, Type, bool)

Attribute.IsDefined(MemberInfo, Type)

Attribute.IsDefined(MemberInfo, Type, bool)

Attribute.IsDefined(Module, Type)

Attribute.IsDefined(Module, Type, bool)

Attribute.IsDefined(ParameterInfo, Type)

Attribute.IsDefined(ParameterInfo, Type, bool)

Attribute.Match(object)

Attribute.TypeId

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Once this key is applied to any field or property of a type, it must be applied to all fields and properties of that type that are candidates for serialization. Reassigning a key to a different member of the same type is an unversioned breaking change in the serialization schema and should be avoided when reading or writing across versions is supported. Unassigned indexes in the array will be left as nil during serialization and ignored during deserialization.

Constructors

KeyAttribute(int)

Initializes a new instance of the KeyAttribute class.

public KeyAttribute(int index)

Parameters

index int

The index into the array where the value of the annotated member will be stored.

Properties

Index

Gets the array index where the value of the annotated member will be stored.

public int Index { get; }

Property Value

int