GetMaskInfo Method (EmbeddableEditorOwnerBase)

Returns masking information. This is only of ibterest to a editor that supports masking.

Syntax

Visual Basic

'Declaration
 
Public Overridable Function GetMaskInfo( _
   ByVal ownerContext As Object, _
   ByRef mask As String, _
   ByRef dataMode As MaskMode, _
   ByRef displayMode As MaskMode, _
   ByRef clipMode As MaskMode _
) As Boolean

C#

public virtual bool GetMaskInfo( 
   object ownerContext,
   out string mask,
   out MaskMode dataMode,
   out MaskMode displayMode,
   out MaskMode clipMode
)

Parameters

ownerContext

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

mask

The string used for masking the value or null if there is no mask.

dataMode

Determines whether literals and prompt characters are included in Value property of the Editor.

displayMode

Determines whether literals and prompt characters are displayed when not in edit mode.

clipMode

Determines whether literals and prompt characters are included when the editor copyies text to the clipboard.

Return Value

True only if masking 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