System.Data.DataSet.SchemaSerializationMode Property

Gets or sets a System.Data.SchemaSerializationMode for a System.Data.DataSet.

Syntax

[System.ComponentModel.Browsable(false)]
[System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)]
public virtual SchemaSerializationMode SchemaSerializationMode { set; get; }

Value

Documentation for this section has not yet been entered.

Remarks

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

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

SchemaSerializationMode.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 SchemaSerializationMode.IncludeSchema.

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

When SchemaSerializationMode.ExcludeSchema is set, only the top level runtime properties present on the System.Data.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 DataSet.DataSetName, DataSet.Namespace, DataSet.Prefix, DataSet.Locale, DataSet.EnforceConstraints, and DataSet.CaseSensitive. These properties are serialized to make sure that overall runtime data integrity is preserved.

Requirements

Namespace: System.Data
Assembly: System.Data (in System.Data.dll)
Assembly Versions: 2.0.0.0