Export (0) Print
Expand All

DataGridTextBoxColumn Constructor (PropertyDescriptor, String)

Initializes a new instance of a DataGridTextBoxColumn with the specified PropertyDescriptor and format.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public DataGridTextBoxColumn(
	PropertyDescriptor prop,
	string format
)

Parameters

prop
Type: System.ComponentModel.PropertyDescriptor

The PropertyDescriptor for the column with which the DataGridTextBoxColumn will be associated.

format
Type: System.String

The format used to format the column values.

Use this constructor to create a custom format for the displayed data.

The DataGridColumnStyle uses a PropertyDescriptor to determine the type of data displayed in the column. To return a PropertyDescriptorCollection, use the GetItemProperties method of the BindingManagerBase class.

For more information about formatting characters, see Formatting Types in the .NET Framework and Custom Date and Time Format Strings.

The following code example demonstrates the use of this member.


   private void MyAddCustomDataTableStyle()
   {
      // Get the currency manager for 'myDataSet'.
      CurrencyManager myCurrencyManger =
               (CurrencyManager)this.BindingContext[myDataSet];

      DataGridTableStyle myTableStyle = new DataGridTableStyle();
      myTableStyle.MappingName = "Customers";

      PropertyDescriptor proprtyDescriptorName =
               myCurrencyManger.GetItemProperties()["CustName"];

      DataGridColumnStyle myCustomerNameStyle =
               new DataGridTextBoxColumn(proprtyDescriptorName);

      myCustomerNameStyle.MappingName = "custName";
      myCustomerNameStyle.HeaderText = "Customer Name";
      myTableStyle.GridColumnStyles.Add(myCustomerNameStyle);

      // Add style for 'Date' column.
      PropertyDescriptor myDateDescriptor =
               myCurrencyManger.GetItemProperties()["Date"];
      // 'G' is for MM/dd/yyyy HH:mm:ss date format.
      DataGridColumnStyle myDateStyle =
               new DataGridTextBoxColumn(myDateDescriptor,"G");

      myDateStyle.MappingName = "Date";
      myDateStyle.HeaderText = "Date";
      myDateStyle.Width = 150;
      myTableStyle.GridColumnStyles.Add(myDateStyle);

      // Add DataGridTableStyle instances to GridTableStylesCollection.
      myDataGrid.TableStyles.Add(myTableStyle);
   }

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft