GridHyperLinkColumn
Each row in a Hyperlink column will contain a predefined hyperlink. This link is not the same for the whole column and can be defined for each row individually.
The content of the column can be bound to a field in a data source or to a static text. You can customize the look of the links by using CSS classes.
You can set multiple fields to a GridHyperlinkColumn through its DataNavigateUrlFields property. These fields can later be used when setting the DataNavigateUrlFormatString property and be part of a query string:
<radG:GridHyperLinkColumn DataNavigateUrlFields= "ProductID,OrderID" DataNavigateUrlFormatString= "~/Details.aspx?ProductID={0}&OrderID={1}"></radG:GridHyperLinkColumn>
Definition
Namespace:Telerik.Web.UI
Assembly:Telerik.Web.UI.dll
Syntax:
public class GridHyperLinkColumn : GridColumn, IStateManager, IComparable, IGridDataColumnInheritance: objectGridColumnGridHyperLinkColumn
Implements:
Inherited Members
Constructors
public GridHyperLinkColumn()Properties
Gets or sets whether the column data can be filtered. The default value is true.
public virtual bool AllowFiltering { get; set; }A Boolean value, indicating whether the column can be filtered.
Implements:
Gets or sets a whether the column data can be sorted.
public virtual bool AllowSorting { get; set; }A boolean value, indicating whether the column data can be sorted.
Implements:
Gets or sets a string, representing a comma-separated enumeration of DataFields from the data source, which will form the url of the windwow/frame that the hyperlink will target.
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
[TypeConverter(typeof(GridStringArrayConverter))]
public virtual string[] DataNavigateUrlFields { get; set; }A string, representing a comma-separated enumeration of DataFields from the data source, which will form the url of the windwow/frame that the hyperlink will target.
Gets or sets a string, specifying the FormatString of the DataNavigateURL. Essentially, the DataNavigateUrlFormatString property sets the formatting for the url string of the target window or frame.
public virtual string DataNavigateUrlFormatString { get; set; }A string, specifying the FormatString of the DataNavigateURL.
Gets or sets a string, representing the DataField name from the data source, which will be used to supply the text for the hyperlink in the column. This text can further be customized, by using the DataTextFormatString property.
public virtual string DataTextField { get; set; }A string, representing the DataField name from the data source, which will be used to supply the text for the hyperlink in the column.
Gets or sets a string, specifying the format string, which will be used to format the text of the hyperlink, rendered in the cells of the column.
public virtual string DataTextFormatString { get; set; }A string, specifying the format string, which will be used to format the text of the hyperlink, rendered in the cells of the column.
Gets or sets a value specifying the ImageUrl property of the HyperLink control rendered in every data cell of the GridHyperLinkColumn.
public virtual string ImageUrl { get; set; }Gets or sets a string, specifying the url, to which to navigate, when a hyperlink within a column is pressed. This property will be honored only if the DataNavigateUrlFields are not set. If either DataNavigateUrlFields are set, they will override the NavigateUrl property.
public virtual string NavigateUrl { get; set; }A a string, specifying the url, to which to navigate, when a hyperlink within a column is pressed.
Sets or gets a string, specifying the window or frame at which to target content. The possible values are:
_blank - the target URL will open in a new window
_self - the target URL will open in the same frame as it was clicked
_parent - the target URL will open in the parent frameset
_top - the target URL will open in the full body of the window
public virtual string Target { get; set; }A string, specifying the window or frame at which to target content.
Gets or sets a string, specifying the text to be displayed by the hyperlinks in the column, when there is no DataTextField specified.
public virtual string Text { get; set; }A string, specifying the text to be displayed by the hyperlinks in the column, when there is no DataTextField specified.
Methods
Creates a copy of the current column.
public override GridColumn Clone()Overrides:
Note: When implementing/overriding this method be sure to call the base member or call CopyBaseProperties to be sure that all base properties will be copied accordingly
protected override void CopyBaseProperties(GridColumn fromColumn)Overrides:
Returns the DataField that will be used for Filter and Sorting operations
This method should be used in case you develop your own column. It returns the full list of DataFields used by the column. GridTableView uses this to decide which DataFields from the specified DataSource will be inlcuded in case of GridTableView.RetrieveAllDataFields is set to false.
public override IDictionary GetCustomPropertyDataFields(object dataItemInstance)Overrides:
Calculate the default Group-by expression based on the settings of the DataField (if available)
public override string GetDefaultGroupByExpression()Overrides:
For example, if a column's DataField is ProductType the default group-by expression will be: 'ProductType Group By ProductType'
This method should be used in case you develop your own column. It returns true if the column supports filtering.
public override bool SupportsFiltering()Returns if the column supports filtering.
Overrides: