DataGridViewHeaderCell Class
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.
Contains functionality common to row header cells and column header cells.
public ref class DataGridViewHeaderCell : System::Windows::Forms::DataGridViewCellpublic class DataGridViewHeaderCell : System.Windows.Forms.DataGridViewCelltype DataGridViewHeaderCell = class
inherit DataGridViewCellPublic Class DataGridViewHeaderCell
Inherits DataGridViewCell- Inheritance
- Derived
Remarks
This class is a base class for other header cell classes, such as DataGridViewRowHeaderCell and DataGridViewColumnHeaderCell. To create custom row header icons or column header glyphs, inherit from the DataGridViewHeaderCell class and add functionality to paint your own icon or glyph.
Notes to Inheritors
When you derive from DataGridViewHeaderCell and add new properties to the derived class, be sure to override the Clone() method to copy the new properties during cloning operations. You should also call the base class's Clone() method so that the properties of the base class are copied to the new cell.
Constructors
| DataGridViewHeaderCell() |
Initializes a new instance of the DataGridViewHeaderCell class. |
Properties
| AccessibilityObject |
Gets the DataGridViewCell.DataGridViewCellAccessibleObject assigned to the DataGridViewCell. (Inherited from DataGridViewCell) |
| ButtonState |
Gets the buttonlike visual state of the header cell. |
| ColumnIndex |
Gets the column index for this cell. (Inherited from DataGridViewCell) |
| ContentBounds |
Gets the bounding rectangle that encloses the cell's content area. (Inherited from DataGridViewCell) |
| ContextMenuStrip |
Gets or sets the shortcut menu associated with the cell. (Inherited from DataGridViewCell) |
| DataGridView |
Gets the DataGridView control associated with this element. (Inherited from DataGridViewElement) |
| DefaultNewRowValue |
Gets the default value for a cell in the row for new records. (Inherited from DataGridViewCell) |
| Displayed |
Gets a value that indicates whether the cell is currently displayed on-screen. |
| EditedFormattedValue |
Gets the current, formatted value of the cell, regardless of whether the cell is in edit mode and the value has not been committed. (Inherited from DataGridViewCell) |
| EditType |
Gets the type of the cell's hosted editing control. (Inherited from DataGridViewCell) |
| ErrorIconBounds |
Gets the bounds of the error icon for the cell. (Inherited from DataGridViewCell) |
| ErrorText |
Gets or sets the text describing an error condition associated with the cell. (Inherited from DataGridViewCell) |
| FormattedValue |
Gets the value of the cell as formatted for display. (Inherited from DataGridViewCell) |
| FormattedValueType |
Gets the type of the formatted value of the cell. |
| Frozen |
Gets a value indicating whether the cell is frozen. |
| HasStyle |
Gets a value indicating whether the Style property has been set. (Inherited from DataGridViewCell) |
| InheritedState |
Gets the current state of the cell as inherited from the state of its row and column. (Inherited from DataGridViewCell) |
| InheritedStyle |
Gets the style currently applied to the cell. (Inherited from DataGridViewCell) |
| IsInEditMode |
Gets a value indicating whether this cell is currently being edited. (Inherited from DataGridViewCell) |
| OwningColumn |
Gets the column that contains this cell. (Inherited from DataGridViewCell) |
| OwningRow |
Gets the row that contains this cell. (Inherited from DataGridViewCell) |
| PreferredSize |
Gets the size, in pixels, of a rectangular area into which the cell can fit. (Inherited from DataGridViewCell) |
| ReadOnly |
Gets a value indicating whether the header cell is read-only. |
| Resizable |
Gets a value indicating whether the cell is resizable. |
| RowIndex |
Gets the index of the cell's parent row. (Inherited from DataGridViewCell) |
| Selected |
Gets or sets a value indicating whether the cell is selected. |
| Size |
Gets the size of the cell. (Inherited from DataGridViewCell) |
| State |
Gets the user interface (UI) state of the element. (Inherited from DataGridViewElement) |
| Style |
Gets or sets the style for the cell. (Inherited from DataGridViewCell) |
| Tag |
Gets or sets the object that contains supplemental data about the cell. (Inherited from DataGridViewCell) |
| ToolTipText |
Gets or sets the ToolTip text associated with this cell. (Inherited from DataGridViewCell) |
| Value |
Gets or sets the value associated with this cell. (Inherited from DataGridViewCell) |
| ValueType |
Gets the type of the value stored in the cell. |
| Visible |
Gets a value indicating whether or not the cell is visible. |
Methods
| AdjustCellBorderStyle(DataGridViewAdvancedBorderStyle, DataGridViewAdvancedBorderStyle, Boolean, Boolean, Boolean, Boolean) |
Modifies the input cell border style according to the specified criteria. (Inherited from DataGridViewCell) |
| BorderWidths(DataGridViewAdvancedBorderStyle) |
Returns a Rectangle that represents the widths of all the cell margins. (Inherited from DataGridViewCell) |
| ClickUnsharesRow(DataGridViewCellEventArgs) |
Indicates whether the cell's row will be unshared when the cell is clicked. (Inherited from DataGridViewCell) |
| Clone() |
Creates an exact copy of this cell. |
| ContentClickUnsharesRow(DataGridViewCellEventArgs) |
Indicates whether the cell's row will be unshared when the cell's content is clicked. (Inherited from DataGridViewCell) |
| ContentDoubleClickUnsharesRow(DataGridViewCellEventArgs) |
Indicates whether the cell's row will be unshared when the cell's content is double-clicked. (Inherited from DataGridViewCell) |
| CreateAccessibilityInstance() |
Creates a new accessible object for the DataGridViewCell. (Inherited from DataGridViewCell) |
| DetachEditingControl() |
Removes the cell's editing control from the DataGridView. (Inherited from DataGridViewCell) |
| Dispose() |
Releases all resources used by the DataGridViewCell. (Inherited from DataGridViewCell) |
| Dispose(Boolean) |
Releases the unmanaged resources used by the DataGridViewHeaderCell and optionally releases the managed resources. |
| DoubleClickUnsharesRow(DataGridViewCellEventArgs) |
Indicates whether the cell's row will be unshared when the cell is double-clicked. (Inherited from DataGridViewCell) |
| EnterUnsharesRow(Int32, Boolean) |
Indicates whether the parent row will be unshared when the focus moves to the cell. (Inherited from DataGridViewCell) |
| Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetClipboardContent(Int32, Boolean, Boolean, Boolean, Boolean, String) |
Retrieves the formatted value of the cell to copy to the Clipboard. (Inherited from DataGridViewCell) |
| GetContentBounds(Graphics, DataGridViewCellStyle, Int32) |
Returns the bounding rectangle that encloses the cell's content area, which is calculated using the specified Graphics and cell style. (Inherited from DataGridViewCell) |
| GetContentBounds(Int32) |
Returns the bounding rectangle that encloses the cell's content area using a default Graphics and cell style currently in effect for the cell. (Inherited from DataGridViewCell) |
| GetEditedFormattedValue(Int32, DataGridViewDataErrorContexts) |
Returns the current, formatted value of the cell, regardless of whether the cell is in edit mode and the value has not been committed. (Inherited from DataGridViewCell) |
| GetErrorIconBounds(Graphics, DataGridViewCellStyle, Int32) |
Returns the bounding rectangle that encloses the cell's error icon, if one is displayed. (Inherited from DataGridViewCell) |
| GetErrorText(Int32) |
Returns a string that represents the error for the cell. (Inherited from DataGridViewCell) |
| GetFormattedValue(Object, Int32, DataGridViewCellStyle, TypeConverter, TypeConverter, DataGridViewDataErrorContexts) |
Gets the value of the cell as formatted for display. (Inherited from DataGridViewCell) |
| GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
| GetInheritedContextMenuStrip(Int32) |
Gets the shortcut menu of the header cell. |
| GetInheritedState(Int32) |
Returns a value indicating the current state of the cell as inherited from the state of its row or column. |
| GetInheritedStyle(DataGridViewCellStyle, Int32, Boolean) |
Gets the style applied to the cell. (Inherited from DataGridViewCell) |
| GetPreferredSize(Graphics, DataGridViewCellStyle, Int32, Size) |
Calculates the preferred size, in pixels, of the cell. (Inherited from DataGridViewCell) |
| GetSize(Int32) |
Gets the size of the cell. |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| GetValue(Int32) |
Gets the value of the cell. |
| InitializeEditingControl(Int32, Object, DataGridViewCellStyle) |
Initializes the control used to edit the cell. (Inherited from DataGridViewCell) |
| KeyDownUnsharesRow(KeyEventArgs, Int32) |
Indicates whether the parent row is unshared if the user presses a key while the focus is on the cell. (Inherited from DataGridViewCell) |
| KeyEntersEditMode(KeyEventArgs) |
Determines if edit mode should be started based on the given key. (Inherited from DataGridViewCell) |
| KeyPressUnsharesRow(KeyPressEventArgs, Int32) |
Indicates whether a row will be unshared if a key is pressed while a cell in the row has focus. (Inherited from DataGridViewCell) |
| KeyUpUnsharesRow(KeyEventArgs, Int32) |
Indicates whether the parent row is unshared when the user releases a key while the focus is on the cell. (Inherited from DataGridViewCell) |
| LeaveUnsharesRow(Int32, Boolean) |
Indicates whether a row will be unshared when the focus leaves a cell in the row. (Inherited from DataGridViewCell) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| MouseClickUnsharesRow(DataGridViewCellMouseEventArgs) |
Indicates whether a row will be unshared if the user clicks a mouse button while the pointer is on a cell in the row. (Inherited from DataGridViewCell) |
| MouseDoubleClickUnsharesRow(DataGridViewCellMouseEventArgs) |
Indicates whether a row will be unshared if the user double-clicks a cell in the row. (Inherited from DataGridViewCell) |
| MouseDownUnsharesRow(DataGridViewCellMouseEventArgs) |
Indicates whether a row will be unshared when the mouse button is held down while the pointer is on a cell in the row. |
| MouseEnterUnsharesRow(Int32) |
Indicates whether a row will be unshared when the mouse pointer moves over a cell in the row. |
| MouseLeaveUnsharesRow(Int32) |
Indicates whether a row will be unshared when the mouse pointer leaves the row. |
| MouseMoveUnsharesRow(DataGridViewCellMouseEventArgs) |
Indicates whether a row will be unshared when the mouse pointer moves over a cell in the row. (Inherited from DataGridViewCell) |
| MouseUpUnsharesRow(DataGridViewCellMouseEventArgs) |
Indicates whether a row will be unshared when the mouse button is released while the pointer is on a cell in the row. |
| OnClick(DataGridViewCellEventArgs) |
Called when the cell is clicked. (Inherited from DataGridViewCell) |
| OnContentClick(DataGridViewCellEventArgs) |
Called when the cell's contents are clicked. (Inherited from DataGridViewCell) |
| OnContentDoubleClick(DataGridViewCellEventArgs) |
Called when the cell's contents are double-clicked. (Inherited from DataGridViewCell) |
| OnDataGridViewChanged() |
Called when the DataGridView property of the cell changes. (Inherited from DataGridViewCell) |
| OnDoubleClick(DataGridViewCellEventArgs) |
Called when the cell is double-clicked. (Inherited from DataGridViewCell) |
| OnEnter(Int32, Boolean) |
Called when the focus moves to a cell. (Inherited from DataGridViewCell) |
| OnKeyDown(KeyEventArgs, Int32) |
Called when a character key is pressed while the focus is on a cell. (Inherited from DataGridViewCell) |
| OnKeyPress(KeyPressEventArgs, Int32) |
Called when a key is pressed while the focus is on a cell. (Inherited from DataGridViewCell) |
| OnKeyUp(KeyEventArgs, Int32) |
Called when a character key is released while the focus is on a cell. (Inherited from DataGridViewCell) |
| OnLeave(Int32, Boolean) |
Called when the focus moves from a cell. (Inherited from DataGridViewCell) |
| OnMouseClick(DataGridViewCellMouseEventArgs) |
Called when the user clicks a mouse button while the pointer is on a cell. (Inherited from DataGridViewCell) |
| OnMouseDoubleClick(DataGridViewCellMouseEventArgs) |
Called when the user double-clicks a mouse button while the pointer is on a cell. (Inherited from DataGridViewCell) |
| OnMouseDown(DataGridViewCellMouseEventArgs) |
Called when the mouse button is held down while the pointer is on a cell. |
| OnMouseEnter(Int32) |
Called when the mouse pointer enters the cell. |
| OnMouseLeave(Int32) |
Called when the mouse pointer leaves the cell. |
| OnMouseMove(DataGridViewCellMouseEventArgs) |
Called when the mouse pointer moves within a cell. (Inherited from DataGridViewCell) |
| OnMouseUp(DataGridViewCellMouseEventArgs) |
Called when the mouse button is released while the pointer is over the cell. |
| Paint(Graphics, Rectangle, Rectangle, Int32, DataGridViewElementStates, Object, Object, String, DataGridViewCellStyle, DataGridViewAdvancedBorderStyle, DataGridViewPaintParts) |
Paints the current DataGridViewHeaderCell. |
| PaintBorder(Graphics, Rectangle, Rectangle, DataGridViewCellStyle, DataGridViewAdvancedBorderStyle) |
Paints the border of the current DataGridViewCell. (Inherited from DataGridViewCell) |
| PaintErrorIcon(Graphics, Rectangle, Rectangle, String) |
Paints the error icon of the current DataGridViewCell. (Inherited from DataGridViewCell) |
| ParseFormattedValue(Object, DataGridViewCellStyle, TypeConverter, TypeConverter) |
Converts a value formatted for display to an actual cell value. (Inherited from DataGridViewCell) |
| PositionEditingControl(Boolean, Boolean, Rectangle, Rectangle, DataGridViewCellStyle, Boolean, Boolean, Boolean, Boolean) |
Sets the location and size of the editing control hosted by a cell in the DataGridView control. (Inherited from DataGridViewCell) |
| PositionEditingPanel(Rectangle, Rectangle, DataGridViewCellStyle, Boolean, Boolean, Boolean, Boolean) |
Sets the location and size of the editing panel hosted by the cell, and returns the normal bounds of the editing control within the editing panel. (Inherited from DataGridViewCell) |
| RaiseCellClick(DataGridViewCellEventArgs) |
Raises the CellClick event. (Inherited from DataGridViewElement) |
| RaiseCellContentClick(DataGridViewCellEventArgs) |
Raises the CellContentClick event. (Inherited from DataGridViewElement) |
| RaiseCellContentDoubleClick(DataGridViewCellEventArgs) |
Raises the CellContentDoubleClick event. (Inherited from DataGridViewElement) |
| RaiseCellValueChanged(DataGridViewCellEventArgs) |
Raises the CellValueChanged event. (Inherited from DataGridViewElement) |
| RaiseDataError(DataGridViewDataErrorEventArgs) |
Raises the DataError event. (Inherited from DataGridViewElement) |
| RaiseMouseWheel(MouseEventArgs) |
Raises the MouseWheel event. (Inherited from DataGridViewElement) |
| SetValue(Int32, Object) |
Sets the value of the cell. (Inherited from DataGridViewCell) |
| ToString() |
Returns a string that describes the current object. |
