FromKeyButton Method (CheckItems)

Retrieves a button from the current button group based on that button's Key value.

Syntax

Visual Basic

'Declaration
 
Public Function FromKeyButton( _
   ByVal key As String _
) As TBarButton

C#

public TBarButton FromKeyButton( 
   string key
)

Parameters

key

The key value of the button being searched for.

Return Value

An instance of the first TBarButton found with the given key, or null (Nothing in Visual Basic .NET) if no such button was found.

Remarks

The comparison of the keys are case-sensitive.

It is the application developer's responsibility not to add buttons with the same Key value to the collection of toolbar items. For optimal performance and robustness, the avoidance of using duplicate keys within the same UltraWebToolbar is recommended.

Requirements

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