RepositoryItemTextEdit.NullValuePrompt Property

Gets or sets a grayed out hint displayed when the editor's value is null or empty. This property is in effect for standalone editors and for editors embedded in toolbars and Ribbon controls. Not supported for in-place editors embedded in grid and tree list controls. Not supported for read-only editors.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v20.1.dll

Declaration

[DXCategory("Behavior")]
public virtual string NullValuePrompt { get; set; }
<DXCategory("Behavior")>
Public Overridable Property NullValuePrompt As String

Property Value

Type Default Description
String

String.Empty

A string that specifies the text displayed grayed out when the edit value is empty.

Remarks

Use the NullValuePrompt property to display a hint in an editor when its value is not set.

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

NullValuePrompt

Use the RepositoryItem.NullText property to present the editor's null value with custom text.

textEdit1.Properties.NullText = "<empty>";

NullText

The following table compares these two properties in more detail.

 

NullValuePrompt property

NullText property

Supported editors

  • Standalone editors

  • Editors embedded in toolbars and Ribbon

Note: Editors embedded in grid and treelist controls do not support the NullValuePrompt.

All in-place and standalone editors

Conditions, when the property's text is displayed.

For any editor, when its edit value equals :

For DateEdit, when its value is:

For any editor, when its edit value equals :

  • null

  • System.DBNull.Value

For DateEdit, when its value is:

Read-only editors

NullValuePrompt is hidden in read-only editors

NullText is displayed in read-only editors

Focused editors

NullValuePrompt keeps displaying when an editor is focused in certain cases, provided that the RepositoryItemTextEdit.ShowNullValuePrompt option equals EditorFocused. See this topic to learn more.

NullText is automatically hidden when an editor is focused

Text color

SystemColors.GrayText

The foreground color specified by the RepositoryItem.Appearance property.

The editor's Text property.

The NullValuePrompt property doesn't affect the editor's BaseEdit.Text property.

The NullText property's value, when displayed, affects the editor's BaseEdit.Text property.

The SearchControl displays the default "Enter text to search..." string even if you have not set the NullValuePrompt property manually. To hide this text, assign a whitespace character to the NullValuePrompt property.

See Also