Class GridImageColumn

Represents a column that displays the image in its cell content.

Inheritance
System.Object
ColumnBase<SfGridBase>
GridColumnBase
GridColumn
GridImageColumn
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.UI.Xaml.DataGrid
Assembly: Syncfusion.Grid.WinUI.dll
Syntax
public class GridImageColumn : GridColumn, IDisposable, INotifyDependencyPropertyChanged, IFilterDefinition

Constructors

GridImageColumn()

Initializes a new instance of the GridImageColumn class.

Declaration
public GridImageColumn()

Fields

ImageHeightProperty

Identifies the ImageHeight dependency property.

Declaration
public static readonly DependencyProperty ImageHeightProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the ImageHeight dependency property.

ImageWidthProperty

Identifies the ImageWidth dependency property.

Declaration
public static readonly DependencyProperty ImageWidthProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the ImageWidth dependency property.

StretchDirectionProperty

Identifies the StretchDirection dependency property.

Declaration
public static readonly DependencyProperty StretchDirectionProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the StretchDirection dependency property.

StretchProperty

Identifies the Stretch dependency property.

Declaration
public static readonly DependencyProperty StretchProperty
Field Value
Type
Microsoft.UI.Xaml.DependencyProperty
Remarks

The identifier for the Stretch dependency property.

Properties

ImageHeight

Gets or sets the height of the image.

Declaration
public double ImageHeight { get; set; }
Property Value
Type Description
System.Double

The height of the image. The default value is positive infinity.

ImageWidth

Gets or sets the width of the image.

Declaration
public double ImageWidth { get; set; }
Property Value
Type Description
System.Double

The width of the image. The default value positive infinity.

Stretch

Gets or sets a value that specifies how an Microsoft.UI.Xaml.Controls.Image can be stretched to fill the destination rectangle.

Declaration
public Stretch Stretch { get; set; }
Property Value
Type Description
Microsoft.UI.Xaml.Media.Stretch

One of the Microsoft.UI.Xaml.Media.Stretch enumeration that specifies how the image is stretched. The default value is Stretch.Uniform.

StretchDirection

Gets or sets a value that indicates how the image is scaled.

Declaration
public StretchDirection StretchDirection { get; set; }
Property Value
Type Description
Microsoft.UI.Xaml.Controls.StretchDirection

One of the Microsoft.UI.Xaml.Controls.StretchDirection values. The default value is StretchDirection.Both.

Methods

CanEditCell(Int32)

Determines whether the cells in GridImageColumn can be edited.

Declaration
protected override bool CanEditCell(int rowIndex = -1)
Parameters
Type Name Description
System.Int32 rowIndex
Returns
Type Description
System.Boolean

Returns false for GridImageColumn.
Overrides

OnCellTemplateChanged(DependencyPropertyChangedEventArgs)

Invoked when the CellTemplate dependency property value changed in GridImageColumn.

Declaration
protected override void OnCellTemplateChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
Microsoft.UI.Xaml.DependencyPropertyChangedEventArgs e

The Microsoft.UI.Xaml.DependencyPropertyChangedEventArgs that contains data for CellTemplate dependency property changes.
Overrides

UpdateBindingBasedOnAllowEditing()

Updates the binding for the AllowEdit property changes in GridImageColumn.

Declaration
protected override void UpdateBindingBasedOnAllowEditing()
Overrides

Implements

System.IDisposable