Class TrDBGrid

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type TrDBGrid = class(TDBGrid)

Description

enhanced DBGrid component which provides many new functions (show checkboxes, glyph for graphics and memo fields, build-in editors, pictures in title row or in data cells, multiple line titles, sorting functions etc)

Hierarchy

  • TDBGrid
  • TrDBGrid

Overview

Methods

Public function IsDatasetLinked: boolean;
Public function IsActive: boolean;
Public function IsFiltered: boolean;
Public function IsNotEmpty: boolean;
Public procedure RefreshLayout;
Public function ReSort: boolean;
Public function ChangeSort(const NewSortFieldName: string; NewSortDesc: boolean): boolean;
Public function ChangeSortEx(const NewSortFieldName, NewSortDirections: string): boolean;
Public function PosInSortField(const FieldName: string): integer;
Public function GetSortDirection(const FieldName: string): boolean;
Public function SortFieldNamesArr: TSortFieldNames;
Public function SortDirectionsArr: TSortDirections;
Public procedure SetColumnWidth(ColumnWidth: TColumnWidth; AdditionalSpace: integer = 0);
Public procedure SetOneColumnWidth(ColumnWidth: TColumnWidth; C: TColumn; AdditionalSpace: integer = 0);
Public procedure RestoreColumnsWidth(RestoreVisibility: boolean = true; RestorePosition: boolean = true);
Public procedure SaveRowPos(SetExUpdateLock: boolean = false);
Public procedure RestoreRowPos;
Public procedure SaveResetDatasetEvents(Reason: integer = 0);
Public procedure RestoreDatasetEvents(Reason: integer = 0);
Public procedure SetFooterDBGrid(FooterDBGrid: TrDBGrid; const FooterFieldPrefix: string; ShowHSBarMaster, ShowHSBarFooter: boolean);
Public function GetInplaceEditor: TrDBGridInplaceEditEx;
Public procedure HideInplaceEditor;
Public procedure StopUpdate(stop: boolean);
Public procedure LoadAutoPickList;
Public function GetFieldNameColumnIndex(const FieldName: string): integer;
Public function GetLeftCol: integer;
Public procedure SetLeftCol(ALeftCol: integer);
Public function GetActiveCellRect: TRect;
Public procedure DrawBMPInCell(Rect: TRect; Bmp: TBitmap);
Public procedure ShowMemo(Field: TField);
Public procedure ShowGraphic(Field: TField);
Public procedure GetCellParams(Field: TField; AFont: TFont; var Background: TColor; ActiveRow, Highlight: boolean); virtual;
Public procedure RefreshCellParamsCond;
Public function SummaryResults(Fld: TField; Recalculate: boolean = true): TSummaryResults; overload;
Public function SummaryResults(Column: TColumn; Recalculate: boolean = true): TSummaryResults; overload;
Public procedure RecalculateSummaryResults(UseCalculatedSummaryForPopup: boolean = false);
Public function GetCellValue(Fld: TField): string;
Public function CopyCellData(CopyToClipboard: boolean = true): string;
Public procedure CopyFieldsData(FieldNames: TStrings; IncludeTitles: boolean = false);
Public procedure CopyActiveFieldData(IncludeTitles: boolean = false);
Public procedure CopyActiveRecordData(IncludeTitles: boolean = false; IncludeHidden: boolean = false);
Public procedure CopyAllData(IncludeTitles: boolean = false; IncludeHidden: boolean = false);
Public procedure PasteData(AddAsNewRecs: boolean);
Public function GetFieldGroupInfo(Fld: TField): TGroupInfo;
Public function IsFieldGroupMasterVisible(Fld: TField): boolean;
Public function IsFieldGroupMasterExpanded(Fld: TField): boolean;
Public procedure FixedGroupedCol(SwitchGroupOn: boolean; RestoreDefaults: boolean = false);
Public procedure CollapseGroup(GroupID: integer); overload;
Public procedure CollapseGroup(Fld: TField); overload;
Public procedure ExpandGroup(GroupID: integer); overload;
Public procedure ExpandGroup(Fld: TField); overload;
Public procedure CollapseAll;
Public procedure ExpandAll;
Public procedure ShowFilterDlg;
Public procedure SetFilterForField(Fld: TField; const FilterString: string; MultiFieldFilter: boolean);
Public procedure RefreshFilteredFieldNames;

