TCustomControlFilterEdit class
Base class for edit controls which filter data in an associated control like TListbox or TTreeview.
Declaration
TCustomControlFilterEdit = class(TCustomEditButton)Inheritance
- TCustomControlFilterEdit
- TCustomEditButton
- TCustomAbstractGroupedEdit
- TCustomControl
- TWinControl
- TControl
- TLCLComponent
- TComponent
- TPersistent
- TObject
Description
When the container control is connected to a filter control, the filtering happens automatically as a user enters text. When the filter is empty and does not have focus, it displays the grayed value "(filter)".
Properties
Filter | public | Contains the textual used to select the visible items in the associated control. |
FilterLowercase | public | The textual representation for the Filter using lowercase characters. |
IdleConnected | public | Indicates if the asynchronous event handler routine is enabled for the Application. |
SortData | public | Indicates whether items are sorted as they are filtered. |
SelectedPart | public | For retaining selection in the filtered control. The actual type depends on the associated control. |
CharCase | published | Controls case conversion performed for a value entered in the control. |
FilterOptions | published | Contains options which control string comparisons using the Filter for the control. |
ButtonCaption | published | Contains the caption used for the Button on the edit control. |
ButtonCursor | published | Cursor shape displayed when the mouse hovers over the Button in the control. |
ButtonHint | published | Text displayed in the pop-up hint window when the mouse hovers over the button. |
ButtonOnlyWhenFocused | published | ButtonOnlyWhenFocused - if True, the SpeedButton only appears when focus is given to the EditButton control. |
ButtonWidth | published | Width for the TSpeedButton on the edit control. |
Constraints | published | Contains the minimum and maximum Width and Height for the control. |
DirectInput | published | Indicates if text can be entered directly into the BaseEditor control. |
Flat | published | When True, the SpeedButton has a flat appearance rather than a three-dimensional one. |
FocusOnButtonClick | published | Indicates if the focus is changed to the Edit control after the Button is clicked. |
Align | published | Specifies the placement of the control on its Parent control. |
Alignment | published | Indicates the text alignment used for the control value. |
Anchors | published | The set of anchor definitions for this control. |
BidiMode | published | Indicates whether text controls use in bi-directional reading. |
BorderSpacing | published | Determines the inner and outer border spacing for this control. |
BorderStyle | published | Indicates the border style displayed around the control. |
AutoSize | published | Allows automatic adjustment of the size for the control, according to its content. |
AutoSelect | published | Indicates if the text in the control is automatically selected when focus is received. |
Color | published | The background color for the control. |
DragCursor | published | The cursor shape shown during a drag operation. |
DragMode | published | Determines how a drag operation is started for the control. |
Enabled | published | Determines whether the control responds to mouse or keyboard input. |
Font | published | The font to be used for text display in this control. |
Glyph | published | Glyph - the small graphic image on the SpeedButton, which ought to indicate its function. |
NumGlyphs | published | NumGlyphs - the number of available glyphs. |
Images | published | Contains the Images that can be displayed on the Button for the grouped edit control. |
ImageIndex | published | Ordinal position in Images for the bitmap displayed on the Button control. |
ImageWidth | published | Specifies the width of the image displayed on the Button control. |
Layout | published | Controls the alignment of the edit control and its associate. |
MaxLength | published | Maximum number of characters allowed in the editor for the control. |
ParentBidiMode | published | Indicates whether the BiDiMode settings in the Parent control are used. |
ParentColor | published | Use the Color from the Parent control, when enabled. |
ParentFont | published | Indicates if the Font from the Parent control is used in the control. |
ParentShowHint | published | If True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True. |
PopupMenu | published | PopupMenu for the control. |
ReadOnly | published | Indicates whether the value for the control can be changed. |
ShowHint | published | Enables Hint display for the control. |
Spacing | published | Specifies the number of pixels reserved between the Edit and Button controls when Button is visible. |
TabOrder | published | Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key. |
TabStop | published | Allows the user to navigate to / from the control by pressing the Tab or Shift+Tab keys. |
Text | published | String with the text or caption for the control. |
TextHint | published | Default hint text shown when the Text property is empty for the grouped edit control. |
Visible | published | Allows the control, and all of its children, to be displayed or hidden. |
Methods
DestroyWnd | protected | Ensures that the Canvas for the control is freed before the window handle is destroyed. |
InternalSetFilter | protected | Performs actions needed when a new value is assigned to the Filter property. |
DoDefaultFilterItem | protected | Provides a default routine used to examine an item in the filtered edit control. |
DoFilterEvents | protected | |
DoFilterItem | protected | Filters items using the handlers for the control. |
EditKeyDown | protected | Handles a KeyDown event for the Edit control. |
EditChange | protected | Performs actions needed when the Edit for the control is changed. |
BuddyClick | protected | Performs actions when the Button for the control is clicked. |
SortAndFilter | protected | Sorts the data in the associated control and applies the filter. |
ApplyFilterCore | protected | Applies the Filter data to the container component. |
ApplyFilter | protected | Applies the Filter to the data displayed on the control. |
MoveNext | protected | Moves to the next value matching the filter for the control. |
MovePrev | protected | Moves to the previous value matching the filter for the control. |
MovePageUp | protected | Moves one page of previous values matching the filter. |
MovePageDown | protected | Moves one page of subsequent values matching the filter. |
MoveHome | protected | Moves to the first value matching the filter. |
MoveEnd | protected | Moves to the last value matching the filter. |
ReturnKeyHandled | protected | Indicates whether an assigned OnKeyPress event handler handles the Return or Enter key in the KeyDown method for the Edit. |
GetDefaultGlyphName | protected | Gets the name of the default glyph resource used for the Button on the control. |
WSRegisterClass | protected | Registers the class reference used to create new instances of the class. |
Create | public | Constructor for the class instance. |
Destroy | public | Destructor for the class instance. |
InvalidateFilter | public | Sets flags and properties to indicate that the filter must be reapplied for the control. |
ResetFilter | public | Clears the Filter text to show all items in the control. |
ForceFilter | public | Applies a new Filter immediately without waiting for an idle state. |
StoreSelection | public | Stores the current selection for the associated control in the class instance. |
RestoreSelection | public | Restores the selection in the associated control after the filter is applied. |
Events
OnAfterFilter | published | Event handler signalled after all items have been filtered in the control. |
OnFilterItem | published | An event handler to give extra conditions for filtering, in addition to the default behavior. Returns True if the passes the filter. |
OnFilterItemEx | published | Event handler signalled to filter data in the control using its caption or item data. |
OnCheckItem | published | Has effect when items in the filtered container can be checked. Typically a CheckListbox. |
OnButtonClick | published | OnButtonClick - event handler for a mouse click on the SpeedButton. |
OnChange | published | Event handler signalled when the value for the control is changed. |
OnClick | published | Notification handler for mouse clicks. |
OnContextPopup | published | Invoked when a context-sensitive pop-up menu is requested. |
OnDblClick | published | Event handler signalled when a mouse double click occurs in the control. |
OnDragDrop | published | Event handler signalled when an object is dropped onto the control. |
OnDragOver | published | Event handler signalled when a control is dragged over the control instance. |
OnEditingDone | published | Event handler signalled when editing is completed for the control. |
OnEndDrag | published | Event handler signalled for the end of a drag-drop operation. |
OnEnter | published | Event handler signalled when the control receives focus. |
OnExit | published | Event handler signalled when the control loses focus. |
OnKeyDown | published | Event handler signalled for key down keyboard events. |
OnKeyPress | published | Event handler signalled for character data entered by the user. |
OnKeyUp | published | Event handler signalled when a key up event has occurred for the control. |
OnMouseDown | published | Event handler signalled when a mouse down event is handled for the control. |
OnMouseEnter | published | Event handler signalled when the mouse pointer has entered the control. |
OnMouseLeave | published | Event handler signalled when the mouse pointer has left the control. |
OnMouseMove | published | Event handler signalled when the mouse pointer is moved in the control. |
OnMouseUp | published | Event handler signalled when a mouse up event is handled for the control. |
OnMouseWheel | published | Event handler for mouse wheel turned. |
OnMouseWheelDown | published | Event handler signalled for a downward movement of the mouse wheel. |
OnMouseWheelUp | published | Event handler signalled for an upward movement of the mouse wheel. |
OnStartDrag | published | Event handler signalled for the start of a dragging operation. |
OnUTF8KeyPress | published | Handler for a character entered by the user. |
Fields
fAlreadyFiltered | protected | Flag which indicates the filter value has already been applied to the filtered control. |
fIsFirstUpdate | protected | Flag indicating if the filter has ever been applied. |
fNeedFiltering | protected | Flag which indicates that the filter needs to be applied to the associated control. |
fNeedButtonEnabled | protected | Flag which indicates that the button for the control needs to be enabled. |
fSelectedPart | protected | Node to select during the next update. |
fOnFilterItem | protected | Stores the event handler in the OnFilterItem property. |
fOnFilterItemEx | protected | Stores the event handler in the OnFilterItemEx property. |
fOnCheckItem | protected | Stores the event handler in the OnCheckItem property. |
Inherited
From TCustomEditButton (11)
Button ButtonClick CalcButtonVisible CalculatePreferredSize CheckButtonVisible Edit GetBuddyClassType GetControlClassDefaultSize GetEditorClassType GlyphChanged LoadDefaultGlyph
From TCustomAbstractGroupedEdit (85)
AutoSelected AutoSizeHeightIsEditHeight BaseEditor Buddy BuddyCaption BuddyCursor BuddyHint BuddyWidth CanUndo CaretPos CheckCursor Clear ClearSelection CMParentColorChanged CopyToClipboard CreateBuddy CreateEditor CutToClipboard DoEnter EchoMode EditCanModify EditClick EditContextPopup EditDblClick EditDragDrop EditDragOver EditEditingDone EditEndDrag EditEnter EditExit EditKeyPress EditKeyUp EditMask EditMouseDown EditMouseEnter EditMouseLeave EditMouseMove EditMouseUp EditMouseWheel EditMouseWheelDown EditMouseWheelUp EditStartDrag EditText EditUtf8KeyPress FocusAndMaybeSelectAll Focused FocusOnBuddyClick GetBuddyCaption GetBuddyCursor GetBuddyHint GetBuddyVisible GetBuddyWidth GetEditPopupMenu GetSel GetSpacing HideSelection IsMasked Loaded Modified NumbersOnly OnBuddyClick PasswordChar PasteFromClipboard RealGetText RealSetText Reset SelectAll SelLength SelStart SelText SetAutoSize SetBuddyCaption SetBuddyCursor SetBuddyHint SetBuddyVisible SetBuddyWidth SetColor SetCursor SetDirectInput SetFocus SetSel ShouldAutoAdjust Undo UpdateSpacing ValidateEdit
From TCustomControl (6)
From TWinControl (222)
AddControl AdjustClientRect AlignControls AllAutoSized AutoAdjustLayout AutoSizeDelayed AutoSizeDelayedHandle AutoSizeDelayedReport AutoSizePhases BeginUpdateBounds BorderWidth BoundsLockCount BroadCast Brush BrushCreated CachedClientHeight CachedClientWidth CanFocus CanSetFocus CanTab ChangeScale ChildClassAllowed ChildHandlesCreated ChildKey ChildSizing ClientRectNeedsInterfaceUpdate CMBiDiModeChanged CMBorderChanged CMDoubleBufferedChanged CMEnabledChanged CMEnter CMExit CMParentDoubleBufferedChanged CMShowHintChanged CMShowingChanged CMVisibleChanged CNChar CNKeyDown CNKeyUp CNSysKeyDown CNSysKeyUp ContainsControl ControlAtPos ControlCount ControlKeyDown ControlKeyUp Controls ControlsAligned CreateBrush CreateDockManager CreateHandle CreateParams CreateParented CreateParentedControl CreateSubClass CreateWnd CustomAlignInsertBefore CustomAlignPosition DefaultHandler DefWndProc DesignerDeleting DestroyHandle DialogChar DisableAlign DoAddDockClient DoAdjustClientRectChange DoAlignChildControls DoAllAutoSize DoAutoSize DoChildSizingChange DockClientCount DockClients DockDrop DockManager DockOver DockSite DoConstraintsChange DoDockClientMsg DoDockOver DoDragMsg DoExit DoFlipChildren DoFloatMsg DoGetDockCaption DoKeyDownBeforeInterface DoKeyPress DoKeyUpBeforeInterface DoRemainingKeyDown DoRemainingKeyUp DoRemoveDockClient DoSendBoundsToInterface DoSendShowHideToInterface DoSetBounds DoubleBuffered DoUnDock DoUndockClientMsg DoUTF8KeyPress EnableAlign EndUpdateBounds EraseBackground FinalizeWnd FindChildControl FindNextControl FixDesignFontsPPIWithChildren FixupTabList FlipChildren FormEndUpdated GetAdjustedLogicalClientRect GetBorderStyle GetChildren GetChildrenRect GetClientOrigin GetClientRect GetControlIndex GetControlOrigin GetDeviceContext GetDockCaption GetEnumeratorControls GetEnumeratorControlsReverse GetMouseCapture GetParentHandle GetPreferredSizeClientFrame GetSiteInfo GetTabOrderList GetTextLen GetTopParentHandle Handle HandleAllocated HandleNeeded InitializeWnd InsertControl IntfGetDropFilesTarget IntfUTF8KeyPress Invalidate InvalidateBoundsRealized InvalidateClientRectCache InvalidatePreferredChildSizes IsClientHeightStored IsClientWidthStored IsControlMouseMsg IsFlipped IsResizing IsSpecialSubControl KeyDown KeyDownAfterInterface KeyDownBeforeInterface KeyPress KeyUp KeyUpAfterInterface KeyUpBeforeInterface LockRealizeBounds MainWndProc NotifyControls OnAlignInsertBefore OnAlignPosition OnDockDrop OnDockOver OnGetDockCaption OnGetSiteInfo OnUnDock PaintControls PaintHandler PaintTo ParentDoubleBuffered ParentFormHandleInitialized ParentHandlesAllocated ParentWindow PerformTab ReAlign RealizeBounds RealizeBoundsRecursive ReloadDockedControl RemoveControl RemoveFocus Repaint ScaleBy ScaleControls ScrollBy ScrollBy_WS SelectFirst SelectNext SendDialogChar SendMoveSizeMessages SetBorderStyle SetBounds SetChildZPosition SetControlIndex SetDockManager SetShape SetTempCursor ShowControl Showing UnlockRealizeBounds Update UpdateControlState UpdateDockCaption UpdateShowing UseDockManager UTF8KeyPress VisibleDockClientCount WindowHandle WMChar WMContextMenu WMDestroy WMEnter WMEraseBkgnd WMExit WMKeyDown WMKeyUp WMKillFocus WMMove WMNotify WMSetFocus WMShowWindow WMSize WMSysChar WMSysKeyDown WMSysKeyUp WMWindowPosChanged WndProc WriteLayoutDebugReport WSSetText
From TControl (327)
AccessibleDescription AccessibleName AccessibleRole AccessibleValue Action ActionChange ActionLink ActiveDefaultControlChanged AddHandler AddHandlerOnBeforeDestruction AddHandlerOnChangeBounds AddHandlerOnEnabledChanged AddHandlerOnEnabledChanging AddHandlerOnKeyDown AddHandlerOnMouseWheel AddHandlerOnResize AddHandlerOnVisibleChanged AddHandlerOnVisibleChanging AdjustSize AnchorAsAlign AnchorClient AnchoredControlCount AnchoredControls AnchorHorizontalCenterTo AnchorParallel AnchorSame AnchorSide AnchorSideBottom AnchorSideChanged AnchorSideLeft AnchorSideRight AnchorSideTop AnchorToCompanion AnchorToNeighbour AnchorVerticalCenterTo AssignTo AutoSizing AutoSizingAll AutoSizingLockCount BaseBounds BaseParentClientSize BeforeDestruction BeforeDragStart BeginAutoDrag BeginAutoSizing BeginDrag BoundsChanged BoundsRect BoundsRectForNewParent BringToFront CalculateDockSizes CanAutoSize Caption CaptureChanged CaptureMouseButtons ChangeBounds Changed CheckChildClassAllowed CheckNewParent CheckOnChangeBounds Click ClientHeight ClientOrigin ClientRect ClientToParent ClientToScreen ClientWidth CMChanged CMCursorChanged CMHintShow CMHitTest CMMouseEnter CMMouseLeave CMParentBiDiModeChanged CMParentFontChanged CMParentShowHintChanged CMSysFontChanged CMTextChanged CNPreferredSizeChanged ColorIsStored ConstrainedResize ControlFontClass ControlOrigin ControlState ControlStyle ControlToScreen CreateAccessibleObject CreateControlBorderSpacing CreateFloatingDockSite Cursor DblClick DefineProperties DesktopFont DisableAutoSizing DoAutoAdjustLayout DoBorderSpacingChange DoCallKeyEventHandler DoCallMouseWheelEventHandler DoCallNotifyHandler Dock Docked DockOrientation DockTrackNoTarget DoContextPopup DoDock DoEndDock DoEndDrag DoFixDesignFontPPI DoMouseDown DoMouseUp DoMouseWheel DoMouseWheelDown DoMouseWheelHorz DoMouseWheelLeft DoMouseWheelRight DoMouseWheelUp DoOnChangeBounds DoOnParentHandleDestruction DoOnResize DoOnShowHint DoScaleFontPPI DoStartDock DoStartDrag DragCanceled DragDrop Dragging DragKind DragOver EditingDone EnableAutoSizing EnabledChanged EnabledChanging EndAutoSizing EndDrag ExecuteCancelAction ExecuteDefaultAction FindSubComponent FixDesignFontsPPI Floating FloatingDockSiteClass ForeignAnchorSideChanged FormIsUpdating GetAccessibleObject GetAction GetActionLinkClass GetAnchorsDependingOnParent GetCachedText GetCanvasScaleFactor GetChildAccessibleObjectAtPos GetClientScrollOffset GetColorResolvingParent GetCursor GetDefaultColor GetDefaultDockCaption GetDefaultHeight GetDefaultWidth GetDockEdge GetDragImages GetEnabled GetFloating GetFloatingDockSiteClass GetLogicalClientRect GetMousePosFromMessage GetPalette GetParentBackground GetParentComponent GetPopupMenu GetPreferredSize GetRGBColorResolvingParent GetScrolledClientRect GetSelectedChildAccessibleObject GetSidePosition GetTextBuf GetTopParent HandleObjectShouldBeVisible HasHelp HasParent Height HeightIsAnchored HelpContext HelpKeyword HelpType Hide Hint HostDockSite InitiateAction InvalidateControl InvalidatePreferredSize IsAParentAligning IsBorderSpacingInnerBorderStored IsCaptionStored IsControl IsControlVisible IsEnabled IsParentColor IsParentFont IsParentOf IsProcessingPaintMsg IsRightToLeft IsVisible Left LMCaptureChanged LoadedAll LRDockWidth ManualDock ManualFloat MouseCapture MouseDown MouseEnter MouseInClient MouseLeave MouseMove MouseUp Notification OnChangeBounds OnConstrainedResize OnEndDock OnMouseWheelHorz OnMouseWheelLeft OnMouseWheelRight OnQuadClick OnResize OnShowHint OnStartDock OnTripleClick Parent ParentBackground ParentDestroyingHandle ParentFontChanged ParentToClient Perform PositionDockRect QuadClick ReadBounds ReadState Refresh RemoveAllHandlersOfObject RemoveHandler RemoveHandlerOnBeforeDestruction RemoveHandlerOnChangeBounds RemoveHandlerOnEnabledChanged RemoveHandlerOnEnabledChanging RemoveHandlerOnKeyDown RemoveHandlerOnMouseWheel RemoveHandlerOnResize RemoveHandlerOnVisibleChanged RemoveHandlerOnVisibleChanging ReplaceDockedControl RequestAlign Resize Scale96ToFont Scale96ToForm Scale96ToScreen ScaleConstraints ScaleDesignToForm ScaleFontsPPI ScaleFontTo96 ScaleFontToScreen ScaleFormTo96 ScaleFormToDesign ScaleScreenTo96 ScaleScreenToFont ScreenToClient ScreenToControl SendToBack SessionProperties SetAction SetAlign SetAnchors SetBiDiMode SetBoundsKeepBase SetDragMode SetEnabled SetHint SetInitialBounds SetName SetParent SetParentBackground SetParentBiDiMode SetParentComponent SetTextBuf SetVisible SetZOrder Show ShowHelp TBDockHeight TextChanged Top TripleClick UndockHeight UndockWidth UpdateAnchorRules UpdateBaseBounds UpdateMouseCursor UpdateRolesForForm UseRightToLeftAlignment UseRightToLeftReading UseRightToLeftScrollBar VisibleChanged VisibleChanging Width WidthIsAnchored WindowProc WMCancelMode WMLButtonDBLCLK WMLButtonDown WMLButtonQuadCLK WMLButtonTripleCLK WMLButtonUp WMMButtonDBLCLK WMMButtonDown WMMButtonQuadCLK WMMButtonTripleCLK WMMButtonUp WMMouseHWheel WMMouseMove WMMouseWheel WMRButtonDBLCLK WMRButtonDown WMRButtonQuadCLK WMRButtonTripleCLK WMRButtonUp WMXButtonDBLCLK WMXButtonDown WMXButtonQuadCLK WMXButtonTripleCLK WMXButtonUp
From TLCLComponent (6)
DecLCLRefCount GetWSComponentClass IncLCLRefCount LCLRefCount NewInstance WidgetSetClass
From TComponent (64)
_AddRef _Release CanObserve ChangeName ComObject ComponentCount ComponentIndex Components ComponentState ComponentStyle DesignInfo DestroyComponents Destroying ExecuteAction FindComponent FreeNotification FreeOnRelease GetChildOwner GetChildParent GetDeltaStreams GetEnumerator GetIDsOfNames GetNamePath GetObservers GetOwner GetTypeInfo GetTypeInfoCount iicrGetComponent InsertComponent Invoke IsImplementorOf Loading Name ObserverAdded Observers OnGetDeltaStreams Owner PaletteCreated QueryInterface ReadDeltaState ReadDeltaStream ReferenceInterface RemoveComponent RemoveFreeNotification RemoveFreeNotifications SafeCallException SetAncestor SetChildOrder SetDesigning SetDesignInstance SetInline SetSubComponent Tag ToString TToStringNameMode UpdateAction Updated UpdateRegistry Updating ValidateContainer ValidateInsert ValidateRename VCLComObject WriteState
From TPersistent (4)
Assign FPOAttachObserver FPODetachObserver FPONotifyObservers
From TObject (35)
AfterConstruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName QualifiedClassName StringMessageTable SystemHasExtendedRTTI UnitName
An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.
