Back to Devexpress

RepositoryItemSearchControl Properties

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

latest44.6 KB
Original Source

RepositoryItemSearchControl Properties

An item in an editor container’s repository used to create a SearchControl.

NameDescription
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.
ActionButtonIndexThis property is not supported by the RepositoryItemSearchControl class.
AdvancedModeOptionsGets Advanced Mode options. Inherited from RepositoryItemTextEdit.
AllowAutoApplyGets or sets whether a search is automatically performed on typing text.
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.
AllowRemoveMRUItemsGets or sets whether close (‘x’) buttons are displayed within dropdown MRU items, allowing an end-user to delete items. Inherited from RepositoryItemMRUEdit.
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.
AppearanceFocusedGets appearance settings used to paint the current editor when it is focused. Inherited from RepositoryItem.
AppearanceItemDisabledProvides access to the appearance settings used to paint list items in the disabled state. Inherited from RepositoryItemComboBox.
AppearanceItemHighlightProvides access to the appearance settings used to paint hot tracked list items if items are not automatically selected when hot tracked. Inherited from RepositoryItemComboBox.
AppearanceItemSelectedProvides access to the appearance settings used to paint list items in the selected state. Inherited from RepositoryItemComboBox.
AppearanceReadOnlyGets appearance settings used to paint the read-only editor. Inherited from RepositoryItem.
AutoCompleteGets or sets a value that specifies whether the auto completion feature is enabled. Inherited from RepositoryItemMRUEdit.
AutoHeightGets or sets a value specifying whether the editor’s height is calculated automatically to fit the editor’s content. Inherited from RepositoryItem.
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.
BestFitWidthGets or sets the editor’s best fit width. Inherited from RepositoryItem.
BorderStyleGets or sets the editor’s border style. Inherited from RepositoryItem.
ButtonsProvides access to the collection of buttons in the current SearchControl.
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.
CaseSensitiveSearchGets or sets a value indicating whether the auto completion feature is case sensitive. Inherited from RepositoryItemComboBox.
CharacterCasingGets or sets the character casing applied to the editor’s content. Inherited from RepositoryItemTextEdit.
ClientGets or sets an ISearchControlClient object whose data is filtered using the SearchControl.
CloseUpKeyGets or sets the key combination used to open and close the pop-up window. Inherited from RepositoryItemPopupBase.
ContainerGets the IContainer that contains the Component. Inherited from Component.
ContextButtonOptionsThis member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. Inherited from RepositoryItemMRUEdit.
ContextButtonsThis member supports the internal infrastructure, and is not intended to be used directly from your code. This property is not relevant for this class. Inherited from RepositoryItemMRUEdit.
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.
CycleOnDblClickGets a value indicating whether the end-user can navigate through dropdown values by double clicking the edit box. Inherited from RepositoryItemComboBox.
DefaultAlignmentGets the default horizontal alignment of the editor’s content. Inherited from RepositoryItem.
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.
DropDownItemHeightGets or sets the height of an item in the dropdown list. Inherited from RepositoryItemComboBox.
DropDownRowsGets or sets the number of items simultaneously displayed in the dropdown window. Inherited from RepositoryItemComboBox.
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 editor 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.
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.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
ExportModeThis property is not supported by the RepositoryItemSearchControl class.
FilterConditionGets or sets the comparison operator (Equals, Starts With, and so forth) used to compare the attached control’s items with the query in the search box. This property is only in effect if the SearchControl is attached to a ListBoxControl.
FindDelayGets or sets the delay for a search performed automatically on typing text.
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. Inherited from RepositoryItemComboBox.
HotTrackDropDownItemsObsolete. Gets or sets, if the items from the dropdown menu can be hot tracked. Inherited from RepositoryItemComboBox.
HotTrackItemsGets or sets whether the items in the dropdown are hot-tracked when the mouse pointer moves over them. Inherited from RepositoryItemComboBox.
HtmlImagesThis property is not supported by the RepositoryItemSearchControl class.
HtmlTemplatesStores HTML and CSS-based templates used to render combo box items. Inherited from RepositoryItemComboBox.
ImmediatePopupGets or sets a value that specifies whether the popup window is displayed immediately after an end-user has typed a character in the edit box. Inherited from RepositoryItemMRUEdit.
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 RepositoryItem.
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.
ItemAutoHeightGets or sets whether the height of items is automatically calculated to fit their entire content. Inherited from RepositoryItemComboBox.
ItemPaddingGets or sets padding within list items. Inherited from RepositoryItemComboBox.
ItemsGets the collection of items displayed by the current MRU editor. Inherited from RepositoryItemMRUEdit.
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.
MaxItemCountGets or sets the maximum number of items displayed in the editor’s dropdown list. Inherited from RepositoryItemMRUEdit.
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.
NullTextThis property is not supported by the RepositoryItemSearchControl class.
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 text specified by the RepositoryItemTextEdit.NullValuePrompt property is displayed when the editor contains an empty string.
OwnerEditGets the editor that 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.
PasswordCharThis property is not supported by the RepositoryItemSearchControl class.
PopupBorderStyleGets or sets the popup window’s border style. Inherited from RepositoryItemPopupBase.
PopupDisplayFormatInherited from RepositoryItemComboBox.
PopupFormMinSizeGets or sets the minimum size for the associated dropdown window. Inherited from RepositoryItemPopupBase.
PopupFormSizeSets the popup window’s initial size. Inherited from RepositoryItemPopupBase.
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 RepositoryItemPopupBaseAutoSearchEdit.
PropertiesObsolete. Gets an object providing properties specific to a MRU edit control. Inherited from RepositoryItemMRUEdit.
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. Inherited from RepositoryItem.
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.
SearchByCaptions
SearchByMembersAllows users to choose data fields to search in. This property is in effect when the RepositoryItemSearchControl.ShowSearchByButton property is true.
ShowClearButtonGets or sets whether the Clear Button is displayed in the SearchControl
ShowDefaultButtonsModeGets or sets the mode in which the Search and Clear buttons are displayed.
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.
ShowMRUButtonGets or sets whether the dropdown button that invokes a list of most recently used search requests is displayed.
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.
ShowPopupShadowGets or sets whether the popup window’s shadow is displayed. Inherited from RepositoryItemPopupBase.
ShowSearchButtonGets or set whether the Search Button is displayed in the SearchControl.
ShowSearchByButtonAllows users to choose data fields to search in. This property is in effect when the RepositoryItemSearchControl.SearchByMembers property contains the fields to search in.
ShowToolTipForTrimmedTextGets or sets whether tooltips are displayed for items whose text is trimmed. Inherited from RepositoryItemComboBox.
SiteGets or sets a ISite for the object. Inherited from RepositoryItem.
SortedGets or sets whether the items are sorted. Inherited from RepositoryItemComboBox.
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 the style in which text is displayed and edited in the button editor. Inherited from RepositoryItemButtonEdit.
TextPaddingGets or sets the text (value) padding within the editor. Inherited from RepositoryItemTextEdit.
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 a value indicating whether the Ctrl key must be pressed when scrolling combo box items. Inherited from RepositoryItemComboBox.
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.
UseSystemPasswordCharThis property is not supported by the RepositoryItemSearchControl class.
UseTextEditorForAutoFilterGets whether to substitute this editor with the single-line text editor in auto-filter rows. Inherited from RepositoryItemButtonEdit.
ValidateOnEnterKeyGets or sets a value specifying whether to invoke the RepositoryItem.Validating event when pressing the ENTER key. Inherited from RepositoryItemMRUEdit.
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

RepositoryItemSearchControl Class

RepositoryItemSearchControl Members

DevExpress.XtraEditors.Repository Namespace