GetToolInEditMode Method

Returns the logical instance of the specified tool that is currently in edit mode.

Syntax

Visual Basic

'Declaration
 
Public Shared Function GetToolInEditMode( _
   ByVal valueEditor As ValueEditor _
) As ValueEditor

C#

public static ValueEditor GetToolInEditMode( 
   ValueEditor valueEditor
)

Parameters

valueEditor

An instance of a ValueEditor derived tool that is to be evaluated.

Return Value

If valueEditor or another instance of that tool within the XamRibbon with the same RibbonToolHelper.IdProperty is in edit mode, then that instance will be returned. Otherwise, null (Nothing in VB) is returned if there is no instance of the tool currently in edit mode.

Exceptions

Exception	Description
System.ArgumentNullException	The valueEditor is null.

Requirements

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