Sign in Join
FPDoc Onlineexperiment

TCustomControlFilterEdit class

In unit EditBtn

Base class for edit controls which filter data in an associated control like TListbox or TTreeview.

Declaration

pascal
TCustomControlFilterEdit = class(TCustomEditButton)

Inheritance

  1. TCustomControlFilterEdit
  2. TCustomEditButton
  3. TCustomAbstractGroupedEdit
  4. TCustomControl
  5. TWinControl
  6. TControl
  7. TLCLComponent
  8. TComponent
  9. TPersistent
  10. 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

FilterpublicContains the textual used to select the visible items in the associated control.
FilterLowercasepublicThe textual representation for the Filter using lowercase characters.
IdleConnectedpublicIndicates if the asynchronous event handler routine is enabled for the Application.
SortDatapublicIndicates whether items are sorted as they are filtered.
SelectedPartpublicFor retaining selection in the filtered control. The actual type depends on the associated control.
CharCasepublishedControls case conversion performed for a value entered in the control.
FilterOptionspublishedContains options which control string comparisons using the Filter for the control.
ButtonCaptionpublishedContains the caption used for the Button on the edit control.
ButtonCursorpublishedCursor shape displayed when the mouse hovers over the Button in the control.
ButtonHintpublishedText displayed in the pop-up hint window when the mouse hovers over the button.
ButtonOnlyWhenFocusedpublishedButtonOnlyWhenFocused - if True, the SpeedButton only appears when focus is given to the EditButton control.
ButtonWidthpublishedWidth for the TSpeedButton on the edit control.
ConstraintspublishedContains the minimum and maximum Width and Height for the control.
DirectInputpublishedIndicates if text can be entered directly into the BaseEditor control.
FlatpublishedWhen True, the SpeedButton has a flat appearance rather than a three-dimensional one.
FocusOnButtonClickpublishedIndicates if the focus is changed to the Edit control after the Button is clicked.
AlignpublishedSpecifies the placement of the control on its Parent control.
AlignmentpublishedIndicates the text alignment used for the control value.
AnchorspublishedThe set of anchor definitions for this control.
BidiModepublishedIndicates whether text controls use in bi-directional reading.
BorderSpacingpublishedDetermines the inner and outer border spacing for this control.
BorderStylepublishedIndicates the border style displayed around the control.
AutoSizepublishedAllows automatic adjustment of the size for the control, according to its content.
AutoSelectpublishedIndicates if the text in the control is automatically selected when focus is received.
ColorpublishedThe background color for the control.
DragCursorpublishedThe cursor shape shown during a drag operation.
DragModepublishedDetermines how a drag operation is started for the control.
EnabledpublishedDetermines whether the control responds to mouse or keyboard input.
FontpublishedThe font to be used for text display in this control.
GlyphpublishedGlyph - the small graphic image on the SpeedButton, which ought to indicate its function.
NumGlyphspublishedNumGlyphs - the number of available glyphs.
ImagespublishedContains the Images that can be displayed on the Button for the grouped edit control.
ImageIndexpublishedOrdinal position in Images for the bitmap displayed on the Button control.
ImageWidthpublishedSpecifies the width of the image displayed on the Button control.
LayoutpublishedControls the alignment of the edit control and its associate.
MaxLengthpublishedMaximum number of characters allowed in the editor for the control.
ParentBidiModepublishedIndicates whether the BiDiMode settings in the Parent control are used.
ParentColorpublishedUse the Color from the Parent control, when enabled.
ParentFontpublishedIndicates if the Font from the Parent control is used in the control.
ParentShowHintpublishedIf True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True.
PopupMenupublishedPopupMenu for the control.
ReadOnlypublishedIndicates whether the value for the control can be changed.
ShowHintpublishedEnables Hint display for the control.
SpacingpublishedSpecifies the number of pixels reserved between the Edit and Button controls when Button is visible.
TabOrderpublishedIndicates the navigation order for the control when the user presses the Tab or Shift+Tab key.
TabStoppublishedAllows the user to navigate to / from the control by pressing the Tab or Shift+Tab keys.
TextpublishedString with the text or caption for the control.
TextHintpublishedDefault hint text shown when the Text property is empty for the grouped edit control.
VisiblepublishedAllows the control, and all of its children, to be displayed or hidden.

Methods

