Export (0) Print
Expand All

DataGridHyperlinkColumn Class

Represents a DataGrid column that hosts Uri elements in its cells.

Namespace:  System.Windows.Controls
Assembly:  PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation

public class DataGridHyperlinkColumn : DataGridBoundColumn
<DataGridHyperlinkColumn .../>

The DataGridHyperlinkColumn type exposes the following members.

  NameDescription
Public methodDataGridHyperlinkColumnInitializes a new instance of the DataGridHyperlinkColumn class.
Top

  NameDescription
Public propertyActualWidthGets the current width of the column, in device-independent units (1/96th inch per unit). (Inherited from DataGridColumn.)
Public propertyBindingGets or sets the binding that associates the column with a property in the data source. (Inherited from DataGridBoundColumn.)
Public propertyCanUserReorderGets or sets a value that indicates whether the user can change the column display position by dragging the column header. (Inherited from DataGridColumn.)
Public propertyCanUserResizeGets or sets a value that indicates whether the user can adjust the column width by using the mouse. (Inherited from DataGridColumn.)
Public propertyCanUserSortGets or sets a value that indicates whether the user can sort the column by clicking the column header. (Inherited from DataGridColumn.)
Public propertyCellStyleGets or sets the style that is used to render cells in the column. (Inherited from DataGridColumn.)
Public propertyClipboardContentBindingGets or sets the binding object to use when getting or setting cell content for the clipboard. (Inherited from DataGridBoundColumn.)
Public propertyContentBindingGets or sets the binding to the text of the hyperlink.
Protected propertyDataGridOwnerGets the DataGrid control that contains this column. (Inherited from DataGridColumn.)
Public propertyStatic memberDefaultEditingElementStyleThe default value of the EditingElementStyle property.
Public propertyStatic memberDefaultElementStyleThe default value of the ElementStyle property.
Public propertyDependencyObjectTypeGets the DependencyObjectType that wraps the CLR type of this instance.  (Inherited from DependencyObject.)
Public propertyDispatcherGets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public propertyDisplayIndexGets or sets the display position of the column relative to the other columns in the DataGrid. (Inherited from DataGridColumn.)
Public propertyDragIndicatorStyleGets or sets the style object to apply to the column header during a drag operation. (Inherited from DataGridColumn.)
Public propertyEditingElementStyleGets or sets the style that is used when rendering the element that the column displays for a cell in editing mode. (Inherited from DataGridBoundColumn.)
Public propertyElementStyleGets or sets the style that is used when rendering the element that the column displays for a cell that is not in editing mode. (Inherited from DataGridBoundColumn.)
Public propertyHeaderGets or sets the content of the column header. (Inherited from DataGridColumn.)
Public propertyHeaderStringFormatGets or sets the format pattern to apply to the content of the column header. (Inherited from DataGridColumn.)
Public propertyHeaderStyleGets or sets the style that is used when rendering the column header. (Inherited from DataGridColumn.)
Public propertyHeaderTemplateGets or sets the template that defines the visual representation of the column header. (Inherited from DataGridColumn.)
Public propertyHeaderTemplateSelectorGets or sets the object that selects which template to use for the column header. (Inherited from DataGridColumn.)
Public propertyIsAutoGeneratedGets a value that indicates whether the column is auto-generated. (Inherited from DataGridColumn.)
Public propertyIsFrozenGets a value that indicates whether the column is prevented from scrolling horizontally. (Inherited from DataGridColumn.)
Public propertyIsReadOnlyGets or sets a value that indicates whether cells in the column can be edited. (Inherited from DataGridColumn.)
Public propertyIsSealedGets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.)
Public propertyMaxWidthGets or sets the maximum width constraint of the column. (Inherited from DataGridColumn.)
Public propertyMinWidthGets or sets the minimum width constraint of the column. (Inherited from DataGridColumn.)
Public propertySortDirectionGets or sets the sort direction (ascending or descending) of the column. (Inherited from DataGridColumn.)
Public propertySortMemberPathGets or sets a property name, or a period-delimited hierarchy of property names, that indicates the member to sort by. (Inherited from DataGridColumn.)
Public propertyTargetNameGets or sets the name of a target window or frame for the hyperlink.
Public propertyVisibilityGets or sets the visibility of the column. (Inherited from DataGridColumn.)
Public propertyWidthGets or sets the column width or automatic sizing mode. (Inherited from DataGridColumn.)
Top

  NameDescription
