RepositoryItemTextEdit.ShowNullValuePromptWhenReadOnly Property

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v20.1.dll

Declaration

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

<Browsable(False)>
Public Property ShowNullValuePromptWhenReadOnly As Boolean

Property Value

Remarks

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

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

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.

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

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