CheckBoxVisibility Property

Determines whether the Header checkbox is visible.

Syntax

Visual Basic

'Declaration
 
Public Property CheckBoxVisibility As HeaderCheckBoxVisibility

C#

public HeaderCheckBoxVisibility CheckBoxVisibility {get; set;}

Example

The snippet demonstrates how to set the Header CheckBox related properties on the ColumnHeader class

Visual Basic

Private Sub SetupColumnWithHeaderCheckBox(ByRef column As UltraGridColumn) 
    
    'Return if no column is supplied. 
    If column Is Nothing Then 
        Exit Sub 
    End If 
    
    
    ' Set the Header's CheckBoxVisibility so it will display the CheckBox if a CheckEditor is used for the UltraGridColumn 
    ' 
    column.Header.CheckBoxVisibility = HeaderCheckBoxVisibility.WhenUsingCheckEditor 
    
    
    ' Set the Header's CheckBoxAlignment so the CheckBox will appear to the Right of the caption. 
    ' 
    column.Header.CheckBoxAlignment = HeaderCheckBoxAlignment.Right 
    
    
    ' Set the Header's CheckBoxSynchronization so all rows within the GridBand will be synchronized with the CheckBox 
    ' 
    column.Header.CheckBoxSynchronization = HeaderCheckBoxSynchronization.Band 

End Sub

C#

private void SetupColumnWithHeaderCheckBox(UltraGridColumn column)
{

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


    // Set the Header's CheckBoxVisibility so it will display the CheckBox if a CheckEditor is used for the UltraGridColumn
    //
    column.Header.CheckBoxVisibility = HeaderCheckBoxVisibility.WhenUsingCheckEditor;


    // Set the Header's CheckBoxAlignment so the CheckBox will appear to the Right of the caption.
    //
    column.Header.CheckBoxAlignment = HeaderCheckBoxAlignment.Right;


    // Set the Header's CheckBoxSynchronization so all rows within the GridBand will be synchronized with the CheckBox
    //
    column.Header.CheckBoxSynchronization = 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