DataSet.SchemaSerializationMode Property

Note: This property is new in the .NET Framework version 2.0.

Gets or sets a SchemaSerializationMode for a DataSet.

Namespace: System.Data
Assembly: System.Data (in

public virtual SchemaSerializationMode SchemaSerializationMode { get; set; 
/** @property */
public SchemaSerializationMode get_SchemaSerializationMode ()

/** @property */
public void set_SchemaSerializationMode (SchemaSerializationMode value)

public function get SchemaSerializationMode () : SchemaSerializationMode

public function set SchemaSerializationMode (value : SchemaSerializationMode)

Property Value

Gets or sets a SchemaSerializationMode for a DataSet.

A DataSet serializes its schema and instance data by default in Web services and remoting scenarios. Setting the SchemaSerializationMode property of a typed DataSet to ExcludeSchema causes schema information to be excluded from the serialization payload.

ExcludeSchema is supported only for a typed DataSet. For an un-typed DataSet this property can only be set to IncludeSchema.

ExcludeSchema should only be used in cases where the schema information of the underlying typed DataTables, DataRelations and Constraints has not been modified. If modifications have occurred, complete schema information should be serialized with IncludeSchema.

ExcludeSchema is supported in version 2.0 of the .NET Framework or later.

When ExcludeSchema is set, only the top level runtime properties present on the DataSet are serialized. In addition, they are serialized only if they happen to be different from the default values. None of the Tables, Relations or Constraints are serialized. The serialized runtime properties include DataSetName, Namespace, Prefix, Locale, EnforceConstraints, and CaseSensitive. These properties are serialized to make sure that overall runtime data integrity is preserved.

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0

.NET Compact Framework

Supported in: 2.0

Community Additions