.NET Framework Class Library
DataSet..::.SchemaSerializationMode Property

Gets or sets a SchemaSerializationMode for a DataSet.

Namespace:  System.Data
Assembly:  System.Data (in System.Data.dll)
Syntax

Visual Basic (Declaration)
<BrowsableAttribute(False)> _
Public Overridable Property SchemaSerializationMode As SchemaSerializationMode
Visual Basic (Usage)
Dim instance As DataSet
Dim value As SchemaSerializationMode

value = instance.SchemaSerializationMode

instance.SchemaSerializationMode = value
C#
[BrowsableAttribute(false)]
public virtual SchemaSerializationMode SchemaSerializationMode { get; set; }
Visual C++
[BrowsableAttribute(false)]
public:
virtual property SchemaSerializationMode SchemaSerializationMode {
    SchemaSerializationMode get ();
    void set (SchemaSerializationMode value);
}
JScript
public function get SchemaSerializationMode () : SchemaSerializationMode
public function set SchemaSerializationMode (value : SchemaSerializationMode)
Remarks

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.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
See Also

Reference

Other Resources

Tags :


Page view tracker