Export (0) Print
Expand All

DataGridViewLinkColumn Class

Represents a column of cells that contain links in a DataGridView control.

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

[ToolboxBitmapAttribute(typeof(DataGridViewLinkColumn), "DataGridViewLinkColumn.bmp")]
public class DataGridViewLinkColumn : DataGridViewColumn

The DataGridViewLinkColumn type exposes the following members.

  NameDescription
Public methodDataGridViewLinkColumnInitializes a new instance of the DataGridViewLinkColumn class.
Top

  NameDescription
Public propertyActiveLinkColorGets or sets the color used to display an active link within cells in the column.
Public propertyAutoSizeModeGets or sets the mode by which the column automatically adjusts its width. (Inherited from DataGridViewColumn.)
Public propertyCellTemplateGets or sets the template used to create new cells. (Overrides DataGridViewColumn.CellTemplate.)
Public propertyCellTypeGets the run-time type of the cell template. (Inherited from DataGridViewColumn.)
Public propertyContextMenuStripGets or sets the shortcut menu for the column. (Inherited from DataGridViewColumn.)
Public propertyDataGridViewGets the DataGridView control associated with this element. (Inherited from DataGridViewElement.)
Public propertyDataPropertyNameGets or sets the name of the data source property or database column to which the DataGridViewColumn is bound. (Inherited from DataGridViewColumn.)
Public propertyDefaultCellStyleGets or sets the column's default cell style. (Inherited from DataGridViewColumn.)
Public propertyDefaultHeaderCellTypeGets or sets the run-time type of the default header cell. (Inherited from DataGridViewBand.)
Public propertyDisplayedGets a value indicating whether the band is currently displayed onscreen. (Inherited from DataGridViewBand.)
Public propertyDisplayIndexGets or sets the display order of the column relative to the currently displayed columns. (Inherited from DataGridViewColumn.)
Public propertyDividerWidthGets or sets the width, in pixels, of the column divider. (Inherited from DataGridViewColumn.)
Public propertyFillWeightGets or sets a value that represents the width of the column when it is in fill mode relative to the widths of other fill-mode columns in the control. (Inherited from DataGridViewColumn.)
Public propertyFrozenGets or sets a value indicating whether a column will move when a user scrolls the DataGridView control horizontally. (Inherited from DataGridViewColumn.)
Public propertyHasDefaultCellStyleGets a value indicating whether the DefaultCellStyle property has been set. (Inherited from DataGridViewBand.)
Public propertyHeaderCellGets or sets the DataGridViewColumnHeaderCell that represents the column header. (Inherited from DataGridViewColumn.)
Protected propertyHeaderCellCoreGets or sets the header cell of the DataGridViewBand. (Inherited from DataGridViewBand.)
Public propertyHeaderTextGets or sets the caption text on the column's header cell. (Inherited from DataGridViewColumn.)
Public propertyIndexGets the relative position of the band within the DataGridView control. (Inherited from DataGridViewBand.)
Public propertyInheritedAutoSizeModeGets the sizing mode in effect for the column. (Inherited from DataGridViewColumn.)
Public propertyInheritedStyleGets the cell style currently applied to the column. (Inherited from DataGridViewColumn.)
Public propertyIsDataBoundGets a value indicating whether the column is bound to a data source. (Inherited from DataGridViewColumn.)
Protected propertyIsRowGets a value indicating whether the band represents a row. (Inherited from DataGridViewBand.)
Public propertyLinkBehaviorGets or sets a value that represents the behavior of links within cells in the column.
Public propertyLinkColorGets or sets the color used to display an unselected link within cells in the column.
Public propertyMinimumWidthGets or sets the minimum width, in pixels, of the column. (Inherited from DataGridViewColumn.)
Public propertyNameGets or sets the name of the column. (Inherited from DataGridViewColumn.)
Public propertyReadOnlyGets or sets a value indicating whether the user can edit the column's cells. (Inherited from DataGridViewColumn.)
Public propertyResizableGets or sets a value indicating whether the column is resizable. (Inherited from DataGridViewColumn.)
Public propertySelectedGets or sets a value indicating whether the band is in a selected user interface (UI) state. (Inherited from DataGridViewBand.)
Public propertySiteInfrastructure. Gets or sets the site of the column. (Inherited from DataGridViewColumn.)
Public propertySortModeGets or sets the sort mode for the column. (Inherited from DataGridViewColumn.)
Public propertyStateGets the user interface (UI) state of the element. (Inherited from DataGridViewElement.)
Public propertyTagGets or sets the object that contains data to associate with the band. (Inherited from DataGridViewBand.)
Public propertyTextGets or sets the link text displayed in a column's cells if UseColumnTextForLinkValue is true.
Public propertyToolTipTextGets or sets the text used for ToolTips. (Inherited from DataGridViewColumn.)
Public propertyTrackVisitedStateGets or sets a value indicating whether the link changes color if it has been visited.
Public propertyUseColumnTextForLinkValueGets or sets a value indicating whether the Text property value is displayed as the link text.
Public propertyValueTypeGets or sets the data type of the values in the column's cells. (Inherited from DataGridViewColumn.)
Public propertyVisibleGets or sets a value indicating whether the column is visible. (Inherited from DataGridViewColumn.)
Public propertyVisitedLinkColorGets or sets the color used to display a link that has been previously visited.
Public propertyWidthGets or sets the current width of the column. (Inherited from DataGridViewColumn.)
Top

  NameDescription
