DataMemberAttribute.IsRequired Property (System.Runtime.Serialization)

IsRequired Property

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

DataMemberAttribute..::.IsRequired Property

Gets or sets a value that instructs the serialization engine that the member must be present when reading or deserializing.

Namespace: System.Runtime.Serialization
Assembly: System.Runtime.Serialization (in System.Runtime.Serialization.dll)

Syntax

Visual Basic (Declaration)

Public Property IsRequired As Boolean

Visual Basic (Usage)

Dim instance As DataMemberAttribute
Dim value As Boolean

value = instance.IsRequired

instance.IsRequired = value

public bool IsRequired { get; set; }

Visual C++

public:
property bool IsRequired {
    bool get ();
    void set (bool value);
}

JScript

public function get IsRequired () : boolean
public function set IsRequired (value : boolean)

Property Value

Type: System..::.Boolean
true, if the member is required; otherwise, false.

Exceptions

Exception	Condition
SerializationException	the member is not present.

Remarks

The property is used for ensuring compatibility with future versions of a type. For more information, see Data Contract Versioning and Best Practices: Data Contract Versioning.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0

Reference

DataMemberAttribute Class

DataMemberAttribute Members

System.Runtime.Serialization Namespace

Other Resources

Data Contract Versioning

Best Practices: Data Contract Versioning