Properties

Public property DateTimePicker: TWinControl read FDateTimePicker;
Public property CellParamsCondList: TCellParamsCondList read FCellParamsCondList;
Public property DropDownRowsCount: Cardinal read FDropDownRowsCount write FDropDownRowsCount;
Public property FilteredFieldNames: string read FFilteredFieldNames write SetFilteredFieldNames;
Published property OptionsEx: TOptionsEx read FOptionsEx write SetOptionsEx default[dgTitleExBtn, dgTitleBtn, dgFixColBtn, dgBool, dgMemo, dgGraphic, dgDateTimePicker, dgUseTitlePopup, dgAutoPickListWidth];
Published property PropSaveFile: TPropSaveFile read FPropSaveFile write SetPropSaveFile;
Published property CustomGlyphs: TrCustomGlyphs read FCustomGlyphs write SetCustomGlyphs;
Published property GlyphLookStyle: TGlyphLookStyles read FGlyphLookStyle write SetGlyphLookStyle default glsStandard;
Published property GridLookStyle: TGridLookStyles read FGridLookStyle write SetGridLookStyle default grs_Default;
Published property ColorOddRow: TColor read FColorOddRow write SetColorOddRow default clMoneyGreen;
Published property ColorActiveRow: TColor read FColorActiveRow write SetColorActiveRow default clInfoBk;
Published property FontColorFiltered: TColor read FFontColorFiltered write SetFontColorFiltered default clNavy;
Published property FontColorLink: TColor read FFontColorLink write FFontColorLink default clHighlight;
Published property FontColorReadOnly: TColor read FFontColorReadOnly write FFontColorReadOnly default clGrayText;
Published property SortFieldName: string read FSortFieldName write SetSortFieldName;
Published property SortDesc: boolean read FSortDesc write SetSortDesc default false;
Published property SortDirections: string read FSortDirections write SetSortDirections;
Published property Sorter: TrDBGridCustomSorter read FSorter write SetSorter;
Published property ColumnWidth: TColumnWidth read FColumnWidth write SetFColumnWidth default cwNone;
Published property ColumnWidthAfterDblClick: TColumnWidth read FColumnWidthAfterDblClick write FColumnWidthAfterDblClick default cwDataLabelWidth;
Published property TextAsMemoSize: integer read FTextAsMemoSize write FTextAsMemoSize default 0;
Published property LookupCondition: TLookupCondition read FLookupCondition write FLookupCondition default lcBrowse;
Published property TitleLines: integer read FTitleLines write SetTitleLines default 1;
Published property RowFixHeight: integer read FRowFixHeight write SetRowFixHeight default 0;
Published property RowLines: integer read FRowLines write SetRowLines default 1;
Published property RowVerticalAlign: TVerticalAlignment read FRowVerticalAlign write SetRowVerticalAlign default taAlignTop;
Published property TitleLineText: TTitleLineText read FTitleLineText write FTitleLineText;
Published property FixedColText: TFixedColText read FFixedColText write FFixedColText;
Published property FooterRow: TFooterRow read FFooterRow write FFooterRow;
Published property PasswordChar: char read FPasswordChar write FPasswordChar default '*';
Published property FieldsAsLink: TStrings read FFieldsAsLink write SetFieldsAsLink;
Published property FieldsAsBoolean: TStrings read FFieldsAsBoolean write SetFieldsAsBoolean;
Published property FieldsAsGraphics: TStrings read FFieldsAsGraphics write SetFieldsAsGraphics;
Published property FieldsAsDate: TStrings read FFieldsAsDate write SetFieldsAsDate;
Published property FieldsAsColor: TStrings read FFieldsAsColor write SetFieldsAsColor;
Published property FieldsAsPassword: TStrings read FFieldsAsPassword write SetFieldsAsPassword;
Published property FieldsAutoPickList: TStrings read FFieldsAutoPickList write SetFieldsAutoPickList;
Published property FieldsDrawDropDown: TStrings read FFieldsDrawDropDown write SetFieldsDrawDropDown;
Published property FieldsFilterButton: TStrings read FFieldsFilterButton write SetFieldsFilterButton;
Published property TitlePopupItems: TStrings read FTitlePopupItems write SetTitlePopupItems;
Published property TitleExPopupMenu: TPopupMenu read FTitleExPopupMenu write SetTitleExPopupMenu;
Published property TitleHints: TStrings read FTitleHints write SetTitleHints;
Published property TitleImageList: TImageList read FTitleImageList write SetTitleImageList;
Published property TitleImages: TStrings read FTitleImages write SetTitleImages;
Published property DataImageList: TImageList read FDataImageList write SetDataImageList;
Published property DataImages: TStringList read FDataImages write SetDataImages;
Published property FieldsGroups: TStringList read FFieldsGroups write SetFieldsGroups;
Published property LookupListItemHeight: integer read FLookupListItemHeight write FLookupListItemHeight default 0;
Published property LookupListItemIncreaseHeight: integer read FLookupListItemIncreaseHeight write FLookupListItemIncreaseHeight default 2;
Published property LookupListItemIncreaseWidth: integer read FLookupListItemIncreaseWidth write FLookupListItemIncreaseWidth default 0;
Published property DateTimePickerCreate: TDateTimePickerCreate read FDateTimePickerCreate write FDateTimePickerCreate;
Published property DateTimePickerEvent: TDateTimePickerEvent read FDateTimePickerEvent write FDateTimePickerEvent;
Published property OnCanEdit: TCanEditEvent read FOnCanEdit write FOnCanEdit;
Published property OnChangeSort: TChangeSortEvent read FOnChangeSort write FOnChangeSort;
Published property OnChangeSortEx: TChangeSortEventEx read FOnChangeSortEx write FOnChangeSortEx;
Published property OnLinkClick: TLinkClickEvent read FOnLinkClick write FOnLinkClick;
Published property OnBoolClick: TLinkClickEvent read FOnBoolClick write FOnBoolClick;
Published property OnTitleExClick: TNotifyEvent read FOnTitleExClick write FOnTitleExClick;
Published property OnFixColClick: TNotifyEvent read FOnFixColClick write FOnFixColClick;
Published property OnFooterCellClick: TFooterCellClick read FOnFooterCellClick write FOnFooterCellClick;
Published property OnGetFixedColState: TGetFixedColStateEvent read FOnGetFixedColState write FOnGetFixedColState;
Published property OnGetFixedRowState: TGetFixedRowStateEvent read FOnGetFixedRowState write FOnGetFixedRowState;
Published property OnDrawTitleLine: TDrawTitleLineEvent read FOnDrawTitleLine write FOnDrawTitleLine;
Published property OnDrawActiveRowFocus: TDrawColumnCellEvent read FOnDrawActiveRowFocus write FOnDrawActiveRowFocus;
Published property OnDrawColumnCellEnd: TDrawColumnCellEvent read FOnDrawColumnCellEnd write FOnDrawColumnCellEnd;
Published property OnGetCellParams: TGetCellParamsEvent read FOnGetCellParams write FOnGetCellParams;
Published property OnDrawFooterRow: TDrawFooterRowEvent read FOnDrawFooterRow write FOnDrawFooterRow;
Published property OnDrawFooterCell: TDrawFooterCellEvent read FOnDrawFooterCell write FOnDrawFooterCell;
Published property OnLoadPickList: TLoadPickListEvent read FOnLoadPickList write FOnLoadPickList;
Published property OnGetHintStringEx: TGetHintStringEventEx read FOnGetHintStringEx write FOnGetHintStringEx;
Published property OnGetSummaryResult: TGetSummaryResultEvent read FOnGetSummaryResult write FOnGetSummaryResult;
Published property OnPickListDrawItem: TDrawItemEvent read FOnPickListDownItem write FOnPickListDownItem;
Published property OnPickListMeasureItem: TMeasureItemEvent read FOnPickListMeasureItem write FOnPickListMeasureItem;
Published property OnPickListSetSize: Controls.TCanResizeEvent read FOnPickListSetSize write FOnPickListSetSize;
Published property OnGetLookupListItemHeight: TGetLookupListItemHeight read FGetLookupListItemHeight write FGetLookupListItemHeight;
Published property OnGetLookupListItemProps: TGetLookupListItemProps read FGetLookupListItemProps write FGetLookupListItemProps;
Published property OnGetEllipsisButtonFormat: TGetEllipsisButtonFormat read FOnGetEllipsisButtonFormat write FOnGetEllipsisButtonFormat;
Published property OnTopLeftChanged: TNotifyEvent read FOnTopLeftChanged write FOnTopLeftChanged;
Published property OnDataScrolled: TNotifyEvent read FOnDataScrolled write FOnDataScrolled;
Published property BeforeScanDataset: TScanDatasetEvent read FBeforeScanDataset write FBeforeScanDataset;
Published property AfterScanDataset: TScanDatasetEvent read FAfterScanDataset write FAfterScanDataset;
Published property OnColWidthChanged: TColWidthChangedEvent read FOnColWidthChanged write FOnColWidthChanged;
Published property OnSetColumnFilter: TSetColumnFilterEvent read FOnSetColumnFilter write FOnSetColumnFilter;
Published property OnRefreshData: TNotifyEvent read FOnRefreshData write FOnRefreshData;