Public methodCloneCreates an exact copy of this column. (Overrides DataGridViewColumn.Clone().)
Public methodDispose()Releases all resources used by the DataGridViewBand. (Inherited from DataGridViewBand.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the DataGridViewBand and optionally releases the managed resources. (Inherited from DataGridViewColumn.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeReleases the resources associated with the band. (Inherited from DataGridViewBand.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetPreferredWidthCalculates the ideal width of the column based on the specified criteria. (Inherited from DataGridViewColumn.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnDataGridViewChangedCalled when the band is associated with a different DataGridView. (Inherited from DataGridViewBand.)
Protected methodRaiseCellClickRaises the DataGridView.CellClick event. (Inherited from DataGridViewElement.)
Protected methodRaiseCellContentClickRaises the DataGridView.CellContentClick event. (Inherited from DataGridViewElement.)
Protected methodRaiseCellContentDoubleClickRaises the DataGridView.CellContentDoubleClick event. (Inherited from DataGridViewElement.)
Protected methodRaiseCellValueChangedRaises the DataGridView.CellValueChanged event. (Inherited from DataGridViewElement.)
Protected methodRaiseDataErrorRaises the DataGridView.DataError event. (Inherited from DataGridViewElement.)
Protected methodRaiseMouseWheelRaises the Control.MouseWheel event. (Inherited from DataGridViewElement.)
Public methodToStringGets a string that describes the column. (Overrides DataGridViewColumn.ToString().)
Top

  NameDescription
Public eventDisposedOccurs when the DataGridViewColumn is disposed. (Inherited from DataGridViewColumn.)
Top

The DataGridViewLinkColumn class is a specialized type of the DataGridViewColumn class used to logically host cells that respond to user clicks. The DataGridViewLinkColumn class is similar to the DataGridViewButtonColumn class but provides a different user experience that may be more appropriate in certain situations, such as displaying a URL stored in a database table.

To display the same link text for every cell, set the UseColumnTextForLinkValue property to true and set the Text property to the desired link text.

A DataGridViewLinkColumn has an associated DataGridViewLinkCell in every DataGridViewRow that intersects it.

The default sort mode for this column type is NotSortable.

To respond to user link clicks, handle the DataGridView.CellContentClick event. You can also use the DataGridView.CellClick event to respond to clicks anywhere in the cell.

Notes to Inheritors

When you derive from DataGridViewLinkColumn 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.

The following code example sets properties on a DataGridViewLinkColumn. This example is part of a larger example available in the DataGridViewComboBoxColumn class overview topic.

private void AddLinkColumn()
{
    DataGridViewLinkColumn links = new DataGridViewLinkColumn();

    links.UseColumnTextForLinkValue = true;
    links.HeaderText = ColumnName.ReportsTo.ToString();
    links.DataPropertyName = ColumnName.ReportsTo.ToString();
    links.ActiveLinkColor = Color.White;
    links.LinkBehavior = LinkBehavior.SystemDefault;
    links.LinkColor = Color.Blue;
    links.TrackVisitedState = true;
    links.VisitedLinkColor = Color.YellowGreen;

    DataGridView1.Columns.Add(links);
}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft