GroupByArea Class

A control used by the XamDataPresenter, XamDataGrid and XamDataCarousel for managing and displaying a list of fields that are available for grouping and a list of fields that are already grouped. It also provides support for managing the contents of the lists as fields are dragged and dropped between the lists.
Public Class GroupByArea 
   Inherits GroupByAreaBase
public class GroupByArea : GroupByAreaBase 

The default style for the GroupByArea provides a UI for grouping data records based on Fields defined in the DataPresenterBase.DefaultFieldLayout. Since there is only one DataPresenterBase.DefaultFieldLayout, the GroupByArea can only provide a grouping UI for that FieldLayout. By default, the DataPresenterBase.DefaultFieldLayout is set to the FieldLayout associated with the first DataRecord encountered. When bound to flat homogeneous data this is not an issue since there is only one FieldLayout. Keep in mind that if the control is bound to non-homogeneous data or hierarchical data the grouping UI will only show the Fields from the DataPresenterBase.DefaultFieldLayout.

The GroupByArea keeps track of its expanded and collapsed state and exposes an IsExpanded property that styles can trigger of off to collapse the elements in the style's Template. The default style for the GroupByArea contains a Template that exposes a UI for expanding and collapsing the control.

Note: The GroupByArea contains the following Template Parts (Template Parts are elements with specific names and types that the control expects to find in its visual tree. They are essential to the operation of the control. If you replace the control's Template you should be sure to include elements with the required names and types):

  • Name: PART_AvailableFieldLabelsArea Type: FrameworkElement - Specifies the area where the AvailableFieldLabels list resides
  • Name: PART_GroupedFieldLabelsArea Type: FrameworkElement - Specifies the area where the GroupedFieldLabels list resides
  • Name: PART_InsertionPoint Type: FrameworkElement - Specifies the element that marks the insertion point when GroupByAreaFieldLabels are dragged and dropped

Note: The GroupByArea is automatically created by the XamDataPresenter, XamDataGrid and XamDataCarousel controls when needed. It is not intended for use outside of these controls and you should never need to create it directly.

Refer to the About Grouping topic in the Developer's Guide for an explanation of how this property is used.


Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also