EditHeader(HeaderBase) Method

Puts the specified header into edit mode so that the user can edit the header caption.

Syntax

Visual Basic

'Declaration
 
Public Overloads Function EditHeader( _
   ByVal header As HeaderBase _
) As Boolean

C#

public bool EditHeader( 
   HeaderBase header
)

Parameters

header

The header to enter edit mode.

Return Value

True if the header successfully entered edit mode; otherwise false.

Remarks

A header can appear more than once - in multiple scroll regions, or inside a row in RowLayout mode. This overload will try to find a header element in the ActiveColScrollRegion and ActiveRowScrollRegion to edit. If it does no find such an element, the method will fail.

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