Introduction
Knowledge Base
API Reference / Server-side / Telerik.Web.UI / GridImageColumn
New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

GridImageColumn

Class

Each cell in a GridImageColumn contains an image. To specify the image url of that image, you can do one of the following:

  • Set the ImageUrl property to a static value. When you use this method, every image appears the same in the entire column.
  • Set the DataImageUrlFields property to a field in the source that can be used to supply the image path and format it by

setting the DataImageUrlFormatString property. You can specify multiple fields if the image url is determined by more than one field in the database.

  • Set the DataAlternateTextField property to specify by which field in the grid source the column will be sorted/filtered.

For the filtering you must also set explicitly the DataType property of the column to the type of the field specified through the DataAlternateTextField property (System.String in the common case). You can also apply format using the DataAlternateTextFormatString property.

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:
C#
public class GridImageColumn : GridColumn, IStateManager, IComparable, IGridDataColumn

Inheritance: objectGridColumnGridImageColumn

Implements: IComparableIGridDataColumnIStateManager

Inherited Members GridColumn.Initialize()GridColumn.InitializeCell(TableCell, int, GridItem)GridColumn.ShouldSerializeFilterImageUrl()GridColumn.ShouldSerializeSortAscImageUrl()GridColumn.ShouldSerializeSortDescImageUrl()GridColumn.RefreshCurrentFilterValue(GridFilteringItem, string)GridColumn.RefreshCurrentFilterValue(GridFilteringItem)GridColumn.SetCurrentFilterValueToControl(TableCell)GridColumn.GetCurrentFilterValueFromControl(TableCell)GridColumn.EvaluateFilterExpression(GridFilteringItem)GridColumn.EvaluateFilterExpression()GridColumn.FunctionTakesNoArguments(GridKnownFunction)GridColumn.SetupFilterControls(TableCell)GridColumn.GetFilterFunctionsList(GridFilterListOptions, ArrayList)GridColumn.PrepareCell(TableCell, GridItem)GridColumn.LoadViewState(object)GridColumn.OnColumnChanged()GridColumn.SaveViewState()GridColumn.TrackViewState()GridColumn.ResetCurrentFilterValue(GridFilteringItem)GridColumn.ResetCurrentFilterValue()GridColumn.IsUniqueName(string)GridColumn.GenerateUniqueNameBase(string)GridColumn.TrySetOnClientClickScript(Control, GridItem, string, params string[])GridColumn.UpdateUniqueNameIfDefault(string)GridColumn.HeaderTooltipGridColumn.HeaderAbbrGridColumn.HeaderAxisGridColumn.SortedBackColorGridColumn.CurrentFilterValueGridColumn.AndCurrentFilterValueGridColumn.ColumnGroupNameGridColumn.SelectedGridColumn.SelectableGridColumn.CurrentFilterFunctionGridColumn.AndCurrentFilterFunctionGridColumn.FilterDelayGridColumn.ExportableGridColumn.EnableHeaderContextMenuGridColumn.ShowFilterIconGridColumn.FilterListOptionsGridColumn.AutoPostBackOnFilterGridColumn.FilterImageToolTipGridColumn.FilterControlToolTipGridColumn.EditorControlToolTipGridColumn.FilterImageUrlGridColumn.SortAscImageUrlGridColumn.SortDescImageUrlGridColumn.DataTypeNameGridColumn.ListOfFilterValuesGridColumn.FilterTemplateGridColumn.TableViewSpecificStateGridColumn.DesignModeGridColumn.FooterStyleGridColumn.FooterTextGridColumn.HeaderImageUrlGridColumn.HeaderStyleGridColumn.HeaderTextGridColumn.IsTrackingViewStateGridColumn.ItemStyleGridColumn.OwnerGridColumn.SortExpressionGridColumn.GroupByExpressionGridColumn.ViewStateGridColumn.ShowSortIconGridColumn.ShowNoSortIconGridColumn.VisibleGridColumn.DisplayGridColumn.OwnerIDGridColumn.OwnerGridIDGridColumn.ResizableGridColumn.ReorderableGridColumn.GroupableGridColumn.ColumnTypeGridColumn.HeaderButtonTypeGridColumn.OrderIndexGridColumn.IsEditableGridColumn.IsDefaultUniqueNameGridColumn.EditFormColumnIndexGridColumn.UniqueNameGridColumn.EditFormHeaderTextFormatGridColumn.DataTypeGridColumn.FilterControlWidthGridColumn.FilterControlAltTextGridColumn.FilterCheckListWebServiceMethodGridColumn.FilterCheckListEnableLoadOnDemandobject.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()object.GetType()object.MemberwiseClone()...

