Export (0) Print
Expand All
Expand Minimize

DataGridView.RowTemplate Property

Note: This property is new in the .NET Framework version 2.0.

Gets or sets the row that represents the template for all the rows in the control.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

public DataGridViewRow RowTemplate { get; set; }
/** @property */
public DataGridViewRow get_RowTemplate ()

/** @property */
public void set_RowTemplate (DataGridViewRow value)

public function get RowTemplate () : DataGridViewRow

public function set RowTemplate (value : DataGridViewRow)

Property Value

A DataGridViewRow representing the row template.

Exception typeCondition

InvalidOperationException

The specified row when setting this property has its DataGridView property set.

Sometimes you want greater control over the appearance of DataGridView rows than what is provided by the various DataGridView cell style properties. The RowTemplate property lets you create and initialize a DataGridViewRow for use as a template by all rows, including the row for new records if AllowUserToAddRows is true.

This is useful when you are setting default values for properties such as row height. For example, you may want to increase the default row height in order to provide extra room beneath ordinary cell content for displaying content that spans multiple columns.

Setting the row template is necessary when external data is displayed using custom types derived from the DataGridViewRow class. With unbound DataGridView controls, you can programmatically populate the Rows collection with instances of your custom row type. When displaying external data, however, the rows are generated automatically, but they are based on the row template, which you can set to an instance of your custom row type.

If this property has not been set the first time you retrieve its value, a new DataGridViewRow is created and returned.

The following code example illustrates how to use the row template to specify an initial row height and a minimum row height.

DataGridViewRow row = this.dataGridView1.RowTemplate;
row.DefaultCellStyle.BackColor = Color.Bisque;
row.Height = 35;
row.MinimumHeight = 20;

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft