DataSet.ShouldSerializeTables Method

Reference

Definition

Namespace:: System.Data

Assemblies:: netstandard.dll, System.Data.Common.dll

Assembly:: System.Data.Common.dll

Assembly:: System.Data.dll

Assembly:: netstandard.dll

Source:: DataSet.cs

Source:: DataSet.cs

Source:: DataSet.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets a value indicating whether Tables property should be persisted.

protected:
 virtual bool ShouldSerializeTables();

protected virtual bool ShouldSerializeTables();

abstract member ShouldSerializeTables : unit -> bool
override this.ShouldSerializeTables : unit -> bool

Protected Overridable Function ShouldSerializeTables () As Boolean

Returns

Boolean

true if the property value has been changed from its default; otherwise, false.

Examples

The following example shows a class derived from the DataSet class. The ShouldSerializeTables method is called from within functions in the derived class.

public  class DerivedDataSet:System.Data.DataSet
{
    public void ResetDataSetRelations()
    {
        // Check the ShouldPersistTable method
        // before invoking Reset.
        if(!this.ShouldSerializeTables())
        {
            this.Reset();
        }
    }
}

Public Class DerivedDataSet
    Inherits System.Data.DataSet
    
    Public Sub ResetDataSetRelations()
        ' Check the ShouldPersistTable method 
        ' before invoking Reset.
        If Not Me.ShouldSerializeTables() Then
            Me.Reset()
        End If
    End Sub
End Class

Remarks

You typically use this method only if you are either creating a designer for the DataSet, or creating your own control incorporating the DataSet.

Applies to

Product	Versions
.NET	Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0, 2.1

Share via