GetPromptChar Method (EmbeddableEditorOwnerBase)

Returns the character used as prompt during editing (e.g. '_').

Syntax

Visual Basic

'Declaration
 
Public Overridable Function GetPromptChar( _
   ByVal ownerContext As Object, _
   ByRef promptChar As Char _
) As Boolean

C#

public virtual bool GetPromptChar( 
   object ownerContext,
   out char promptChar
)

Parameters

ownerContext

The context that was passed into the GetEmbeddableElement(UIElement,EmbeddableEditorOwnerBase,Object,EmbeddableUIElementBase) method.

promptChar

Prompt character.

Return Value

True only if prompt character info is available.

Remarks

The default implementation returns false

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