Back to Devexpress

TreeListOptionsFind Members

windowsforms-devexpress-dot-xtratreelist-dot-columns-dot-treelistoptionsfind-dot-underscore-members.md

latest8.5 KB
Original Source

TreeListOptionsFind Members

Provides access to the Find Panel‘s view and behavior settings.

Constructors

NameDescription
TreeListOptionsFind(TreeList)Initializes a new instance of the TreeListOptionsFind class.

Fields

NameDescription
DefaultFilterColumnsStringReturns ‘*’ which means that the search is performed against all visible columns.

Properties

NameDescription
AllowFindPanelGets or sets whether the Find Panel can be invoked by an end-user.
AllowIncrementalSearchGets or sets whether or not end-users can utilize incremental search to find required records.
AllowMruItemsGets or sets whether the Find Panel keeps the history of recently used search items. Users can access and re-apply search items from a dropdown list.
AlwaysVisibleGets or sets whether the Find Panel is always visible.
BehaviorGets or sets whether records that do not match a query in the find panel are hidden.
ClearFindOnCloseGets or sets whether the Find Panel’s search (filter) string is cleared when the Find Panel is hidden.
ConditionGets or sets the operator (Starts With, Contains, etc.) used to evaluate words in cells against keywords in the Find Panel.
ExpandNodesOnIncrementalSearchGets or sets whether or not the TreeList should expand collapsed nodes that contain records which match the text an end-user types.
ExpandNodesOnSearchGets or sets whether to expand a node if its child nodes contain the search string.
FindDelayGets or sets the delay in milliseconds, after which a data search is initiated (if automatic search mode is active).
FindFilterColumnsGets or sets the field names against which searches are performed by the Find Panel.
FindModeGets or sets whether data searches start automatically, or must be started manually.
FindNullPromptGets or sets the text displayed grayed out when the search box is empty.
HighlightFindResultsGets or sets whether the search string is highlighted within located records.
ParserKindGets or sets whether a search query in the Find Panel is treated as a whole, or as separate keywords for a logical conjunction or disjunction.
ShowClearButtonGets or sets whether the Clear button is displayed within the Find Panel.
ShowCloseButtonGets or sets whether the close (‘x’) button is displayed within the Find Panel.
ShowFindButtonGets or sets whether the Find button is displayed within the Find Panel.
ShowSearchNavButtonsGets or sets whether the Previous and Next buttons are displayed allowing users to navigate through search results.

Methods

NameDescription
Assign(BaseOptions)Copies all the settings of the options object passed as this method’s parameter to the current object.
BeginUpdate()Locks the BaseOptions object by disallowing visual updates until the EndUpdate or CancelUpdate method is called. Inherited from BaseOptions.
CancelUpdate()Unlocks the BaseOptions object after it has been locked by the BeginUpdate method, without causing an immediate visual update. Inherited from BaseOptions.
EndUpdate()Unlocks the BaseOptions object after a call to the BeginUpdate method and causes an immediate visual update. Inherited from BaseOptions.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetType()Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
Reset()Resets all options to their default values. Inherited from BaseOptions.
ToString()Returns a string representing the currently enabled options. Inherited from BaseOptions.

See Also

TreeListOptionsFind Class

DevExpress.XtraTreeList.Columns Namespace