RepositoryItemTextEdit.ShowNullValuePromptWhenFocused Property

Gets or sets whether the focused editor displays a prompt when its value is not specified.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v19.2.dll

Declaration

C#

[Browsable(false)]
public bool ShowNullValuePromptWhenFocused { get; set; }

VB.NET

<Browsable(False)>
Public Property ShowNullValuePromptWhenFocused As Boolean

Property Value

Type	Default	Description
Boolean	**false**	true, if the focused editor displays a prompt when its value is not specified; otherwise, false.

Remarks

The editor can display a prompt when its value is not specified. Use the NullValuePrompt property to specify the prompt.

C#

textEdit1.Properties.NullValuePrompt = "Enter text to search...";

VB.NET

textEdit1.Properties.NullValuePrompt = "Enter text to search..."

The ShowNullValuePrompt property provides access to the following flags that specify when the prompt is shown:

• EmptyValue — the prompt is displayed when the editor’s value equals String.Empty or null (Nothing in VB). Disable this option to only display the prompt when the editor’s value equals null (Nothing in VB).

  This option is equivalent to the NullValuePromptShowForEmptyValue property.

• EditorReadOnly — the prompt is displayed when the editor is in the read-only and editable states. Disable this option to only display the prompt when the editor is editable.

  This option is equivalent to the ShowNullValuePromptWhenReadOnly property.

• EditorFocused — the prompt is displayed when the editor is focused and not focused. Disable this option to only display the prompt when the editor is not focused.

  This option is equivalent to the ShowNullValuePromptWhenFocused property.

The prompt disappears when the user clicks the focused editor or starts to enter a value. The prompt does not appear again if the user clears the entered value.

You can specify the flags in the Properties window.

The snippet below shows how to specify the flags in code.

C#

textEdit1.Properties.ShowNullValuePrompt =
    ShowNullValuePromptOptions.EditorFocused | ShowNullValuePromptOptions.EmptyValue;

VB.NET

textEdit4.Properties.ShowNullValuePrompt =
    ShowNullValuePromptOptions.EditorFocused Or ShowNullValuePromptOptions.EmptyValue

Note

Since version 19.2, all options are enabled — the default value is Default. For previous versions, all options are disabled — the default value is NullValue.

See Version Compatibility: Default Property Values for more information about changes introduced in specific versions.