DestroyWndprotectedEnsures that the Canvas for the control is freed before the window handle is destroyed.
InternalSetFilterprotectedPerforms actions needed when a new value is assigned to the Filter property.
DoDefaultFilterItemprotectedProvides a default routine used to examine an item in the filtered edit control.
DoFilterEventsprotected
DoFilterItemprotectedFilters items using the handlers for the control.
EditKeyDownprotectedHandles a KeyDown event for the Edit control.
EditChangeprotectedPerforms actions needed when the Edit for the control is changed.
BuddyClickprotectedPerforms actions when the Button for the control is clicked.
SortAndFilterprotectedSorts the data in the associated control and applies the filter.
ApplyFilterCoreprotectedApplies the Filter data to the container component.
ApplyFilterprotectedApplies the Filter to the data displayed on the control.
MoveNextprotectedMoves to the next value matching the filter for the control.
MovePrevprotectedMoves to the previous value matching the filter for the control.
MovePageUpprotectedMoves one page of previous values matching the filter.
MovePageDownprotectedMoves one page of subsequent values matching the filter.
MoveHomeprotectedMoves to the first value matching the filter.
MoveEndprotectedMoves to the last value matching the filter.
ReturnKeyHandledprotectedIndicates whether an assigned OnKeyPress event handler handles the Return or Enter key in the KeyDown method for the Edit.
GetDefaultGlyphNameprotectedGets the name of the default glyph resource used for the Button on the control.
WSRegisterClassprotectedRegisters the class reference used to create new instances of the class.
CreatepublicConstructor for the class instance.
DestroypublicDestructor for the class instance.
InvalidateFilterpublicSets flags and properties to indicate that the filter must be reapplied for the control.
ResetFilterpublicClears the Filter text to show all items in the control.
ForceFilterpublicApplies a new Filter immediately without waiting for an idle state.
StoreSelectionpublicStores the current selection for the associated control in the class instance.
RestoreSelectionpublicRestores the selection in the associated control after the filter is applied.

Events

OnAfterFilterpublishedEvent handler signalled after all items have been filtered in the control.
OnFilterItempublishedAn event handler to give extra conditions for filtering, in addition to the default behavior. Returns True if the passes the filter.
OnFilterItemExpublishedEvent handler signalled to filter data in the control using its caption or item data.
OnCheckItempublishedHas effect when items in the filtered container can be checked. Typically a CheckListbox.
OnButtonClickpublishedOnButtonClick - event handler for a mouse click on the SpeedButton.
OnChangepublishedEvent handler signalled when the value for the control is changed.
OnClickpublishedNotification handler for mouse clicks.
OnContextPopuppublishedInvoked when a context-sensitive pop-up menu is requested.
OnDblClickpublishedEvent handler signalled when a mouse double click occurs in the control.
OnDragDroppublishedEvent handler signalled when an object is dropped onto the control.
OnDragOverpublishedEvent handler signalled when a control is dragged over the control instance.
OnEditingDonepublishedEvent handler signalled when editing is completed for the control.
OnEndDragpublishedEvent handler signalled for the end of a drag-drop operation.
OnEnterpublishedEvent handler signalled when the control receives focus.
OnExitpublishedEvent handler signalled when the control loses focus.
OnKeyDownpublishedEvent handler signalled for key down keyboard events.
OnKeyPresspublishedEvent handler signalled for character data entered by the user.
OnKeyUppublishedEvent handler signalled when a key up event has occurred for the control.
OnMouseDownpublishedEvent handler signalled when a mouse down event is handled for the control.
OnMouseEnterpublishedEvent handler signalled when the mouse pointer has entered the control.
OnMouseLeavepublishedEvent handler signalled when the mouse pointer has left the control.
OnMouseMovepublishedEvent handler signalled when the mouse pointer is moved in the control.
OnMouseUppublishedEvent handler signalled when a mouse up event is handled for the control.
OnMouseWheelpublishedEvent handler for mouse wheel turned.
OnMouseWheelDownpublishedEvent handler signalled for a downward movement of the mouse wheel.
OnMouseWheelUppublishedEvent handler signalled for an upward movement of the mouse wheel.
OnStartDragpublishedEvent handler signalled for the start of a dragging operation.
OnUTF8KeyPresspublishedHandler for a character entered by the user.

Fields

fAlreadyFilteredprotectedFlag which indicates the filter value has already been applied to the filtered control.
fIsFirstUpdateprotectedFlag indicating if the filter has ever been applied.
fNeedFilteringprotectedFlag which indicates that the filter needs to be applied to the associated control.
fNeedButtonEnabledprotectedFlag which indicates that the button for the control needs to be enabled.
fSelectedPartprotectedNode to select during the next update.
fOnFilterItemprotectedStores the event handler in the OnFilterItem property.
fOnFilterItemExprotectedStores the event handler in the OnFilterItemEx property.
fOnCheckItemprotectedStores 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)

Canvas FontChanged OnPaint Paint PaintWindow WMPaint

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.