Class TOptionsFilters

Unit

Declaration

type TOptionsFilters = class(TPersistent)

Description

setting for TrDBGrid filters, part of TOptionsEx2

Hierarchy

  • TPersistent
  • TOptionsFilters

Overview

Methods

Public function GetTextFilterLikeChar: char;
Public function GetTextFilterLikeOperator: string;
Public function FilterPanelRect: TRect;

Properties

Public property EditValues: TStrings read FEditValues;
Public property TextValueList: TMemIniFile read FEditValueList;
Public property FilterPanelPaddingHeight: integer read FFilterPanelPaddingHeight write SetFilterPanelPaddingHeight;
Public property FilterPanelComboMaxWidth: integer read FFilterPanelComboMaxWidth write FFilterPanelComboMaxWidth;
Published property FunnelBtn: boolean read FFunnelBtn write SetFunnelBtn default false;
Published property FunnelBtnActiveOnly: boolean read FFunnelBtnActiveOnly write FFunnelBtnActiveOnly default false;
Published property MultiFieldFilter: boolean read FMultiFieldFilter write FMultiFieldFilter default false;
Published property TextBar: boolean read FTextBar write SetTextBar default false;
Published property TextBarTopLayout: boolean read FTextBarTopLayout write SetTextBarTopLayout default false;
Published property TextMarginX: integer read FTextMarginX write SetTextMarginX default 2;
Published property TextMarginY: integer read FTextMarginY write SetTextMarginY default 1;
Published property TextBkColor: TColor read FTextBkColor write SetTextBkColor default clWindow;
Published property TextListAutoLoad: boolean read FTextListAutoLoad write FTextListAutoLoad default false;
Published property TextListAddFilter: boolean read FTextListAddFilter write FTextListAddFilter default true;
Published property TextFilterType: TOptionTextFilterType read FTextFilterType write FTextFilterType default oftAnyPos;
Published property TextFilterLikeChar: char read FTextFilterLikeChar write FTextFilterLikeChar default #0;
Published property TextFilterLikeOperator: string read FTextFilterLikeOperator write FTextFilterLikeOperator;
Published property TextComboStyle: TComboBoxStyle read FTextComboStyle write SetTextComboStyle default csDropDown;
Published property UseDatePartAsRange: boolean read FUseDatePartAsRange write FUseDatePartAsRange default true;
Published property UseNumberPartAsRange: boolean read FUseNumberPartAsRange write FUseNumberPartAsRange default true;
Published property NumberPartWildChar: char read FNumberPartWildChar write FNumberPartWildChar default '*';
Published property SetFilterDelay: cardinal read FSetFilterDelay write FSetFilterDelay default 1000;
Published property FilterPanel: boolean read FFilterPanel write SetFilterPanel default false;
Published property FilterPanelColor: TColor read FFilterPanelColor write SetFilterPanelColor default $00D6D6D6;
Published property FilterPanelButtonList: string read FFilterPanelButtonList write SetFilterPanelButtonList;

Description

Methods

Public function GetTextFilterLikeChar: char;

return like char used for filter

Public function GetTextFilterLikeOperator: string;

return like operator used for filter

Public function FilterPanelRect: TRect;

return rectangle of footer filter panel row

Properties

Public property EditValues: TStrings read FEditValues;

list of active values in the text bar per fields

Public property TextValueList: TMemIniFile read FEditValueList;

list of combo items in the text bar per fields (INI file format)

Public property FilterPanelPaddingHeight: integer read FFilterPanelPaddingHeight write SetFilterPanelPaddingHeight;

height padding for filter panel (added to default combo height)

Public property FilterPanelComboMaxWidth: integer read FFilterPanelComboMaxWidth write FFilterPanelComboMaxWidth;

maximal width of combo in the filter panel

Published property FunnelBtn: boolean read FFunnelBtn write SetFunnelBtn default false;

show funnel buttons in the title row

Published property FunnelBtnActiveOnly: boolean read FFunnelBtnActiveOnly write FFunnelBtnActiveOnly default false;

show funnel glyphs only for cell with active filter or hottrack title cell

Published property MultiFieldFilter: boolean read FMultiFieldFilter write FMultiFieldFilter default false;

enable combination of funnel filter for more coluumns (AND condition)

Published property TextBar: boolean read FTextBar write SetTextBar default false;

show text edit bar to enter filter text in the title row

Published property TextBarTopLayout: boolean read FTextBarTopLayout write SetTextBarTopLayout default false;

show text edit bar above title text

Published property TextMarginX: integer read FTextMarginX write SetTextMarginX default 2;

free space on left and right between text edit and cell border

Published property TextMarginY: integer read FTextMarginY write SetTextMarginY default 1;

free space on top and bottom between text edit and cell border

Published property TextBkColor: TColor read FTextBkColor write SetTextBkColor default clWindow;

background color of text edit

Published property TextListAutoLoad: boolean read FTextListAutoLoad write FTextListAutoLoad default false;

load filter picklist values from the dataset values (dataset scan is needed, do not use for large dataset)

Published property TextListAddFilter: boolean read FTextListAddFilter write FTextListAddFilter default true;

add entered value for filter to the picklist

Published property TextFilterType: TOptionTextFilterType read FTextFilterType write FTextFilterType default oftAnyPos;

comparison type for text filter (defines automatic usage of Like Char, can be entered also manualy)

Published property TextFilterLikeChar: char read FTextFilterLikeChar write FTextFilterLikeChar default #0;

define used LIKE char for filter, global setting from RosiGlobalSetting is used if not set

Published property TextFilterLikeOperator: string read FTextFilterLikeOperator write FTextFilterLikeOperator;

define used LIKE operator for filter, global setting from RosiGlobalSetting is used if not set

Published property TextComboStyle: TComboBoxStyle read FTextComboStyle write SetTextComboStyle default csDropDown;

define style of text filter combo

Published property UseDatePartAsRange: boolean read FUseDatePartAsRange write FUseDatePartAsRange default true;

enable range filtering for date field by entering of year or month+year only

Published property UseNumberPartAsRange: boolean read FUseNumberPartAsRange write FUseNumberPartAsRange default true;

enable range filtering for numeric field by entering of numer with wild char on last digits (120* => x>=1200 and x<1201

Published property NumberPartWildChar: char read FNumberPartWildChar write FNumberPartWildChar default '*';

define used wild char for UseNumberPartAsRange

Published property SetFilterDelay: cardinal read FSetFilterDelay write FSetFilterDelay default 1000;

delay for automatic activation of filter after text edit change

Published property FilterPanel: boolean read FFilterPanel write SetFilterPanel default false;

show filter panel in footer row with active filter condition and filter MRU, optionaly with additional custom buttons

Published property FilterPanelColor: TColor read FFilterPanelColor write SetFilterPanelColor default $00D6D6D6;

background color of the filter panel

Published property FilterPanelButtonList: string read FFilterPanelButtonList write SetFilterPanelButtonList;

list of image indexes (comma separated) for custom buttons in the filter panel, event OnFilterPanelButtonClick is called


Generated by PasDoc 0.15.0.