Class CaptionSummaryRowControl

Represents the class that provides the common functionalities of CaptionSummaryRow in SfDataGrid.

Inheritance
System.Object
DataGridRowControl
CaptionSummaryRowControl
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.UI.Xaml.DataGrid
Assembly: Syncfusion.Grid.WinUI.dll
Syntax
public class CaptionSummaryRowControl : DataGridRowControl, IDisposable
Remarks

Caption summary row displays the summary information at the header of each group in SfDataGrid.

Constructors

CaptionSummaryRowControl()

Initializes a new instance of CaptionSummaryRowControl class.

Declaration
public CaptionSummaryRowControl()

Fields

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.

Properties

IsExpanded

Gets or sets a value indicating whether the CaptionSummaryRow is expanded or collapsed.

Declaration
public bool IsExpanded { get; set; }
Property Value
Type Description
System.Boolean

true if the CaptionSummaryRow is expanded; otherwise, false. The default value is false.
Remarks

When set to true, the records under the group are visible; otherwise, the records are hidden.

Methods

ArrangeOverride(Size)

Provides the behaviour for the "Arrange" pass of layout. Positions the row panel and clips the expander border based on the visible column line of the group.

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(Boolean)

Disposes all the resources used by the CaptionSummaryRowControl class. Unwires the loaded and unloaded event handlers and releases the row panel, expander border, and callback references.

Declaration
protected override void Dispose(bool isDisposing)
Parameters
Type Name Description
System.Boolean isDisposing

Indicates whether the call is from Dispose method or from a finalizer.
Overrides

OnApplyTemplate()

Invoked to apply the control template for the CaptionSummaryRowControl. Resolves the PART_CaptionSummaryRowGrid and PART_CaptionSummaryRowBorder template parts and synchronizes the IsExpanded state with the underlying Group.

Declaration
protected override void OnApplyTemplate()
Overrides

OnPointerPressed(PointerRoutedEventArgs)

Called before the PointerPressed event occurs. Captures the pointer position and the left-button state so the click can be validated in OnPointerReleased(PointerRoutedEventArgs).

Declaration
protected override void OnPointerPressed(PointerRoutedEventArgs e)
Parameters
Type Name Description
Microsoft.UI.Xaml.Input.PointerRoutedEventArgs e

The Microsoft.UI.Xaml.Input.PointerRoutedEventArgs that contains the event data.

OnPointerReleased(PointerRoutedEventArgs)

Called before the PointerReleased event occurs. Toggles the expand state of the group when a valid press and release occur on the caption row.

Declaration
protected override void OnPointerReleased(PointerRoutedEventArgs e)
Parameters
Type Name Description
Microsoft.UI.Xaml.Input.PointerRoutedEventArgs e

The Microsoft.UI.Xaml.Input.PointerRoutedEventArgs that contains the event data.
Overrides

Implements

System.IDisposable