Description

Methods

Public function IsDatasetLinked: boolean;

indicates whether Grid is linked to any Dataset

Public function IsActive: boolean;

indicates whether linked Dataset is active

Public function IsFiltered: boolean;

indicates whether linked Dataset has active filter

Public function IsNotEmpty: boolean;

indicates whether Dataset is not empty

Public procedure RefreshLayout;

force LayoutChange event

Public function ReSort: boolean;

manually resort grid - calls Sorter DoSort procedure or OnChangeSortEx or OnChangeSort event

Public function ChangeSort(const NewSortFieldName: string; NewSortDesc: boolean): boolean;

set new sort properties and call Sorter DoSort procedure or OnChangeSort procedure, obsolete, use ChangeSortEx for multifield sorting

Public function ChangeSortEx(const NewSortFieldName, NewSortDirections: string): boolean;

set new sort properties and call Sorter DoSort procedure or OnChangeSortEx procedure

Public function PosInSortField(const FieldName: string): integer;

returns position of SelFldName in SortFieldName (0=not found)

Public function GetSortDirection(const FieldName: string): boolean;

returns sort direction for field (true=DESC, false=ASC)

Public function SortFieldNamesArr: TSortFieldNames;

returns array of sort fields

Public function SortDirectionsArr: TSortDirections;

returns array of sort directions

Public procedure SetColumnWidth(ColumnWidth: TColumnWidth; AdditionalSpace: integer = 0);

change all column widths according ColumnWidth parameter and increase width by Additional space

Public procedure SetOneColumnWidth(ColumnWidth: TColumnWidth; C: TColumn; AdditionalSpace: integer = 0);

changes one column width according ColumnWidth parameter

Public procedure RestoreColumnsWidth(RestoreVisibility: boolean = true; RestorePosition: boolean = true);

changes all columns position, width and visibility according original loaded state

Public procedure SaveRowPos(SetExUpdateLock: boolean = false);

save internal position of selected row in grid, use RestoreRowPos to restore the same possition

Public procedure RestoreRowPos;

moved grid to same row with same dataset record as was saved by SaveRowPos

Public procedure SaveResetDatasetEvents(Reason: integer = 0);

store and reset all dataset and datasource events for quick movement throught all records

Public procedure RestoreDatasetEvents(Reason: integer = 0);

restore all dataset and datasource events stored by SaveResetDatasetEvents

Public procedure SetFooterDBGrid(FooterDBGrid: TrDBGrid; const FooterFieldPrefix: string; ShowHSBarMaster, ShowHSBarFooter: boolean);

link another grid as footer DBGrid and set all properties

Public function GetInplaceEditor: TrDBGridInplaceEditEx;

returns pointer to InplaceEditor

Public procedure HideInplaceEditor;

hide InplaceEditor

Public procedure StopUpdate(stop: boolean);

stop or start updating of grid, used mainly for internal purposes

Public procedure LoadAutoPickList;

load PickList values for all AutoPickList fields, use OnLoadPickList event for loading by used defined query

Public function GetFieldNameColumnIndex(const FieldName: string): integer;

return column index for specific field name

Public function GetLeftCol: integer;

returns index of left column

Public procedure SetLeftCol(ALeftCol: integer);

set left column of grid (move grids scrollbar to right)

Public function GetActiveCellRect: TRect;

returns rect of active cell, can be used in some events

Public procedure DrawBMPInCell(Rect: TRect; Bmp: TBitmap);

draw bitmap in cell rectangle

Public procedure ShowMemo(Field: TField);

show memo editor for the field

Public procedure ShowGraphic(Field: TField);

show graphics editor for the field

Public procedure GetCellParams(Field: TField; AFont: TFont; var Background: TColor; ActiveRow, Highlight: boolean); virtual;

evaluate conditions for selected field and active record and returns Font and Background

Public procedure RefreshCellParamsCond;

refresh grid colors after changing of CellParamCondList

Public function SummaryResults(Fld: TField; Recalculate: boolean = true): TSummaryResults; overload;

return summary results for Field

Public function SummaryResults(Column: TColumn; Recalculate: boolean = true): TSummaryResults; overload;

return summary results for Column

Public procedure RecalculateSummaryResults(UseCalculatedSummaryForPopup: boolean = false);

recalculate summary results for all field, paramater define that calculated result is used also for popup summary

Public function GetCellValue(Fld: TField): string;

get displayed value from selected cell

Public function CopyCellData(CopyToClipboard: boolean = true): string;

copy data from selected cell to clipboard

Public procedure CopyFieldsData(FieldNames: TStrings; IncludeTitles: boolean = false);

copy data from selected fields and all records to clipboard

Public procedure CopyActiveFieldData(IncludeTitles: boolean = false);

copy data from active field and all records to clipboard

Public procedure CopyActiveRecordData(IncludeTitles: boolean = false; IncludeHidden: boolean = false);

copy data from active record and all fields to clipboard

Public procedure CopyAllData(IncludeTitles: boolean = false; IncludeHidden: boolean = false);

copy data from dataset to clipboard

Public procedure PasteData(AddAsNewRecs: boolean);

paste data from clipboard to dataset

Public function GetFieldGroupInfo(Fld: TField): TGroupInfo;

returns GroupInfo record for field

Public function IsFieldGroupMasterVisible(Fld: TField): boolean;

indicates whether master field of the same group as Fld is visible

Public function IsFieldGroupMasterExpanded(Fld: TField): boolean;

indicates whether master field of the same group as Fld is expanded

Public procedure FixedGroupedCol(SwitchGroupOn: boolean; RestoreDefaults: boolean = false);

rearrange all grouped columns to be together = should be called after user defined column moving

Public procedure CollapseGroup(GroupID: integer); overload;

collapse one group defined by GroupID

Public procedure CollapseGroup(Fld: TField); overload;

collapse one group defined by Field

Public procedure ExpandGroup(GroupID: integer); overload;

expand one group defined by GroupID

Public procedure ExpandGroup(Fld: TField); overload;

expand one group defined by Field

Public procedure CollapseAll;

collapse all groups

Public procedure ExpandAll;

expand all groups

Public procedure ShowFilterDlg;

show filter dialog with list of possible values for active column

Public procedure SetFilterForField(Fld: TField; const FilterString: string; MultiFieldFilter: boolean);
 
Public procedure RefreshFilteredFieldNames;

refresh list of field which is used in filter - loaded directly from filter string

Properties

Public property DateTimePicker: TWinControl read FDateTimePicker;

Returns TDateTimePicker for setting of their props

Public property CellParamsCondList: TCellParamsCondList read FCellParamsCondList;

Defines list of conditions defining cell colors

Public property DropDownRowsCount: Cardinal read FDropDownRowsCount write FDropDownRowsCount;

define number of rows for picklist

Public property FilteredFieldNames: string read FFilteredFieldNames write SetFilteredFieldNames;

define list of field which is used in filter = show active filter glyph

Published property OptionsEx: TOptionsEx read FOptionsEx write SetOptionsEx default[dgTitleExBtn, dgTitleBtn, dgFixColBtn, dgBool, dgMemo, dgGraphic, dgDateTimePicker, dgUseTitlePopup, dgAutoPickListWidth];

list of new options

Published property PropSaveFile: TPropSaveFile read FPropSaveFile write SetPropSaveFile;

define link to PropSaveFile which is used for saving of possition of dialogs

Published property CustomGlyphs: TrCustomGlyphs read FCustomGlyphs write SetCustomGlyphs;

