DataColumn.ExtendedProperties Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the collection of custom user information associated with a DataColumn.

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

[BrowsableAttribute(false)]
public PropertyCollection ExtendedProperties { get; }

Property Value

Type: System.Data.PropertyCollection

A PropertyCollection of custom information.

The ExtendedProperties property lets you store custom information with the object. For example, you may store a time when the data should be refreshed.

Extended properties must be of type String. Properties that are not of type String are not persisted when the DataColumn is written as XML.

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());
}

.NET Framework
Available since 1.1
Return to top
Show: