Class GroupDropArea
Represents a class that provides the common functionalities of the group drop area control.
Inheritance
Implements
Namespace: Syncfusion.UI.Xaml.Grid
Assembly: Syncfusion.SfGrid.WPF.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 |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the GroupDropAreaText dependency property.
IsExpandedProperty
Identifies the IsExpanded dependency property.
Declaration
public static readonly DependencyProperty IsExpandedProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Remarks
The identifier for the IsExpanded dependency property.
WatermarkTextVisibilityProperty
Identifies the WatermarkTextVisibility dependency property.
Declaration
public static readonly DependencyProperty WatermarkTextVisibilityProperty
Field Value
| Type |
|---|
| System.Windows.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 |
|---|---|
| System.Windows.Visibility | One of the System.Windows.Visibility enumeration values that specifies whether the watermark is visible. The default value is System.Windows.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()
Declaration
public override void OnApplyTemplate()
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. |
ShowContextMenu()
Declaration
protected virtual bool ShowContextMenu()
Returns
| Type |
|---|
| System.Boolean |