DataSet.ExtendedProperties Property

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 the collection of customized user information associated with the DataSet.

public:
 property System::Data::PropertyCollection ^ ExtendedProperties { System::Data::PropertyCollection ^ get(); };

[System.ComponentModel.Browsable(false)]
public System.Data.PropertyCollection ExtendedProperties { get; }

[System.ComponentModel.Browsable(false)]
[System.Data.DataSysDescription("ExtendedPropertiesDescr")]
public System.Data.PropertyCollection ExtendedProperties { get; }

[<System.ComponentModel.Browsable(false)>]
member this.ExtendedProperties : System.Data.PropertyCollection

[<System.ComponentModel.Browsable(false)>]
[<System.Data.DataSysDescription("ExtendedPropertiesDescr")>]
member this.ExtendedProperties : System.Data.PropertyCollection

Public ReadOnly Property ExtendedProperties As PropertyCollection

Property Value

PropertyCollection

A PropertyCollection with all custom user information.

Attributes: BrowsableAttribute DataSysDescriptionAttribute

Examples

The following example adds a custom property to the PropertyCollection returned by the ExtendedProperties property. The second example retrieves the custom property.

private void SetProperty(DataColumn column)
{
    column.ExtendedProperties.Add("TimeStamp", DateTime.Now);
}

private void GetProperty(DataColumn column)
{
    Console.WriteLine(column.ExtendedProperties["TimeStamp"].ToString());
}

 Private Sub SetProperty(column As DataColumn)
     column.ExtendedProperties.Add("TimeStamp", DateTime.Now)
 End Sub    
    
 Private Sub GetProperty(column As DataColumn)
     Console.WriteLine(column.ExtendedProperties("TimeStamp").ToString())
End Sub

Remarks

The ExtendedProperties property enables you to store custom information with the DataSet. For example, you might store a time when the data should be refreshed.

Extended properties must be of type String if you want them persisted when the DataSet is written as XML.

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