Class TreeGridCell

Represents a class that maintains the common functionalities of cells in SfTreeGrid.

Inheritance
System.Object
TreeGridElement
TreeGridCell
TreeGridExpanderCell
TreeGridRowHeaderCell
TreeGridRowHeaderIndentCell
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.UI.Xaml.TreeGrid
Assembly: Syncfusion.SfGrid.WPF.dll
Syntax
public class TreeGridCell : TreeGridElement, IDisposable

Constructors

TreeGridCell()

Initializes a new instance of TreeGridCell class.

Declaration
public TreeGridCell()

Fields

CellSelectionBrushProperty

Dependency registration for CellSelectionBrushProperty.

Declaration
public static readonly DependencyProperty CellSelectionBrushProperty
Field Value
Type
System.Windows.DependencyProperty

CurrentCellBorderBrushProperty

Dependency registration for CurrnetCell border brush

Declaration
public static readonly DependencyProperty CurrentCellBorderBrushProperty
Field Value
Type
System.Windows.DependencyProperty

CurrentCellBorderThicknessProperty

Dependency registration for CurrentCellBorderThickness.

Declaration
public static readonly DependencyProperty CurrentCellBorderThicknessProperty
Field Value
Type
System.Windows.DependencyProperty

ErrorMessageProperty

Dependency registration for ErrorMessage.

Declaration
public static readonly DependencyProperty ErrorMessageProperty
Field Value
Type
System.Windows.DependencyProperty

SelectionBorderVisibilityProperty

Declaration
public static readonly DependencyProperty SelectionBorderVisibilityProperty
Field Value
Type
System.Windows.DependencyProperty

SelectionForegroundBrushProperty

Dependency Registration for SelectionForegroundBrush

Declaration
public static readonly DependencyProperty SelectionForegroundBrushProperty
Field Value
Type
System.Windows.DependencyProperty

Properties

CellSelectionBrush

Get or sets the CurrentCell Background which is bind to CurrentCell Background property.

Declaration
public Brush CellSelectionBrush { get; set; }
Property Value
Type
System.Windows.Media.Brush

ColumnBase

Gets or sets the ColumnBase.

Declaration
public TreeDataColumnBase ColumnBase { get; }
Property Value
Type
TreeDataColumnBase

CurrentCellBorderBrush

Gets or sets Brush for CurrnetCell border.

Declaration
public Brush CurrentCellBorderBrush { get; set; }
Property Value
Type
System.Windows.Media.Brush

CurrentCellBorderThickness

Gets or sets a thickness for CurrentCell border

Declaration
public Thickness CurrentCellBorderThickness { get; set; }
Property Value
Type
System.Windows.Thickness

ErrorMessage

Gets or sets cell error message which is displayed in cell error indicator's ToolTip.

Declaration
public string ErrorMessage { get; set; }
Property Value
Type
System.String

HasError

Gets a value indicating whether TreeGridCell has error or not.

Declaration
public bool HasError { get; }
Property Value
Type
System.Boolean

SelectionBorderVisibility

Declaration
public Visibility SelectionBorderVisibility { get; set; }
Property Value
Type
System.Windows.Visibility

SelectionForegroundBrush

Gets or sets the value for SelectionForegroundBrush

Declaration
public Brush SelectionForegroundBrush { get; set; }
Property Value
Type
System.Windows.Media.Brush

Methods

ApplyValidationVisualState(Boolean)

Updates the Visual State of the TreeGridCell based on the cell validation applied on SfTreeGrid.

Declaration
protected virtual void ApplyValidationVisualState(bool canApplyDefaultState = true)
Parameters
Type Name Description
System.Boolean canApplyDefaultState

Dispose()

Disposes all the resources used by the TreeGridCell class.

Declaration
public void Dispose()

Dispose(Boolean)

Disposes all the resources used by the TreeGridCell class.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

Indicates whether the call is from Dispose method or from a finalizer.

MeasureOverride(Size)

Provides the behaviour for the "Measure" pass of the layout cycle.

Declaration
protected override Size MeasureOverride(Size availableSize)
Parameters
Type Name Description
System.Windows.Size availableSize

The available size that this object can give to child objects.Infinity can be specified as a value to indicate that the object will to size whatever the content is available.
Returns
Type Description
System.Windows.Size

The Size that this object determines it needs during layout,based on its calculations of the allocated sizes for child objects or based on other considerations such as a fixed container size.

OnApplyTemplate()

Declaration
public override void OnApplyTemplate()

OnColumnChanged()

Invoked when columns are reused in horizontal scrolling.

Declaration
protected virtual void OnColumnChanged()

OnCreateAutomationPeer()

Returns a class-specific AutomationPeer Implementations for the Microsoft UI Automation infrastructure.

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
Type Description
System.Windows.Automation.Peers.AutomationPeer

The class-specific AutomationPeer subclass.

OnMouseDoubleClick(MouseButtonEventArgs)

Declaration
protected override void OnMouseDoubleClick(MouseButtonEventArgs e)
Parameters
Type Name Description
System.Windows.Input.MouseButtonEventArgs e

OnMouseDown(MouseButtonEventArgs)

When click the pop up and select the row, the OnPreviewMouseDown() method is not hit and the row is not selected because the Scrollviewer handled the OnPreviewMouseDown method. So here we written the OnMouseDown() method to overcome this issue.

Declaration
protected override void OnMouseDown(MouseButtonEventArgs e)
Parameters
Type Name Description
System.Windows.Input.MouseButtonEventArgs e

OnMouseEnter(MouseEventArgs)

Method override to set tooltip for TreeGridCell.

Declaration
protected override void OnMouseEnter(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Input.MouseEventArgs e

OnMouseMove(MouseEventArgs)

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Input.MouseEventArgs e

OnMouseUp(MouseButtonEventArgs)

Declaration
protected override void OnMouseUp(MouseButtonEventArgs e)
Parameters
Type Name Description
System.Windows.Input.MouseButtonEventArgs e

OnPreviewMouseDown(MouseButtonEventArgs)

Declaration
protected override void OnPreviewMouseDown(MouseButtonEventArgs e)
Parameters
Type Name Description
System.Windows.Input.MouseButtonEventArgs e

OnPreviewMouseUp(MouseButtonEventArgs)

Declaration
protected override void OnPreviewMouseUp(MouseButtonEventArgs e)
Parameters
Type Name Description
System.Windows.Input.MouseButtonEventArgs e

OnPreviewMouseWheel(MouseWheelEventArgs)

Declaration
protected override void OnPreviewMouseWheel(MouseWheelEventArgs e)
Parameters
Type Name Description
System.Windows.Input.MouseWheelEventArgs e

ShowContextMenu()

Declaration
protected virtual bool ShowContextMenu()
Returns
Type
System.Boolean

Implements

System.IDisposable