New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

TreeListHyperLinkColumn

Class

Represents a TreeListColumn extended to display a HyperLink in each of its data cells.

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

[SuppressMessage("Microsoft.Design", "CA1001:TypesThatOwnDisposableFieldsShouldBeDisposable")]
public class TreeListHyperLinkColumn : TreeListColumn, IMarkableStateManager, IStateManager, IComparable

Inheritance: objectStateManagerTreeListColumnTreeListHyperLinkColumn

Implements: IComparableIMarkableStateManagerIStateManager

Inherited Members TreeListColumn.InitializeCell(TableCell, int, TreeListItem)TreeListColumn.InitializeFooterCells(TableCell, int, TreeListFooterItem)TreeListColumn.InitializeHeaderCells(TableCell, int, TreeListHeaderItem)TreeListColumn.IsUniqueName(string)TreeListColumn.GenerateUniqueNameBase(string)TreeListColumn.GenerateUniqueName()TreeListColumn.UpdateUniqueNameIfDefault(string)TreeListColumn.GetSortExpression()TreeListColumn.TrackViewState()TreeListColumn.SaveViewState()TreeListColumn.LoadViewState(object)TreeListColumn.OwnerTreeListColumn.DesignModeTreeListColumn.ColumnTypeTreeListColumn.HeaderTextTreeListColumn.HeaderTooltipTreeListColumn.FooterTextTreeListColumn.IsDefaultUniqueNameTreeListColumn.UniqueNameTreeListColumn.HeaderStyleTreeListColumn.ItemStyleTreeListColumn.VisibleTreeListColumn.ResizableTreeListColumn.ReorderableTreeListColumn.MinWidthTreeListColumn.MaxWidthTreeListColumn.DisplayTreeListColumn.OrderIndexTreeListColumn.SortExpressionStateManager.IsTrackingViewStateStateManager.ViewStateobject.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()object.GetType()object.MemberwiseClone()...

Constructors

TreeListHyperLinkColumn()

public TreeListHyperLinkColumn()

Properties

AllowSorting

bool

Gets or sets a whether the column data can be sorted.

public virtual bool AllowSorting { get; set; }

Property Value:

A boolean value, indicating whether the column data can be sorted.

DataNavigateUrlFields

string[]

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; }

Property Value:

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.

DataNavigateUrlFormatString

string

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; }

Property Value:

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; }

Property Value:

A string, representing the DataField name from the data source, which will be used to supply the text for the hyperlink in the column.

DataTextFormatString

string

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; }

Property Value:

A string, specifying the format string, which will be used to format the text of the hyperlink, rendered in the cells of the column.

NavigateUrl

string

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; }

Property Value:

A a string, specifying the url, to which to navigate, when a hyperlink within a column is pressed.

Sortable

bool

Should override if sorting will be disabled

protected override bool Sortable { get; }

Overrides: TreeListColumn.Sortable

Target

string

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; }

Property Value:

A string, specifying the window or frame at which to target content.

Text

string

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; }

Property Value:

A string, specifying the text to be displayed by the hyperlinks in the column, when there is no DataTextField specified.

Methods

FormatDataNavigateUrlValue(object[])

protected virtual string FormatDataNavigateUrlValue(object[] dataUrlValues)

Parameters:dataUrlValuesobject[]Returns:

string

FormatDataTextValue(object)

protected virtual string FormatDataTextValue(object dataTextValue)

Parameters:dataTextValueobjectReturns:

string

InitializeDataCells(TableCell, int, TreeListDataItem)

protected override void InitializeDataCells(TableCell cell, int columnIndex, TreeListDataItem inItem)

Parameters:cellTableCellcolumnIndexintinItemTreeListDataItem

Overrides: TreeListColumn.InitializeDataCells(TableCell, int, TreeListDataItem)

OnColumnDataCellBinding(object, EventArgs)

protected void OnColumnDataCellBinding(object sender, EventArgs e)

Parameters:senderobjecteEventArgs