RepositoryItemTextEdit.NullValuePromptShowForEmptyValue Property

Gets or sets whether the editor displays a prompt when its value is not specified (equals String.Empty).

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[Browsable(false)]
[EditorBrowsable(EditorBrowsableState.Never)]
public virtual bool NullValuePromptShowForEmptyValue { get; set; }

VB.NET

<Browsable(False)>
<EditorBrowsable(EditorBrowsableState.Never)>
Public Overridable Property NullValuePromptShowForEmptyValue As Boolean

Property Value

Type	Default	Description
Boolean	false	true if the editor displays a prompt when its value is not specified (equals String.Empty); 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.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the NullValuePromptShowForEmptyValue property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-mvvm-best-practices/CS/POCOBindableProperties/StandardDataBindingUserControl.cs#L20

editor.Properties.NullValuePrompt = "Please, enter the Title here...";
editor.Properties.NullValuePromptShowForEmptyValue = true;

winforms-grid-customize-find-panel/CS/MyXtraGrid/MyFindControl.cs#L45

    be.Properties.NullValuePrompt = "MyCustomPanel";
    be.Properties.NullValuePromptShowForEmptyValue = true;
}

winforms-scheduler-sync-google-event-colors-with-labels/CS/SchedulerGSync/SchedulerGSync/SyncOptionsForm.cs#L15

Service = service;
this.lookUpEdit1.Properties.NullValuePromptShowForEmptyValue = false;
this.lookUpEdit1.Properties.AllowNullInput = DevExpress.Utils.DefaultBoolean.False;

VB.NET

winforms-mvvm-best-practices/VB/POCOBindableProperties/StandardDataBindingUserControl.vb#L20

editor.Properties.NullValuePrompt = "Please, enter the Title here..."
editor.Properties.NullValuePromptShowForEmptyValue = True

winforms-grid-customize-find-panel/VB/MyXtraGrid/MyFindControl.vb#L42

    be.Properties.NullValuePrompt = "MyCustomPanel"
    be.Properties.NullValuePromptShowForEmptyValue = True
End Sub

winforms-scheduler-sync-google-event-colors-with-labels/VB/SchedulerGSync/SchedulerGSync/SyncOptionsForm.vb#L18

Me.Service = service
Me.lookUpEdit1.Properties.NullValuePromptShowForEmptyValue = False
Me.lookUpEdit1.Properties.AllowNullInput = DevExpress.Utils.DefaultBoolean.False