Protected methodCancelCellEditCauses the cell being edited to revert to the original, unedited value. (Inherited from DataGridColumn.)
Public methodCheckAccessDetermines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Public methodClearValue(DependencyProperty)Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
Public methodClearValue(DependencyPropertyKey)Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
Public methodCoerceValueCoerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. (Inherited from DependencyObject.)
Protected methodCommitCellEditPerforms any required validation before exiting cell editing mode. (Inherited from DataGridColumn.)
Public methodEqualsDetermines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected methodGenerateEditingElementGets an editable TextBox element that is bound to the column's ContentBinding property value. (Overrides DataGridColumn.GenerateEditingElement(DataGridCell, Object).)
Protected methodGenerateElementGets a read-only Hyperlink element that is bound to the column's ContentBinding property value. (Overrides DataGridColumn.GenerateElement(DataGridCell, Object).)
Public methodGetCellContent(DataGridRow)Retrieves the Content property value for the cell at the intersection of this column and the specified row. (Inherited from DataGridColumn.)
Public methodGetCellContent(Object)Gets the Content property value for the cell at the intersection of this column and the row that represents the specified data item. (Inherited from DataGridColumn.)
Public methodGetHashCodeGets a hash code for this DependencyObject. (Inherited from DependencyObject.)
Public methodGetLocalValueEnumeratorCreates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueReturns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
Public methodInvalidatePropertyRe-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodNotifyPropertyChangedNotifies the DataGrid that contains this column that a column property has changed. (Inherited from DataGridColumn.)
Protected methodOnBindingChangedNotifies the DataGrid when the value of the Binding property changes. (Inherited from DataGridBoundColumn.)
Protected methodOnCoerceIsReadOnlyDetermines the value of the IsReadOnly property based on property rules from the data grid that contains this column. (Inherited from DataGridBoundColumn.)
Protected methodOnContentBindingChangedNotifies the DataGrid when the ContentBinding property changes.
Public methodOnCopyingCellClipboardContentRaises the CopyingCellClipboardContent event. (Inherited from DataGridColumn.)
Public methodOnPastingCellClipboardContentRaises the PastingCellClipboardContent event. (Inherited from DataGridColumn.)
Protected methodOnPropertyChangedInvoked whenever the effective value of any dependency property on this DependencyObject has been updated. The specific dependency property that changed is reported in the event data. (Inherited from DependencyObject.)
Protected methodPrepareCellForEditCalled when a cell in the column enters editing mode. (Overrides DataGridColumn.PrepareCellForEdit(FrameworkElement, RoutedEventArgs).)
Public methodReadLocalValueReturns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
Protected methodRefreshCellContentRefreshes the contents of a cell in the column in response to a column property value change. (Overrides DataGridBoundColumn.RefreshCellContent(FrameworkElement, String).)
Public methodSetCurrentValueSets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
Public methodSetValue(DependencyProperty, Object)Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
Public methodSetValue(DependencyPropertyKey, Object)Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)
Protected methodShouldSerializePropertyReturns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodVerifyAccessEnforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Top

  NameDescription
Public eventCopyingCellClipboardContentOccurs after the cell clipboard content is prepared. (Inherited from DataGridColumn.)
Public eventPastingCellClipboardContentOccurs before the clipboard content is moved to the cell. (Inherited from DataGridColumn.)
Top

  NameDescription
Public fieldStatic memberTargetNamePropertyIdentifies the TargetName dependency property.
Top

