DataSet.ShouldSerializeRelations Method

Definition

Gets a value indicating whether Relations property should be persisted.

C#
protected virtual bool ShouldSerializeRelations();

Returns

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

Examples

The following examples show a class derived from the DataSet class. The Reset and ShouldSerializeRelations methods are invoked from within functions in the derived class.

C#
public  class DerivedDataSet:System.Data.DataSet
{
    public void ResetDataSetRelations()
    {
        // Check the ShouldSerializeRelations methods
        // before invoking Reset.
        if(!this.ShouldSerializeRelations())
        {
            this.Reset();
        }
    }
}

Remarks

You typically use this method 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

See also