defines link to rCustomGlyphs component which can define all glyphs

Published property GlyphLookStyle: TGlyphLookStyles read FGlyphLookStyle write SetGlyphLookStyle default glsStandard;

Defines look of glyphs for memo and graphics fields

Published property GridLookStyle: TGridLookStyles read FGridLookStyle write SetGridLookStyle default grs_Default;

Defines used color theme (gradient, backgrounf, fonts)

Published property ColorOddRow: TColor read FColorOddRow write SetColorOddRow default clMoneyGreen;

Defines color of each odd row, works only for bidirectional dataset

Published property ColorActiveRow: TColor read FColorActiveRow write SetColorActiveRow default clInfoBk;

Defines color of active row

Published property FontColorFiltered: TColor read FFontColorFiltered write SetFontColorFiltered default clNavy;

Defines text color when dataset is filtered

Published property FontColorLink: TColor read FFontColorLink write FFontColorLink default clHighlight;

Defines text color of link cells (http, mail)

Published property FontColorReadOnly: TColor read FFontColorReadOnly write FFontColorReadOnly default clGrayText;

Defines text color when field or column is readonly during editing

Published property SortFieldName: string read FSortFieldName write SetSortFieldName;

Defines which columns has sort marker, supports MultiField (e.g. FirtsName,LastName)

Published property SortDesc: boolean read FSortDesc write SetSortDesc default false;

Defines direction of sort marker

Published property SortDirections: string read FSortDirections write SetSortDirections;

Defines directions in case of multifield, A=Asc, D=Desc, e.g. A,D,A

Published property Sorter: TrDBGridCustomSorter read FSorter write SetSorter;

Defines sorter component - descendant of TrDBGridCustomSorter

Published property ColumnWidth: TColumnWidth read FColumnWidth write SetFColumnWidth default cwNone;

Defines type of automatic changing of column width

Published property ColumnWidthAfterDblClick: TColumnWidth read FColumnWidthAfterDblClick write FColumnWidthAfterDblClick default cwDataLabelWidth;

Defines type of automatic changing of column width after double click on column border in title row

Published property TextAsMemoSize: integer read FTextAsMemoSize write FTextAsMemoSize default 0;

Defines minimum size of string field for using a memo dialog for editation

Published property LookupCondition: TLookupCondition read FLookupCondition write FLookupCondition default lcBrowse;

Defines in which situation lookup is started after keypress

Published property TitleLines: integer read FTitleLines write SetTitleLines default 1;

Defines number of lines in title row

Published property RowFixHeight: integer read FRowFixHeight write SetRowFixHeight default 0;

Defines fixed height of data rows

Published property RowLines: integer read FRowLines write SetRowLines default 1;

Defines number of lines in data row

Published property RowVerticalAlign: TVerticalAlignment read FRowVerticalAlign write SetRowVerticalAlign default taAlignTop;

Defines vertical alignment for data row - used only if RowLines>1

Published property TitleLineText: TTitleLineText read FTitleLineText write FTitleLineText;

define properties for text in title line, see TTitleLineText

Published property FixedColText: TFixedColText read FFixedColText write FFixedColText;

define properties for text in fixed column, see TFixedColText

Published property FooterRow: TFooterRow read FFooterRow write FFooterRow;

define properties for footer row, see TFooterRow

Published property PasswordChar: char read FPasswordChar write FPasswordChar default '*';

Defines char used as mask for password fields

Published property FieldsAsLink: TStrings read FFieldsAsLink write SetFieldsAsLink;

Defines list of fields as link with link type, can be set easily by design time dialog

Published property FieldsAsBoolean: TStrings read FFieldsAsBoolean write SetFieldsAsBoolean;

Defines list of fields as boolean fields with TRUE FALSE values, can be set easily by design time dialog

Published property FieldsAsGraphics: TStrings read FFieldsAsGraphics write SetFieldsAsGraphics;

Defines list of fields as graphics fields, can be set easily by design time dialog

Published property FieldsAsDate: TStrings read FFieldsAsDate write SetFieldsAsDate;

Defines list of fields displayed as date fields, can be set easily by design time dialog

Published property FieldsAsColor: TStrings read FFieldsAsColor write SetFieldsAsColor;

Defines list of fields displayed as color fields, can be set easily by design time dialog

