DataColumn.ExtendedProperties Property
Definition
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 custom user information associated with a DataColumn.
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
A PropertyCollection of custom information.
- Attributes
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 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.