HeaderCheckBoxSynchronization Property

Determines which cells will be synchronized with the Header checkbox.

Syntax

Visual Basic

'Declaration
 
Public Property HeaderCheckBoxSynchronization As HeaderCheckBoxSynchronization

C#

public HeaderCheckBoxSynchronization HeaderCheckBoxSynchronization {get; set;}

Example

This snippet demonstrates how to set the Header CheckBox related properties on the UltraGridOverride class.

Visual Basic

Private Sub SetupGrid(ByRef grid As UltraGrid) 

    'Return if no grid is supplied.
    '
    If grid Is Nothing Then 
        Exit Sub 
    End If 
    

    ' Set the HeaderCheckBoxVisibility so it will display the CheckBox whenever a CheckEditor is used within the UltraGridColumn 
    ' 
    grid.DisplayLayout.Override.HeaderCheckBoxVisibility = HeaderCheckBoxVisibility.WhenUsingCheckEditor 
    

    ' Set the HeaderCheckBoxAlignment so the CheckBox will appear to the Right of the caption. 
    ' 
    grid.DisplayLayout.Override.HeaderCheckBoxAlignment = HeaderCheckBoxAlignment.Right 
    

    ' Set the HeaderCheckBoxSynchronization so all rows within the GridBand will be synchronized with the CheckBox 
    ' 
    grid.DisplayLayout.Override.HeaderCheckBoxSynchronization = HeaderCheckBoxSynchronization.Band
 
End Sub

C#

private void SetupGrid(UltraGrid grid)
{

    //Return if no grid is supplied.
    if (grid == null)
        return;


    // Set the HeaderCheckBoxVisibility so it will display the CheckBox whenever a CheckEditor is used within the UltraGridColumn
    //
    grid.DisplayLayout.Override.HeaderCheckBoxVisibility = HeaderCheckBoxVisibility.WhenUsingCheckEditor;


    // Set the HeaderCheckBoxAlignment so the CheckBox will appear to the Right of the caption.
    //
    grid.DisplayLayout.Override.HeaderCheckBoxAlignment = HeaderCheckBoxAlignment.Right;


    // Set the HeaderCheckBoxSynchronization so all rows within the GridBand will be synchronized with the CheckBox
    //
    grid.DisplayLayout.Override.HeaderCheckBoxSynchronization = HeaderCheckBoxSynchronization.Band;
}

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, 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