Published property FieldsAsPassword: TStrings read FFieldsAsPassword write SetFieldsAsPassword;

Defines list of fields displayed and edited as password = hide chars

Published property FieldsAutoPickList: TStrings read FFieldsAutoPickList write SetFieldsAutoPickList;

Defines list of fields with autopicklist function, can be set easily by design time dialog

Published property FieldsDrawDropDown: TStrings read FFieldsDrawDropDown write SetFieldsDrawDropDown;

Defines list of fields with custom draw event of dropdown list

Published property FieldsFilterButton: TStrings read FFieldsFilterButton write SetFieldsFilterButton;

Defines list of fields with filter button in Title Row (if dgFilterButtons is true)

Published property TitlePopupItems: TStrings read FTitlePopupItems write SetTitlePopupItems;

Defines Popup Items for calculation of numeric fields, see rstring.pas for default values

Published property TitleExPopupMenu: TPopupMenu read FTitleExPopupMenu write SetTitleExPopupMenu;

Defines Popup Items for left top cell

Published property TitleHints: TStrings read FTitleHints write SetTitleHints;

Defines title hints for each field (column), can be set easily by design time dialog

Published property TitleImageList: TImageList read FTitleImageList write SetTitleImageList;

link to ImageList for images in title rows

Published property TitleImages: TStrings read FTitleImages write SetTitleImages;

defines images in title row, can be set easily by design time dialog

Published property DataImageList: TImageList read FDataImageList write SetDataImageList;

link to ImageList for images in data cells

Published property DataImages: TStringList read FDataImages write SetDataImages;

defines images in data cells, can be set easily by design time dialog

Published property FieldsGroups: TStringList read FFieldsGroups write SetFieldsGroups;

defines field groups, can be set easily by design time dialog

Published property LookupListItemHeight: integer read FLookupListItemHeight write FLookupListItemHeight default 0;

defines absolute item height of lookup list, default is used if LookupItemHeight=0

Published property LookupListItemIncreaseHeight: integer read FLookupListItemIncreaseHeight write FLookupListItemIncreaseHeight default 2;

defines increase of standard item height of dropdown list

Published property LookupListItemIncreaseWidth: integer read FLookupListItemIncreaseWidth write FLookupListItemIncreaseWidth default 0;

defines increase of item column width

Published property DateTimePickerCreate: TDateTimePickerCreate read FDateTimePickerCreate write FDateTimePickerCreate;

event type for creating of DateTimePicker

Published property DateTimePickerEvent: TDateTimePickerEvent read FDateTimePickerEvent write FDateTimePickerEvent;

event type for DateTimePicker action

Published property OnCanEdit: TCanEditEvent read FOnCanEdit write FOnCanEdit;

event is called before editing of cell, CanEdit define possibility to editation

Published property OnChangeSort: TChangeSortEvent read FOnChangeSort write FOnChangeSort;

event is called after click on title row to provide sorting if Sorter component is not used; if "Accept" remains true, "SortFieldName" and "SortDesc" is changed and sort marker is shown, in other case nothing is changed; obsolete, use ChangeSortEventEx for multifield sorting

Published property OnChangeSortEx: TChangeSortEventEx read FOnChangeSortEx write FOnChangeSortEx;

Enhanced event with MultiField sorting supprt; event is called after click on title row to provide sorting if Sorter component is not used; if "Accept" remains true, "SortFieldName" and "SortDirections" is changed and sort marker is shown, in other case nothing is changed

Published property OnLinkClick: TLinkClickEvent read FOnLinkClick write FOnLinkClick;

event is called after click to user_defined hyperlink in the cell

Published property OnBoolClick: TLinkClickEvent read FOnBoolClick write FOnBoolClick;

event is called after click to checkbox in then cell

Published property OnTitleExClick: TNotifyEvent read FOnTitleExClick write FOnTitleExClick;

event is called after click to title ex (cell 0,0)

Published property OnFixColClick: TNotifyEvent read FOnFixColClick write FOnFixColClick;

event is called after click to fixed col cell (column 0)

Published property OnFooterCellClick: TFooterCellClick read FOnFooterCellClick write FOnFooterCellClick;

event is called after click to footer cell

