Edit

Share via

DataSet.ExtendedProperties Property

  • Reference

Definition

Namespace:
System.Data
Assembly:
System.Data.Common.dll
Assembly:
System.Data.dll
Assembly:
netstandard.dll
Source:
DataSet.cs
Source:
DataSet.cs
Source:
DataSet.cs

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

See also