Back to Devexpress

RepositoryItemLookUpEdit Properties

windowsforms-devexpress-dot-xtraeditors-dot-repository-dot-repositoryitemlookupedit-dot-underscore-properties.md

latest45.4 KB
Original Source

RepositoryItemLookUpEdit Properties

Contains settings specific to a lookup editor.

NameDescription
AcceptEditorTextAsNewValueGets or sets whether a custom value (a value that is not present in the lookup data source) that is entered in the edit box is accepted by the editor (when the value is validated and editor loses focus). This property supports ComboBox mode for the lookup editor.
AccessibleDefaultActionDescriptionGets or sets the default action description of the repository item for use by accessibility client applications. Inherited from RepositoryItem.
AccessibleDescriptionGets or sets the object’s description used by accessibility client applications. Inherited from RepositoryItem.
AccessibleNameGets or sets the object’s name used by accessibility client applications. Inherited from RepositoryItem.
AccessibleRoleGets or sets the object’s accessible role. Inherited from RepositoryItem.
ActionButtonIndexGets or sets a value specifying which editor button will open the editor’s dropdown window. Inherited from RepositoryItemPopupBase.
AdvancedModeOptionsGets Advanced Mode options. Inherited from RepositoryItemTextEdit.
AllowButtonNavigationGets or sets whether to allow users to focus ButtonEdit buttons with the keyboard. Inherited from RepositoryItemButtonEdit.
AllowContextImageChangeAnimationGets or sets whether the context image is changed using animation. This property is not in effect for in-place editors. Inherited from RepositoryItemTextEdit.
AllowDropDownWhenReadOnlyGets or sets whether an editor’s dropdown can be displayed when the editor is in the read-only state. Inherited from RepositoryItemPopupBase.
AllowFocusedGets or sets a value specifying whether the focus rectangle is displayed within the editor when it has focus. Inherited from RepositoryItem.
AllowFocusedAppearanceGets a value which indicates whether the appearance settings used to paint the editor when it’s focused can be used. Inherited from RepositoryItem.
AllowGlyphSkinningGets or sets whether this TextEdit can colorize its icons. Inherited from RepositoryItemTextEdit.
AllowHtmlDrawGets or sets whether HTML tags can be used to format an editor’s text or text of the editor’s items. Inherited from RepositoryItem.
AllowInplaceAutoFilterThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
AllowInplaceBorderPainterThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
AllowMouseWheelGets or sets whether value scrolling via the Mouse Wheel is supported by the editor. Inherited from RepositoryItemTextEdit.
AllowNullInputGets or sets whether end users can reset the editor’s value to null with the keyboard. Inherited from RepositoryItemTextEdit.
AllowUpdatePopupWidthGets whether it is allowed to update popup width.
AppearanceGets appearance settings used to paint the editor when it is enabled. Inherited from RepositoryItem.
AppearanceDisabledGets appearance settings used to paint the editor when it is disabled. Inherited from RepositoryItem.
AppearanceDropDownGets appearance settings used to paint the editor’s popup window. Inherited from RepositoryItemPopupBase.
AppearanceDropDownHeaderGets the header panel’s appearance settings.
AppearanceFocusedGets appearance settings used to paint the current editor when it is focused. Inherited from RepositoryItem.
AppearanceReadOnlyGets appearance settings used to paint the read-only editor. Inherited from RepositoryItem.
AutoHeightGets or sets a value specifying whether the editor’s height is calculated automatically to fit the editor’s content. Inherited from RepositoryItem.
AutoSearchColumnIndexGets or sets the visible column index against which an incremental search is performed in SearchMode.AutoComplete and SearchMode.OnlyInPopup modes.
BeepOnErrorGets or sets whether the masked editor should play a system error sound when a user enters an invalid character (for example, a literal in an editor with a Numeric mask). This property replaces the DevExpress.XtraEditors.Mask.MaskProperties.BeepOnError property. Inherited from RepositoryItemTextEdit.
BestFitModeGets or sets the “best-fit” mode for columns in the dropdown window. Inherited from RepositoryItemLookUpEditBase.
BestFitRowCountSpecifies the maximum number or rows that are processed when invoking the “best-fit” functionality.
BestFitWidthGets or sets the editor’s best fit width. Inherited from RepositoryItem.
BorderStyleGets or sets the editor’s border style. Inherited from RepositoryItem.
ButtonsReturns the collection of buttons in the current button editor. Inherited from RepositoryItemButtonEdit.
ButtonsBorderStyleObsolete. This member is not supported. Inherited from RepositoryItemButtonEdit.
ButtonsStyleGets or sets the style used to draw editor buttons. Inherited from RepositoryItemButtonEdit.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
CascadingMemberGets or sets the name(s) of the foreign key field(s) by which the popup data source of the lookup editor is filtered. The field must be editable and accept new values (read-only fields are not supported). Inherited from RepositoryItemLookUpEditBase.
CaseSensitiveSearchGets or sets whether the end-user needs to type text matching the case when performing an incremental search.
CharacterCasingGets or sets the character casing applied to the editor’s content. Inherited from RepositoryItemTextEdit.
CheckBoxSelectorMemberGets or sets the name of the data source field that specifies whether the item is selected.
CloseUpKeyGets or sets the key combination used to open and close the pop-up window. Inherited from RepositoryItemPopupBase.
ColumnsProvides access to the collection of columns displayed in the dropdown window.
ContainerGets the IContainer that contains the Component. Inherited from Component.
ContextButtonOptionsProvides access to the settings applied to the context buttons displayed by editor items. Inherited from RepositoryItemPopupBase.
ContextButtonsProvides access to the collection of context buttons displayed by editor items. Inherited from RepositoryItemPopupBase.
ContextImageGets or sets a custom image displayed in the editor. This property is obsolete. Use the ContextImageOptions property instead. Inherited from RepositoryItemTextEdit.
ContextImageAlignmentGets or sets the alignment of an image displayed by this editor. Inherited from RepositoryItemTextEdit.
ContextImageOptionsProvides access to all properties that allow you to assign and customize a custom image displayed at the editor’s edge. Inherited from RepositoryItemTextEdit.
ContextMenuGets or sets the context menu for the editor. Inherited from RepositoryItem.
DataSourceGets or sets the source of data displayed in the dropdown window. Inherited from RepositoryItemLookUpEditBase.
DefaultAlignmentGets the default alignment of the editor’s contents when the editor operates as an inplace control. Inherited from RepositoryItemLookUpEditBase.
DefaultBorderStyleInBarsThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
DefaultBorderStyleInGridThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DisplayFormatGets format settings applied to the editor’s value. Inherited from RepositoryItem.
DisplayMemberGets or sets the field whose values are displayed in the edit box. Inherited from RepositoryItemLookUpEditBase.
DropDownItemHeightGets or sets the height of a row in the dropdown (in pixels).
DropDownRowsGets or sets the height of the dropdown (in rows).
EditableGets whether the editor’s value can be changed. Inherited from RepositoryItem.
EditFormatProvides access to the settings used to format the edit value when the editor has input focus. Inherited from RepositoryItem.
EditorTypeNameGets the class name of an edit control corresponding to the current repository item.
EditValueChangedDelayGets or sets the time interval between the moment when an end-user stops changing the editor’s value and the RepositoryItem.EditValueChanged event being raised. Inherited from RepositoryItem.
EditValueChangedFiringDelay staticGets or sets the default time interval between the moment when an end-user stops changing the editor’s value and the RepositoryItem.EditValueChanged event being raised. Inherited from RepositoryItem.
EditValueChangedFiringModeGets or sets the RepositoryItem.EditValueChanged event’s firing mode. Inherited from RepositoryItem.
EditValueTypeGets or sets whether the editor’s EditValue property returns a selected item, a list of selected items, or a string that combines DisplayMember property values of selected items.
EnabledGets or sets a value indicating whether the edit control can respond to user actions. This property is supported for standalone editors. Inherited from RepositoryItem.
EnableEditValueCollectionEditingGets or sets whether you can bind the LookUpEdit.EditValue property to a read-only property of a collection type. With this option enabled, the editor calls the collection’s methods to add and remove items.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
ExportModeSpecifies whether the editor’s value or display text is exported when data is exported to XLS and CSV formats. Inherited from RepositoryItem.
HeaderClickModeGets or sets which functionality is invoked as a result of clicking a column header within the dropdown.
HideSelectionGets or sets whether the selection is hidden when moving focus to another control. Inherited from RepositoryItemTextEdit.
HighlightedItemStyleSpecifies how selected and hot-tracked items are highlighted within the control’s popup window.
HotTrackItemsGets or sets a value specifying whether the items in the popup window are hottracked when the mouse pointer passes over them.
HotTrackRowsObsolete. Gets or sets a value specifying whether the rows in the popup window are hot-tracked when the mouse pointer passes over them.
HtmlImagesGets or sets a collection of images that can be embedded in the editor’s display text or the display text of the editor’s items, using the image tag. Inherited from RepositoryItem.
ImmediatePopupGets or sets whether the popup window is displayed immediately after an end-user has typed a character in the edit box. Inherited from RepositoryItemPopupBaseAutoSearchEdit.
InplaceModeImmediatePostChangesGets or sets whether the in-place editor posts its value to the bound data source immediately after the popup is closed. Inherited from RepositoryItemPopupBase.
IsDesignModeIndicates whether the editor is currently in design mode. Inherited from RepositoryItem.
IsDisposedGets a value indicating whether the control has been disposed of. Inherited from RepositoryItem.
IsEditValueChangedEventPendingGets whether the EditValueChanged event is postponed. Inherited from RepositoryItem.
IsFilterLookUpThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItemLookUpEditBase.
IsLoadingIndicates whether the editor is being loaded. Inherited from RepositoryItem.
IsLockUpdateGets a value indicating whether the editor is immediately updated in response to changing its settings. Inherited from RepositoryItem.
IsNonSortableEditorThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
KeyMemberGets or sets a string that specifies a key field (or multiple key fields) used for business object identification (when a lookup editor is bound to a business object). Inherited from RepositoryItemLookUpEditBase.
LinkCountGets the number of objects connected to the current repository item. Inherited from RepositoryItem.
LookAndFeelProvides access to the stand-alone editor’s look and feel settings. These settings are not in effect for the editor in a bar, ribbon, grid, etc. Inherited from RepositoryItem.
MaskThis member supports the .NET Framework infrastructure and cannot be used directly from your code. Inherited from RepositoryItemPopupBaseAutoSearchEdit.
MaskBoxPaddingGets or sets the amount of space around the text box embedded in the TextEdit. Inherited from RepositoryItemTextEdit.
MaskSettingsFor internal use. Inherited from RepositoryItemPopupBaseAutoSearchEdit.
MaxDisplayTextLengthGets or sets the maximum number of characters displayed in the edit box.
MaxLengthGets or sets the maximum number of characters an end-user can enter into the editor. Inherited from RepositoryItemTextEdit.
MaxToolTipTextLength staticGets or sets the maximum number of characters in the automatically generated tooltip displayed for an in-place editor. Inherited from RepositoryItemTextEdit.
NameGets or sets the repository item name. Inherited from RepositoryItem.
NormalizeDisplayText staticSet the NormalizeDisplayText property to true to correctly process diacritics when selecting rows from a dropdown window in the LookUpEdit control. Inherited from RepositoryItem.
NullTextGets or sets the text that presents the editor’s null value ( null , System.DBNull.Value and RepositoryItemDateEdit.NullDate - for DateEdit). Inherited from RepositoryItem.
NullValuePromptGets 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. Inherited from RepositoryItemTextEdit.
NullValuePromptForeColorInherited from RepositoryItemTextEdit.
NullValuePromptShowForEmptyValueGets or sets whether the editor displays a prompt when its value is not specified (equals String.Empty). Inherited from RepositoryItemTextEdit.
OwnerEditGets the editor which owns the current repository item object.
OwnerItemThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
PaddingGets or sets the TextEdit padding. The MemoEdit does not fully support this property, use the MaskBoxPadding property instead. Inherited from RepositoryItemTextEdit.
PasswordCharGets or sets the password character that appears instead of actual characters. Inherited from RepositoryItemTextEdit.
PopupBorderStyleGets or sets the popup window’s border style. Inherited from RepositoryItemPopupBase.
PopupFilterModeGets or sets how data records in the popup window are filtered.
PopupFormMinSizeGets or sets the minimum size for the associated dropdown window. Inherited from RepositoryItemPopupBase.
PopupFormSizeThis property is not supported by the RepositoryItemLookUpEdit class.
PopupFormWidthGets or sets the popup window’s width. Inherited from RepositoryItemPopupBase.
PopupOffsetGets or sets the popup window’s location. Inherited from RepositoryItem.
PopupResizeModeGets or sets whether the popup window’s contents are displayed during resize operations. Inherited from RepositoryItemPopupBase.
PopupSizeableGets or sets a value indicating whether the dropdown window is sizeable. Inherited from RepositoryItemLookUpEditBase.
PopupWidthGets or sets the width of the dropdown window (in pixels).
PopupWidthModeGets or sets whether the initial popup width matches the editor or content width. Inherited from RepositoryItemLookUpEditBase.
PropertiesObsolete. Gets an object providing properties specific to the popup control. Inherited from RepositoryItemPopupBase.
ReadOnlyGets or sets a value specifying whether the editor’s value can be changed by end-users. Inherited from RepositoryItem.
RequireDisplayTextSortingThis member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
ResetTextEditStyleToStandardInFilterControlGets or sets whether the RepositoryItemButtonEdit.TextEditStyle property is automatically set to TextEditStyles.Standard, when the editor is displayed within a FilterControl and FilterEditorControl. Inherited from RepositoryItemButtonEdit.
SearchModeGets or sets whether to immediately apply the found value to the editor as a user types a query, or only highlight the found value in the drop-down window.
SelectFirstRowOnEnterKeyGets or sets whether the LookUp selects the first found item in the drop-down list when the user presses Enter.
SeparatorCharGets or sets the character that separates selected items in the edit box.
ShowDropDownGets or sets whether the popup window can be opened by clicking the edit box and whether a single or double click is required. Inherited from RepositoryItemPopupBase.
ShowFooterGets or sets whether the dropdown window’s footer region is visible. Inherited from RepositoryItemLookUpEditBase.
ShowHeaderGets or sets the visibility of column headers.
ShowLinesGets or sets the visibility of vertical lines separating columns in the dropdown.
ShowNullValuePromptGets or sets conditions under which this editor should display its null value text (see the NullValuePrompt property). Inherited from RepositoryItemTextEdit.
ShowNullValuePromptWhenFocusedGets or sets whether the focused editor displays a prompt when its value is not specified. Inherited from RepositoryItemTextEdit.
ShowNullValuePromptWhenReadOnlyGets or sets whether the read-only editor displays a prompt when its value is not specified. Inherited from RepositoryItemTextEdit.
ShowPopupButtonsGets or sets whether to display OK and Cancel buttons in the popup.
ShowPopupShadowGets or sets whether the popup window’s shadow is displayed. Inherited from RepositoryItemPopupBase.
SiteGets or sets a ISite for the object. Inherited from RepositoryItem.
SortColumnIndexGets or sets the column index against which data is sorted.
SuppressMouseEventOnOuterMouseClickAllows you to suppress mouse events when clicking outside an open popup menu. Inherited from RepositoryItemPopupBase.
TagGets or sets the data associated with the repository item. Inherited from RepositoryItem.
TextEditStyleGets or sets a value that specifies whether users can type in the lookup’s text box.
TextPaddingGets or sets the text (value) padding within the editor. Inherited from RepositoryItemTextEdit.
ThrowExceptionOnInvalidLookUpEditValueTypeGets or sets whether the LookUp editor automatically detects data type issues and throws an exception. Inherited from RepositoryItemLookUpEditBase.
UseAdvancedModeSwitches the editor to Advanced Mode. This mode supports new caret and selection animations, emojis, and embedded labels. You can set up properties from the RepositoryItemTextEdit.AdvancedModeOptions group to choose which Advanced Mode features are enabled. Inherited from RepositoryItemTextEdit.
UseCtrlScrollGets or sets whether you should use the CTRL+UP-DOWN ARROW/CTRL+MOUSE WHEEL or UP-DOWN ARROW/MOUSE WHEEL combinations to scroll lookup records when the pop-up window is closed. Inherited from RepositoryItemLookUpEditBase.
UseDropDownRowsAsMaxCountGets or sets whether the number of visible data rows limits the height of the dropdown window.
UseMaskAsDisplayFormatFor internal use. Inherited from RepositoryItemPopupBaseAutoSearchEdit.
UseParentBackgroundThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
UseReadOnlyAppearanceGets or sets whether the TextEdit is grayed out in the read only mode. Inherited from RepositoryItemTextEdit.
UseSystemPasswordCharGets or sets whether password mode is active and the system password character is used to mask the editor’s text. Inherited from RepositoryItemTextEdit.
UseTextEditorForAutoFilterGets whether to substitute this editor with the single-line text editor in auto-filter rows. Inherited from RepositoryItemButtonEdit.
ValidateOnEnterKeyGets or sets whether to raise the RepositoryItem.Validating event on pressing the ENTER key. Inherited from RepositoryItemTextEdit.
ValueMemberGets or sets the field name whose values identify dropdown rows. Inherited from RepositoryItemLookUpEditBase.
XlsxFormatStringGets or sets the native Excel format string used to format the editor’s value when exporting to XLSX. This property is in effect in WYSIWYG export mode. Inherited from RepositoryItemTextEdit.

See Also

RepositoryItemLookUpEdit Class

RepositoryItemLookUpEdit Members

DevExpress.XtraEditors.Repository Namespace