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

Each cell in a GridBinaryImageColumn contains an image streamed from a binary image source field (specified through the DataField property of the column). When used this column will show a RadBinaryImage control in view mode and RadUpload in edit mode to upload an image. The image will be sized automatically to ImageHeight and ImageWidth pixel values if the ResizeMode property of the column is different than None. Possible values for the ResizeMode property of the column are:

  • Crop (the image will be trimmed)
  • Fit (the image will be sized to fit the given dimensions)
  • None (default)

Additionally, you can 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 GridBinaryImageColumn : GridEditableColumn, IStateManager, IComparable, IGridEditableColumn, IGridDataColumn

Inheritance: objectGridColumnGridEditableColumnGridBinaryImageColumn

Implements: IComparableIGridDataColumnIGridEditableColumnIStateManager

Inherited Members GridEditableColumn.SetDefaultColumnEditor(IGridColumnEditor)GridEditableColumn.GetEditableColumn()GridEditableColumn.ShouldExtractValues(GridEditableItem)GridEditableColumn.ConvertValueIfEmpty(string)GridEditableColumn.GetActiveDataField()GridEditableColumn.ColumnEditorIDGridEditableColumn.MobileEditorGridEditableColumn.CurrentColumnEditorGridEditableColumn.InnerColumnEditorGridEditableColumn.ColumnEditorGridEditableColumn.ConvertEmptyStringToNullGridEditableColumn.UseNativeEditorsInMobileModeGridEditableColumn.DefaultInsertValueGridEditableColumn.ReadOnlyGridEditableColumn.InsertVisiblityModeGridEditableColumn.ForceExtractValueGridEditableColumn.AllowSortingGridEditableColumn.AllowFilteringGridColumn.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.GetDefaultGroupByExpression()GridColumn.IsUniqueName(string)GridColumn.GenerateUniqueNameBase(string)GridColumn.TrySetOnClientClickScript(Control, GridItem, string, params string[])GridColumn.UpdateUniqueNameIfDefault(string)GridColumn.GetCustomPropertyDataFields(object)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.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

C#
public GridBinaryImageColumn()

Properties

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

Specifies if the HTML image element's dimensions are inferred from image's binary data

C#
public bool AutoAdjustImageControlSize { 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 the field name from the specified data source to bind to the GridBinaryImageColumn.

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

A string, specifying the data field from the data source, from which to bind the column.

Gets or sets a url, specifying the location of a default image which to be loaded if there is no data for the binary image

C#
public string DefaultImageUrl { get; set; }

Gets or sets the ImageAlign property for each cell.

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

The ImageAlign property for each cell.

Gets or sets the height of the image

C#
public Unit ImageHeight { get; set; }

Gets or sets the width of the image

C#
public Unit ImageWidth { get; set; }

This property is supposed for developers of new grid columns. It gets whether a column is currently ReadOnly. The ReadOnly property determines whether a column will be editable in edit mode. A column for which the ReadOnly property is true will not be present in the automatically generated edit form.

C#
public override bool IsEditable { get; }
Property Value:

A boolean value, indicating whether a specific column is editable.

Overrides: GridColumn.IsEditable

Gets or sets a value indicating if the binary that will be persisted when editing. Setting the value to true will pass the old binary image data to the data source so the image could be persisted and not deleted.

C#
public virtual bool PersistBinaryDataOnEdit { get; set; }

Gets or sets the ResizeMode property for each cell.

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

The ResizeMode property for each cell.

Get or set the name of the file which will appear inside of the SaveAs browser dialog

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

Should override if sorting will be disabled

C#
protected override bool Sortable { get; }

Overrides: GridEditableColumn.Sortable

Gets or sets a value indicating what type of upload control will be initialized during edit. (Default value = RadUpload)

C#
public virtual GridUploadControlType UploadControlType { get; set; }

Methods

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

C#
protected override void ColumnEditorChange(IGridColumnEditor newValue)
Parameters:newValueIGridColumnEditor

Overrides: GridEditableColumn.ColumnEditorChange(IGridColumnEditor)

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

Overrides: GridEditableColumn.CopyBaseProperties(GridColumn)

C#
protected override IGridColumnEditor CreateDefaultColumnEditor()
Returns:

IGridColumnEditor

Overrides: GridEditableColumn.CreateDefaultColumnEditor()

Extracts the values from the editedItem and fills the names/values pairs for each data-field edited by the column in the newValues dictionary.

C#
public override void FillValues(IDictionary newValues, GridEditableItem editableItem)
Parameters:newValuesIDictionary

dictionary to fill. This param should not be null (Nothing in VB.NET)

editableItemGridEditableItem

the GridEditableItem to extract values from

Overrides: GridEditableColumn.FillValues(IDictionary, GridEditableItem)

C#
protected override string GenerateUniqueName()
Returns:

string

Overrides: GridColumn.GenerateUniqueName()

C#
protected override string GetFilterDataField()
Returns:

string

Overrides: GridColumn.GetFilterDataField()

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)

C#
protected virtual void OnCellDataBinding(object sender, GridCellDataBoundEventArgs args)
Parameters:senderobjectargsGridCellDataBoundEventArgs

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()