Use DataGridHyperlinkColumn to display data that contains a Uri, such as an HTTP address or e-mail address. The following illustration shows an example of a DataGridHyperlinkColumn.

DataGridHyperlinkColumn with email addresses
NoteNote

Hyperlink navigation can only occur if either the direct or indirect parent of a Hyperlink is a navigation host. Examples of navigation hosts include NavigationWindow, Frame, or any browser that can host XBAPs, such as Microsoft Internet Explorer 6 or later and Firefox 2.0 or later. For more information, see the "Navigation Hosts" topic in Navigation Overview.

To populate the column, bind the column to the Uri data by using the Binding property. To display hyperlink text that is different than the URI string, bind the text value to the ContentBinding property. The Binding property is applied to the Hyperlink or TextBox element created in the column. The DataContext for the element in each cell is the data item for the row the cell is in. Therefore, to set up the binding you only have to set the Binding.Path. Optionally, you can specify a Binding.Converter if you want to convert the data. For more information about data binding, see Data Binding (WPF).

NoteNote

DataGridHyperlinkColumn creates a Hyperlink element in the non-editing mode and a TextBox element in the editing mode.

If you want to display other types of data, DataGrid provides the following column types:

Column Type

Data Display

DataGridCheckBoxColumn

Use to display Boolean data.

DataGridComboBoxColumn

Use to display enumeration data.

DataGridTextColumn

Use to display text.

If you want to use other controls in your DataGrid, you can create your own column types by using DataGridTemplateColumn.

The following example shows a DataGridHyperlinkColumn that sets the Uri with the Binding property and the hyperlink text with the ContentBinding property. The Hyperlink.Click event is handled automatically because NavigationWindow is the parent of the DataGrid.


<NavigationWindow x:Class="DataGrid_CustomColumns.Window1"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:core="clr-namespace:System;assembly=mscorlib"
    xmlns:local="clr-namespace:DataGrid_CustomColumns"
    Title="Customers" Height="300" Width="300" ShowsNavigationUI="False"  >

<NavigationWindow.Resources>


...


    <!--Create an instance of the converter for Email-->
    <local:EmailConverter x:Key="EmailConverter" />
</NavigationWindow.Resources>
<NavigationWindow.Content>  

<Grid>
    <DataGrid Name="DG1" ItemsSource="{Binding}" AutoGenerateColumns="False" >
        <DataGrid.Columns>


...


<!--The Email property contains a URI.  For example "mailto:lucy0@adventure-works.com"-->
<DataGridHyperlinkColumn Header="Email" Binding="{Binding Email}"  ContentBinding="{Binding Email, Converter={StaticResource EmailConverter}}" />


...


            </DataGrid.Columns>
        </DataGrid>
    </Grid>
    </NavigationWindow.Content>
</NavigationWindow>



public partial class Window1 : NavigationWindow
{


...


public Window1()
{
    InitializeComponent();

    //GetData() creates a collection of Customer data from a database
    ObservableCollection<Customer> custdata = GetData();

    //Bind the DataGrid to the customer data
    DG1.DataContext = custdata;

}


...


//Defines the customer object
public class Customer
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public Uri Email { get; set; }
    public bool IsMember { get; set; }
    public OrderStatus Status { get; set; }

}


...


}


...


//Converts the mailto uri to a string with just the customer alias
public class EmailConverter : IValueConverter
{
    public object Convert(object value, Type targetType, object parameter, System.Globalization.CultureInfo culture)
    {
        if (value != null)
        {
            string email = value.ToString();
            int index = email.IndexOf("@");
            string alias = email.Substring(7, index-7);
            return alias;
        }
        else
        {
            string email = "";
            return email;
        }
    }

    public object ConvertBack(object value, Type targetType, object parameter, System.Globalization.CultureInfo culture)
    {
        Uri email = new Uri((string)value);
        return email;
    }
}


.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.

Community Additions

ADD
Show:
© 2014 Microsoft