OptionalFieldAttribute Class

Definition

Namespace:

System.Runtime.Serialization

Assembly:

System.Runtime.dll

Source:

OptionalFieldAttribute.cs

Specifies that a field can be missing from a serialization stream so that the BinaryFormatter and the SoapFormatter does not throw an exception.

public ref class OptionalFieldAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Field, Inherited=false)]
public sealed class OptionalFieldAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Field, Inherited=false)>]
type OptionalFieldAttribute = class
    inherit Attribute

Public NotInheritable Class OptionalFieldAttribute
Inherits Attribute

Inheritance

Object

Attribute

OptionalFieldAttribute

Attributes

AttributeUsageAttribute

Remarks

This attribute allows you to specify that new fields in a serializable type (a type to which the SerializableAttribute is applied to) are ignored by the BinaryFormatter or the SoapFormatter. This enables version-tolerant serialization of types created for older versions of an application that serializes data. For example, when the formatters encounter a stream produced by a version that does not include the new fields, no exception is thrown, and the existing data on the older type is processed as normal.

Constructors

OptionalFieldAttribute()

Initializes a new instance of the OptionalFieldAttribute class.

Properties

TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)
VersionAdded	Gets or sets a version number to indicate when the optional field was added.

Methods

Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	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)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)