Published property OnGetFixedColState: TGetFixedColStateEvent read FOnGetFixedColState write FOnGetFixedColState;

event is called to get font and text of fixed column cell

Published property OnGetFixedRowState: TGetFixedRowStateEvent read FOnGetFixedRowState write FOnGetFixedRowState;

event is called to get font and text of fixed row cell (title cell)

Published property OnDrawTitleLine: TDrawTitleLineEvent read FOnDrawTitleLine write FOnDrawTitleLine;

event is called to get title line text or custom draw of title line directly

Published property OnDrawActiveRowFocus: TDrawColumnCellEvent read FOnDrawActiveRowFocus write FOnDrawActiveRowFocus;

event is called after cell draw to custom draw of focus rectange

Published property OnDrawColumnCellEnd: TDrawColumnCellEvent read FOnDrawColumnCellEnd write FOnDrawColumnCellEnd;

event is called to add any custom draw of cell directly

Published property OnGetCellParams: TGetCellParamsEvent read FOnGetCellParams write FOnGetCellParams;

event is called to get params of data cell

Published property OnDrawFooterRow: TDrawFooterRowEvent read FOnDrawFooterRow write FOnDrawFooterRow;

event is called to draw whole footer row

Published property OnDrawFooterCell: TDrawFooterCellEvent read FOnDrawFooterCell write FOnDrawFooterCell;

event is called to draw one cell of footer row

Published property OnLoadPickList: TLoadPickListEvent read FOnLoadPickList write FOnLoadPickList;

event is called to load picklist for particular field - usually by aggregated query

Published property OnGetHintStringEx: TGetHintStringEventEx read FOnGetHintStringEx write FOnGetHintStringEx;

event is called before showing of hint window to get user defined hint string

Published property OnGetSummaryResult: TGetSummaryResultEvent read FOnGetSummaryResult write FOnGetSummaryResult;

event is called to format calculated value of field (sum, min, max, avg ...)

Published property OnPickListDrawItem: TDrawItemEvent read FOnPickListDownItem write FOnPickListDownItem;

event is called to custom draw of PickList dropdowm item, FieldsDrawDropDown defines fields with dropdowm custom drawing

Published property OnPickListMeasureItem: TMeasureItemEvent read FOnPickListMeasureItem write FOnPickListMeasureItem;

event is called to get PickList dropdowm item height, FieldsDrawDropDown defines fields with dropdowm custom drawing

Published property OnPickListSetSize: Controls.TCanResizeEvent read FOnPickListSetSize write FOnPickListSetSize;

event is called to set size of PickList dropdown box

Published property OnGetLookupListItemHeight: TGetLookupListItemHeight read FGetLookupListItemHeight write FGetLookupListItemHeight;

event is called to set Lookup dropdown item height

Published property OnGetLookupListItemProps: TGetLookupListItemProps read FGetLookupListItemProps write FGetLookupListItemProps;

event is called to set Lookup dropdown item style or custom draw item

Published property OnGetEllipsisButtonFormat: TGetEllipsisButtonFormat read FOnGetEllipsisButtonFormat write FOnGetEllipsisButtonFormat;

event is called to define format of Ellipsis button in the cell

Published property OnTopLeftChanged: TNotifyEvent read FOnTopLeftChanged write FOnTopLeftChanged;

event is called after horizonal scrolling (first visible column is changed)

Published property OnDataScrolled: TNotifyEvent read FOnDataScrolled write FOnDataScrolled;

event is called after user scroll to another record

Published property BeforeScanDataset: TScanDatasetEvent read FBeforeScanDataset write FBeforeScanDataset;

event is called before dataset scan

Published property AfterScanDataset: TScanDatasetEvent read FAfterScanDataset write FAfterScanDataset;

event is called after dataset scan

Published property OnColWidthChanged: TColWidthChangedEvent read FOnColWidthChanged write FOnColWidthChanged;

event is called after changing of column width

Published property OnSetColumnFilter: TSetColumnFilterEvent read FOnSetColumnFilter write FOnSetColumnFilter;

event is called to custom setting of funel filter for the column

Published property OnRefreshData: TNotifyEvent read FOnRefreshData write FOnRefreshData;

event is not called by rDBGrid, is used by rDBAction only


Generated by PasDoc 0.13.0 on 2016-10-19 12:19:00