Class GroupDropArea

Represents a class that provides the common functionalities of the group drop area control.

Inheritance

System.Object

GroupDropArea

Implements

System.IDisposable

Namespace: Syncfusion.UI.Xaml.DataGrid

Assembly: Syncfusion.Grid.WinUI.dll

Syntax

public class GroupDropArea : Control, IDisposable

Remarks

The GroupDropArea is displayed above the SfDataGrid when ShowGroupDropArea is true. It accepts column headers dragged from the SfDataGrid and visually represents the columns that are currently used to group the underlying data.

Constructors

GroupDropArea()

Initializes a new instance of the GroupDropArea class.

Declaration

public GroupDropArea()

Fields

GroupDropAreaTextProperty

Identifies the GroupDropAreaText dependency property.

Declaration

public static readonly DependencyProperty GroupDropAreaTextProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

Remarks

The identifier for the GroupDropAreaText dependency property.

IsExpandedProperty

Identifies the IsExpanded dependency property.

Declaration

public static readonly DependencyProperty IsExpandedProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

Remarks

The identifier for the IsExpanded dependency property.

WatermarkTextVisibilityProperty

Identifies the WatermarkTextVisibility dependency property.

Declaration

public static readonly DependencyProperty WatermarkTextVisibilityProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

Remarks

The identifier for the WatermarkTextVisibility dependency property.

Properties

GroupDropAreaText

Gets or sets the text that is displayed in the GroupDropArea when no columns are grouped.

Declaration

public string GroupDropAreaText { get; set; }

Property Value

Type	Description
System.String	The watermark text shown in the group drop area.

IsExpanded

Gets or sets a value indicating whether the GroupDropArea is expanded.

Declaration

public bool IsExpanded { get; set; }

Property Value

Type	Description
System.Boolean	true if the group drop area is expanded; otherwise, false. The default value is false.

WatermarkTextVisibility

Gets or sets the visibility of the watermark text displayed in the GroupDropArea.

Declaration

public Visibility WatermarkTextVisibility { get; set; }

Property Value

Type	Description
Microsoft.UI.Xaml.Visibility	One of the Microsoft.UI.Xaml.Visibility enumeration values that specifies whether the watermark is visible. The default value is Microsoft.UI.Xaml.Visibility.Visible.

Methods

Dispose()

Disposes all the resources used by the GroupDropArea class.

Declaration

public void Dispose()

Dispose(Boolean)

Disposes all the resources used by the GroupDropArea 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.

OnApplyTemplate()

Builds the visual tree for the GroupDropArea when a new template is applied.

Declaration

protected override void OnApplyTemplate()

Remarks

This method is invoked when the control template is applied. It wires up the required template parts (such as the panel that hosts the group drop area items) and initializes the group drop area contents.

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.

OnHolding(HoldingRoutedEventArgs)

When long press on SfDataGrid Cell, Context menu appears for the selected cell. We are using this event for context menu support in Group Drop Area.

Declaration

protected override void OnHolding(HoldingRoutedEventArgs e)

Parameters

Type	Name	Description
Microsoft.UI.Xaml.Input.HoldingRoutedEventArgs	e	Holding event arguments

OnRightTapped(RightTappedRoutedEventArgs)

When Right click SfDataGrid Cell, Context menu appears for the selected cell. We are using this event for context menu support in Group drop area cell.

Declaration

protected override void OnRightTapped(RightTappedRoutedEventArgs e)

Parameters

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

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