Class TreeGridHeaderCell

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

Inheritance

System.Object

TreeGridHeaderCell

Implements

System.IDisposable

Namespace: Syncfusion.UI.Xaml.TreeGrid

Assembly: Syncfusion.Grid.WinUI.dll

Syntax

public class TreeGridHeaderCell : ContentControl, IDisposable

Constructors

TreeGridHeaderCell()

Initializes a new instance of TreeGridHeaderCell class.

Declaration

public TreeGridHeaderCell()

Fields

ColumnProperty

Dependency registration for Column.

Declaration

public static readonly DependencyProperty ColumnProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

FilterIconVisibilityProperty

Dependency property for the FilterIconVisibility property.

Declaration

public static readonly DependencyProperty FilterIconVisibilityProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

SortDirectionProperty

Dependency registration for SortDirection.

Declaration

public static readonly DependencyProperty SortDirectionProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

SortNumberProperty

Dependency registration for SortNumber.

Declaration

public static readonly DependencyProperty SortNumberProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

SortNumberVisibilityProperty

Dependency registration for SortNumberVisibility.

Declaration

public static readonly DependencyProperty SortNumberVisibilityProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

Properties

Column

Gets or sets the TreeGridColumn.

Declaration

public TreeGridColumn Column { get; set; }

Property Value

Type
TreeGridColumn

FilterIconVisibility

Gets or sets the visibility of the filter icon on the TreeGridHeaderCell.

Declaration

public Visibility FilterIconVisibility { get; set; }

Property Value

Type
Microsoft.UI.Xaml.Visibility

IsFilterApplied

Gets a value indicating whether filter is applied.

Declaration

protected bool IsFilterApplied { get; }

Property Value

Type	Description
System.Boolean	True if filter is applied for this column; otherwise, false.

SortDirection

Gets or sets the SortDirection.

Declaration

public object SortDirection { get; set; }

Property Value

Type
System.Object

SortNumber

Gets or sets the SortNumber.

Declaration

public string SortNumber { get; }

Property Value

Type
System.String

SortNumberVisibility

Gets or sets the Visibility for SortNumber.

Declaration

public Visibility SortNumberVisibility { get; set; }

Property Value

Type
Microsoft.UI.Xaml.Visibility

TreeGrid

Declaration

protected SfTreeGrid TreeGrid { get; set; }

Property Value

Type
SfTreeGrid

Methods

ApplyFilterToggleButtonVisualState()

Changes the state of the filter icon on header based on the value of IsFilterApplied property.

Declaration

protected virtual void ApplyFilterToggleButtonVisualState()

ArrangeOverride(Size)

Provides the behaviour for the "Arrange" pass of layout.

Declaration

protected override Size ArrangeOverride(Size finalSize)

Parameters

Type	Name	Description
Windows.Foundation.Size	finalSize	The final area within the parent that this object should use to arrange itself and its children.

Returns

Type	Description
Windows.Foundation.Size	The actual size that is used after the element is arranged in layout.

Dispose()

Disposes all the resources used by the TreeGridHeaderCell class.

Declaration

public void Dispose()

Dispose(Boolean)

Disposes all the resources used by the TreeGridHeaderCell class.

Declaration

protected virtual void Dispose(bool isDisposing)

Parameters

Type	Name	Description
System.Boolean	isDisposing	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 TreeGridHeaderCell.

Declaration

protected override void OnApplyTemplate()

OnColumnChanged()

Invoked when the column changed.

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
Microsoft.UI.Xaml.Automation.Peers.AutomationPeer	The class-specific AutomationPeer subclass.

OnDoubleTapped(DoubleTappedRoutedEventArgs)

Called before the DoubleTapped event occurs.

Declaration

protected override void OnDoubleTapped(DoubleTappedRoutedEventArgs e)

Parameters

Type	Name	Description
Microsoft.UI.Xaml.Input.DoubleTappedRoutedEventArgs	e	The Microsoft.UI.Xaml.Input.DoubleTappedRoutedEventArgs instance containins the event data.

OnHolding(HoldingRoutedEventArgs)

Called before the Holding event occurs.

Declaration

protected override void OnHolding(HoldingRoutedEventArgs e)

Parameters

Type	Name	Description
Microsoft.UI.Xaml.Input.HoldingRoutedEventArgs	e	The Microsoft.UI.Xaml.Input.HoldingRoutedEventArgs instance contains the event data.

