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

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

Definition

Constructors

C#
public TreeListImageColumn()

Fields

C#
protected const string SuportedExtensions = "*.gif;*.jpg;*.jpeg;*.bmp;*.wmf;*.png"

Properties

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

C#
public virtual bool AllowSorting { get; set; }
Property Value:

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

Gets or sets a string, specifying the text which will be shown as alternate text to the image

C#
public virtual string AlternateText { get; set; }

Gets or sets a string, representing the DataField name from the data source, which will be used to supply the alternateText for the image in the column. This text can further be customized, by using the DataTextFormatString property.

C#
public virtual string DataAlternateTextField { get; set; }
Property Value:

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

Gets or sets a string, specifying the format string, which will be used to format the alternate text of the image, rendered in the cells of the column.

C#
public virtual string DataAlternateTextFormatString { 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.

Gets or sets a string, representing a comma-separated enumeration of DataFields from the data source, which will form the url of the image which will be shown.

C#
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
[TypeConverter(typeof(GridStringArrayConverter))]
public virtual string[] DataImageUrlFields { get; set; }
Property Value:

A string, representing a comma-separated enumeration of DataFields from the data source, which will form the url of the image which will be shown.

Gets or sets a string, specifying the FormatString of the DataNavigateURL. Essentially, the DataNavigateUrlFormatString property sets the formatting for the url string of the image.

C#
public virtual string DataImageUrlFormatString { get; set; }
Property Value:

A string, specifying the FormatString of the DataNavigateURL.

Gets or sets (see the Remarks) the type of the data from the DataField as it was set in the DataSource.

C#
[TypeConverter(typeof(GridDataTypeConverter))]
public Type DataType { get; set; }

The DataType property supports the following base .NET Framework data types:

  • Boolean
  • Byte
  • Char
  • DateTime
  • Decimal
  • Double
  • Int16
  • Int32
  • Int64
  • SByte
  • Single
  • String
  • TimeSpan
  • UInt16
  • UInt32
  • UInt64

Gets or sets a value from the ImageAlign enumeration representing the alignment of the rendered image in relation to the text.

C#
public virtual ImageAlign ImageAlign { get; set; }

Gets or sets the height of the image

C#
public Unit ImageHeight { get; set; }

Gets or sets a string, specifying the url, from which the image should be retrieved. This property will be honored only if the DataImageUrlFields are not set. If either DataImageUrlFields are set, they will override the ImageUrl property.

C#
public virtual string ImageUrl { get; set; }
Property Value:

A string, specifying the url, from which the image, should be loaded.

Gets or sets the width of the image

C#
public Unit ImageWidth { get; set; }

Should override if sorting will be disabled

C#
protected override bool Sortable { get; }

Overrides: TreeListColumn.Sortable

Methods

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

C#
public void Dispose()

Implements: IDisposable.Dispose()

C#
protected virtual void Dispose(bool disposing)
Parameters:disposingbool
C#
protected virtual string FormatDataAlternativeTextValue(object dataTextValue)
Parameters:dataTextValueobjectReturns:

string

C#
protected virtual string FormatDataImageUrlValue(object[] dataUrlValues)
Parameters:dataUrlValuesobject[]Returns:

string

By default returns the SortExpression of the column. If the SortExpression is not set explicitly, it would be calculated, based on the DataField of the column.

C#
protected override string GetSortExpression()
Returns:

string

Overrides: TreeListColumn.GetSortExpression()

C#
protected override void InitializeDataCells(TableCell cell, int columnIndex, TreeListDataItem inItem)
Parameters:cellTableCellcolumnIndexintinItemTreeListDataItem

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

C#
protected void OnColumnDataCellBinding(object sender, EventArgs e)
Parameters:senderobjecteEventArgs