Class TreeGridHeaderCell
Represents a class that maintains the common functionalities of Headercells in SfTreeGrid.
Inheritance
Implements
Namespace: Syncfusion.UI.Xaml.TreeGrid
Assembly: Syncfusion.SfGrid.WPF.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 |
---|
System.Windows.DependencyProperty |
FilterIconVisibilityProperty
Dependency property for the FilterIconVisibility property.
Declaration
public static readonly DependencyProperty FilterIconVisibilityProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
SortDirectionProperty
Dependency registration for SortDirection.
Declaration
public static readonly DependencyProperty SortDirectionProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
SortNumberProperty
Dependency registration for SortNumber.
Declaration
public static readonly DependencyProperty SortNumberProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
SortNumberVisibilityProperty
Dependency registration for SortNumberVisibility.
Declaration
public static readonly DependencyProperty SortNumberVisibilityProperty
Field Value
Type |
---|
System.Windows.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 |
---|
System.Windows.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 |
---|
System.Windows.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 |
---|---|---|
System.Windows.Size | finalSize | The final area within the parent that this object should use to arrange itself and its children. |
Returns
Type | Description |
---|---|
System.Windows.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 |
---|---|---|
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()
Invoked to apply template for TreeGridHeaderCell.
Declaration
public 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 |
---|---|
System.Windows.Automation.Peers.AutomationPeer | The class-specific AutomationPeer subclass. |
OnLostMouseCapture(MouseEventArgs)
Declaration
protected override void OnLostMouseCapture(MouseEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.MouseEventArgs | e |
OnManipulationCompleted(ManipulationCompletedEventArgs)
Declaration
protected override void OnManipulationCompleted(ManipulationCompletedEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.ManipulationCompletedEventArgs | e |
OnManipulationDelta(ManipulationDeltaEventArgs)
Declaration
protected override void OnManipulationDelta(ManipulationDeltaEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.ManipulationDeltaEventArgs | e |
OnMouseDoubleClick(MouseButtonEventArgs)
Declaration
protected override void OnMouseDoubleClick(MouseButtonEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.MouseButtonEventArgs | e |
OnMouseDown(MouseButtonEventArgs)
Occurs when mouse button is pressed over the header cell.
Declaration
protected override void OnMouseDown(MouseButtonEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.MouseButtonEventArgs | e | The System.Windows.Input.MouseButtonEventArgs that contains the event data. |
OnMouseEnter(MouseEventArgs)
Method override to set tooltip for TreeGridHeaderCell
Declaration
protected override void OnMouseEnter(MouseEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.MouseEventArgs | e |
OnMouseLeave(MouseEventArgs)
Declaration
protected override void OnMouseLeave(MouseEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.MouseEventArgs | e |
OnMouseLeftButtonDown(MouseButtonEventArgs)
Declaration
protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.MouseButtonEventArgs | e |
OnMouseLeftButtonUp(MouseButtonEventArgs)
Called before the PointerReleased event occurs.
Declaration
protected override void OnMouseLeftButtonUp(MouseButtonEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.MouseButtonEventArgs | e | The System.Windows.Input.MouseButtonEventArgs instance contains the event data. |
OnMouseMove(MouseEventArgs)
Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.MouseEventArgs | e |
OnMouseUp(MouseButtonEventArgs)
Occurs when mouse button is released over the header cell.
Declaration
protected override void OnMouseUp(MouseButtonEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.MouseButtonEventArgs | e | The System.Windows.Input.MouseButtonEventArgs that contains the event data. |
OnSortDirectionChanged(DependencyPropertyChangedEventArgs)
Declaration
protected virtual void OnSortDirectionChanged(DependencyPropertyChangedEventArgs args)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.DependencyPropertyChangedEventArgs | args |
OnTouchDown(TouchEventArgs)
Declaration
protected override void OnTouchDown(TouchEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.TouchEventArgs | e |
OnTouchUp(TouchEventArgs)
Declaration
protected override void OnTouchUp(TouchEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.TouchEventArgs | e |
ShowContextMenu()
Opens the context menu at the specified position.
Declaration
protected virtual bool ShowContextMenu()
Returns
Type | Description |
---|---|
System.Boolean | true If the context menu opened;Otherwisefalse |