OnManipulationStarted(ManipulationStartedRoutedEventArgs)

/Called before the ManipulationStarted event occurs.

Declaration

protected override void OnManipulationStarted(ManipulationStartedRoutedEventArgs e)

Parameters

Type	Name	Description
Microsoft.UI.Xaml.Input.ManipulationStartedRoutedEventArgs	e	The Microsoft.UI.Xaml.Input.ManipulationStartedRoutedEventArgs instance contains the event data.

OnManipulationStarting(ManipulationStartingRoutedEventArgs)

Called before the ManipulationStarting event occurs.

Declaration

protected override void OnManipulationStarting(ManipulationStartingRoutedEventArgs e)

Parameters

Type	Name	Description
Microsoft.UI.Xaml.Input.ManipulationStartingRoutedEventArgs	e	The Microsoft.UI.Xaml.Input.ManipulationStartingRoutedEventArgs instance contains the event data.

OnPointerCaptureLost(PointerRoutedEventArgs)

Called before the PointerCaptureLost event occurs.

Declaration

protected override void OnPointerCaptureLost(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Microsoft.UI.Xaml.Input.PointerRoutedEventArgs	e	The Microsoft.UI.Xaml.Input.PointerRoutedEventArgs instance contains the event data.

OnPointerEntered(PointerRoutedEventArgs)

Method override to set tooltip for TreeGridHeaderCell

Declaration

protected override void OnPointerEntered(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Microsoft.UI.Xaml.Input.PointerRoutedEventArgs	e

OnPointerExited(PointerRoutedEventArgs)

Called before the PointerExited event occurs.

Declaration

protected override void OnPointerExited(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Microsoft.UI.Xaml.Input.PointerRoutedEventArgs	e	The Microsoft.UI.Xaml.Input.PointerRoutedEventArgs instance contains the event data.

OnPointerMoved(PointerRoutedEventArgs)

Called before the PointerMoved event occurs.

Declaration

protected override void OnPointerMoved(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Microsoft.UI.Xaml.Input.PointerRoutedEventArgs	e	The Microsoft.UI.Xaml.Input.PointerRoutedEventArgs instance contains the event data.

OnPointerPressed(PointerRoutedEventArgs)

Called before the PointerPressed event occurs.

Declaration

protected override void OnPointerPressed(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Microsoft.UI.Xaml.Input.PointerRoutedEventArgs	e	The Microsoft.UI.Xaml.Input.PointerRoutedEventArgs instance contains the event data.

OnPointerReleased(PointerRoutedEventArgs)

Called before the PointerReleased event occurs.

Declaration

protected override void OnPointerReleased(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Microsoft.UI.Xaml.Input.PointerRoutedEventArgs	e	The Microsoft.UI.Xaml.Input.PointerRoutedEventArgs instance contains the event data.

OnRightTapped(RightTappedRoutedEventArgs)

When Right click the SfTreeGrid Cell, Context menu appears for the selected cell. we are using this event for context menu support in Header cell.

Declaration

protected override void OnRightTapped(RightTappedRoutedEventArgs e)

Parameters

Type	Name	Description
Microsoft.UI.Xaml.Input.RightTappedRoutedEventArgs	e	Right tapped event arguments

OnSortDirectionChanged(DependencyPropertyChangedEventArgs)

Declaration

protected virtual void OnSortDirectionChanged(DependencyPropertyChangedEventArgs args)

Parameters

Type	Name	Description
Microsoft.UI.Xaml.DependencyPropertyChangedEventArgs	args

OnTapped(TappedRoutedEventArgs)

Called before the Tapped event occurs.

Declaration

protected override void OnTapped(TappedRoutedEventArgs e)

Parameters

Type	Name	Description
Microsoft.UI.Xaml.Input.TappedRoutedEventArgs	e	The Microsoft.UI.Xaml.Input.TappedRoutedEventArgs instance contains the event data.

ShowContextFlyout(Point)

Opens the context flyout at the specified position.

Declaration

protected virtual bool ShowContextFlyout(Point position)

Parameters

Type	Name	Description
Windows.Foundation.Point	position	The position to display context flyout.

Returns

Type	Description
System.Boolean	true If the context flyout opened;Otherwisefalse

Implements

System.IDisposable