Constructors

GridImageColumn()

C#
public GridImageColumn()

Fields

SuportedExtensions

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

Properties

AllowFiltering

Gets or sets whether the column data can be filtered. The default value is true.

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

A Boolean value, indicating whether the column can be filtered.

Implements: IGridDataColumn.AllowFiltering

AllowSorting

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.

Implements: IGridDataColumn.AllowSorting

AlternateText

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

DataAlternateTextField

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.

DataAlternateTextFormatString

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.

DataImageUrlFields

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.

DataImageUrlFormatString

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.

ImageAlign

Gets or sets the image alignment of the column Image control.

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

The image alignment of the column Image control.

ImageHeight

Gets or sets the height of the image

C#
public Unit ImageHeight { get; set; }

ImageUrl

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.

ImageWidth

Gets or sets the width of the image

C#
public Unit ImageWidth { get; set; }

Sortable

Should override if sorting will be disabled

C#
protected override bool Sortable { get; }

Overrides: GridColumn.Sortable

Methods

Clone()

Creates a copy of the current column.

C#
public override GridColumn Clone()
Returns:

GridColumn

Overrides: GridColumn.Clone()

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

CopyBaseProperties(GridColumn)

C#
protected override void CopyBaseProperties(GridColumn fromColumn)
Parameters:fromColumnGridColumn

Overrides: GridColumn.CopyBaseProperties(GridColumn)

FormatDataAlternativeTextValue(object)

C#
protected virtual string FormatDataAlternativeTextValue(object dataTextValue)
Parameters:dataTextValueobjectReturns:

string

FormatDataImageUrlValue(object[])

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

string

GenerateUniqueName()

C#
protected override string GenerateUniqueName()
Returns:

string

Overrides: GridColumn.GenerateUniqueName()

GetActiveDataField()

Returns the DataField that will be used for Filter and Sorting operations

C#
public string GetActiveDataField()
Returns:

string

Implements: IGridDataColumn.GetActiveDataField()

GetCustomPropertyDataFields(object)

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.

C#
public override IDictionary GetCustomPropertyDataFields(object dataItemInstance)
Parameters:dataItemInstanceobjectReturns:

IDictionary

Overrides: GridColumn.GetCustomPropertyDataFields(object)

GetDefaultGroupByExpression()

Calculate the default Group-by expression based on the settings of the DataField (if available)

C#
public override string GetDefaultGroupByExpression()
Returns:

string

Overrides: GridColumn.GetDefaultGroupByExpression()

For example, if a column's DataField is ProductType the default group-by expression will be: 'ProductType Group By ProductType'

GetFilterDataField()

C#
protected override string GetFilterDataField()
Returns:

string

Overrides: GridColumn.GetFilterDataField()

IsBoundToFieldName(string)

This method returns true if the column is bound to the specified field name.

C#
public override bool IsBoundToFieldName(string name)
Parameters:namestring

The name of the DataField, which will be checked.

Returns:

bool

Overrides: GridColumn.IsBoundToFieldName(string)

IsBoundToFieldName(string[], string)

Determines whether [is bound to field name] [the specified URL fields].

C#
public bool IsBoundToFieldName(string[] urlFields, string name)
Parameters:urlFieldsstring[]

The URL fields.

namestring

The name.

Returns:

bool

OnDataBindColumn(object, EventArgs)

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

SupportsFiltering()

This method should be used in case you develop your own column. It returns true if the column supports filtering.

C#
public override bool SupportsFiltering()
Returns:

bool

Overrides: GridColumn.SupportsFiltering()

In this article
DefinitionConstructorsGridImageColumn()FieldsSuportedExtensionsPropertiesAllowFilteringAllowSortingAlternateTextDataAlternateTextFieldDataAlternateTextFormatStringDataImageUrlFieldsDataImageUrlFormatStringImageAlignImageHeightImageUrlImageWidthSortableMethodsClone()CopyBaseProperties(GridColumn)FormatDataAlternativeTextValue(object)FormatDataImageUrlValue(object[])GenerateUniqueName()GetActiveDataField()GetCustomPropertyDataFields(object)GetDefaultGroupByExpression()GetFilterDataField()IsBoundToFieldName(string)IsBoundToFieldName(string[], string)OnDataBindColumn(object, EventArgs)SupportsFiltering()
Not finding the help you need?
Contact Support