Class TreeGridCell
Represents a class that maintains the common functionalities of cells in SfTreeGrid.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.UI.Xaml.TreeGrid
Assembly: Syncfusion.SfGrid.UWP.dll
Syntax
public class TreeGridCell : TreeGridElement, IDisposable
Constructors
TreeGridCell()
Initializes a new instance of TreeGridCell class.
Declaration
public TreeGridCell()
Fields
CurrentCellBorderBrushProperty
Dependency registration for CurrnetCell border brush
Declaration
public static readonly DependencyProperty CurrentCellBorderBrushProperty
Field Value
| Type |
|---|
| Windows.UI.Xaml.DependencyProperty |
CurrentCellBorderThicknessProperty
Dependency registration for CurrentCellBorderThickness.
Declaration
public static readonly DependencyProperty CurrentCellBorderThicknessProperty
Field Value
| Type |
|---|
| Windows.UI.Xaml.DependencyProperty |
ErrorMessageProperty
Dependency registration for ErrorMessage.
Declaration
public static readonly DependencyProperty ErrorMessageProperty
Field Value
| Type |
|---|
| Windows.UI.Xaml.DependencyProperty |
Properties
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 |
|---|
| Windows.UI.Xaml.Media.Brush |
CurrentCellBorderThickness
Gets or sets a thickness for CurrentCell border
Declaration
public Thickness CurrentCellBorderThickness { get; set; }
Property Value
| Type |
|---|
| Windows.UI.Xaml.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 |
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 |
|---|---|---|
| Windows.Foundation.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 |
|---|---|
| Windows.Foundation.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()
Invoked to apply template for TreeGridCell.
Declaration
protected override void OnApplyTemplate()
OnDoubleTapped(DoubleTappedRoutedEventArgs)
Called before the DoubleTapped event occurs.
Declaration
protected override void OnDoubleTapped(DoubleTappedRoutedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| Windows.UI.Xaml.Input.DoubleTappedRoutedEventArgs | e | The Windows.UI.Xaml.Input.DoubleTappedRoutedEventArgs instance containing the event data. |
OnHolding(HoldingRoutedEventArgs)
When long press on SfTreeGrid Cell, Context menu appears for the selected cell. We are using this event for context menu support in Record cell and Expander cell.
Declaration
protected override void OnHolding(HoldingRoutedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| Windows.UI.Xaml.Input.HoldingRoutedEventArgs | e | Holding event arguments |
OnPointerEntered(PointerRoutedEventArgs)
Method override to set tooltip for the TreeGridCell
Declaration
protected override void OnPointerEntered(PointerRoutedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| Windows.UI.Xaml.Input.PointerRoutedEventArgs | e |
OnPointerMoved(PointerRoutedEventArgs)
Called before the PointerMoved event occurs.
Declaration
protected override void OnPointerMoved(PointerRoutedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| Windows.UI.Xaml.Input.PointerRoutedEventArgs | e | The Windows.UI.Xaml.Input.PointerRoutedEventArgs instance containing the event data. |
OnPointerPressed(PointerRoutedEventArgs)
Called before the PointerPressed event occurs.
Declaration
protected override void OnPointerPressed(PointerRoutedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| Windows.UI.Xaml.Input.PointerRoutedEventArgs | e | The Windows.UI.Xaml.Input.PointerRoutedEventArgs instance containing the event data. |
OnPointerReleased(PointerRoutedEventArgs)
Called before the PointerReleased event occurs.
Declaration
protected override void OnPointerReleased(PointerRoutedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| Windows.UI.Xaml.Input.PointerRoutedEventArgs | e | The Windows.UI.Xaml.Input.PointerRoutedEventArgs instance containing the event data. |
OnRightTapped(RightTappedRoutedEventArgs)
When Right click the SfDataGrid Cell, Context menu appears for the selected cell. We are using this event for context menu support in Record cell and Expander cell.
Declaration
protected override void OnRightTapped(RightTappedRoutedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| Windows.UI.Xaml.Input.RightTappedRoutedEventArgs | e | Right tapped event arguments |
OnTapped(TappedRoutedEventArgs)
Called before the Tapped event occurs.
Declaration
protected override void OnTapped(TappedRoutedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| Windows.UI.Xaml.Input.TappedRoutedEventArgs | e | The Windows.UI.Xaml.Input.TappedRoutedEventArgs instance containing the event data. |
ShowContextMenu(Point)
Declaration
protected virtual bool ShowContextMenu(Point position)
Parameters
| Type | Name | Description |
|---|---|---|
| Windows.Foundation.Point | position |
Returns
| Type |
|---|
| System.Boolean |