X-Files Software Components Developer's Guide

X-Files Software Components provides a collection of advanced components designed for Delphi and C++Builder. This guide details the features and usage of the components, allowing developers to incorporate them into their applications.

PDF

Document

X-Files Software

Developer’s Guide

Version 6.3

X-Files Components - Overview

______________________________________________ 5

X-Files Components - Requirements

__________________________________________ 7

X-Files Components - Installation

____________________________________________ 8

X-Files Components - Support

______________________________________________ 12

XDBGrids unit

TXDBGrid

__________________________________________________________________ 15

TXCustomDBGrid

__________________________________________________________ 15

TXDBGridColumns

________________________________________________________ 112

TXColumn

________________________________________________________________ 115

TXColumnTitle

____________________________________________________________ 148

TXColumnTotal

___________________________________________________________ 155

TXColumnTotalValue

______________________________________________________ 163

TXColumnTotalValues

_____________________________________________________ 169

TXColumnTotalHeader

_____________________________________________________ 171

TXColumnTotalFooter

_____________________________________________________ 172

TXColumnTotalFields

______________________________________________________ 173

TXDBGridTotals

___________________________________________________________ 174

TXColumnReport

__________________________________________________________ 180

TXDBGridFilter

____________________________________________________________ 184

TXDBGridSearch

__________________________________________________________ 189

TXGridStyle

_______________________________________________________________ 193

TXScrollProp

_____________________________________________________________ 196

TXDBGridSettings

_________________________________________________________ 199

TXDBGridGradient

________________________________________________________ 205

TXBookmarkList

__________________________________________________________ 206

TXColumnList

_____________________________________________________________ 212

XQRGrids unit

TXQRGrid

________________________________________________________________ 229

TXQRPreviewSettings

_____________________________________________________ 244

TXReportBands

___________________________________________________________ 246

TXReportBand

____________________________________________________________ 250

TXReportGridBand

________________________________________________________ 252

TXReportTextBand

________________________________________________________ 252

TXReportGroupBand

______________________________________________________ 253

TXReportPageBand

_______________________________________________________ 254

TXReportBandStyle

_______________________________________________________ 255

TXReportText

_____________________________________________________________ 257

TXReportStyle

____________________________________________________________ 261

XDBLists unit

TXDBColumnsDialog

______________________________________________________ 264

TXDBPrintColumnsDialog

_________________________________________________ 269

XDBFields unit

TXBlobField

______________________________________________________________ 270

TXGraphicField

___________________________________________________________ 271

XFSGraph unit

TXFGradient

______________________________________________________________ 273

TXFGradientBackground

__________________________________________________ 281

TXFGradientButton

________________________________________________________ 281

TXFGradientProgress

_____________________________________________________ 282

XFSCtrls unit

TXFButton

________________________________________________________________ 286

TXFBitBtn

________________________________________________________________ 289

TXFSpeedButton

__________________________________________________________ 292

TXFLabel

_________________________________________________________________ 294

TXFCustomStaticText

_____________________________________________________ 295

TXFStaticText

_____________________________________________________________ 296

TXFCustomCheckBox

_____________________________________________________ 296

TXFCheckBox

_____________________________________________________________ 297

TXFRadioButton

__________________________________________________________ 297

TXFGroupCheckBox

_______________________________________________________ 298

TXFCustomGroupBox

_____________________________________________________ 300

TXFGroupBox

_____________________________________________________________ 302

TXFCustomRadioGroup

___________________________________________________ 302

TXFRadioGroup

___________________________________________________________ 303

TXFCustomCheckGroup

___________________________________________________ 303

TXFCheckGroup

__________________________________________________________ 304

TXFCustomPanel

__________________________________________________________ 305

TXFPanel

_________________________________________________________________ 306

TXFUpDown

______________________________________________________________ 307

TXFStatusBar

_____________________________________________________________ 309

TXFTrackBar

______________________________________________________________ 310

TXFProgressBar

__________________________________________________________ 311

XDBCtrls unit

TXDBNavigator

___________________________________________________________ 312

TXDBNavButton

___________________________________________________________ 316

TXDBText

_________________________________________________________________ 317

TXDBCheckBox

___________________________________________________________ 318

TXDBRadioGroup

_________________________________________________________ 318

_______

Note. Find all occurences of

{* ver. 6.3 *}

marker to read new topics only.

X-Files Components

- Overview

X-Files Components 6.3 package contains a full set of professional advanced components designed for

Delphi 5, 6, 7, 2005, 2006, 2007, 2009, 2010, XE, XE2, XE3, XE4, XE5, XE6, XE7, XE8, 10 Seattle, 10.1

Berlin and for C++Builder 5, 6, 2006, 2007, 2009, 2010, XE, XE2, XE3, XE4, XE5, XE6, XE7, XE8, 10

Seattle, 10.1 Berlin.

X-DBGrid Component 6.3 package contains few fundamental components designed for database developers. This package is a main part of X-Files Components package.

X-DBGrid Component package contains:

Main DB-Aware controls:

TXDBGrid component is a powerful functional extension of standard TDBGrid component. TXDBGrid component looks beautiful and implements many additional features like: fixed columns, Windows themes and custom styles, many variants of gradient drawing, proportional scrolling for any DataSet even filtered, expandable columns and title headers, checkboxes, hot buttons, title and indicator images, many variants of pictures drawing into cells, sorting markers and multicolumns sorting, enhanced lookup list, data list, calculator, calendar, storing and loading columns layout, enhanced support for bdRightToLeft BiDiMode, extended rows, columns and cells selection, auto-number and auto-select column, hints and tooltips, column stretching and many, many more ...

TXDBGrid offers in addition: auto-updated quick sequence number, auto-changed sorting order for all standard DataSet descendants (ADO, BDE, CDS, DBX, IBX, FireDAC) and many of third-party DAC components, auto-calculated totals values for whole DataSet and/or for SelectedRows, 4 kinds of integrated totals footers, extended lookup columns, integrated filtering system and auto-filter list for each column.

TXDBGrid is fully compatible with standard TDBGrid and can be used as a replacement without losing existing values. TXDBGrid has its own Column Editor and Designer, which can fully support all new column's properties.

TXDBColumnsDialog is a complementary component for TXDBGrid designed for grid columns management in run-time. User can show/hide selected columns in the grid by using convenient dialog which presents columns list with checkboxes.

TXDBNavigator represents a gradient database navigator. TXDBNavigator is a functional extension of standard TDBNavigator . TXDBNavigator introduces several new properties to control border of buttons, gradient drawing style and parent's background.

DB-Aware graphic classes:

TXBlobField & TXGraphicField classes extend functionality of TBlobField & TGraphicField to achieve assignment compatibility between graphic BLOB field and TPicture class for another graphic formats. It allows directly using TImage , TDBImage , TQRImage , TQRDBImage with any graphic format stored in graphic BLOB fields (*.bmp, *.ico, *.gif, *.png, *.jpg and others supported by FieldGraphicClass ).

Gradient graphic classes:

TXFGradient class is a fundamental class of gradient drawing style. It holds all properties and methods needed to realize gradient drawing for all controls. TXFGradient introduced a set of properties & options to select many variants of gradient drawing style. The properties, methods & events from this class allow to self-implement gradient drawing style in other controls.

X-Files Components package contains all above components/classes and the following:

DB-Aware reporting controls:

TXQRGrid is a complementary component for TXDBGrid designed for dynamic report creation on the basis of TXDBGrid current settings. TXQRGrid component can print and preview the content of

TXDBGrid component. TXQRGrid creates in run-time complete report in QuickReport format. The report can be automatically stretched or created as few parts (vertical bands) depend on selected paper size settings.

TXDBPrintColumnsDialog is a complementary component for TXDBGrid & TXQRGrid designed for selection printed columns in run-time. User can select columns that are printed by using convenient dialog which presents columns list with checkboxes.

Additional DB-Aware controls:

TXDBText represents a data-aware control that displays the value of a field on a gradient background.

TXDBText is derrived from the standard TDBText control, but Transparent property is default True.

TXDBCheckBox represents a data-aware transparent check box. TXDBCheckBox is derived from the standard TDBCheckBox control, but works effecive on gradient background.

TXDBRadioGroup represents a gradient group of radio buttons connected to a database.

TXDBRadioGroup is similar to the standard TDBRadioGroup control, but introduces several properties to control gradient style and parent's background.

Gradient buttons:

TXFButton is a gradient push button control. TXFButton is derrived from the standard TButton control.

TXFButton introduces several properties to control border and gradient style.

TXFBitBtn is a gradient bitmap button control. TXFBitBtn is derrived from the standard TBitBtn control.

TXFBitBtn introduces several properties to control border and gradient style.

TXFSpeedButton is a gradient button control. TXFSpeedButton is derrived from the standard

TSpeedButton control. TXFSpeedButton introduces several properties to control border and gradient style.

TXFUpDown is a gradient up-down control. TXFUpDown is similar to the standard TUpDown control, but introduces several properties to control border and gradient style.

Transparent controls:

TXFLabel is a nonwindowed control that displays text on a gradient background. TXFLabel is derrived from the standard TLabel control, but Transparent property is default True.

TXFStaticText is a windowed control that displays text on a gradient background. TXFStaticText is similar to the standard TStaticText control, but Transparent property works effective on a gradient background.

TXFCheckBox represents a transparent check box. TXFCheckBox is similar to the standard

TCheckBox control, but works effecive on gradient background.

TXFRadioButton represents a transparent radio button. TXFRadioButton is similar to the standard

TRadioButton control, but works effecive on gradient background.

Gradient panels:

TXFGroupBox represents a gradient group box. TXFGroupBox is similar to the standard TGroupBox control, but introduces several properties to control gradient style and parent's background.

TXFRadioGroup represents a gradient group of radio buttons that function together. TXFRadioGroup is similar to the standard TRadioGroup control, but introduces several properties to control gradient style and parent's background.

TXFCheckGroup represents a gradient group of check buttons that function together. TXFCheckGroup is similar to the TRadioGroup control, but introduces Checked property to maintain state of check buttons and several properties to control gradient style and parent's background.

TXFPanel represents a gradient panel. TXFPanel is similar to the standard TPanel control, but introduces several properties to control gradient style and parent's background.

Gradient bars:

TXFStatusBar represents a gradient status bar. TXFStatusBar is similar to the standard TStatusBar control, but introduces several properties to control gradient style.

TXFTrackBar represents a gradient track bar. TXFTrackBar is similar to the standard TTrackBar control, but introduces several properties to control gradient style.

TXFProgressBar represents a gradient progress bar. TXFProgressBar is similar to the standard

TProgressBar control, but introduces several properties to control gradient style.

X-Files Components

- Requirements

Delphi/C++Builder updates:

__________________________________________________________

The package requires using latest released updates for each version of Delphi/C++Builder: Delphi

5.01, Delphi 6.02 RTL 3, Delphi 7.01, Delphi 2005.03 Win32, Delphi 2006.02 Win32, Delphi 2007.03

Win32, Delphi 2009.03, Delphi 2010.05, Delphi XE.01, Delphi XE2.04, Delphi XE3.02, Delphi XE4.01,

Delphi XE5.02, Delphi XE6.01, Delphi XE7.01, Delphi XE8.01, Delphi 10 Seattle, Delphi 10.1 Berlin,

C++Builder 5.01, C++Builder 6.04, C++Builder 2006.02, C++Builder 2007.03, C++Builder 2009.03,

C++Builder 2010.05, C++Builder XE.01, C++Builder XE2.04, C++Builder XE3.02, C++Builder XE4.01,

C++Builder XE5.02, C++Builder XE6.01, C++Builder XE7.01, C++Builder XE8.01, C++Builder 10

Seattle, C++Builder 10.1 Berlin. You may can't install the package on the Trial/Personal version of some Delphi/C++Builder.

QuickReport updates:

_____________________________________________

TXQRGrid component requires to install latest version of QuickReport Standard for appropriate version of Delphi/C++Builder. For Delphi 5 - QR 3.5 (qr35sd5.exe), for Delphi 6 - QR 3.5.1 (qr351sd6.exe), for

Delphi 7 - QR 3.5.1 (qr351sd7.exe), for C++Builder 5 - QR 3.5 (qr35sc5.exe), for C++Builder 6 - QR

3.5 (qr35sc6.exe).

The latest version of QuickReport Standard may be downloaded from QuSoft AS Home Page or directly from X-Files Components Website . If you want to use TXQRGrid component with other version of QuickReport (e.g. Professional) you should register the Professional version of X-Files Components

(with source) to recompile this package.

TXQRGrid component for Delphi 2005 and higher is not delivered in X-Files Components Standard package due the QuickReport Standard package is missing in these versions of Delphi. To can still use

TXQRGrid component in Delphi 2005 or higher you must register X-Files Components Professional and QuickReport Professional. TXQRGrid component works correctly with latest versions of

QuickReport Professional 3.6x, 4.0x, 5.0x.

Windows Themes:

_______________________________________

To get (on Delphi/C++Builder 5 & 6) Windows Themes for TXDBGrid component and to use Windows

Themes for other controls delivered in the package, you should download and install Windows XP

Theme Manager (freeware by Mike Lischke) from http://www.soft-gems.net/ and register the

Professional version (with source) of the package. (Mike Lischke is author of Themes unit delivered in

Delphi 7 and higher).

Graphics in BLOB fields:

___________________________________________________

To can display additional graphic formats in TXDBGrid (*.pcx, *.scr, *.tif, *.eps, etc.) you should download GraphicEx library by Mike Lischke (Mozilla Public Licence 1.1) from http://www.softgems.net/ and register the Professional version (with source) of a package.

To can using TXBlobField & TXGraphicField as default classes for BLOB fields, you must register the

Professional version (with source) of a package, to can recompile it.

X-Files Components

- Installation

To install X-Files Components package you should:

____________________________________________________________________________________________________________

1. Uninstall previous version of X-Files Components / X-DBGrid Component, if exists.

2. Run X-FilesNNXXX.exe installer.

To install X-DBGrid Component package you should:

_______________________________________________________________________________________________________________

1. Uninstall previous version of X-DBGrid Component / X-Files Components, if exists.

2. Run X-DBGridNNXXX.exe installer.

How to update Library Path ?

______________________________________________________________

Make sure your Library Path contains only one path pointing to X-Files Components or X-DBGrid

Component package.

•

The default path for X-Files Components is:

$(DELPHI)\XFiles - for Delphi 5, 6, 7

$(BCB)\XFiles - for C++Builder 5, 6

$(BDS)\XFiles - for Delphi 2005, 2006, 2007, 2009, 2010, XE, XE2, ..., XE8

$(BDS)\XFiles - for C++Builder 2006, 2007, 2009, 2010, XE, XE2, ..., XE8

$(BDS)\XFiles - for RAD Studio 10 Seattle, RAD Studio 10.1 Berlin

•

The default path for X-DBGrid Component is:

$(DELPHI)\XDBGrid - for Delphi 5, 6, 7

$(BCB)\XDBGrid - for C++Builder 5, 6

$(BDS)\XDBGrid - for Delphi 2005, 2006, 2007, 2009, 2010, XE, XE2, ..., XE8

$(BDS)\XDBGrid - for C++Builder 2006, 2007, 2009, 2010, XE, XE2, ..., XE8

$(BDS)\XDBGrid - for RAD Studio 10 Seattle, RAD Studio 10.1 Berlin

When you install the new package, the new installer can automatically change path in the Library Path for this reason.

How to install Context Help File ?

_______________________________________________________________________

The installer can automatically install Context Help File, then you don't need to do it manualy. If your

OpenHelp can't find any topic from X-Files Components Reference file, you should:

1. Select the Help | Customize... menu item to display OpenHelp window.

2. Add the ..\Help\XFiles.cnt file to the Contents page.

3. Add the ..\Help\XFiles.hlp file to the Index page.

4. Add the ..\Help\XFiles.hlp file to the Link page.

5. Click on File | Save Project to save your changes.

Notice. You may need to remove any indexes you do not use because default help indexing is near the limits of Microsoft's WinHelp. If you experience an empty list on the Index tab page of WinHelp, this indicates you need to remove some files from OpenHelp.

How to install Context Help File for Delphi 2005 or higher ?

_____________________________________________________________________________________________________________________

Delphi 2005 and higher uses help files in HtmlHelp format. You can't integrate WinHelp XFiles.hlp file with

HtmlHelp, but you can still open XFiles.hlp file from Start Menu Folder, you have selected during installation.

How to replace TDBGrid component with TXDBGrid component in old projects ?

_________________________________________________________________________________________________________________________________________________________________________

TXDBGrid is fully compatible with TDBGrid component on properties level and can be used as a replacement without losing existing values.

1. Replace "DBGrids" unit name to "XDBGrids" unit in uses clause.

2. Replace all occurence of "TDBGrid" class to "TXDBGrid" class.

3. Click right mouse button on a form and select "View as Text".

4. Replace all occurence of "TDBGrid" class to "TXDBGrid" class.

5. Click right mouse button on editor and select "View as Form".

6. Save changes, (important) close the form and reopen it.

7. Replace other class name to "TX" class name (e.g. TColumn to TXColumn).

How to replace standard controls with appropriate gradient controls in old projects ?

__________________________________________________________________________________________________________________________________________________________________________________

1. Check "Install Demo files" and "Compile Demo files" tasks during package installation.

2. Run XFChanger application from Start Menu Folder, you have selected during installation.

3. Select the unit(s) to exchange standard controls with gradient controls.

How to recompile X-DBGrid Component package ?

________________________________________________________________________________________________________

1. Open Conditionals.pas source file from $(Delphi)\XDBGrid\Source directory.

2. Change swich(es), save the file on disk and close Delphi/C++Builder environment.

3. Find DCCXDBGridNN.bat file in $(Delphi)\XDBGrid\Source directory and run it.

4. Check, the compilation for both packages finished successfully.

5. Press Enter to install recompiled files, press Ctrl+C to cancel installation.

To do this you should have the Professional version (with source) of the package.

How to recompile X-Files Components package ?

________________________________________________________________________________________________________

1. Open Conditionals.pas source file from $(Delphi)\XFiles\Source directory.

2. Change swich(es), save the file on disk and close Delphi/C++Builder environment.

3. Find DCCXFilesNN.bat file in $(Delphi)\XFiles\Source directory and run it.

4. Check, the compilation for both packages finished successfully.

5. Press Enter to install recompiled files, press Ctrl+C to cancel installation.

To do this you should have the Professional version (with source) of the package.

How to achieve using Windows Themes under Delphi/C++Builder 5 & 6 ?

_________________________________________________________________________________________________________________________________________________________________

To achieve using Windows Themes the TThemeServices class is required. This class is available in

Themes unit as early as Delphi 7. To achieve themed version of all X-Files controls under

Delphi/C++Builder 5 & 6, you should:

1. Download Windows XP Theme Manager by Mike Lischke (freeware) from http://www.softgems.net/ .

2. Open ThemeManagerN.dpk package and select "Explicit rebuild" Build control in Package

Options.

3. Compile and install Windows XP ThemeManager package.

4. Copy ThemeManagerN.dcp file from $(Delphi)\Projects\Bpl directory to $(Delphi)\XFiles\Source directory.

5. Replace switch

{$UNDEF THEMES}

with

{$DEFINE THEMES}

in ..\Source\Conditionals.pas file.

6. Recompile X-DBGrid Component or X-Files Components package.

7. Remember to add XP Manifest either file or resource to your project.

To do this you must have the Professional version (with source) of the package.

How to use X-Files Components Professional with QuickReport Professional ?

___________________________________________________________________________________________________________________________________________________________________

X-Files Components package is compiled with using latest version of QuickReport Standard. When the fatal error occurs (

[Fatal Error] Project1.dpr(5): Unit XQRGrids was compiled with a different version of QuickRpt.TCustomQuickRep

) you must recompile this package. To recompile package with other version of QuickReport (e.g. Professional), you should:

1. Copy QuickReport's run-time *.dcp file (e.g QR4RunD7.dcp) from $(Delphi)\Projects\Bpl to

$(Delphi)\XFiles\Source directory.

1a.To recompile also 64-bit version of the package you must copy 64-bit version of QuickReport's runtime *.dcp file to $(Delphi)\XFiles\Source\Win64 directory.

2. Replace switch

{$UNDEF XQRGRID}

with

{$DEFINE XQRGRID}

in ..\Source\Conditionals.pas file, if needed.

3. Define switch

QR36

QR40

or either

QR50

in ..\Source\Conditionals.pas file, depend on

QuickReport's version.

4. Check, the name of QuickReport's run-time package is correct in ..\Source\VCLXFilesNN.dpk file.

5. Recompile X-Files Components package.

To do this you must have the Professional version (with source) of the package.

Notice. Some versions of Quick Report Professional have selected incorrect Build control switch in

Package Options ("Rebuild as needed"). In that case, you must first change this option to "Explicit

rebuild" and rebuild both packages of Quick Report, to successfully recompile X-Files Components

Professional package.

How to display additional graphic formats (*.pcx, *.tiff, etc.) in TXDBGrid ?

____________________________________________________________________________________________________________________________________________________________

TXDBGrid component can directly display *.bmp, *.ico, *.wmf, *.emf, *.gif, *.png & *.jpg graphics stored in

BLOB fields, when DataType of BLOB field is ftGraphic. To directly display additional graphic formats in

TXDBGrid, you should:

1. Download GraphicEx library by Mike Lischke (Mozilla Public Licence 1.1) from http://www.softgems.net/ .

2. Open ..\GraphicEx\GraphicConfiguration.inc file and select graphic formats you need to include.

3. Open ..\Source\DCCXDBGridNN.bat or ..\Source\DCCXFilesNN.bat batch file and add path to

GraphicEx library after -u switch (e.g. -u..\..\GraphicEx).

4. Replace switch

{$UNDEF GRAPHICEX}

with

{$DEFINE GRAPHICEX}

..\Source\Conditionals.pas file.

5. Recompile X-DBGrid Component or X-Files Components package.

To do this you must have the Professional version (with source) of the package.

How to display additional graphic formats in TDBImage, TQRDBImage ?

________________________________________________________________________________________________________________________________________________________

TDBImage & TQRDBImage can display only *.bmp graphics stored in BLOB fields, because TBlobField &

TGraphicField classes supports assignment only from/to TBitmap graphic class. To achieve assignment compatibility between graphic BLOB field and TPicture class for additional graphic formats (*.ico, *.wmf,

*.emf, *.gif, *.png, *.jpg and others supported by GraphicEx library) you should to add XDBFields unit to the uses clause and replace TBlobField & TGraphicField class names with TXBlobField &

TXGraphicField . You can do it manually or by running XFChanger application from Start Menu Folder, you have selected during installation.

How to install TXBlobField & TXGraphicField as default classes for BLOB fields ?

__________________________________________________________________________________________________________________________________________________________________________

To install TXBlobField & TXGraphicField as default classes for BLOB fields, you should:

1. Replace switch

{$UNDEF XDBFIELDS}

with

{$DEFINE XDBFIELDS}

..\Source\Conditionals.pas file.

2. Recompile X-DBGrid Component or X-Files Components package.

To do this you must have the Professional version (with source) of the package.

Notice. From now, all necessary BLOB fields added in Fields Editor will be created as TXBlobField &

TXGraphicField, but you still must to replace TBlobField & TGraphicField class names with TXBlobField &

TXGraphicField in existing *.dfm & *.pas files. You can do it manually or by running XFChanger application from Start Menu Folder, you have selected during installation.

X-Files Components

- Support

X-Files Support

________________________________

If you experience any technical problems, please feel free to contact me for support. I will try to answer your questions within 24 hours. Before you'll send e-mail, please check X-Files Components FAQ page for looking up a ready solution for your problem.

Sincerely,

Krzysztof Szyszka, X-Files Software

Developer of X-Files Components

Embarcadero Technology Partner

______________________________________________________________________________

Website: http://www.x-files.pl/

E-mail: [email protected]

Troubleshooting

__________________________________

1. Using TXDBGrid component on Middle Eastern locale.

TXDBGrid component implements bdRightToLeft BiDiMode on the platform whether the local represents a

Middle Eastern locale ( SysLocale .MiddleEast = True), but some bugs have been detected in antecesor class ( TCustomGrid ).

To ensure correct working for TXDBGrid component when SysLocale.MiddleEast is True and BiDiMode is bdRightToLeft, you need fix the bugs in Grids.pas unit and add source of the Grids unit to your project.

These are the statements from Grids.pas unit, you need to improve:

{ Need for Delphi 5, 6, 7, 2005, 2006, 2007, 2009, 2010, XE, XE2 }{ Solved in

XE3 }

function TCustomGrid.CalcCoordFromPoint(X, Y: Integer;

const DrawInfo: TGridDrawInfo): TGridCoord;

... begin

if not UseRightToLeftAlignment then

Result.X := DoCalc(DrawInfo.Horz, X)

else

Result.X := DoCalc(DrawInfo.Horz, ClientWidth - X); // Added by K.S.

12/23/2000

// Result.X := DoCalcRightToLeft(DrawInfo.Horz, X); // Commented by K.S.

12/23/2000

Result.Y := DoCalc(DrawInfo.Vert, Y); end;

{ Need for Delphi 5 only }

procedure TCustomGrid.CalcSizingState(X, Y: Integer; var State: TGridState;

var Index: Longint; var SizingPos, SizingOfs: Integer;

var FixedInfo: TGridDrawInfo);

procedure CalcAxisState(const AxisInfo: TGridAxisDrawInfo; Pos: Integer;

NewState: TGridState);

var

I, Line, Back, Range: Integer;

begin

if NewState = gsColSizing then // Added by K.S. 12/23/2000

if UseRightToLeftAlignment then

Pos := ClientWidth - Pos;

{ Need for Delphi 5 only }

procedure TCustomGrid.MouseDown(Button: TMouseButton; Shift: TShiftState;

X, Y: Integer);

...

if FGridState <> gsNormal then

begin

if FGridState = gsColSizing then // Added by K.S. 12/23/2000

if UseRightToLeftAlignment then

FSizingPos := ClientWidth - FSizingPos;

DrawSizingLine(DrawInfo);

Exit;

end;

{ Need for Delphi 5 only }

procedure TCustomGrid.MouseUp(Button: TMouseButton; Shift: TShiftState;

X, Y: Integer);

...

gsRowSizing, gsColSizing:

begin

CalcDrawInfo(DrawInfo);

DrawSizingLine(DrawInfo);

if FGridState = gsColSizing then // Added by K.S. 12/23/2000

if UseRightToLeftAlignment then

FSizingPos := ClientWidth - FSizingPos;

If you'll implement these changes, mouse click on fixed columns and row resizing by the user should work correct for TXDBGrid component and for each TCustomGrid's descendant when SysLocale.MiddleEast is

True and BiDiMode is bdRightToLeft.

2. Using TXDBGrid component when invisible column starts from XDBGrid.ClientWidth.

When the property Visible will be False for the column that starts from XDBGrid.ClientWidth the Invalidate method work incorrect. When you'll click on several cells, you may see old and new selection for this cells.

You need fix the bug in Grids.pas unit and add source of this unit to your project. These are the statements from Grids.pas unit, you need to improve:

{ Need for Delphi 5, 6, 7, 2005, 2006, 2007, 2009, 2010, XE, XE2, XE3, XE4,

XE5, XE6, XE7 }

procedure TCustomGrid.GridRectToScreenRect(GridRect: TGridRect;

var ScreenRect: TRect; IncludeLine: Boolean);

function LinePos(const AxisInfo: TGridAxisDrawInfo; Line: Integer): Integer;

...

for I := Start to Line - 1 do

begin

Inc(Result, GetExtent(I) + EffectiveLineWidth);

if Result > GridExtent + EffectiveLineWidth then // Added by K.S.

09/25/2002

// if Result > GridExtent then // See CalcAxis // Commented by K.S.

09/25/2002

begin

Result := 0;

Exit;

end;

DISCLAIMER OF WARRANTY

_________________________________________________________________________

THIS SOFTWARE IS PROVIDED TO YOU "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER

EXPRESSED OR IMPLIED INCLUDING BUT NOT LIMITED TO THE APPLIED WARRANTIES OF

MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE. YOU ASSUME THE

ENTIRE RISK AS TO THE ACCURACY AND THE USE OF THE SOFTWARE AND ALL OTHER RISK

ARISING OUT OF THE USE OR PERFORMANCE OF THIS SOFTWARE AND DOCUMENTATION.

X-Files Software SHALL NOT BE LIABLE FOR ANY DAMAGES WHATSOEVER ARISING OUT OF

THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF X-Files Software HAS BEEN

ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. TO THE MAXIMUM EXTENT PERMITTED BY

APPLICABLE LAW, IN NO EVENT SHALL X-Files Software BE LIABLE FOR ANY

CONSEQUENTIAL, NCIDENTAL, DIRECT, INDIRECT, SPECIAL, PUNITIVE, OR OTHER DAMAGES

WHATSOEVER, INCLUDING BUT NOT LIMITED TO DAMAGES OR LOSS OF BUSINESS PROFITS,

BUSINESS INTERRUPTION, LOSS OF BUSINESS INFORMATION, OR OTHER PECUNIARY LOSS,

EVEN IF X-Files Software HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

TXDBGrid

TXDBGrid displays and manipulates records from a dataset in a tabular grid.

Unit

XDBGrids

Description

TXDBGrid component is a powerful functional extension of standard TDBGrid component.

TXDBGrid component implements many additional features like: fixed columns, Windows themes and custom styles, many variants of gradient drawing, proportional scrolling for any DataSet even filtered, expandable columns and title headers, checkboxes, hot buttons, title and indicator images, many variants of pictures drawing into cells, sorting markers and multicolumns sorting, enhanced lookup list, data list, calculator, calendar, storing and loading columns layout, enhanced support for bdRightToLeft BiDiMode, extended rows, columns and cells selection, auto-number and auto-select column, hints and tooltips, column stretching and many, many more ...

TXDBGrid implements the generic behavior introduced in TXCustomDBGrid . TXDBGrid publishes many of the properties inherited from TXCustomDBGrid, but does not introduce any new behavior.

_______

TXCustomDBGrid

TXCustomDBGrid is the abstract base class for grid controls that display the records from a dataset in a tabular format.

Unit

XDBGrids

Description

TXCustomDBGrid introduces new properties, events, and methods to expand the capabilities of

TCustomDBGrid .

Do not create instances of TXCustomDBGrid. Use TXCustomDBGrid as a base class when declaring grid objects that display information from datasets. Properties and methods of TXCustomDBGrid provide basic behavior that descendant classes inherit as well as behavior that components can override to customize their behavior.

_______

TXCustomDBGrid.AlignStretchToBorder

Specifies whether the stretched grid is aligned to border frame.

property AlignStretchToBorder: Boolean; {* ver. 6.0 *}

Description

Use AlignStretchToBorder property to determine whether the grid is aligned to border frame.

AlignStretchToBorder returns True when StretchMode is active, vertical scrollbar is not visible, grid is not themed and control has not 3D border frame.

AlignStretchToBorder is a read-only property.

_______

See also: TXCustomDBGrid.AlignTotalsToBorder

TXCustomDBGrid.AlignTotalsToBorder

Specifies whether the stretched grid is aligned to border frame.

property AlignTotalsToBorder: Boolean; {* ver. 6.0 *}

Description

Use AlignTotalsToBorder property to determine whether the grid is aligned to border frame.

AlignTotalsToBorder returns True when any total row is visible, horizontal scrollbar is not visible, grid is not themed and control has not 3D border frame.

AlignTotalsToBorder is a read-only property.

_______

See also: TXCustomDBGrid.AlignStretchToBorder

TXCustomDBGrid.BlankHeight

Specifies the height (in pixels) of blank row.

property BlankHeight: Integer;

Description

If the OptionsEx property include dgBlankRow, BlankHeight specifies a height of blank row between data rows and total rows, otherwise BlankHeight specifies a height of blank area between data rows and the bottom of grid. BlankHeight is calculated as ClientHeight - TitleHeight - TotalHeight - DataRowsHeight .

BlankHeight is a read-only property.

_______

See also: TXCustomDBGrid.TitleHeight

, TXCustomDBGrid.TotalHeight

, TXCustomDBGrid.DataRowsHeight

TXCustomDBGrid.DataHeight

TXCustomDBGrid.BorderStyle

Determines whether a single line border is drawn around the grid.

property BorderStyle: TBorderStyle ;

Description

Set BorderStyle to bsSingle to add a single line border around the grid's image. Set BorderStyle to bsNone to omit the border. When BorderStyle is bsSingle and Ctl3D property is False, the color of line border is automatically adjusted to current FixedStyle property. It allows to obtain flat or semi-flat look for the grid control.

_______

See also: TXCustomDBGrid.FixedStyle

, TXCustomDBGrid.ListBorder

, TXCustomDBGrid.Ctl3D

TXCustomDBGrid.ColLineWidth

Specifies the width (in pixels) of the lines that separate the columns of the grid.

property ColLineWidth: Integer;

Description

If the Options property include dgColLines, ColLineWidth is 1, otherwise ColLineWidth is 0.

ColLineWidth is a read-only property.

_______

TXCustomDBGrid.ColsChanged

Indicates the changes were made in SelectedCols list.

property ColsChanged: Boolean; {* ver. 4.3 *}

Description

The ColsChanged flag indicates the changes were made in SelectedCols list after BeginSelect method was called at the start of the changes. When the changes were made the ColsChanged is True. The

ColsChanged flag is cleared by EndSelect method.

ColsChanged is a read-only property

_______

TXCustomDBGrid.ColsSelected

Specifies whenever any column or data cell is multiselected.

property ColsSelected: Boolean; {* ver. 4.3 *}

Description

Read ColsSelected to determine is any column or data cell currently multiselected in the grid.

ColsSelected returns True when ColsSelection is True and SelectedCols list is not empty, otherwise

ColsSelected return False.

ColsSelected is a read-only property.

_______

TXCustomDBGrid.ColsSelection

Specifies whenever any column or data cell is multiselected.

property ColsSelection: Boolean; {* ver. 4.3 *}

Description

Read ColsSelection to determine is multiselection of columns or cells currently active. ColsSelection returns True when MultiSelect is msCols or msCells, otherwise ColsSelection return False. When

ColsSelection is True, the SelectedCols list contains selected columns (msCols) or columns of selected area (msCells).

ColsSelection is a read-only property.

_______

TXCustomDBGrid.ColumnNames

Describes the display attributes of the columns.

property ColumnNames[const FieldName: string]: TXColumn read GetColumnNames;

default; {* ver. 4.31 *}

property ColumnNames[const FieldName: WideString]: TXColumn read

GetColumnNames; default;

// Delphi 2006, 2007 Win32, 2009, 2010, XE

Description

Use ColumnNames to read or set attributes of the columns in TXDBGrid. The ColumnNames property allows to access to Columns collection with using FieldName as an index of the collection. The

ColumnNames is default property for TXDBGrid. It allows you to use short syntax

XDBGrid1[FieldName]

instead

XDBGrid1.ColumnNames[FieldName]

Example:

CustomerDBGrid[ 'Country' ].Visible := False;

Text := CustomerDBGrid[ 'Company' ].TotalHeader.DisplayText;

_______

See also: TXCustomDBGrid.Columns

TXCustomDBGrid.Columns

Describes the display attributes and field bindings of the columns.

property Columns: TXDBGridColumns ;

Description

Use Columns to read or set the field bindings and display attributes of the columns in TXDBGrid. Columns is an indexed collection of TXColumn objects. Use the properties of the TXColumn objects to specify the display attributes or field bindings of individual columns in the grid. The field binding of a column designates a field within the dataset specified by the DataSource property.

_______

See also: TXColumn , TXDBGridColumns , TXCustomDBGrid.ColumnNames

TXCustomDBGrid.ColumsWidth

Specifies the width (in pixels) of all visibled columns in the grid.

property ColumnsWidth: Integer;

Description

The ColumnsWidth property determines the width of all visibled columns in the grid in pixels. When

ColumnsWidth is greater than ClientWidth the horizontal scrollbar appears in the grid.

ColumnsWidth is a read-only property.

_______

TXCustomDBGrid.Ctl3D

Determines whether a grid has a three-dimensional (3-D) or two-dimensional look.

property Ctl3D: Boolean;

Description

When BorderStyle property is bsSingle the Ctl3D property determines whether the grid has a flat (or semiflat) or beveled appearance.

_______

See also: TXCustomDBGrid.FixedStyle

, TXCustomDBGrid.BorderStyle

Specifies the color of the data column lines in the grid

property DataColLineColor: TColor ; {* ver. 4.3 *}

Description

Set DataColLineColor to specify custom color for the data column lines in the grid.

The DataColLineColor property can handle two special colors: clDefault, clNone.

Select clDefault value to use DefaultDataLineColor value (clSilver).

Select clNone value when the data column lines should not be drawed.

_______

See also: TXCustomDBGrid.DataRowLineColor

, TXCustomDBGrid.FixedLineColor

, TXCustomDBGrid.DefaultDataLineColor

TXCustomDBGrid.DataHeight

Specifies the height (in pixels) of data area.

property DataHeight: Integer;

Description

DataHeight is calculated as ClientHeight - TitleHeight - TotalHeight .

DataHeight is a read-only property.

_______

TXCustomDBGrid.DataLeftCol

Specifies the index of the first visible scrollable column in the grid.

property DataLeftCol: Integer;

Description

Read DataLeftCol to determine the index of the first column in the scrollable region that is visible. Set

DataLeftCol to scroll the columns in the grid so that the column with index DataLeftCol is the first column after the fixed columns.

_______

TXCustomDBGrid.DataRowCount

Indicates the number of data rows shown by the grid.

property DataRowCount: Integer;

Description

Examine DataRowCount to determine the number of data rows shown by the grid. Applications might use this property with Position to iterate through all visibled data rows in the grid. When DataLink is active,

DataRowCount return value of RecordCount , otherwise DataRowCount return 0.

DataRowCount is a read-only property.

_______

TXCustomDBGrid.DataRowLineColor

Specifies the color of the data row lines in the grid

property DataRowLineColor: TColor ; {* ver. 4.3 *}

Description

Set DataRowLineColor to specify custom color for the data row lines in the grid.

The DataRowLineColor property can handle two special colors: clDefault, clNone.

Select clDefault value to use DefaultDataLineColor value (clSilver).

Select clNone value when the data row lines should not be drawed.

_______

See also: TXCustomDBGrid.DataColLineColor

, TXCustomDBGrid.FixedLineColor

, TXCustomDBGrid.DefaultDataLineColor

TXCustomDBGrid.DataRows

Specifies "proxy" class that returns enumerator for all data rows in the grid.

property DataRows: TXDBGridDataRows; {* ver. 5.6 *} // For Delphi 2009 or higher

Description

Use DataRows only when you need enumerator for all data rows in the grid.

type

Bookmark: TBookmark;

begin

for Bookmark in XDBGrid1.DataRows do

begin

// Perform action on each record into XDBGrid1.DataSource.DataSet

end;

_______

TXCustomDBGrid.DataRowsHeight

Specifies the height (in pixels) of all data rows.

property DataRowsHeight: Integer;

Description

DataRowsHeight is calculated as sum of height of all data rows visibled in the grid.

DataRowsHeight is a read-only property.

_______

See also: TXCustomDBGrid.TitleHeight

, TXCustomDBGrid.TotalHeight

, TXCustomDBGrid.BlankHeight

TXCustomDBGrid.DataHeight

TXCustomDBGrid.DefaultWidthMax

Specifies the maximum width for default columns.

property DefaultWidthMax: Integer; {* ver. 6.3 *}

Description

Set DefaultWidthMax to the maximum value of column's width for default columns. The DefaultWidthMin and DefaultWidthMax properties define the initial range for Width property for default columns.

DefaultWidthMax is useful for very large string fields.

_______

See also: TXCustomDBGrid.DefaultWidthMin

TXCustomDBGrid.DefaultWidthMin

Specifies the minimum width for default columns.

property DefaultWidthMin: Integer; {* ver. 6.3 *}

Description

Set DefaultWidthMin to the minimum value of column's width for default columns. The DefaultWidthMin and DefaultWidthMax properties define the initial range for Width property for default columns.

_______

See also: TXCustomDBGrid.DefaultWidthMax

TXCustomDBGrid.DetailFields

Identifies detail fields in the detail dataset linked to the grid.

property DetailFields: string; {* ver. 6.2 *}

property DetailFields: WideString;

// Delphi 2006, 2007 Win32, 2009, 2010, XE only

Description

DetailFields specifies detail fields in master->detail relationship when detail dataset is linked to the grid.

When you specify this property the ChangeIndexFields and CurrentIndexFields methods will automatically take account of DetailFields when master->detail relationship is active.

_______

TXCustomDBGrid.DoubleBuffered

Determines whether the grid's image is rendered directly to the window or painted to an in-memory bitmap first.

property DoubleBuffered: Boolean;

Description

When DoubleBuffered is False, the grid paints itself directly to the window. When DoubleBuffered is True, the grid paints itself to an in-memory bitmap that is then used to paint the window. Double buffering reduces the amount of flicker when the grid repaints, but the rows scroll speed is slowest. Set

DoubleBuffered to False only when you must run your application on slow machines. Especially, you should leave DoubleBuffered = True, when StripeColor is not clNone, or FixedTheme is not ftNone or the user can resize the grid in run-time.

_______

TXCustomDBGrid.DragRows

Determines using drag-and-drop operations for grid's data row(s).

property DragRows: Boolean;

Description

Set DragRows to True (for DragKind = dgDrag and DragMode = dmManual), to set whether the XDBGrid should initial drag-and-drop operations for grid's data row(s).

_______

TXCustomDBGrid.DrawingOptions

Specifies the drawing options of the some color's properties.

type

TGridDrawingOption = (gdoHighlightText, gdoDataColLines, gdoDataRowLines, gdoSelectedCell, gdoSelectedRow, gdoMultiSelected, gdoTotalSelected, gdoStripedRows, gdoEditorColor);

TGridDrawingOptions = set of TGridDrawingOption;

property DrawingOptions: TGridDrawingOptions; {* ver. 5.1 *}

Description

Use DrawingOptions to easily include/exclude using of some Color's properties. The DrawingOptions is a master property for other published properties of TColor type. When a drawing option is included, the corresponding Color property is set to clDefault. When a drawing option is excluded, the corresponding

Color property is set to clNone. The current value of DrawingOptions always shows which Color's properties are efficient used (are different than clNone). These are the possible values of DrawingOptions:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

gdoHighlightText gdoDataColLines

The HighlightText property is used (highlighted text is visible).

The DataColLinesColor property is used (lines of columns are drawn). gdoDataRowLines gdoSelectedCell gdoSelectedRow

The DataRowLinesColor property is used (lines of rows are drawn).

The

SelectCellColor

SelectRowColor

property is used (focused cell is highlighted).

property is used (current row is highlighted).

gdoMultiSelected The SelectionColor property is used (multiselected cells are highlighted). gdoTotalSelected gdoStripedRows gdoEditorColor

The

Totals.SelectedColor

StripeColor

property is used (selected totals are highlighted).

property is used (striped rows are visible).

The EditorColor property is used (edited cell has changing color).

_______

TXCustomDBGrid.DrawingStyle

Specifies the drawing style of the fixed cells.

type

TGridDrawingStyle = (gdsClassic, gdsThemed, gdsGradient);

// For

C++Builder/Delphi 5, 6, 7, 8, 2005, 2006, 2007, 2009

TGridDrawingStyle = Grids.TGridDrawingStyle;

// For

C++Builder/Delphi 2010 or higher

property DrawingStyle: TGridDrawingStyle; {* ver. 5.0 *}

Description

Use DrawingStyle to select drawing style for fixed cells. The DrawingStyle is a master property for

FixedStyle, FixedTheme and Gradient property. These are the possible values of DrawingStyle:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

gdsClassic gdsThemed

The classic drawing style dependent on current FixedStyle value.

The themed drawing style dependent on current FixedTheme value. gdsGradient

_______

The gradient drawing style dependent on current Gradient

See also: TXCustomDBGrid.FixedStyle

, TXCustomDBGrid.FixedTheme

, TXCustomDBGrid.Gradient

settings.

TXCustomDBGrid.EditorColor

Specifies the background color of the editor and editor's list in the grid.

property EditorColor: TColor ;

Description

Set EditorColor to specify background color for editor in the grid.

The EditorColor property can handle two special colors: clDefault, clNone.

Select clDefault value to use DefaultEditorColor value (clInfoBk).

Select clNone value to leave editor color unchanged.

_______

See also: TXCustomDBGrid.SelectCellColor

, TXCustomDBGrid.SelectionColor

, TXCustomDBGrid.SelectRowColor

TXCustomDBGrid.StripeColor

TXCustomDBGrid.FillerButton

Determines using title of indicator as a button.

property FillerButton: Boolean;

Description

If the Options property include dgTitleButtons, set FillerButton to True to use title of indicator (Filler) as button.

_______

TXCustomDBGrid.FillerColor

Specifies the background color of the title of indicator in the grid.

property FillerColor: TColor ;

Description

Set FillerColor to specify custom color for the title of indicator (Filler) in the grid.

_______

TXCustomDBGrid.FillerHint

Contains the text string that can appear when the user moves the mouse over the title of indicator.

property FillerHint: string;

Description

See HintOptions and TControl.Hint

to read more.

_______

TXCustomDBGrid.FillerIndex

Specifies which image is displayed in the title of indicator.

property FillerIndex: Integer;

Description

Use the FillerIndex property with the TitleImages property to specify the image for the title of indicator

(Filler). If the FillerIndex is less than -1, then FillerIndex specifies image from Indicators calculated as -

FillerIndex - 2.

_______

TXCustomDBGrid.FillerPopupMenu

Identifies the pop-up menu associated with the title of indicator.

property FillerPopupMenu: TPopupMenu ;

Description

Assign a value to FillerPopupMenu to make a pop-up menu appear when the user selects the title of indicator (Filler) and clicks the right mouse button.

_______

See also: TXCustomDBGrid.IndicatorPopupMenu

, TXCustomDBGrid.FillerButton

, TXCustomDBGrid.FillerColor

TXCustomDBGrid.FillerHint

, TXCustomDBGrid.FillerIndex

, TXColumnTitle.PopupMenu

TXCustomDBGrid.Filter

Contains the Filter condition from DataSet linked to TXDBGrid.

property Filter: string; {* ver. 6.0 *}

Description

Filter property points to TDataSet.Filter

condition stored in DataSet linked to TXDBGrid. When the Filter property is changed in TXDBGrid the new Filter string is stored in DataSet property, but the change is controlled by TXDBGrid. If KeyFields are defined, the current record is restored, if the record is still available in filtered record set. If dgAutoKeepSelection option is included in OptionsEx and grid has multiselected records, still visible selected records are restored.

_______

TXCustomDBGrid.Filtered

Specifies whether or not filtering is active for a dataset.

property Filtered: Boolean; {* ver. 6.0 *}

Description

Filtered property points to TDataSet.Filtered

state of DataSet linked to TXDBGrid. When the Filtered property is changed in TXDBGrid the Filtered state is changed in DataSet, but the change is controlled by

TXDBGrid. If KeyFields are defined, the current record is restored, if the record is still available in filtered record set. If dgAutoKeepSelection option is included in OptionsEx and grid has multiselected records, still visible selected records are restored.

_______

TXCustomDBGrid.FilterGrid

Indicates the TXDBGridFilter that determines internal filter settings for the grid.

property FilterGrid: TXDBGridFilter ;

Description

The FilterGrid property points to TXDBGridFilter object that determines internal filter settings for the grid.

_______

TXCustomDBGrid.FixedCols

Specifies the number of columns on the left of the grid that cannot be scrolled.

property FixedCols: Integer;

Description

See TCustomGrid.FixedCols

to read more.

_______

See also: TXCustomDBGrid.FixedStyle

TXCustomDBGrid.FixedColsWidth

Specifies the width (in pixels) of all fixed columns in the grid.

property FixedColsWidth: Integer;

Description

The FixedColsWidth property determines the width of all fixed columns in the grid in pixels.

FixedColsWidth is a read-only property.

_______

TXCustomDBGrid.FixedStyle

Specifies the style of the fixed cells in grid.

type

TFixedStyle = (fsDefault, fsSoft, fsNice, fsFlat, fsGreat, fsGray, fsFine, fsMild);

property FixedStyle: TFixedStyle;

Description

Use FixedStyle to draw a variety lines that appears as a frame around fixed cells. The FixedStyle is a master property for other design properties like: Ctl3D , HotButtons , ListBorder , MarkerStyle ,

CheckBoxStyle , ScrollProp.Style

. These are the possible values of FixedStyle:

fsDefault

X-Files Components Developer’s Guide

fsSoft

fsNice fsFlat fsGreat fsGray fsFine fsMild

_______

TXCustomDBGrid.FixedTheme

Specifies the theme of the fixed cells in grid (Windows XP only).

type

TFixedTheme = (ftNone, ftDefault, ftButtons, ftTabs);

property FixedTheme: TFixedTheme;

Description

Use FixedTheme to draw a variety elements that appears as a background of fixed cells. These are the possible values of FixedTheme:

ftDefault ftTabs ftButtons ftNone

Themed cells appear only on Windows XP platform when XP Manifest is present and dgColLines & dgRowLines are included in Options . Select ftNone value to disable themes on Windows XP platform.

Notice. The FixedTheme property requires TThemeServices class. This class is available only in Delphi 7 in Themes unit. To really use FixedTheme in earlier version of Delphi/C++Builder you should download and install Windows XP Theme Manager by Mike Lischke (freeware) from http://www.soft-gems.net/ and recompile XDBGrids.pas unit with using switch

{$DEFINE THEMES}

. To do this you should have the

Professional version (with source) of the package.

_______

See also: TXCustomDBGrid.FixedStyle

TXCustomDBGrid.FixedLineColor

Specifies the color of the fixed lines in the grid (lines between fixed cells).

property FixedLineColor: TColor ; {* ver. 4.3 *}

Description

Read FixedLineColor property to get current color of fixed lines in the grid. The color of fixed lines depend on current FixedStyle and FixedTheme property.

The FixedLineColor is a readonly property.

_______

See also: TXCustomDBGrid.DataColLineColor

, TXCustomDBGrid.DataRowLineColor

TXCustomDBGrid.FlatSBMode

Indicates whether grid uses flat scrollbars.

function FlatSBMode: Boolean;

Description

Call FlatSBMode to determine whether XDBGrid uses flat scrollbars. FlatSBMode returns True when

ComCtl32.dll supports flat scrollbars and when using of flat scrollbars is possible. Using of flat scrollbars is possible only when ThemesEnabled returns False and UseRightToLeftScrollBar return False.

When FlatSBMode is True the additional ScrolProp 's possibilities are practicable.

_______

TXCustomDBGrid.FocusRect

Specifies kind of rectangle drawn around focused cell.

type

TFocusRect = (frAuto, frDefault, frGray, frMild, frNone);

property FocusRect: TFocusRect;

Description

Use FocusRect to select a kind of rectangle drawn around focused cell. The FocusRect property is practicable for both non-Windows XP and Windows XP styles. These are the possible values of

FocusRect:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

frAuto The focus rectangle is dependent on current values.

FixedStyle and FixedTheme frDefault The focus rectangle is a dotted rectangle (system default). frGray frMild

The focus rectangle is drawn in gray color.

The focus rectangle is drawn in light gray color. frNone

_______

The focus rectangle isn't drawn.

See also: TXCustomDBGrid.FixedStyle

, TXCustomDBGrid.FixedTheme

TXCustomDBGrid.Gradient

Specifies the gradient drawing style for the fixed cells in the grid.

property Gradient: TXDBGridGradient ;

Description

The Gradient property points to TXDBGridGradient object that determines additional parameters needed to drawing gradient fixed and data cells. The gradient drawing style IsActive for grid only when not

IsGridThemed .

_______

TXCustomDBGrid.GridStyle

Indicates the TXGridStyle that determines spacing for standard and XP drawing style.

property GridStyle: TXGridStyle ;

Description

The GridStyle property points to TXGridStyle object that determines additional parameters needed to determine drawing style.

_______

See also: TXCustomDBGrid.FixedStyle

, TXCustomDBGrid.FixedTheme

, TXGridStyle

TXCustomDBGrid.HeaderColor

Specifies the background color of the headers of columns in the grid.

property HeaderColor: TColor ;

Description

Set HeaderColor to specify custom color for the headers of columns in the grid. HeaderColor is only meaningful if the Options property includes dgTitleHeaders.

_______

TXCustomDBGrid.HeaderFont

Describes the font used to draw the headers of columns in the grid.

property HeaderFont: TFont ;

Description

Set HeaderFont to change the font used to draw the headers of columns. HeaderFont is only meaningful if the Options property includes dgTitleHeaders.

_______

TXCustomDBGrid.HeaderLinesCount

Specifies the value that appears in the multi-line headers of columns in the grid.

property HeaderLinesCount: Integer;

Description

Set HeaderLinesCount to specify number of lines for multi-line headers of columns in the grid.

HeaderLinesCount is only meaningful if the Options property includes dgTitleHeaders.

_______

TXCustomDBGrid.HighlightText

Specifies the color of text for focused or multiselected cells in the grid.

property HighlightText: TColor ; {* ver. 4.3 *}

Description

Set HighlightText to change color of text for focused or multiselected cells in the grid.

The HighlightText property can handle two special colors: clDefault, clNone.

Select clDefault value to use DefaultHighlightText value (clHighlightText).

Select clNone value to leave unchanged color of text (Font.Color).

_______

See also: TXCustomDBGrid.SelectCellColor

, TXCustomDBGrid.SelectionColor

, TXCustomDBGrid.DefaultHighlightText

TXCustomDBGrid.HintOptions

Specifies various hint and tooltips properties of the XDBGrid.

type

TXHintOption = (hoTitleHints, hoShowTitleHints, hoEditorHints, hoShowEditorHints, hoShowToolTips, hoKeepShowToolTips, hoAlwaysShowToolTips, hoDataHints, hoShowDataHints, hoAllowForGraphics, hoTotalHints, hoShowTotalHints, hoShowTotalToolTips);

TXHintOptions = set of TXHintOption;

property HintOptions: TXHintOptions;

Description

Set HintOptions to include various hint and tooltips properties for the XDBGrid. Set ShowHint property to

True to activate HintOptions. HintOptions is a set drawn from the following values:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

hoTitleHints Activates hints for individual titles and headers. Hints are specified in the Hint ,

HeaderHint and FillerHint properties. hoShowTitleHints Appears hint window for individual titles and headers when HintOptions includes hoTitleHints. hoEditorHints Activates hints for edited cells in the grid. Hints are specified in the property.

EditorHint hoShowEditorHints Appears hint window for edited cells in the grid when HintOptions includes hoEditorHints. hoShowToolTips Appears tooltips window for longest text in the cell.

hoKeepShowToolTips Tooltips window keeps visibility to the user moves mouse outside the cell. By default tooltips window is hidden after 2 x HintHidePause . hoAlwaysShowToolTips Appears tooltips window for any text in the cell when HintOptions includes hoShowToolTips. hoDataHints Activates hints for individual data cells. Hints are specified in the Hint and

IndicatorHint properties. To activate hint for data cell you must exclude hoShowToolTips option from HintOptions or set ToolTips property to False for selected columns. hoShowDataHints Appears hint window for individual data cells when HintOptions includes hoDataHints. hoAllowForGraphics Appears hint or tooltips window for data cells also for graphics ( Images or ftGraphic field). You may need to write OnColGetText event handler for ftGraphic field to replace default [GRAPHIC] text. hoTotalHints Activates hints for individual total cells. Hints are specified in the Hint property.

To activate hint for total cell you must exclude hoShowTotalToolTips option from HintOptions or set ToolTips property to False for selected total cell. hoShowTotalHints Appears hint window for individual total cells when HintOptions includes hoTotalHints. hoShowTotalToolTips Appears tooltips for longest text in the total cell. The options hoShowToolTips and hoKeepShowToolTips are also applicable for hoShowTotalToolTips.

_______

See also: TXCustomDBGrid.Options

, TXCustomDBGrid.OnCellHint

, TApplication.OnHint

TXCustomDBGrid.HotButtons

Specifies kind of hot buttons of the column titles.

type

THotButtons = (hbAuto, hbNone, hbBump, hbTile, hbLowered, hbRaised);

property HotButtons: THotButtons;

Description

Use HotButtons to select a kind of style for title buttons when the mouse cursor moves over the title cell.

The HotButtons property is practicable only for non-Windows XP styles when dgHotButtons option is included in Options . These are the possible values of HotButtons:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

hbAuto hbNone

The style of hot buttons is dependent on current FixedStyle value.

The hot buttons are unavailable for non-Windows XP styles but they are still available for Windows XP styles when dgHotButtons option is included in

Options. hbBump The bumped hot buttons are most suitable for 3D title buttons (FixedStyle in

[fsDefault, fsSoft]). hbTile The tiled hot buttons are most suitable for tiled title buttons (FixedStyle in

[fsFine, fsMild]). hbLowered The hot buttons are similar to pressed buttons. There is default option for

FixedStyle = fsNice. hbRaised The hot buttons are similar to flat's hot buttons. There is default option for

FixedStyle = fsFlat.

_______

See also: TXCustomDBGrid.Options

, TXCustomDBGrid.FixedStyle

TXCustomDBGrid.IndicatorHint

Contains the text string that can appear when the user moves the mouse over the indicator.

property IndicatorHint: string;

Description

See HintOptions and TControl.Hint

to read more.

_______

TXCustomDBGrid.IndicatorImages

Specifies custom images that are drawn in the indicator.

const {ImageIndex constants for IndicatorImages} iiClear = -1; iiArrow = 0; iiEdit = 1; iiInsert = 2; iiMultiArrow = 3; iiMultiDot = 4; iiMenu = 5; iiAnchor = 6; iiMultiAnchor = 7; iiArrowUp = 8; iiArrowDown = 9; iiArrowLeft = 10; iiArrowRight = 11; iiCheck = 12; iiCross = 13; iiSquare = 14; iiCircle = 15; iiTriangle = 16; iiPlus = 17; iiMinus = 18; iiExclamation = 19; iiFilter = 20; {* ver. 6.0 *} iiActiveFilter = 21; {* ver. 6.0 *} iiPrev = 22; {* ver. 6.2 *} iiNext = 23; {* ver. 6.2 *} iiFirst = 24; {* ver. 6.2 *} iiLast = 25; {* ver. 6.2 *} iiClose = 26; {* ver. 6.2 *}

property IndicatorImages: TImageList ;

Description

Use IndicatorImages to provide a customized list of bitmaps that can be displayed in the indicator. You may change and/or expand default indicator's markers. Use OnCalcImageIndex event to select expanded indicator's markers.

_______

TXCustomDBGrid.IndicatorPopupMenu

Identifies the pop-up menu associated with the indicator.

property IndicatorPopupMenu: TPopupMenu ;

Description

Assign a value to IndicatorPopupMenu to make a pop-up menu appear when the user selects the indicator and clicks the right mouse button.

_______

See also: TXCustomDBGrid.FillerPopupMenu

, TXColumnTitle.PopupMenu

TXCustomDBGrid.Indicators

Specifies the image list that are drawn in the indicator.

property Indicators: TImageList ;

Description

If the IndicatorImages property is assigned, Indicators specifies IndicatorImages , otherwise Indicators specifies internal image list that are drawn in the indicator.

Markers is a read-only property.

_______

TXCustomDBGrid.IndicatorWidth

Specifies the width of the indicator.

property IndicatorWidth: Integer;

Description

The IndicatorWidth property determines the width of the indicator in pixels.

Notice. Since version 3.3 the default value for IndicatorWidth is 20 (instead 11). This value is suitable for new default VisualStyle .

_______

TXCustomDBGrid.InUpdateListItems

Indicates the current operating mode of the grid.

property InUpdateListItems: Boolean; {* ver. 4.3 *}

Description

Use InUpdateListItems to determine the grid is currently during UpdateListItems .

InUpdateListItems is a read-only property.

_______

See also: TXCustomDBGrid.UpdateListItems

, TXCustomDBGrid.UpdateInProgress

TXCustomDBGrid.InUpdateSequence

Indicates the current operating mode of the grid.

property InUpdateSequence: Boolean;

Description

Use InUpdateSequence to determine the grid is currently during UpdateSequence .

InUpdateSequence is a read-only property.

_______

TXCustomDBGrid.InUpdateTotals

Indicates the current operating mode of the grid.

property InUpdateTotals: Boolean;

Description

Use InUpdateTotals to determine the grid is currently during UpdateTotals .

InUpdateTotals is a read-only property.

_______

TXCustomDBGrid.KeyFields

Identifies the key field or fields in the dataset linked to the grid.

property KeyFields: string;

property KeyFields: WideString;

// Delphi 2006, 2007 Win32, 2009, 2010, XE only

Description

KeyFields specifies the field or fields which allows to identify any record in dataset linked to the grid. When you specify this property the ChangeDataSetOrder or RefreshDataSet methods will automatically restore current record. When KeyFields is empty, the first record in dataset will be current after calling this methods. KeyFields must be defined in format appropriate to use as a parameter for Locate method.

_______

TXCustomDBGrid.LastShiftState

Indicates last state of the Alt, Ctrl, and Shift keys and the mouse buttons.

property LastShiftState: TShiftState ;

Description

LastShiftState hold TShiftState flags last used by key-event and mouse-event handlers to determine the state of the Alt, Ctrl, and Shift keys and the state of the mouse buttons when the last event occurred.

LastShiftState is a read-only property.

_______

TXCustomDBGrid.LinesCount

Specifies the value that appears in the multi-line rows of data in the grid.

property LinesCount: Integer;

Description

Set LinesCount to specify number of lines for multi-line rows of data in the grid. If the dgRowResize flag is set in the data grid's Options property, users can resize the row at runtime.

_______

See also: TXCustomDBGrid.HeaderLinesCount

, TXCustomDBGrid.TitleLinesCount

, TXCustomDBGrid.LinesCountMin

TXCustomDBGrid.LinesCountMax

Specifies the maximum value for LinesCount property.

property LinesCountMax: Integer;

Description

Set LinesCountMax to the maximum value the LinesCount property can take. The LinesCountMin and

LinesCountMax properties define the total range over which LinesCount can't vary.

_______

TXCustomDBGrid.LinesCountMin

Specifies the minimum value for LinesCount property.

property LinesCountMin: Integer;

Description

Set LinesCountMin to the minimum value the LinesCount property can take. The LinesCountMin and

LinesCountMax properties define the total range over which LinesCount can't vary.

_______

TXCustomDBGrid.ListBorder

Specifies kind of list border for pick list and lookup list.

type

TListBorder = (lbAuto, lbDefault, lbGray, lbMild);

property ListBorder: TListBorder;

Description

Use ListBorder to select a kind of list border for pick and lookup lists when the cell is edited. The

ListBorder property is practicable for both non-Windows XP and Windows XP styles. These are the possible values of ListBorder:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

lbAuto lbDefault

The style of list border is dependent on current FixedStyle value.

The list border is drawn in default black color suitable for FixedStyle in

[fsDefault, fsNice, fsFlat].

lbGray The list border is drawn in gray color suitable for all FixedStyle and

FixedTheme values. lbMild The list border is drawn in light gray color suitable for FixedStyle in [fsFine, fsMild] and all FixedTheme values.

_______

See also: TXColumn.PickList

, TXCustomDBGrid.FixedStyle

, TXCustomDBGrid.FixedTheme

TXCustomDBGrid.ManageGrid

Specifies first XDBGrid in chain managed by this master grid.

property ManageGrid: TXCustomDBGrid ;

Description

Use ManageGrid property to read, which XDBGrid has set this grid in MasterGrid

property

ManageGrid is a read-only property.

_______

TXCustomDBGrid.Markers

Specifies the image list that are drawn as sorting markers in the titles.

property Markers: TImageList ;

Description

If the TitleMarkers property is assigned, Markers specifies TitleMarkers , otherwise Markers specifies internal image list that are drawn as sorting markers.

Markers is a read-only property.

_______

TXCustomDBGrid.MarkerStyle

Specifies style of markers drawn in the titles.

type

TMarkerStyle = (msAuto, msAutoGray, msDefault, msSoft, msRaisedDark, msRaisedGray, msRaisedMild, msLoweredDark, msLoweredGray, msLoweredMild, msFlat, msGray, msMild);

property MarkerStyle: TMarkerStyle;

Description

Use MarkerStyle to select a style of sorting markers drawn in the titles. The MarkerStyle property is practicable for both non-Windows XP and Windows XP styles but only when TitleMarkers property is undefined. These are the possible values of MarkerStyle:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

msAuto The style of markers is dependent on current FixedStyle and FixedTheme values. msAutoGray The style of markers is one from Gray styles dependent on current FixedStyle and FixedTheme values. msDefault The style of markers is 3D - suitable for FixedStyle = fsDefault.

msSoft msRaisedDark msRaisedGray msRaisedMild msLoweredDark msLoweredGray msLoweredMild msFlat

The style of markers is 3D - suitable for FixedStyle = fsSoft.

The style of markers is convex - suitable for FixedStyle = fsNice.

The style of markers is convex - suitable for all FixedStyle values.

The style of markers is convex - suitable for FixedStyle = fsFine.

The style of markers is concave - suitable for FixedStyle = fsNice.

The style of markers is concave - suitable for all FixedStyle values.

The style of markers is concave - suitable for FixedStyle = fsFine.

The style of markers is flat - suitable for FixedStyle = fsFlat. msGray msMild

The style of markers is flat - suitable for all FixedStyle values.

The style of markers is flat - suitable for FixedStyle = fsMild.

_______

See also: TXCustomDBGrid.FixedStyle

, TXCustomDBGrid.FixedTheme

, TXCustomDBGrid.MarkerTransparent

TXCustomDBGrid.Markers

TXCustomDBGrid.MarkerTransparent

Specifies background of markers drawn in the titles.

type

TMarkerTransparent = (mtAuto, mtFalse, mtTrue);

property MarkerTransparent: TMarkerTransparent;

Description

Use MarkerTransparent to select a background of sorting markers drawn in the titles. The

MarkerTransparent property is practicable for both non-Windows XP and Windows XP styles but only when TitleMarkers property is undefined. These are the possible values of MarkerTransparent:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

mtAuto mtFalse

The background of markers is dependent on current MarkerStyle value.

The background of markers is white. mtTrue

_______

The background of markers is transparent.

TXCustomDBGrid.MasterGrid

Specifies master XDBGrid to link with corresponding columns in this grid to establish a relationship between the grids.

property MasterGrid: TXCustomDBGrid ;

Description

Set MasterGrid property to specify the master XDBGrid to use in establishing a relationship between this grid and the one specified in MasterGrid.

Each time the column's width, order or visibility in the master grid changes, the new values are used to change corresponding columns in this grid.

_______

TXCustomDBGrid.MultiSelect

Determines current kind of multiselection.

type

TMultiSelection = (msNone, msRows, msCols, msCells, msFixed);

TMultiSelect = msNone .. msCells;

property MultiSelect: TMultiSelect; {* ver. 4.3 *}

Description

The MultiSelect property determines the current kind of multiselection in the grid. The possible kinds of multiselection are limited by MultiSelectOptions property. The accepted value for MultiSelect must be included in MultiSelectOptions. In other case the MultiSelect property returns msNone.

The default value of MultiSelect is msRows (when msRows is included in MultiSelectOptions) or msNone

(in other case). The default value for MultiSelect property is always restored when ClearSelection is called. When dgSelectRow option is included in Options only the msRows multiselection is available in the grid. When dgMultiSelect option is included in Options the user's mouse and keyboard actions can change the current value of MultiSelect.

When no any row/column/cell is multiselected ( MultiSelected = False) the multiselection is starting:

•

When the user clicks on indicator (or on fixed data cell), the msRows multiselection is starting.

•

When the user clicks on title cell and move mouse pointer down, the msCols multiselection is starting.

•

When the user clicks on non-fixed data cell, the msCells multiselection is starting.

•

When the user clicks on any data cell and the Ctrl key is hold down, the msRows multiselection is starting.

•

When the user clicks on any data cell and the Shift key is hold down, the msCols multiselection is starting.

When the multiselection is just started ( MultiSelected = True), the user can select additional row/col/cell:

•

When the user clicks on any data cell and the Ctrl key is hold down, the additional single row/column is selected.

•

When the user clicks on any data cell and the Shift key is hold down, all the next rows/columns/cells are selected.

Note. When msFixed option is included in MultiSelectOptions the fixed data cells (See also: FixedCols ) are multiselected in the same way as non-fixed data cells.

The user can also start (and continue) multiselection with using keyboard:

•

When the Shift key is hold down and the user press Up/Down arrow key (also PgUp/PgDn), the msRows multiselection is performed. When the Shift key is still hold down and the user press now Left/Right arrow key (also Home/End), the multiselection is changed to msCells.

•

When the Shift key is hold down and the user press Left/Right arrow key (also Home/End), the msCols multiselection is performed. When the Shift key is still hold down and the user press now Up/Down arrow key (also PgUp/PgDn), the multiselection is changed to msCells.

Note. When not all of [msRows, msCols, msCells] options are included in MultiSelectOptions property some of the above actions may not work or may work in other way.

_______

See also: TXCustomDBGrid.MultiSelectOptions

, TXCustomDBGrid.MultiSelected

, TXCustomDBGrid.ClearSelection

TXCustomDBGrid.MultiSelected

Specifies whenever any row, column or cell is multiselected.

property MultiSelected: Boolean; {* ver. 4.3 *}

Description

Read MultiSelected to determine is any row, column or cell currently multiselected in the grid.

MultiSelected returns True when RowsSelected or ColsSelected returns True, otherwise MultiSelected return False. Use MultiSelected property to recognize is the grid currently in "multiselected mode".

MultiSelected is a read-only property.

_______

TXCustomDBGrid.MultiSelectOptions

Specifies kinds of multiselection available in XDBGrid.

type

TMultiSelectOption = msRows .. msFixed; // For C++Builder/Delphi 5, 6, 7

TMultiSelectOption = msNone .. msFixed; // For C++Builder/Delphi 8 or higher

(due problem with subset property) {* ver. 5.0 *}

TMultiSelectOptions = set of TMultiSelectOption;

property MultiSelectOptions: TMultiSelectOptions; {* ver. 4.3 *}

Description

Set MultiSelectOptions to determind kinds of multiselection available in XDBGrid. Include dgMultiSelect option to Options property to activate MultiSelectOptions for user and developer. Include dgInternalSelect option to Options property to activate MultiSelectOptions for developer only. MultiSelectOptions is a set drawn from the following values:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

msRows msCols

Multiselection of rows is available.

Multiselection of columns is available. msCells Multiselection of cells (area) is available. msFixed Fixed data cells participate in multiselection. See also

_______

TXCustomDBGrid.Options

Specifies various display and behavioral properties of the XDBGrid.

type

TXDBGridOption = (dgEditing, dgAlwaysShowEditor, dgTitles, dgIndicator, dgColumnResize, dgColLines, dgRowLines, dgTabs, dgRowSelect, dgAlwaysShowSelection, dgConfirmDelete, dgCancelOnExit, dgMultiSelect, dgExtendedSelect, dgInternalSelect, dgRowResize, dgRowScroll, dgHotButtons, dgTitleButtons, dgTitleHeaders, dgTitleWidthOff, dgAllowDeleteOff, dgAllowInsertOff, dgAutoUnselectOff

{obsolete}

, dgIndicatorMarkOff, dgMarkerAutoAlign, dgMarkerAutoSwitch, dgMarkerAutoToggle, dgMarkerAscendOnly, dgForceSequence, dgThumbTracking, dgRightMoving

{obsolete}

);

TXDBGridOptions = set of TXDBGridOption;

property Options: TXDBGridOptions;

Description

Set Options to include the desired properties for the XDBGrid component. Options is a set drawn from the following values:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

dgEditing The user can edit data using the grid. dgEditing is ignored if Options includes dgRowSelect. dgAlwaysShowEditor The grid is always in edit mode. That is, the user does not have to press Enter or F2 before editing the contents of a cell. dgAlwaysShowEditor does nothing unless dgEditing is also included in Options. dgAlwaysShowEditor is ignored if

Options includes dgRowSelect. Other restrictions has been removed in version

5.3. {* ver. 5.3 *} dgTitles Titles appear at the top of the columns in the grid. dgIndicator dgColumnResize dgColLins

A small pointer appears in the first column to indicate which row is current.

Columns can be resized or moved. See also

Lines appear between columns in the grid.

ResizeOptions . dgRowLines dgTabs

Lines appear between the rows of the grid.

The user can navigate through the grid using the Tab and Shift+Tab keys. dgRowSelect The user can select an entire row, as well as selecting individual cells. If

Options includes dgRowSelect, dgEditing and dgAlwaysShowEditor are ignored. dgAlwaysShowSelection The selected cell displays the focus rectangle even when the grid does not have focus. dgConfirmDelete A message box appears, asking for confirmation, when the user types

Ctrl+Delete to delete a row in the grid. dgCancelOnExit When the user exits the grid from an inserted record to which the user made no modifications, the inserted record is not posted to the dataset. This prevents the inadvertent posting of empty records. dgMultiSelect More than one row/col/cell in the grid can be selected at a time. See also

MultiSelectOptions . {* ver. 4.3 *}

______________________________________________________________________________________________________________________________________________________________________________

dgExtendedSelect If Options includes dgExtendedSelect, the user can take advantage extended selection. This option handles the following keyboard and mouse events:

Ctrl+A ( SelectAll ), Ctrl+C or either Ctrl+Insert ( CopyToClipboard ) Shift+PgUp,

Shift+PgDn, Shift+Home, Shift+End, Shift+Ctrl+Home, Shift+Ctrl+End,

Alt+Shift+Click (SelectAll), Alt+Ctrl+Click ( InvertAll ), Alt+Click ( UnselectAll ).

The dgExtendedSelect option is respected common with dgMultiSelect option only. dgInternalSelect If Options includes dgInternalSelect and excludes dgMultiSelect, the user can't change selection using standard keyboard or mouse actions, but the developer can use selection in run-time code. dgRowResize dgRowScroll

The user can resize height of rows using left mouse button.

If Options includes dgRowSelect, the user can scroll column as well using keyboard. dgHotButtons dgTitleButtons dgTitleHeaders

Highlights the title buttons as the mouse passes over them.

Title of column can be used as button.

Headers appear at the top of the titles. Headers are visible only, if Options includes dgTitles. dgTitleWidthOff dgAllowDeleteOff dgAllowInsertOff dgAutoUnselectOff

Width of title's caption is excluded from calculation of default width for column.

When the user types Ctrl+Delete to delete a row in the grid, action is ignored.

When the user types Insert or Ctrl+Insert to insert new row, action is ignored.

When user clicks on the row, selected rows are not unselected. This option is used only when RowsSelection is True.

{* ver. 6.0 *} dgIndicatorMarkOff dgMarkerAutoAlign dgMarkerAutoSwitch

If Options includes dgIndicator, the small pointer not appears in the indicator.

Sorting markers drawn in the titles are aligned to the right side of title's caption.

When new sorting marker is set, all others markers are clear. dgMarkerAutoToggle dgMarkerAscendOnly dgForceSequence

When the user clicks on title, sorting marker is self toggled.

When sorting marker is toggled, only ascending order is accepted.

This option forces sequence numbers for database records linked to the grid.

This allow to realize proportional scrolling and AutoNumber for any dataset.

See also: ForcedSequence , UpdateSequence , RecNumber , RecCount . dgThumbTracking The grid image updates while the user is dragging the thumb tab of the scrollbar. If dgThumbTracking is not included, the image does not update until the user releases the thumb tab in a new position. dgRightMoving Columns can be moved by using right (instead left) mouse button. This option is now obsolete and it can't be included in .NET version.

_______

See also: TXCustomDBGrid.HintOptions

, TXCustomDBGrid.OptionsEx

, TXCustomDBGrid.OptionsExt

TXCustomDBGrid.OrderFields

TXCustomDBGrid.OptionsEx

Specifies another various display and behavioral properties of the XDBGrid.

type

TXDBGridOptionEx = (dgBlankRow, dgTotalHeader, dgTotalValues, dgTotalFields, dgTotalFooter, dgTotalColLines, dgTotalHeaderBox, dgTotalValuesBox, dgTotalFieldsBox, dgTotalFooterBox, dgTotalDataBoxOnly, dgLoadCurrentOrder, dgAutoUpdateOrder, dgAutoAscendOrder, dgAutoKeepSelection, dgAutoUpdateSequence, dgDelayUpdateSequence, dgAutoUpdateTotals, dgDelayUpdateTotals, dgCalcInvisibleRows, dgCalcWholeDataSet, dgCalcSelectedRows, dgDelaySelectedRows, dgTotalHeaderSelected, dgTotalValuesSelected, dgTotalFooterSelected, dgSelectedAutoHidden, dgClickSelectOff);

TXDBGridOptionsEx = set of TXDBGridOptionEx;

property OptionsEx: TXDBGridOptionsEx;

Description

Set OptionsEx to include the desired properties for the XDBGrid component. OptionsEx is a set drawn from the following values:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

dgBlankRow dgTotalHeader

Blank row appears at the bottom of the columns in the grid.

TotalHeader single row appears at the bottom of the grid. dgTotalValues TotalValues rows appear at the bottom of the grid.

TotalFields rows appear at the bottom of the grid. dgTotalFields dgTotalFooter dgTotalColLines

TotalFooter single row appears at the bottom of the grid.

Lines appear between columns in the total rows (dgColLines must be included in Options ). When IsGridThemed this option is ignored. dgTotalHeaderBox Box appears in the TotalHeader cells when TotalBox is tbAuto. dgTotalValuesBox dgTotalFieldsBox

Box appears in the TotalValues cells when TotalBox is tbAuto.

Box appears in the TotalFields cells when TotalBox is tbAuto. dgTotalFooterBox dgTotalDataBoxOnly dgLoadCurrentOrder

Box appears in the TotalFooter cells when TotalBox is tbAuto.

Box appear in the total cells only when total cell is not empty.

Automatically SetupCurrentOrder from DataSet linked to the grid when

DataSet is opened. dgAutoUpdateOrder Automatically ChangeDataSetOrder in DataSet linked to the grid when

OrderFields changed or when DataSet is opened and dgLoadCurrentOrder in not included in OptionsEx property. See also OnOrderUpdated event. dgAutoAscendOrder When ChangeDataSetOrder method is performed automatically modify dgMarkerAscendOrder option in Options property depend on possibilities of current DataSet linked to the grid. See also RegisterChangeOrder procedure. dgAutoKeepSelection When RefreshDataSet or ChangeDataSetOrder method is performed the grid automatically saves and restores current state of selection. This option works effecively only when KeyFields property is defined.

{* ver. 5.32 *} dgAutoUpdateSequence When dgForceSequence is included in Options property the grid automatically perform UpdateSequence when data in the grid has changed and sequence number must be recalculated. See also OnSequenceUpdated event.

dgDelayUpdateSequence When dgAutoUpdateSequnece is included in OptionsEx property the grid delays call of UpdateSequnece to reduce number of calls. See also

DelayInterval global variable. This option is not respected in design-time.

{* ver. 5.0 *} dgAutoUpdateTotals Automatically perform UpdateTotals when data in the grid has changed or when SelectedRows changed and calculated values in total cells ( TotalResult

= trCalcValue) must be recalculated. See also OnTotalsUpdated event. dgDelayUpdateTotals When dgAutoUpdateTotals in included in OptionsEx property the grid delays call of UpdateTotals to reduce number of calls. See also DelayInterval global variable. This option is not respected in design-time.

{* ver. 5.0 *} dgCalcInvisibleRows Perform CalcValue visible in the grid.

function for total cells also when total row is currently not dgCalcWholeDataSet dgCalcSelectedRows

Apply UpdateTotals for all records in DataSet when

Apply UpdateTotals for SelectedRows

Totals.Selected

is True.

or/and

Totals.Selected

SelectedCols

is False.

only when dgDelaySelectedRows Delays call of SelectedRowsChanged method to reduce number of calls. See also DelayInterval global variable, OnSelectedRowsChanged and

OnSelectedColsChanged events. This option is not respected in design-time.

{* ver. 5.0 *} dgTotalHeaderSelected Apply TotalHeader row to calculate total values for SelectedRows only. dgTotalValuesSelected Apply TotalValues rows to calculate total values for SelectedRows only. dgTotalFooterSelected Apply TotalFooter row to calculate total values for SelectedRows only. dgSelectedAutoHidden Automatically hide "Selected" total rows when there is no selected rows/columns in the grid (Totals.Selected is False). This option works only in run-time. dgClickSelectOff When dgMultiSelect and dgExtendedSelect are included in Options property simple click does'nt select a record. When this option is included in OptionsEx use Ctrl-Click to select single record. Using this option allows to permanently include dgMultiSelect option and select records only when the user really need this. dgShowEditorByCharOff When this option is included in OptionsEx and dgEditing is included in Options the character keys (like 1, 2, ..., A, B, ...) do not show inplace editor. You can start editing by Enter or F2 key only.

{* ver. 6.00 *}

_______

See also: TXCustomDBGrid.Options

, TXCustomDBGrid.OptionsExt

TXCustomDBGrid.OptionsExt

Specifies another various display and behavioral properties of the XDBGrid.

type

TXDBGridOptionExt = (dgAutoNumberColumn, dgAutoSelectColumn, dgAutoUpdateListItems, dgDelayUpdateListItems, dgGridStyleLists, dgMouseScrolling, dgMouseTracking, dgMarkerClearAllowed, dgScrollGridMode, dgScrollPageMode, dgForceSystemTheme, dgForceSystemButton, dgForceSystemMarker, dgForceCustomized, dgScaleByParentFont ); {* ver. 6.0

*}{* ver. 6.2 *}

TXDBGridOptionsExt = set of TXDBGridOptionExt;

property OptionsExt: TXDBGridOptionsExt; {* ver. 4.3 *}

Description

Set OptionsExt to include the desired properties for the XDBGrid component. OptionsExt is a set drawn from the following values:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

dgAutoNumberColumn When dgAutoNumberColumn is included in OptionsExt property and

Columns.State

is csDefault the AddAutoNumber function is automatically performed when the dataset linked to the grid is opened. In design-time you must include this option before you click "Add All Fields" button in Column

Editor. See also: DefAutoNumberTitle , DefAutoNumberWidth global variable. dgAutoSelectColumn When dgAutoSelectColumn is included in OptionsExt property and

Columns.State

is csDefault the AddAutoSelect function is automatically performed when the dataset linked to the grid is opened. In design-time you must include this option before you click "Add All Fields" button in Column

Editor. See also: DefAutoSelectTitle , DefAutoSelectWidth global variable. dgAutoUpdateListItems When poAutoLoadList option is included in PickOptions property, the grid automatically perform UpdateListItems when data in the grid has changed and auto-loaded PickList must be updated. See also OnListItemsUpdated event dgDelayUpdateListItems When dgAutoUpdateListItems is included in OptionsExt property, the grid delays call of UpdateListItems to reduce number of calls. See also

DelayInterval global variable. This option is not respected in design-time.

{* ver. 5.0 *} dgGridStyleLists When dgGridStyleLists is included in OptionsExt property, the

PickList / PickText / LookupList is displayed with using new grid style. This new style allows also to use additional functionallity for lookup list defined as new options in ListOptions property. See also: ListDropDownDelay ,

ListMouseTracking global variable. dgMouseScrolling When the grid is not in edit mode and when you click left mouse button on the data cell and you still hold left mouse button pressed, you can move the mouse pointer in any direction to scroll visibled data in the grid. When dgMultiSelect option is included in Options and you move the mouse pointer, the selection will be changed according to mouse pointer. dgMouseTracking When the grid is not in edit mode and when you move the mouse pointer over the data cells, the focused cell will be changed according to mouse pointer. dgMarkerClearAlowed When the user clicks on a title with holding Ctrl key, the first sorting marker is cleared (none sorting order is allowed).

{* ver. 5.1 *} dgScrollGridMode When the grid is vertically scrolled by using keyboard, scrollbar or mouse wheel all data rows are scrolled and current row in the grid leave unchanged.

This option works only when dgForcedSequence is included in Options.

{* ver. 5.31 *} dgScrollPageMode When the grid is vertically scrolled by using scrollbar's thumb button or mouse wheel and dgScrollGridMode option works effectively the data rows are scrolled page by page.

{* ver. 5.31 *} dgScrollRowsMode When the grid is vertically scrolled by using mouse wheel all data rows are scrolled and current row in the grid leave unchanged instead of scrolling current row in the grid. This option works only when dgScrollGridMode are not included in OptionsExt.

{* ver. 5.6 *} dgForceSystemTheme When FixedTheme is ftDefault you can replace default theme by system theme on Windows Vista and Windows 7. System theme is always used as default on

Windows 8.

{* ver. 5.32 *} dgForceSystemButton When ThemesEnabled or StylesEnabled is True you can replace default button in title cell by system button. System button is always used when

SystemTheme is used.

{* ver. 6.0 *} dgForceSystemMarker When ThemesEnabled or StylesEnabled is True you can replace default sorting marker in title cell by system marker. System marker is always used when SystemTheme is used.

{* ver. 6.0 *} dgForceCustomized When Columns.State is csDefault (columns were not added to the grid by

Columns Editor in design-time) you may force Columns.State = csCustomized after DataSet linked to the grid is first time open. This option causes that columns are not destroyed and re-created when DataSet linked to the grid is closed and re-opened to refresh data. To can change DataSet linked to the grid, you must call Columns.Clear first.

{* ver. 5.32 *} dgScaleByParentFont When ParentFont is True and the parent font size is changed the width of grid columns is changed proportionally.

{* ver. 6.2 *}

_______

See also: TXCustomDBGrid.Options

, TXCustomDBGrid.OptionsEx

TXCustomDBGrid.OrderFields

Specifies one or more fields separated by comma that indicates current order in dataset linked to the grid.

property OrderFields: string;

property OrderFields: WideString;

// Delphi 2006, 2007 Win32, 2009, 2010, XE only

Description

Set OrderFields to appear sorting Marker s to the right of a title's caption. Each time when OrderFields property changes and dgAutoUpdateOrder option is inluded in OptionsEx the ChangeDataSetOrder universal method is called. When dgAutoUpdateOrder is not included in OptionsEx or when DataSet linked to the grid is not registered to automatically change order the OnOrderChanged event is triggered to change sorting order in DataSet.

_______

TXCustomDBGrid.Position

Indicates a position of the active record in the grid.

property Position: Integer;

Description

Examine Position to determine position of the active record in the grid. Active record is the current record within the internal record buffer maintained by the grid. When DataLink is active the Position return value of ActiveRecord , otherwise the Position return 0.

Set Position to value from range 0 to DataRowCount -1 to select as current one of visibled records in the grid.

_______

TXCustomDBGrid.RecCount

Indicates the total number of records in the grid.

property RecCount: Integer;

Description

Examine RecordCount to determine the total number of records in the grid. Applications might use this property with RecNumber to iterate through all the records in the grid.

When ForcedSequence is True, RecCount return total number of records in the grid for any linked dataset even when filter is active. When ForcedSequence is False, RecCount return RecordCount value for linked dataset.

This property allow to realize proportional scrolling and AutoNumber for any dataset. See also when you must call yourself UpdateSequence to retain correct RecNumber and RecCount value.

RecCount is a read-only property.

_______

TXCustomDBGrid.RecNumber

Indicates ordinal position of the active record in the grid.

property RecNumber: Integer;

Description

Examine RecNumber to determine ordinal position of the active record in the grid. Active record is the current record within the internal record buffer maintained by the grid. See also: ActiveRecord .

When ForcedSequence is True, RecNumber return ordinal position of the active record for any linked dataset even when filter is active. When ForcedSequence is False, RecNumber return RecNo value for linked dataset. This value indicates correct ordinal position in the grid only when IsSequenced is True.

Applications might use this property with RecCount to iterate through all the records in the grid. This property allow to realize proportional scrolling and AutoNumber for any dataset. See also when you must call yourself UpdateSequence to retain correct RecNumber value.

_______

TXCustomDBGrid.ResizedColumn

Specifies the lately resized column in the grid.

property ResizedColumn: TXColumn ;

Description

Read ResizedColumn in OnColumnResize event handler to determine the lately resized column in the grid. The value of this property is valid only in OnColumnResize event. The value of ResizedColumn can be nil, when more than one column have been changed, a column moved or width of Indicator changed.

ResizedColumn is a read-only property.

_______

TXCustomDBGrid.ResizeOptions

Specifies various columns resize properties of the XDBGrid.

type

TXResizeOption = (roColumnResize, roOptimalWidth, roDefaultWidth, roColumnMoving);

TXResizeOptions = set of TXResizeOption;

property ResizeOptions: TXResizeOptions;

Description

Set ResizeOptions to include various columns resize properties for the XDBGrid. Include dgColumnResize option to Options property to activate ResizeOptions. ResizeOptions is a set drawn from the following values:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

roColumnResize Columns can be resized. roOptimalWidth roDefaultWidth

Double click can set optimal width for the column. See also OptimalWidth

Middle mouse button click can set default width for the column. See also

DefaultWidth . roColumnMoving Columns can be moved. See also dgRightMoving option in Options .

_______

See also: TXCustomDBGrid.Options

, TXColumn.OptimalWidth

, TColumn.DefaultWidth

, TXCustomDBGrid.OnColumnMoving

TCustomDBGrid.OnColumnMoved

TXCustomDBGrid.RowHeight

Specifies the height (in pixels) of all data rows.

property RowHeight: Integer;

Description

RowHeight is calculated as DefaultRowHeight + RowLineWidth.

RowHeight is a read-only property.

_______

See also: TXCustomDBGrid.TitleHeight

, TXCustomDBGrid.ScrollBarHeight

, TXCustomDBGrid.RowLineHeight

TXCustomDBGrid.RowLineWidth

Specifies the width (in pixels) of the lines that separate the rows of the grid.

property RowLineWidth: Integer;

Description

If the Options property include dgRowLines, RowLineWidth is 1, otherwise RowLineWidth is 0.

RowLineWidth is a read-only property.

_______

TXCustomDBGrid.RowsChanged

Indicates the changes were made in SelectedRows list.

property RowsChanged: Boolean; {* ver. 4.3 *}

Description

The RowsChanged flag indicates the changes were made in SelectedRows list after BeginSelect method was called at the start of the changes. When the changes were made the RowsChanged is True. The

RowsChanged flag is cleared by EndSelect method.

RowsChanged is a read-only property.

_______

TXCustomDBGrid.RowsSelected

Specifies whenever any row or data cell is multiselected.

property RowsSelected: Boolean; {* ver. 4.3 *}

Description

Read RowsSelected to determine is any row or data cell currently multiselected in the grid. RowsSelected returns True when RowsSelection is True and SelectedRows list is not empty, otherwise RowsSelected return False.

RowsSelected is a read-only property.

_______

TXCustomDBGrid.RowsSelection

Specifies whenever any row or data cell is multiselected.

property RowsSelection: Boolean; {* ver. 4.3 *}

Description

Read RowsSelection to determine is multiselection of rows or cells currently active. RowsSelection returns

True when MultiSelect is msRows or msCells, otherwise RowsSelection return False. When

RowsSelection is True, the SelectedRows list contains bookmarks of selected rows (msRows) or bookmarks of selected area (msCells).

RowsSelection is a read-only property.

_______

TXCustomDBGrid.ScrollBarHeight

Specifies the height (in pixels) of horizontal scroll bar.

property ScrollBarHeight: Integer;

Description

ScrollBarHeight is depend on system configuration settings. When horizontal scroll bar is invisible,

ScrollBarHeight is 0.

ScrollBarHeight is a read-only property.

_______

TXCustomDBGrid.ScrollBars

Specifies whether the grid includes horizontal and vertical scroll bars.

property ScrollBars: TScrollStyle ;

Description

See TCustomGrid.ScrollBars

to read more. See also AutoHidden .

_______

See also: TXCustomDBGrid.ScrollBarHeight

, TXCustomDBGrid.ScrollBarWidth

, TXCustomDBGrid.ScrollProp

TXCustomDBGrid.ScrollBarWidth

Specifies the width (in pixels) of vertical scroll bar.

property ScrollBarWidth: Integer;

Description

ScrollBarWidth is depend on system configuration settings. When vertical scroll bar is invisible,

ScrollBarWidth is 0.

ScrollBarWidth is a read-only property.

_______

See also: TXCustomDBGrid.ScrollBarHeight

, TXCustomDBGrid.ScrollBars

, TXCustomDBGrid.ColLineWidth

TXCustomDBGrid.IndicatorWidth

TXCustomDBGrid.ScrollGridMode

Determines whether the grid scrolls all data rows at once.

property ScrollGridMode: Boolean; {* ver. 5.31 *}

Description

Use ScrollGridMode to determine whether the grid scroll all data rows at once instead of scrolling current row. The ScrollGridMode return True, when dgScrollGridMode option is included in OptionsExt property and dgForceSequence option is included in Options property.

ScrollGridMode is a read-only property.

_______

TXCustomDBGrid.ScrollPageMode

Determines whether the grid scrolls data rows page by page.

property ScrollPageMode: Boolean; {* ver. 5.31 *}

Description

Use ScrollPageMode to determine whether the grid scroll data rows page by page. The ScrollPageMode return True, when dgScrollPageMode option is included in OptionsExt property and ScrollGridMode property is True.

ScrollPageMode is a read-only property.

_______

TXCustomDBGrid.ScrollRowsMode

Determines whether the mouse wheel scrolls all data rows instead of scrolling current row.

property ScrollRowsMode: Boolean; {* ver. 5.6 *}

Description

Use ScrollRowsMode to determine whether the mouse wheel scrolls all data rows instead of scrolling current row. The ScrollRowsMode return True, when dgScrollRowsMode option is included in OptionsExt property and dgScrollGridMode option is not included in OptionsExt property.

ScrollRowsMode is a read-only property.

_______

TXCustomDBGrid.ScrollProp

Indicates the TXScrollProp obect that determines additional possibilities for scrollbars.

property ScrollProp: TXScrollProp ;

Description

The ScrollProp property points to TXScrollProp object that determines additional possibilities for scrollbars. The ScrollProp possibilities are practicable only when FlatSBMode is accessible.

_______

See also: TXCustomDBGrid.ScrollBars

, TXCustomDBGrid.FlatSBMode

, TXScrollProp

TXCustomDBGrid.Search

Indicates the TXDBGridSearch that represents search settings for the grid.

property Search: TXDBGridSearch ; {* ver. 6.2 *}

Description

The Search property points to TXDBGridSearch object that determines search settings for the grid.

_______

TXCustomDBGrid.SearchPanelHeight

Specifies the height (in pixels) of search panel.

property SearchPanelHeight: Integer; {* ver. 6.2 *}

Description

If the search panel is visible, SearchPanelHeight specifies the height of the panel in pixels, otherwise

SearchPanelHeight is 0.

SearchPanelHeight is not a read-only property, but you should not self change this property in code.

_______

See also: TXCustomDBGrid.SearchPanelVisible

TXCustomDBGrid.SearchPanelVisible

Specifies the search panel is visible in the grid.

property SearchPanelVisible: Boolean; {* ver. 6.2 *}

Description

If the search panel is visible in the grid the SearchPanelVisible is True, otherwise SearchPanelVisible is

False.

SearchPanelVisible is a read-only property.

_______

See also: TXCustomDBGrid.ShowSearchPanel

, TXCustomDBGrid.CloseSearchPanel

, TXCustomDBGrid.SearchPanelHeight

TXCustomDBGrid.SelectCellColor

Specifies the alternate highlight color to highlight focused cell in the grid.

property SelectCellColor: TColor ;

Description

Set SelectCellColor to alternate highlight color to highlight focused cell in the grid. SelectCellColor is also respected for whole current row when dgRowSelect option is included in Options .

The SelectCellColor property can handle two special colors: clDefault, clNone.

Select clDefault value to use DefaultSelectCellColor value (clHighlight).

Select clNone value when the focused cell should not be highlighted.

_______

TXCustomDBGrid.SelectedCols

Specifies a set of columns that are selected in the grid.

property SelectedCols: TXColumnList ; {* ver. 4.3 *}

Description

Use the properties and methods of the TXColumnList object returned by SelectedCols to

•

Determine the number of columns in the grid that are selected.

•

Determine whether the current column in the grid is selected.

•

Determine whether a particular column in the grid is selected.

SelectedCols are highlighted in the grid only when dgMultiSelect or either dgInternalSelect option is included in Options.

_______

See also: TXColumnList , TXCustomDBGrid.Options

, TXCustomDBGrid.SelectedRows

TXCustomDBGrid.SelectedColumn

Specifies the column component for the currently selected cell in the grid.

property SelectedColumn: TXColumn ; {* ver. 4.3 *}

Description

Set SelectedColumn to move focus to a particular column in the grid. Read SelectedColumn to obtain access to the column component for the currently selected cell. If there is not currently selected cell,

SelectedColumn is nil. For example, when an entire row is selected, SelectedColumn is nil.

_______

See also: TXCustomDBGrid.Columns

, TXCustomDBGrid.SelectedField

, TXCustomDBGrid.SelectedIndex

TXCustomDBGrid.SelectedField

Specifies the field component for the currently selected cell in the grid.

property SelectedField: TField ;

Description

Set SelectedField to move focus to a particular field in the grid. Read SelectedField to obtain access to the field component for the currently selected cell. If there is not currently selected cell, SelectedField is nil.

For example, when an entire row is selected, SelectedField is nil.

_______

TXCustomDBGrid.SelectedIndex

Specifies the index of the currently selected column in the Columns array.

property SelectedIndex: Integer;

Description

Set SelectedIndex to move focus to a column in the grid that is identified by position. Read SelectedIndex to determine which column in the grid has focus. A value of 0 indicates the first data column, 1 is the second data column, and so on. SelectedIndex is -1 if there is no currently selected column.

If the Options property includes dgIndicator, the index of the data column given by SelectedIndex will differ from the index of the physical column in the grid.

To access the field component for the selected column, use the SelectedField property.

To access the column component for the selected column, use the SelectedColumn property.

_______

See also: TXCustomDBGrid.Columns

, TXCustomDBGrid.SelectedColumn

, TXCustomDBGrid.SelectedField

TXCustomDBGrid.SelectedRows

Specifies a set of bookmarks for all the records in the dataset that correspond to rows selected in the grid.

property SelectedRows: TXBookmarkList ;

Description

Use the properties and methods of the TXBookmarkList object returned by SelectedRows to

•

Determine the number of rows in the grid that are selected.

•

Determine whether the current record in the dataset is selected.

•

Determine whether a particular record in the dataset is selected.

•

Delete all selected rows from the dataset.

SelectedRows are highlighted in the grid only when dgMultiSelect or either dgInternalSelect option is included in Options.

_______

See also: TXBookmarkList , TXCustomDBGrid.Options

Specifies the alternate color for the grid to draw horizontal striped cells.

property StripeColor: TColor ;

Description

Set StripeColor to alternate color to draw horizontal striped cells in the grid. The selected color should be alternate to main Color value, which is always used as color of second stripe.

The StripeColor property can handle two special colors: clDefault, clNone.

Select clDefault value to use DefaultStripeColor value (clBtnHighlight).

Select clNone value when the grid should not be striped.

_______

See also: TXCustomDBGrid.SelectCellColor

, TXCustomDBGrid.SelectionColor

, TXCustomDBGrid.SelectRowColor

TXCustomDBGrid.EditorColor

TXCustomDBGrid.StyleElements

Specifies the style elements that are used by the grid.

type

TStyleElements = set of (seFont, seClient, seBorder);

property StyleElements: TStyleElements; {* ver. 5.3 *} // For

C++Builder/Delphi XE2 or higher

Description

Use StyleElements to customize the style of the grid. If a custom style is enabled, you can enable or disable some style elements in the grid. StyleElements is a set of values that specify which elements of the current style are to be applied to this control. By default, all the elements of the style are enabled.

These are the possible values of StyleElements:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

seFont seClient

The grid uses the font color defined in the style (for data cells).

The grid uses the background color defined in the style (for data cells). seBorder The grid uses the border and scroll bars of the style.

Notice. The fixed and selected cells are always styled when custom style is enabled.

_______

See also: StylesEnabled , TXCustomDBGrid.SystemStyleElements

TXCustomDBGrid.SystemStyleElements

Specifies the system style elements that are used by the grid.

type

TSystemStyleElements = set of (sseFixed, sseText, sseButton, sseMarker, sseData, sseFont, sseClient);

property SystemStyleElements: TSystemStyleElements; {* ver. 5.3 *} // For

C++Builder/Delphi XE2 or higher

Description

Use SystemStyleElements to customize the system style of the grid. Starting from Windows Vista , if a system style is enabled, you can enable or disable some style elements in the grid (only when

DrawingStyle is gdsThemed). SystemStyleElements is a set of values that specify which elements of the system style are to be applied to this control. By default, most elements of the style are enabled. These are the possible values of SystemStyleElements:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

sseFixed The grid uses the background image defined in the system style (for fixed cells). sseText The grid uses the text color defined in the system style (for fixed cells). sseButton sseMarker sseData

The grid uses the expand button defined in the system style (for title cells).

The grid uses the sorting marker defined in the system style (for title cells).

The grid uses the background image defined in the system style (for selected cells). sseFont sseClient

The grid uses the font color defined in the style (for data cells).

The grid uses the background color defined in the style (for data cells).

Notice. By default, the fixed and selected cells are styled when system style is enabled (starting from

Windows Vista). You may exclude all (or some) elements from SystemStyleElements to go back to an earlier themed style of the grid. See also IsSystemStyle function.

_______

TXCustomDBGrid.TitleHeight

Specifies the height (in pixels) of title's row.

property TitleHeight: Integer;

Description

If the Options property include dgTitles, TitleHeight is calculated as height of first row + RowLineWidth, otherwise TitleHeight is 0. If any Expandable column is Expanded , TitleHeight is calculated as sum of rows height occupied by titles.

TitleHeight is a read-only property.

_______

See also: TXCustomDBGrid.ScrollBarHeight

, TXCustomDBGrid.RowHeight

, TXCustomDBGrid.BlankHeight

TXCustomDBGrid.TotalHeight

, TXCustomDBGrid.DataRowsHeight

, TXCustomDBGrid.DataHeight

TXCustomDBGrid.TitleImages

Determines which image list is associated with the titles.

property TitleImages: TImageList ;

Description

Use TitleImages to provide a customized list of bitmaps that can be displayed to the left of a title's caption.

Individual columns specify the image from this list that should appear by setting their ImageIndex property.

_______

See also: TXCustomDBGrid.IndicatorImages

, TXCustomDBGrid.TitleMarkers

, TXColumn.Images

, TXColumnTitle.ImageIndex

TXCustomDBGrid.TitleLinesCount

, TXCustomDBGrid.TotalHeaderRowCount

TXCustomDBGrid.TotalValuesRowCount

, TXCustomDBGrid.TotalRowCount

TXCustomDBGrid.TotalHeaderRowCount

Specifies the number of TotalHeader's rows.

property TotalHeaderRowCount: Integer;

Description

If the OptionsEx property include dgTotalHeader, TotalHeaderRowCount is 1, otherwise

TotalHeaderRowCount is 0.

TotalHeaderRowCount is a read-only property.

_______

See also: TXCustomDBGrid.TotalFooterRowCount

, TXCustomDBGrid.TotalFieldsRowCount

TXCustomDBGrid.TotalValuesRowCount

, TXCustomDBGrid.TotalRowCount

TXCustomDBGrid.TotalHeight

Specifies the height (in pixels) of all total rows.

property TotalHeight: Integer;

Description

If the OptionsEx property include dgTotalHeader, dgTotalValues, dgTotalFields or dgTotalFooter,

TotalHeight is calculated as sum of height of all total rows, otherwise TotalHeight is 0.

TotalHeight is a read-only property.

_______

See also: TXCustomDBGrid.TitleHeight

, TXCustomDBGrid.BlankHeight

, TXCustomDBGrid.DataRowsHeight

TXCustomDBGrid.DataHeight

TXCustomDBGrid.TotalRowCount

Specifies the number of all total rows.

property TotalRowCount: Integer;

Description

If the OptionsEx property include dgTotalHeader, dgTotalValues, dgTotalFields or dgTotalFooter,

TotalRowCount specifies count of all total rows, otherwise TotalRowCount is 0.

TotalRowCount is a read-only property.

_______

TXCustomDBGrid.Totals

Indicates the TXDBGridTotals object that determines common properties for all total cells.

property Totals: TXDBGridTotals ;

Description

The Totals property points to TXDBGridTotals object that holds common properties for all total cells.

_______

TXCustomDBGrid.TotalValuesRowCount

Specifies the number of TotalValues rows.

property TotalValuesRowCount: Integer;

Description

If the OptionsEx property include dgTotalValues, TotalValuesRowCount specifies count of all TotalValues rows, otherwise TotalValuesRowCount is 0. TotalValuesRowsCount depend on maximum value of

TotalValues .Count property calculated for all columns defined in the grid.

TotalValuesRowCount is a read-only property.

_______

See also: TXCustomDBGrid.TotalFooterRowCount

, TXCustomDBGrid.TotalHeaderRowCount

TXCustomDBGrid.TotalFieldsRowCount

, TXCustomDBGrid.TotalRowCount

TXCustomDBGrid.UpdateInProgress

Indicates the update mode is in progres in the grid.

property UpdateInProgress: Boolean; {* ver. 4.3 *}

Description

Use UpdateInProgress to determine the grid is currently in update mode.

UpdateInProgress is True, when one of InUpdateListItems , InUpdateSequence or InUpdateTotals is True.

UpdateInProgress is a read-only property.

_______

See also: TXCustomDBGrid.InUpdateListItems

, TXCustomDBGrid.InUpdateSequence

, TXCustomDBGrid.InUpdateTotals

TXCustomDBGrid.WheelScrollRows

Specifies the number of rows that are scrolled for each notch that the mouse wheel is rotated.

property WheelScrollRows: Integer;

Description

Set WheelScrollRows to specify number of rows to scroll when one mouse wheel notch is rotated. When

WheelScrollRows is 0 the system value of WheelScrollLines will be used. WheelScrollLines can be set under Mouse in the Windows Control Panel. When WheelScrollRows is -1 the number of visible rows in the grid will be used (one page will be scrolled). To get the true number of rows that are scrolled for each notch that the mouse wheel is rotated use MouseWheelScrollRows function.

Using mouse wheel with Ctrl key pressed allows to scroll the grid always by 1 row. Using mouse wheel with Shift key pressed allows to scroll the grid always by 1 page.

{* ver. 5.6 *}

_______

See also: TXCustomDBGrid.MouseWheelScrollRows

TXCustomDBGrid.BeginOrderUpdate

Increments internal OrderChangeLock property when the data order in the grid changes.

procedure BeginOrderUpdate;

Description

XDBGrid calls BeginOrderUpdate internally before making changes that affect the data order in the grid.

Once the change is complete, the XDBGrid calls EndOrderUpdate, which decrements internal

OrderChangeLock property.

While OrderChangeLock is greater than 0, the grid does not repaint its cells and does not call

OnOrderChanged event. BeginOrderUpdate and EndOrderUpdate prevent the grid from partially order changes.

_______

TXCustomDBGrid.BeginSelect

Increments internal SelectLock property when selected rows or columns changes.

procedure BeginSelect;

Description

XDBGrid calls BeginSelect internally before making group of changes in SelectedRows and/or

SelectedCols . Once the change is complete, the XDBGrid calls EndSelect , which decrements internal

SelectLock property.

When SelectLock is decremented to 0, EndSelect calls OnSelectedRowsChanged and/or

OnSelectedColsChanged events. The OnSelectedRowsChanged event is triggered only when

RowsChanged flag is True. The OnSelectedColsChanged event is triggered only when ColsChanged flag is True. It allows to call each event once - after group of changes was made in

SelectedRows/SelectedCols. You can examine RowsChanged/ColsChanged flags in your event handlers.

_______

TXCustomDBGrid.CancelSelect

This method is now obsolete.

procedure CancelSelect; { obsolete }

Description

XDBGrid calls CancelSelect internally when no changes are made in SelectedRows / SelectedCols after

BeginSelect was performed. This method is now obsolete and it calls EndSelect . {* ver. 4.3 *}

_______

TXCustomDBGrid.ChangeDataSetFilter

Changes filter properties in dataset linked to the grid.

procedure ChangeDataSetFilter(AFiltered: Boolean; AFilter: string;

AOnFilterRecord: TFilterRecordEvent ; AKeyFields: string = ''); virtual; {* ver. 6.0 *}

Description

Use ChangeDataSetFilter to change filter properties in DataSet linked to the grid. AFiltered parameter contains new state of filtering, AFilter parameter describes new filter condition and AOnFilterRecord parameter contains new OnFilterRecord event handler. AKeyFields parameter specifies the field or fields which allows to identify records in dataset. When the parameter is omitted the current value of KeyFields property will be used to identify records in DataSet.

Usually, you not need to call this method directly. To change any filter property in DataSet linked to the grid simply change the property Filter , Filtered or OnFilterRecord in TXDBGrid.

_______

TXCustomDBGrid.ChangeDataSetOrder

Changes sorting order in dataset linked to the grid.

function ChangeDataSetOrder(AOrderFields: string = ''): Boolean; virtual;

function ChangeDataSetOrder(AOrderFields: WideString = ''): Boolean; virtual;

// C++Builder/Delphi 2006, 2007 Win32 only

Description

Use ChangeDataSetOrder to change sorting order in DataSet linked to the grid. AOrderFields parameter describes new order in DataSet. When the parameter is omitted the current value of OrderFields property will be set as new order for DataSet.

When dgAutoUpdateOrder is included in OptionsEx this method is called automatically (without parameter) when OrderFields (sorting markers) changed. When dgAutoUpdateOrder is not included in

OptionsEx, OnOrderChanged event is triggered. You can write this event handler and call method

ChangeDataSetOrder with any value for AOrderFields parameter. It's especially useful, when you want to replace any calculated or lookup fields to it's equivalent in DataSet before you call this method.

This method is effective only for DataSet's registered by RegisterChangeOrder or

RegisterCustomChangeOrder . The result of this function is True when DataSet linked to the grid is registered or False when DataSet is not registered. When sorting order was changed in DataSet

OnOrderUpdated event is triggered.

ChangeDataSetOrder is a universal method for all registered DataSet's. All standard DataSet descendats

(except unidirectional) are registered by default to automatically change order (ADO, BDE, CDS, DBX,

IBX). This method calls internally ChangeIndexFields , ChangeOrderFields , ChangeSQLOrderFields or the custom method registered by RegisterCustomChangeOrder procedure depend on the ClassName of

DataSet linked to the grid.

See also: SetupCurrentOrder , CurrentDataSetOrder .

_______

See also: TXCustomDBGrid.ChangeIndexFields

, TXCustomDBGrid.ChangeOrderFields

, TXCustomDBGrid.ChangeSQLOrderFields

TXCustomDBGrid.UpdateOrder

TXCustomDBGrid.ChangeIndexFields

Changes sorting order in a table linked to the grid.

procedure ChangeIndexFields(AOrderFields: string = ''; PropName: string = '';

Suffix: string = '');

procedure ChangeIndexFields(AOrderFields: WideString = ''; PropName: string =

''; Suffix: string = '');

// C++Builder/Delphi 2006, 2007 Win32 only

Description

Use ChangeIndexFields (in OnOrderChanged event handler) to change sorting order in a table linked to the grid. AOrderFields parameter describes new order in DataSet. When the parameter is omitted the current value of OrderFields property will be set as new order for DataSet. AOrderFields parameter must be compatible with format of OrderFields property. It's internally converted to the format appropriate for

IndexFieldNames property.

PropName parameter describes index fields published property in DataSet linked to the grid. When

PropName parameter is omitted (or empty) the default published property called "IndexFieldNames" will be expected in DataSet to change index fields. For other names, you must explicity specify the name of the property in PropName parameter.

{* ver. 4.31 *}

Suffix parameter describes index fields modifier. When Suffix parameter is omitted

(or empty) the default suffix

'ASC;DESC;'

will be used to change current sorting order in data set. For other suffixes, you must explicity specify the ASC and DESC modifiers when they are accepted by

DataSet. For example, the AnyDAC's data sets accept the modifiers '

:A;:D;:N'

. Use semicolon to separate ASC and DESC modifiers. When none modifier is accepted by data set you must register the change order method with parameter AscOnly.

You can use this method only for DataSets which support IndexFieldNames as a method of specifying the index to use for a table. The sorting order will be changed only for indexed fields in the table. For other fields you will hear Beep only.

This method is internally registered for: TTable , TADOTable , TADODataSet , TIBTable , TIBClientDataSet ,

TClientDataSet , TSimpleDataSet , TSQLClientDataSet , TBDEClientDataSet .

See also: ChangeDataSetOrder , CurrentIndexFields .

_______

See also: TXCustomDBGrid.ChangeDataSetOrder

, TXCustomDBGrid.ChangeOrderFields

TXCustomDBGrid.ChangeSQLOrderFields

, TXCustomDBGrid.UpdateOrder

TXCustomDBGrid.ChangeOrderFields

Changes sorting order in a dataset linked to the grid.

procedure ChangeOrderFields(AOrderFields: string = ''; PropName: string = '');

procedure ChangeOrderFields(AOrderFields: WideString = ''; PropName: string =

'');

// C++Builder/Delphi 2006, 2007 Win32 only

Description

Use ChangeOrderFields (in OnOrderChanged event handler) to change sorting order in a dataset linked to the grid. AOrderFields parameter describes new order in DataSet. When the parameter is omitted the current value of OrderFields property will be set as new order for DataSet. AOrderFields parameter must be compatible with format of OrderFields property. It replaces fields in ORDER BY clause of

CommandText property.

PropName parameter describes command text published property in DataSet linked to the grid. When

PropName parameter is omitted (or empty) the default published property called "CommandText" will be expected in DataSet to change order fields. For other names, you must explicity specify the name of the property in PropName parameter.

You can use this method only when DataSet linked to the grid allow to specify SQL SELECT statement as

String or WideString published property. The sorting order will be changed only when AOrderFields parameter will be accepted in ORDER BY clause. In other case (lookup or calculated fields) you will hear

Beep only.

This method is internally registered for: TADODataSet , TIBClientDataSet , TClientDataSet ,

TSimpleDataSet , TSQLClientDataSet , TBDEClientDataSet .

See also: ChangeDataSetOrder , CurrentOrderFields .

_______

See also: TXCustomDBGrid.ChangeIndexFields

, TXCustomDBGrid.ChangeDataSetOrder

TXCustomDBGrid.ChangeSQLOrderFields

, TXCustomDBGrid.UpdateOrder

TXCustomDBGrid.ChangeSQLOrderFields

Changes sorting order in a query linked to the grid.

procedure ChangeSQLOrderFields(AOrderFields: string = ''; PropName: string =

'');

procedure ChangeSQLOrderFields(AOrderFields: WideString = ''; PropName: string

= '');

// C++Builder/Delphi 2006, 2007 Win32 only

Description

Use ChangeSQLOrderFields (in OnOrderChanged event handler) to change sorting order in a query linked to the grid. AOrderFields parameter describes new order in DataSet. When the parameter is omitted the current value of OrderFields property will be set as new order for DataSet. AOrderFields parameter must be compatible with format of OrderFields property. It replaces fields in ORDER BY clause of SQL property.

PropName parameter describes SQL published property in DataSet linked to the grid. When PropName parameter is omitted (or empty) the default published property called "SQL" will be expected in DataSet to change order fields. For other names, you must explicity specify the name of the property in PropName parameter.

You can use this method only when DataSet linked to the grid allow to specify SQL SELECT statement as

TStrings or TWideStrings published property. The sorting order will be changed only when AOrderFields parameter will be accepted in ORDER BY clause. In other case (lookup or calculated fields) you will hear

Beep only.

This method is internally registered for: TQuery , TADOQuery , TIBQuery , TIBDataSet .

See also: ChangeDataSetOrder , CurrentSQLOrderFields .

_______

See also: TXCustomDBGrid.ChangeIndexFields

, TXCustomDBGrid.ChangeOrderFields

, TXCustomDBGrid.ChangeDataSetOrder

TXCustomDBGrid.UpdateOrder

TXCustomDBGrid.ClearSelection

Clears all multiselected records/columns/cells in the grid.

procedure ClearSelection;

Description

Use ClearSelection to unselect all records/columns/cells in the grid. ClearSelection restores also default value for MultiSelect property and clears SelectionAnchor .

Note. You sholud call this method especially after dataset linked to the grid was refreshed and dataset's bookmarks are no longer valid.

_______

See also: TXCustomDBGrid.SelectionAnchor

, TXCustomDBGrid.MultiSelect

, TXCustomDBGrid.MultiSelectOptions

TXCustomDBGrid.SelectedRows

, TXCustomDBGrid.SelectedCols

TXCustomDBGrid.CloseSearchPanel

Close the search panel visible in the grid.

procedure CloseSearchPanel; {* ver. 6.2 *}

Description

Use CloseSearchPanel to hide search panel when it's visible in the grid. The user can perform this action by Esc key.

_______

See also: TXCustomDBGrid.ShowSearchPanel

, TXCustomDBGrid.UpdateSearchPanel

, TXCustomDBGrid.SearchPanelHeight

TXCustomDBGrid.SearchPanelVisible

TXCustomDBGrid.ColGetText

Performs additional processing for the Text retrieved by grid's Column.

type

TTextKind = (tkEdit, tkDisplay, tkReport);

function ColGetText(Column: TXColumn ; const Text: string; TextKind:

TTextKind): string; virtual;

Description

ColGetText method performs additional processing for a Text value, when the Text is retrieved from dataset. ColGetText is designed to format Text value depend on Column's properties. ColGetText considers PickText and PickOptions properties and finally calls OnColGetText event. The TextKind parameter determines text destination.

_______

TXCustomDBGrid.ColSetText

Performs additional processing for the Text stored by grid's Column.

function ColSetText(Column: TXColumn ; const Text: string): string; virtual;

Description

ColSetText method performs additional processing for a Text value, when the Text is stored to dataset.

ColSetText is designed to format Text value depend on Column's properties. ColSetText calls

OnColSetText event and finally considers PickText and PickOptions properties.

_______

TXCustomDBGrid.ColumnAtDepth

Returns the column object associated with parent column of the given column.

function ColumnAtDepth(Col: TXColumn; ADepth: Integer): TXColumn ;

Description

ColumnAtDepth is used to calculate MasterCol used in the CalcTitleRect and FullTitleRect methods.

ADepth parameter determines a depth in titles area starting from 0.

_______

TXCustomDBGrid.ColumnByName

Finds a column based on a specified field name.

function ColumnByName(const FieldName: string; FromIndex: Integer = 0):

TXColumn ;

function ColumnByName(const FieldName: WideString; FromIndex: Integer = 0):

TXColumn ;

// C++Builder/Delphi 2006, 2007 Win32 only

Description

Call ColumnByName to retrieve column information for a column when only the field's name is known.

FieldName is the name of a field stored in FieldName property in any column. ColumnByName returns the

TXColumn object for the specified field. If the field can not be found in any column, an exception is raised.

Specify FromIndex to continue searching duplicated FieldName starting from specified column index.

_______

TXCustomDBGrid.CompareOrderFields

Compares two OrderFields strings.

function CompareOrderFields(F1, F2: string): Boolean;

function CompareOrderFields(F1, F2: WideString): Boolean;

// C++Builder/Delphi

2006, 2007 Win32 only

Description

Use CompareOrderFields to compare two OrderFields strings field by field without case sensitive. The result is True, if both values determine the same sorting order. Otherwise, the result is False. This function is called before ChangeDataSetOrder changes sorting order in DataSet linked to the grid.

_______

See also: TXCustomDBGrid.ChangeDataSetOrder

, TXCustomDBGrid.OrderFields

TXCustomDBGrid.CopyToClipboard

Copies the cells selected in the grid to the Clipboard.

procedure CopyToClipboard; {* ver. 4.3 *}

Description

Use CopyToClipboard to replace the contents of the Clipboard with the text of cells MultiSelected in the grid. CopyToClipboard does not clear the Clipboard if no cell is selected (MultiSelected = False). If no cell is selected, CopyToClipboard does nothing.

If Options include dgExtendedSelect, the user can copy selected cells to Clipboard by using Ctrl+C or

Ctrl+Insert key.

_______

See also: TXCustomDBGrid.ForEachDataCell

, TXCustomDBGrid.MultiSelected

TXCustomDBGrid.CurrentDataSetOrder

Retrieves current sorting order from dataset linked to the grid.

function CurrentDataSetOrder: string; virtual;

function CurrentDataSetOrder: WideString; virtual;

// C++Builder/Delphi 2006,

2007 Win32 only

Description

Use CurrentDataSetOrder to retrieve sorting order from DataSet linked to the grid.

This method is effective only for DataSet's registered by RegisterChangeOrder or

RegisterCustomChangeOrder . The result of this function is compatible with format of OrderFields property.

CurrentDataSetOrder is a universal method for all registered DataSet's. All standard DataSet descendats

(except unidirectional) are registered by default to automatically change order (ADO, BDE, CDS, DBX,

IBX). This method calls internally CurrentIndexFields , CurrentOrderFields , CurrentSQLOrderFields or the custom function registered by RegisterCustomChangeOrder procedure depend on the ClassName of

DataSet linked to the grid.

See also: SetupCurrentOrder , ChangeDataSetOrder .

_______

See also: TXCustomDBGrid.CurrentIndexFields

, TXCustomDBGrid.CurrentOrderFields

, TXCustomDBGrid.CurrentSQLOrderFields

TXCustomDBGrid.SetupCurrentOrder

TXCustomDBGrid.CurrentIndexFields

Retrieves current sorting order from a table linked to the grid.

function CurrentIndexFields(PropName: string = ''; Suffix: string = ''):

string;

function CurrentIndexFields(PropName: string = ''; Suffix: string = ''):

WideString;

// C++Builder/Delphi 2006, 2007 Win32 only

Description

Use CurrentIndexFields to retrieve sorting order from a table linked to the grid. The result of this function is compatible with format of OrderFields property.

PropName parameter describes index fields published property in DataSet linked to the grid. When

PropName parameter is omitted (or empty) the default published property called "IndexFieldNames" will be expected in DataSet to retrieve current sorting order. For other names, you must explicity specify the name of the property in PropName parameter.

{* ver. 4.31 *}

Suffix parameter describes index fields modifier. When Suffix parameter is omitted

(or empty) the default suffix

'ASC;DESC;'

will be accepted to retrieve current sorting order from data set.

For other suffixes, you must explicity specify the ASC and DESC modifiers when they are accepted by

DataSet. For example, the AnyDAC's data sets accept the modifiers '

:A;:D;:N'

. Use semicolon to separate ASC and DESC modifiers. When none modifier is accepted by data set you must register the change order method with parameter AscOnly.

This method is internally registered for: TTable , TADOTable , TADODataSet , TIBTable , TIBClientDataSet ,

TClientDataSet , TSimpleDataSet , TSQLClientDataSet , TBDEClientDataSet .

See also: CurrentDataSetOrder , ChangeIndexFields .

_______

See also: TXCustomDBGrid.CurrentDataSetOrder

, TXCustomDBGrid.CurrentOrderFields

TXCustomDBGrid.CurrentSQLOrderFields

, TXCustomDBGrid.SetupCurrentOrder

TXCustomDBGrid.CurrentOrderFields

Retrieves current sorting order from a dataset linked to the grid.

function CurrentOrderFields(PropName: string = ''): string;

function CurrentOrderFields(PropName: string = ''): WideString;

C++Builder/Delphi 2006, 2007 Win32 only

Description

Use CurrentOrderFields to retrieve sorting order from dataset linked to the grid. The result of this function is compatible with format of OrderFields property.

PropName parameter describes command text published property in DataSet linked to the grid. When

PropName parameter is omitted (or empty) the default published property called "CommandText" will be expected in DataSet to retrieve current sorting order. For other names, you must explicity specify the name of the property in PropName parameter.

This method is internally registered for: TADODataSet , TIBClientDataSet , TClientDataSet ,

TSimpleDataSet , TSQLClientDataSet , TBDEClientDataSet .

See also: CurrentDataSetOrder , ChangeOrderFields .

_______

See also: TXCustomDBGrid.CurrentIndexFields

, TXCustomDBGrid.CurrentSQLOrderFields

, TXCustomDBGrid.SetupCurrentOrder

TXCustomDBGrid.CurrentSQLOrderFields

Retrieves current sorting order from a query linked to the grid.

function CurrentSQLOrderFields(PropName: string = ''): string;

function CurrentSQLOrderFields(PropName: string = ''): WideString;

C++Builder/Delphi 2006, 2007 Win32 only

Description

Use CurrentSQLOrderFields to retrieve sorting order from a query linked to the grid. The result of this function is compatible with format of OrderFields property.

PropName parameter describes SQL published property in DataSet linked to the grid. When PropName parameter is omitted (or empty) the default published property called "SQL" will be expected in DataSet to retrieve current sorting order. For other names, you must explicity specify the name of the property in

PropName parameter.

This method is internally registered for: TQuery , TADOQuery , TIBQuery , TIBDataSet .

See also: CurrentDataSetOrder , ChangeOrderFields .

_______

See also: TXCustomDBGrid.CurrentIndexFields

, TXCustomDBGrid.CurrentOrderFields

, TXCustomDBGrid.CurrentDataSetOrder

TXCustomDBGrid.SetupCurrentOrder

TXCustomDBGrid.DefaultDataLineColor

Indicates default color of the data lines in the grid.

function DefaultDataLineColor: TColor ; {* ver. 4.3 *}

Description

Call DefaultDataLineColor to get default color of data lines in the grid. DefaultDataLineColor is used when

DataColLineColor or DataRowLineColor property is set to clDefault color.

_______

See also: TXCustomDBGrid.DataColLineColor

, TXCustomDBGrid.DataRowLineColor

Indicates default color for multiselected rows in the grid.

function DefaultSelectionColor: TColor ;

Description

Call DefaultSelectionColor to get default color for multiselected rows in the grid. DefaultSelectionColor is used when SelectionColor property is set to clDefault color.

_______

TXCustomDBGrid.DefaultSelectRowColor

Indicates default color for current row in the grid.

function DefaultSelectRowColor: TColor ;

Description

Call DefaultSelectRowColor to get default color for current row in the grid. DefaultSelectRowColor is used when SelectRowColor property is set to clDefault color.

_______

TXCustomDBGrid.DefaultStripeColor

Indicates default color for striped rows in the grid.

function DefaultStripeColor: TColor ;

Description

Call DefaultStripeColor to get default color for striped rows in the grid. DefaultStripeColor is used when

StripeColor property is set to clDefault color.

_______

TXCustomDBGrid.DisableGrid

Disables response on events incoming to XDBGrid component.

procedure DisableGrid;

Description

Call DisableGrid prior to iterating through a large number of records in the dataset connected to XDBGrid to prevent grid from updating every time the active record changes. Disabling grid prevents flicker and speeds performance because data does not need to be written to the display and the user can't change iterating process.

DisableGrid calls internally DisableControls and sets Enabled property to False.

DisableGrid is especially useful for Print and Preview method which iterates through the dataset connected to XDBGrid.

_______

TXCustomDBGrid.DisablePosition

Stores position in the grid and disables data display in data-aware controls associated with grid's dataset.

procedure DisablePosition;

Description

Call DisablePosition prior to iterating through a large number of records in the dataset connected to

XDBGrid to prevent grid from updating every time the active record changes. Disabling grid prevents flicker and speeds performance because data does not need to be written to the display and the user can't change iterating process.

DisablePosition stores internally current row's position in the grid and a Bookmark to the active record in grid's dataset, then calls DisableControls .

Current row's position and active record can be restored by EnablePosition .

_______

See also: TXCustomDBGrid.PositionDisabled

, TXCustomDBGrid.EnablePosition

TXCustomDBGrid.DropDownList

Drops down the list for the column.

function DropDownList(Column: TXColumn ; Title: Boolean): Boolean;

Description

Call DropDownList to drop down the list for the Column. As now the DropDownList method is used to drop down FilterList only. This function returns True, if list was shown, otherwise it returns False.

_______

TXCustomDBGrid.DropDownMenu

Drops down the PopupMenu for the column.

function DropDownMenu(Column: TXColumn ; Title: Boolean; PopupMenu: TPopupMenu

= nil): Boolean;

Description

Call DropDownMenu to drop down the PopupMenu for the Column in DropDownPoint . If PopupMenu parameter is nil the default PopupMenu for the Column will be drop down. If Title parameter is True the default PopupMenu is Column.Title.

DropDownMenu . If Title parameter is False the default PopupMenu is

Column.

DropDownMenu . If Column parameter is nil the default PopupMenu is FillerPopupMenu

(Title=True) or either IndicatorPopupMenu (Title=False). This function returns True, if PopupMenu was shown, otherwise it returns False.

_______

TXCustomDBGrid.DropDownPoint

Returns a point suitable to drop down menu for the column.

function DropDownPoint(Column: TXColumn ; Title: Boolean): TPoint ;

Description

Call DropDownPoint to determine a point suitable to drop down menu for the Column. If Title parameter is

True the function returns left lower corner of the Column title. If Title parameter is False the function returns left lower corner of data cell in current row. If Column parameter is nil the function returns a point for the filler (Title=True) or either for the indicator (Title=False). This function is internally used by

DropDownMenu method. The result of function is returned as global screen coordinates.

_______

TXCustomDBGrid.DropDownRect

Returns a rectangle suitable to drop down list for the column.

function DropDownRect(Column: TXColumn ; Title: Boolean): TRect ;

Description

Call DropDownRect to determine a rectangle suitable to drop down list for the Column. If Title parameter is True the function returns a rectangle of the Column title. If Title parameter is False the function returns a rectangle of data cell in current row. If Column parameter is nil the function returns a rectangle for the filler

(Title=True) or either for the indicator (Title=False). This function is internally used by DropDownList method. The result of function is returned as global screen coordinates.

_______

TXCustomDBGrid.EnableGrid

Re-enables response on events incoming to XDBGrid component.

procedure EnableGrid;

Description

Call EnableGrid to permit response on events incoming to XDBGrid component after a prior call to

DisableGrid.

_______

TXCustomDBGrid.EnablePosition

Restores position in the grid and enables data display in data-aware controls associated with grid's dataset.

procedure EnablePosition(UseCurrentRec: Boolean = False);

Description

Call EnablePosition to permit response on events incoming to XDBGrid component after a prior call to

DisablePosition . EnablePosition restores last raw position in the grid (and last active record in grid's dataset), then call EnableControls .

If UseCurrentRec is False, EnablePosition restores active record used before DisablePosition. Last active record can be properly restored, if internally stored Bookmark is still valid. Otherwise, current record in grid's dataset is unchanged.

If UseCurrentRec is True, EnablePosition restores only last row position in the grid and leaves current record in grid's dataset unchanged. In this way, you may select any new current record in dataset before you call EnablePosition.

_______

See also: TXCustomDBGrid.PositionDisabled

, TXCustomDBGrid.DisablePosition

TXCustomDBGrid.EndOrderUpdate

Decrements internal OrderChangeLock property.

procedure EndOrderUpdate;

Description

XDBGrid calls EndOrderUpdate internally after making changes that affect the data order in the grid.

EndOrderUpdate returns internal OrderChangeLock property to the state it was in before the

BeginOrderUpdate method was called at the start of the changes.

While OrderChangeLock is greater than 0, the grid does not repaint its cells and does not call

OnOrderChanged event. When OrderChangeLock returns to 0, painting is reenabled and

OnOrderChanged event is fired. BeginOrderUpdate and EndOrderUpdate prevent the grid from partially order changes.

_______

See also: TXCustomDBGrid.BeginOrderUpdate

, TXCustomDBGrid.OrderFields

TXCustomDBGrid.EndSelect

Decrements internal SelectLock property.

procedure EndSelect;

Description

XDBGrid calls EndSelect internally after making group of changes in SelectedRows and/or SelectedCols list. EndSelect decrements internal SelectLock property to return to the state it was before the BeginSelect method was called at the start of the changes.

When SelectLock is decremented to 0, EndSelect calls OnSelectedRowsChanged ,

OnSelectedColsChanged and OnSelectionChanged events. The OnSelectedRowsChanged event is triggered only when RowsChanged flag is True. The OnSelectedColsChanged event is triggered only when ColsChanged flag is True. The OnSelectionChanged event is triggered when RowsChanged or

ColsChanged flag is True. It allows to call each event once - after group of changes was made in

SelectedRows/SelectedCols list. You can examine RowsChanged/ColsChanged flag in your event handlers.

Alter all EndSelect clears RowsChanged and ColsChanged flags.

_______

Indicates whether sequence numbers for database records are forced in grid.

function ForcedSequence: Boolean;

Description

This function has similar meaning to IsSequenced . ForcedSequence is True, if dgForceSequence option is included in Options and dataset linked to the grid is Active . Otherwise, ForcedSequence is False.

When ForcedSequence is True the grid can realize proportional scrolling and AutoNumber for any dataset. See also: UpdateSequence , RecNumber , RecCount .

_______

TXCustomDBGrid.ForEachDataCell

Processes all/selected data cells in the grid.

type

TForEachCellScope = (fsAutoSelect, fsWholeDataSet, fsSelectedOnly);

TForEachCellFlag = (feFirstCol, feLastCol, feFirstRow, feLastRow);

TForEachCellFlags = set of TForEachCellFlag;

TForEachCellProc = procedure(Column: TXColumn; Flags: TForEachCellFlags) of

object; {* ver. 4.3 *} // For Delphi 2007 and earlier

TForEachCellProc = reference to procedure(Column: TXColumn; Flags:

TForEachCellFlags); {* ver. 6.2 *} // For Delphi 2009 or higher

procedure ForEachDataCell(DoProc: TForEachCellProc; Scope: TForEachCellScope = fsAutoSelect); {* ver. 4.3 *} // For Delphi 2007 and earlier

procedure ForEachDataCell(DoProc: TForEachCellProc; Scope: TForEachCellScope = fsAutoSelect); overload; {* ver. 6.2 *} // For Delphi 2009 or higher

Description

Use ForEachDataCell to process all/selected data cells in the grid. The grid calls DoProc method for each data cell determined by Scope parameter. When Scope is fsSelectedOnly the ForEachDataCell can handle all kinds of multiselection depend on MultiSelect property.

To use ForEachDataCell method you must define DoProc method to process values for each data cell.

When DoProc method is called the current record in dataset linked to the grid indicates the row of processed cell and Column parameter indicates the column of processed cell. The Flag parameter allows to do additional actions when first/last row/column is processed.

The Scope parameter determines the scope of processed cells from the following values:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

fsAutoSelect fsWholeDataSet

When MultiSelected is True, the scope is fsSelectedOnly else fsWholeDataSet.

All columns in whole dataset are processed. fsSelectedOnly Selected rows/columns/cells are processed only.

Example

______________________________________________________________________________________________________________________________________________________________________________

procedure TForm1.DoSaveToFile(Column: TXColumn; Flags: TForEachCellFlags);

const

List: TStrings = nil;

Text: string = '' ;

ARow: Integer = 0;

begin

if feFirstCol in Flags then

begin

if feFirstRow in Flags then

begin

FreeAndNil(List);

List := TStringList.Create;

ARow := 0;

end;

Text := '' ;

Inc(ARow);

end;

if Column.Showing then

begin

if Column.AutoNumber then Text := Text + AutoNumberStr(ARow)

else Text := Text + StringReplace(Column.EditText, ';' , ' ' ,

[rfReplaceAll]);

if not (feLastCol in Flags) then Text := Text + ';' ;

end;

if feLastCol in Flags then

begin

List.Add(Text);

if feLastRow in Flags then

begin

List.SaveToFile( 'SaveToFile.txt' );

FreeAndNil(List);

Text := '' ;

end;

procedure TForm1.SaveToFile(Sender: TObject);

begin

XDBGrid1.ForEachDataCell(DoSaveToFile);

end;

_______

See also: TXCustomDBGrid.CopyToClipboard

TXCustomDBGrid.ForEachDataCell

Processes all/selected/current data cells in the grid.

procedure ForEachDataCell(RowEnum: TDataRowEnum ; ColEnum: TDataColEnum ;

DoProc: TDataColProc ); overload; {* ver. 6.2 *} // For Delphi 2009 or higher

Description

Use ForEachDataCell to process all/selected/current data cells in the grid. The grid calls DoProc method for each data row determined by RowEnum parameter and for each column determined by ColEnum parameter. To use ForEachDataCell method you must define DoProc method to process values for each data cell. When DoProc method is called the current record in dataset linked to the grid indicates the row of processed cell and Column parameter indicates the column of processed cell.

The ForEachDataCell method works similar to

ForEachDataRow(RowEnum,

procedure(ForEachDataCol(ColEnum, DoProc)))

but it's more efficient.

_______

TXCustomDBGrid.ForEachDataCol

Processes all/selected/current columns in the grid.

type

TDataColEnum = (ceAllCols, ceSelectedCols, ceSelectedColsOrAllCols, ceSelectedColsOrCurrent, ceCurrentCol);

TDataColProc = reference to procedure(Column: TXColumn );

procedure ForEachDataCol(ColEnum: TDataColEnum; DoProc: TDataColProc); {* ver.

6.2 *} // For Delphi 2009 or higher

Description

Use ForEachDataCol to process all/selected/current columns in the grid. The grid calls DoProc method for each column determined by ColEnum parameter. To use ForEachDataCol method you must define

DoProc method to process values for each column. When DoProc method is called the Column parameter indicates the processed column.

These are the possible values of ColEnum parameter:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

ceAllCols All columns in the grid. ceSelectedCols All selected columns in the grid. ceSelectedColsOrAllCols All selected columns in the grid or all columns when no column is selected. ceSelectedColsOrCurrent All selected columns in the grid or current column when no column is selected. ceCurrentCol Current column in the grid.

Example

______________________________________________________________________________________________________________________________________________________________________________

function TForm1.FieldNameList(ColEnum: TDataColEnum): string;

var

List: string;

begin

XDBGrid1.ForEachDataCol(ColEnum,

procedure(Column: TXColumn)

begin

if Column.Showing then

List := List + ';' + Column.FieldName;

end);

Result := Copy(List, 2 , Length(List));

end;

_______

TXCustomDBGrid.ForEachDataRow

Processes all/selected/current data rows in the grid.

type

TDataRowEnum = (reAllRows, reSelectedRows, reSelectedRowsOrAllRows, reSelectedRowsOrCurrent, reCurrentRow);

TDataRowProc = reference to procedure;

procedure ForEachDataRow(RowEnum: TDataRowEnum; DoProc: TDataRowProc); {* ver.

6.2 *} // For Delphi 2009 or higher

Description

Use ForEachDataRow to process all/selected/current data rows in the grid. The grid calls DoProc method for each data row determined by RowEnum parameter. To use ForEachDataRow method you must define

DoProc method to process values for each data row. When DoProc method is called the current record in dataset linked to the grid indicates the processed row.

These are the possible values of RowEnum parameter:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

reAllRows reSelectedRows reSelectedRowsOrAllRows

All data rows in the grid.

All selected rows in the grid.

All selected rows in the grid or all data rows when no row is selected. reSelectedRowsOrCurrent All selected rows in the grid or current data row when no row is selected. reCurrentRow Current data row in the grid or nothing when data set is empty.

Example

______________________________________________________________________________________________________________________________________________________________________________

function TForm1.FieldTextList(Field: TField; RowEnum: TDataRowEnum): string;

var

List: string;

begin

XDBGrid1.ForEachDataRow(RowEnum,

procedure

begin

List := List + ';' + Field.Text;

end);

Result := Copy(List, 2 , Length(List));

end;

_______

TXCustomDBGrid.GetDataColEnum

Retrieves a column enumerator.

function GetDataColEnum(ColEnum: TDataColEnum ): TXColumnEnumerator; {* ver.

6.2 *} // For Delphi 2009 or higher

Indicates whether XDBGrid component do not response on incoming events.

function GridDisabled: Boolean;

Description

Call GridDisabled to determine if the response on incoming events is currently disabled. If GridDisabled is

True, XDBGrid is currently disabled by prior using DisableGrid .

_______

TXCustomDBGrid.InvertAll

Invert selection of all records or columns in the grid.

procedure InvertAll;

Description

Use InvertAll to invert selection of all records or columns in the grid. This method works only when

MultiSelect is msRows or msCols.

If Options include dgExtendedSelect, the user can invert selection of all records or columns by using

Alt+Ctrl+Click.

_______

TXCustomDBGrid.InvertRows

Invert selection of multiple records in the grid.

procedure InvertRows;

Description

Use InvertRows to invert selection of records from SelectionAnchor to the current record. This method works only when MultiSelect is msRows.

_______

TXCustomDBGrid.IsCustomStyle

Indicates whether grid uses custom style to draw fixed and/or data cells.

function IsCustomStyle(Elements: TStyleElements = []): Boolean; {* ver. 6.0 *}

// For C++Builder/Delphi XE2 or higher

Description

Call IsCustomStyle to determine whether grid uses custom style drawing for fixed and/or data cells.

IsCustomStyle function return True when StylesEnabled is True. When Elements parameter is not omitted, the StyleElements property must also contain all Elements passed in parameter.

_______

See also: StylesEnabled , TXCustomDBGrid.IsSystemStyle

TXCustomDBGrid.IsGridThemed

Indicates whether grid uses ThemeServices (Windows XP styles) to draw fixed cells.

function IsGridThemed(ForceThemed: Boolean = False) {* ver. 5.0 *} : Boolean;

Description

Call IsGridThemed to determine whether XDBGrid uses Windows XP style drawing for fixed cells.

IsGridThemed return True when ThemesEnabled return True and FixedTheme property is not ftNone or either the ForceThemed parameter is True.

_______

TXCustomDBGrid.IsSystemStyle

Indicates whether grid uses system style to draw fixed and/or data cells.

function IsSystemStyle(Elements: TSystemStyleElements = []): Boolean; {* ver.

5.3 *} // For C++Builder/Delphi XE2 or higher

Description

Call IsSystemStyle to determine whether grid uses system style drawing for fixed and/or data cells.

IsSystemStyle function return True when class property SystemStyleEnabled is True and StylesEnabled is

False, IsVista return True, ThemesEnabled return True and FixedTheme property is not ftNone. When

Elements parameter is not omitted, the SystemStyleElements property must also contain all Elements passed in parameter.

_______

See also: StylesEnabled , ThemesEnabled , IsVista , TXCustomDBGrid.IsCustomStyle

TXCustomDBGrid.IsSystemTheme

Indicates whether system theme is used instead default fixed theme.

function IsSystemTheme: Boolean; {* ver. 5.32 *}

Description

Call IsSystemTheme to determine whether grid uses system theme drawing instead default theme for fixed cells. IsSystemTheme function return True when IsGridThemed return True and FixedTheme property is ftDefault and Windows 8 platform was detected or either Windows Vista or Windows 7 was detected when dgForceSystemTheme option is included in OptionsExt .

_______

See also: FixedTheme , IsGridThemed , IsVista

TXCustomDBGrid.IsThemeTransparent

Indicates whether current fixed theme is drawing transparently.

function IsThemeTransparent: Boolean; {* ver. 5.32 *}

Description

Call IsThemeTransparent to determine whether current fixed theme is drawing transparently.

IsThemeTransparent function return True when FixedTheme property is ftDefault and Windows 8 platform was not detected and Windows Vista or Windows 7 was detected but dgForceSystemTheme option is not included in OptionsExt . Only when IsThemeTransparent return True the FixedColor property works effectively when fixed theme is applied.

_______

TXCustomDBGrid.KeepPosition

Indicates whether the grid can keep position of current record.

function KeepPosition: Boolean; {* ver. 5.32 *}

Description

Call KeepPosition to determine whether the grid can keep position of current record. This function return

True when KeyFields property is defined. KeepPosition is evaluated by RefreshDataSet and

ChangeDataSetOrder methods.

_______

TXCustomDBGrid.KeepSelection

Indicates whether the grid can keep current selection.

function KeepSelection: Boolean; {* ver. 5.32 *}

Description

Call KeepSelection to determine whether the grid can keep current selection. This function return True when KeyFields property is defined and dgAutoKeepSelection option is included in OptionsEx .

KeepSelection is evaluated by RefreshDataSet and ChangeDataSetOrder methods.

_______

TXCustomDBGrid.MouseWheelScrollRows

Indicates the number of rows that are scrolled for each notch that the mouse wheel is rotated.

function MouseWheelScrollRows: Integer;

Description

Call MouseWheelScrollRows to get number of rows that are currently scrolled for each notch that the mouse wheel is rotated. The value of this function is determined by WheelScrollRows property.

_______

See also: TXCustomDBGrid.WheelScrollRows

TXCustomDBGrid.OrderUpdated

Triggers OnOrderUpdated event.

procedure OrderUpdated; virtual;

Description

The OrderUpdated method is called when sorting order in dataset linked to the grid was successfully changed by one of the methods designed to automatically change sorting order ( ChangeDataSetOrder ,

ChangeIndexFields , ChangeOrderFields or ChangeSQLOrderFields ) or by the method registered with using RegisterCustomChangeOrder procedure. When you write custom method to change sorting order remember to call OrderUpdated when you method successfully finished.

The OrderUpdated method triggers OnOrderUpdated event.

_______

TXCustomDBGrid.PerformDelayed

Performs delayed calculations.

procedure PerformDelayed: Boolean; virtual;

Description

Call PerformDelayed to perform all delayed calculations when dgDelayUpdateSequence, dgDelayUpdateTotals or dgDelaySelectedRows option is included in OptionsEx property. PerformDelayed always calls CheckBrowseMode first and then finalizes delayed UpdateSequnece , UpdateTotals and/or

SelectedRowsChanged methods because these methods can be finalized only when DataSet linked to the grid is in dsBrowse State . You may need to call PerformDelayed (to update sequence number or total values) before Append, Insert or Edit is called outside the grid.

Notice. If you are using (X)DBNavigator with nbInsert button you should write BeforeAction (or

OnBeforeInsert ) event handler to call PerformDelayed before Insert.

_______

See also: DelayInterval , TXCustomDBGrid.OptionsEx

TXCustomDBGrid.PositionDisabled

Indicates whether XDBGrid component has disabled position.

function PositionDisabled: Boolean;

Description

Call PositionDisabled to determine if XDBGrid has disabled position. If PositionDisabled is True, XDBGrid is currently disabled by prior using DisablePosition .

_______

See also: TXCustomDBGrid.DisablePosition

, TXCustomDBGrid.EnablePosition

TXCustomDBGrid.RefreshDataSet

Refresh dataset linked to the grid.

procedure RefreshDataSet(AKeyFields: string = '') {* ver. 5.0 *} ;

Description

Use RefreshDataSet to refresh data in the grid when data in DataSet linked to the grid changed. This method performs Close and Open on DataSet linked to the grid with using DisablePosition and

EnablePosition . When AKeyFields parameter is defined, the KeyValues for current record are saved before Close and current record is restored after Open with using Locate method. When AKeyFields parameter is empty, the KeyFields property will be used instead.

Using RefreshDataSet allows to refresh data in the grid without changing the current position in the grid when KeepPosition is True and without clearing the current selection when KeepSelection is True. It's especially useful after calling ApplyUpdates method.

_______

TXCustomDBGrid.RestoreSelection

Restore saved selection.

procedure RestoreSelection(AKeyFields: string = '') ; {* ver. 5.32 *}

Description

Call RestoreSelection to restore selection saved by SaveSelection method. AKeyFields parameter specifies the field or fields to uniquely identify records in dataset. To use more than one field, separate each field name with a semicolon. When AKeyFields parameter is empty, the KeyFields property will be used. When KeyFields property is empty, an error will be raised. The specified key fields must be of the same types as the corresponding key fields used in SaveSelection method, or the RestoreSelection method fails. This method always restores current state of SelectedRows , SelectedCols and MultiSelect properties.

This method is called automatically by RefreshDataSet and ChangeDataSetOrder procedures when

KeepSelection function return True.

_______

TXCustomDBGrid.SaveSelection

Save current state of selection.

procedure SaveSelection(AKeyFields: string = '') ; {* ver. 5.32 *}

Description

Call SaveSelection to save current state of selection. AKeyFields parameter specifies the field or fields to uniquely identify records in dataset. To use more than one field, separate each field name with a semicolon. When AKeyFields parameter is empty, the KeyFields property will be used. When KeyFields property is empty, an error will be raised. Each call of SaveSelection procedure overrides the saved selection. This method always saves current state of SelectedRows , SelectedCols and MultiSelect properties.

This method is called automatically by RefreshDataSet and ChangeDataSetOrder procedures when

KeepSelection function return True.

_______

See also: TXCustomDBGrid.RestoreSelection

TXCustomDBGrid.ScaleColumnsBy

Scale the width and height of grid columns.

procedure ScaleColumnsBy(M, D: Integer; ScaleFont: Boolean = True {* ver. 6.3

*} ); {* ver. 6.2 *}

Description

Use ScaleColumnsBy to change width and height of grid columns proportionally.

The M and D parameters define a fraction by which to scale the width of columns. The M parameter is the multiplier and the D parameter is the divisor. For example, to make a width 75% of its original size, specify the value of M as 75, and the value of D as 100 (75/100). Alternately, the same results are achieved by specifying the value of M as 3, and the value of D as 4 (3/4). Both fractions are equal and result in the width of columns being scaled by the same amount, 75%.

To scale the width of columns to be 33% larger than its previous size, specify the value of M as 133, and the value of D as 100 (133/100). Alternately, specify the value of M as 4, and the value of D as 3 (4/3), as the fraction 133/100 is approximately equal to 4/3.

Since version 6.3 all fonts used in TXDBGrid are also scaled when ScaleFont parameter is True. It allows to change columns width and rows height proportionally.

{* ver. 6.3 *}

_______

TXCustomDBGrid.SearchCell

Searches for any text in the grid.

type

TXSearchMode = (smFirst, smNext, smPrev, smLast);

function SearchCell(SearchMode: TXSearchMode; const SearchText: string;

SearchOptions: TXSearchOptions ): Boolean; {* ver. 6.2 *}

Description

Use SearchCell to search any text in the grid. The SearchText parameter contains any text to search. The

SearchOptions parameter constains options to match SearchText with data in the grid. Only soCaseSensitive and soWholeWords options are taken into account. The SearchMode determines the result of the searching. When SearchText has been found SearchCell returns True and current row and current column are set up to the cell that contains the searched text. When SearchText has not been found SearchCell returns False and current row and current column are not changed. These are the possible values of SearchMode:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

smFirst smNext

The function returns first occurence of search text in the grid.

The function returns next occurence of search text in the grid. smPrev The function returns previous occurence of search text in the grid. smLast

_______

The function returns last occurence of search text in the grid.

TXCustomDBGrid.SearchGrid

Searches for text in the grid.

function SearchGrid(SearchMode: TXSearchMode ): Boolean; {* ver. 6.2 *}

Description

Use SearchGrid to search Search.Text

value in the grid with using Search.Options

. The SearchGrid calls internally SearchCell method and respects soWrapAround and soSkipMessage search options. The

SearchMode determines the result of the searching. When search text has been found SearchGrid returns

True and current row and current column are set up to the cell that contains the searched text. When search text has not been found SearchGrid returns False and current row and current column are not changed.

_______

TXCustomDBGrid.SelectAll

Select all records/columns/cells in the grid.

procedure SelectAll;

Description

Use SelectAll to select all records/columns/cells in the grid. This method does'nt change current value of

MultiSelect property.

If Options include dgExtendedSelect, the user can select all records/columns/cells by using Alt+Shift+Click or Ctrl+A key.

_______

TXCustomDBGrid.SelectRows

Select multiple records in the grid.

procedure SelectRows;

Description

Use SelectRows to select records from SelectionAnchor to the current record. This method works only when MultiSelect is msRows.

If Options include dgExtendedSelect, the user can select multiple records by using Shift+Click.

_______

TXCustomDBGrid.SetupCurrentOrder

Sets current sorting order retrieved from dataset linked to the grid.

procedure SetupCurrentOrder;

Description

SetupCurrentOrder calls CurrentDataSetOrder function to retrieve current sorting order from DataSet linked to the grid and pass the result to SetupOrderFields method to synchronize sorting Markers with sorting order in DataSet. When dgLoadCurrentOrder is included in OptionsEx this method is called automatically when DataSet linked to grid is opened.

TXCustomDBGrid.SetupOrderFields

Sets sorting order (OrderFields) in the grid.

procedure SetupOrderFields(Value: string);

procedure SetupOrderFields(Value: WideString);

// C++Builder/Delphi 2006, 2007

Win32 only

Description

SetupOrderFields sets one or more fields separated by comma in OrderFields property. SetupOrderFields does not trigger OnOrderChanged event and can be used to synchronize between sorting order in

DataSet and sorting Marker s in the grid. To extract current sorting order from DataSet call

CurrentDataSetOrder function.

_______

TXCustomDBGrid.ShowSearchPanel

Show the search panel in the grid.

procedure ShowSearchPanel; {* ver. 6.2 *}

Description

Use ShowSearchPanel to show search panel in the grid. The user can perform this action by Ctrl+F shortcut.

_______

See also: TXCustomDBGrid.CloseSearchPanel

, TXCustomDBGrid.UpdateSearchPanel

, TXCustomDBGrid.SearchPanelHeight

TXCustomDBGrid.SearchPanelVisible

Include or exclude MultiSelectOptions depending on State.

procedure SwitchMultiSelectOptions(Part: TMultiSelectOptions ; State: Boolean);

{* ver. 6.0 *}

Description

Use SwitchMultiSelectOptions to include or exclude the Part of MultiSelectOptions property. When State is

True the Part options are included, otherwise excluded.

_______

See also: TXCustomDBGrid.SwitchResizeOptions

Include or exclude ResizeOptions depending on State.

procedure SwitchResizeOptions(Part: TXResizeOptions ; State: Boolean); {* ver.

6.0 *}

Description

Use SwitchResizeOptions to include or exclude the Part of ResizeOptions property. When State is True the Part options are included, otherwise excluded.

_______

See also: TXCustomDBGrid.SwitchMultiSelectOptions

TXCustomDBGrid.SwitchStyleElements

Include or exclude StyleElements depending on State.

procedure SwitchStyleElements(Part: TStyleElements ; State: Boolean); {* ver.

6.0 *} // For C++Builder/Delphi XE2 or higher

Description

Use SwitchStyleElements to include or exclude the Part of StyleElements property. When State is True the Part elements are included, otherwise excluded.

_______

See also: TXCustomDBGrid.SwitchSystemStyleElements

TXCustomDBGrid.SwitchSystemStyleElements

Include or exclude SystemStyleElements depending on State.

procedure SwitchSystemStyleElements(Part: TSystemStyleElements ; State:

Boolean); {* ver. 6.0 *} // For C++Builder/Delphi XE2 or higher

Description

Use SwitchSystemStyleElements to include or exclude the Part of SystemStyleElements property. When

State is True the Part elements are included, otherwise excluded.

_______

See also: TXCustomDBGrid.SwitchStyleElements

TXCustomDBGrid.Synchronize

Fits width of all columns to width of MasterGrid's columns.

procedure Synchronize;

Description

Use Synchronize when MasterGrid is assigned and you made any special changes you need call this method.

_______

TXCustomDBGrid.ThemesEnabled

Indicates whether ThemeServices (Windows XP style) is available and enabled.

function ThemesEnabled: Boolean;

Description

Call ThemesEnabled to determine whether ThemeServices is available and enabled. ThemesEnabled return True only on Windows XP platform when XP Manifest is present, otherwise ThemesEnabled return

False. See also IsGridThemed .

_______

TXCustomDBGrid.UnselectAll

Unselect all records/columns/cells in the grid.

procedure UnselectAll;

Description

Use UnselectAll to unselect all records/columns/cells in the grid. This method calls internally

ClearSelection . See also: MultiSelect .

If Options include dgExtendedSelect, the user can unselect all records/columns/cells by using Alt+Click.

_______

TXCustomDBGrid.UnselectRows

Unselect multiple records in the grid.

procedure UnselectRows;

Description

Use UnselectRows to unselect records from SelectionAnchor to the current record. This method works only when MultiSelect is msRows.

_______

TXCustomDBGrid.UpdateFilter

Updates filter settings in dataset linked to the grid.

procedure UpdateFilter; {* ver. 6.0 *}

Description

UpdateFilter changes filter settings in DataSet linked to the grid according to the current state of filter settings in the grid. UpdateFilter calls internally ChangeDataSetFilter to change properties in DataSet. You not need to call this method directly.

_______

See also: TXCustomDBGrid.ChangeDataSetFilter

, TXCustomDBGrid.FilterUpdated

, TXCustomDBGrid.OnFilterUpdated

TXCustomDBGrid.UpdateListItems

Updates the auto-loaded list items for the grid's columns.

procedure UpdateListItems(CheckAutoUpdate: Boolean = False); {* ver. 4.3 *}

Description

UpdateListItems updates PickList property for each column when poAutoLoadList option is included in

PickOptions . When CheckAutoUpdate parameter is True the method is performed only when dgAutoUpdateListItems is included in OptionsExt . The grid calls automatically this method (with

CheckAutoUpdate = True) each time when data in the grid have been changed. When dgAutoUpdateListItems is included in OptionsExt the auto-loaded list items are always updated, but this method may be called to often. You can minimize the number of calls by including dgDelayUpdateListItems option in OptionsExt.

When dgAutoUpdateListItems is not included in OptionsEx, this method is called only when DataSet is opened. Then, you must yourself call UpdateListItems when you need to update auto-loaded list items especially after EnableControls and EnablePosition . You should also call yourself UpdateListItems after

DataSet's method: Post, Delete, Refresh or when filter or range in dataset has been changed and when this changes may have an influence on list items.

Each time when UpdateListItems is finished the OnListItemsUpdated event is triggered.

_______

See also: TXCustomDBGrid.InUpdateListItems

, TXCustomDBGrid.OnListItemsUpdated

TXCustomDBGrid.UpdateOrder

Modify sorting order in datset linked to the grid or update sorting markers in the grid.

procedure UpdateOrder(CheckAutoUpdate: Boolean = False);

Description

UpdateOrder synchronizes sorting order in dataset linked to the grid with grid's OrderFields and sorting

Marker s. This method is effective only when linked dataset is registered to automatically change order. All standard DataSet descendats (except unidirectional) are registered by default to automatically change order (ADO, BDE, CDS, DBX, IBX). To register other typical or specific DataSets use

RegisterChangeOrder or RegisterCustomChangeOrder procedures.

When CheckAutoUpdate parameter is True the method is performed only when dgLoadCurrentOrder or dgAutoUpdateOrder is included in OptionsEx .

When dgLoadCurrentOrder is included in OptionsEx the OrderFields (and sorting markers) are initialized on the basis of current DataSet's order by calling SetupCurrentOrder . When dgLoadCurrentOrder is not included and dgAutoUpdateOrder is included in OptionsEx sorting order in DataSet linked to the grid is automatically modified on the basis of OrderFields property by calling ChangeDataSetOrder .

When CheckAutoUpdate parameter is False the method always performs ChangeDataSetOrder to modify order in DataSet.

_______

TXCustomDBGrid.UpdateSearchPanel

Update bounds of the search panel in the grid.

procedure UpdateSearchPanel; {* ver. 6.2 *}

Description

Use UpdateSearchPanel to update bounds of the search panel in the grid. You not need to call this method directly.

_______

See also: TXCustomDBGrid.CloseSearchPanel

, TXCustomDBGrid.ShowSearchPanel

, TXCustomDBGrid.SearchPanelHeight

TXCustomDBGrid.SearchPanelVisible

TXCustomDBGrid.UpdateSequence

Updates the sequence numbers for database records linked to grid.

procedure UpdateSequence(CheckAutoUpdate: Boolean = False);

Description

UpdateSequence updates RecNumber and RecCount property when ForcedSequence is True. When

CheckAutoUpdate parameter is True the method is performed only when dgAutoUpdateSequence is included in OptionsEx . The grid calls automatically this method (with CheckAutoUpdate = True) each time when data in the grid changed. When dgAutoUpdateSequence is included in OptionsEx the sequence number is always updated, but this method may be called to often. You can minimize the number of calls by including dgDelayUpdateSequence option in OptionsEx.

When dgAutoUpdateSequence is not included in OptionsEx, this method is called automatically (with

CheckAutoUpdate = False) only when dataset linked to the grid is opened. Then, you must yourself call

UpdateSequence especially after EnableControls or EnablePosition (when ControlsDisabled or

PositionDisabled is True the grid is'nt notified about changes in DataSet). You should also call yourself

UpdateSequence after DataSet's method: Locate, FindKey, FindNearest, GotoKey, GotoNearest,

GotoBookmark, Insert, Delete, Refresh or when index, filter or range in dataset has been changed and when this changes may have an influence on sequence number.

All navigation actions made by user directly in the grid update sequence internally in the grid. All sequence updates are always stored only in the grid. In the linked dataset nothing is changed. Each time when

UpdateSequence is finished the OnSequenceUpdated event is triggered.

_______

TXCustomDBGrid.UpdateTotals

Updates the calculated values in totals cells.

procedure UpdateTotals(CheckAutoUpdate: Boolean = False);

Description

UpdateTotals updates Value property for each total cell when TotalResult is trCalcValue. When

CheckAutoUpdate parameter is True the method is performed only when dgAutoUpdateTotals is included in OptionsEx . The grid calls automatically this method (with CheckAutoUpdate = True) each time when data in the grid or selected rows have been changed. When dgAutoUpdateTotals is included in OptionsEx the calculated values are always updated, but this method may be called to often. You can minimize the number of calls by including dgDelayUpdateTotals option in OptionsEx.

When dgAutoUpdateTotals is not included in OptionsEx, this method is never called automatically. Then, you must yourself call UpdateTotals when you need to recalculate totals values especially after

EnableControls , EnablePosition or when SelectedRowsChanged . You should also call yourself

UpdateTotals after DataSet's method: Post, Delete, Refresh or when filter or range in dataset has been changed and when this changes may have an influence on totals values.

Each time when UpdateTotals is finished the OnTotalsUpdated event is triggered.

_______

TXCustomDBGrid.OnCalcBoldDays

Occurs whenever a new month is displayed in the calendar (InplaceEditor).

type

TCalcBoldDaysEvent = procedure(Sender: TObject; Date: DateTime; var BoldDay:

Boolean) of object;

property OnCalcBoldDays: TCalcBoldDays;

Description

Use the OnCalcBoldDays event to initialize the display properties of a month. In particular,

OnCalcBoldDays allows applications to bold individual days in the calendar (such as holidays).

Default value of BoldDay is False (for every Date). To specify that specific dates are to be bolded, set

BoldDay to True. To specify that all sundays are to be bolded you can use: BoldDay := DayOfWeek(Date)

= 1;

Notice. As Sender is passed TMonthCalendar descendand. It allows you to access to other

TMonthCalendar(Sender) properties and methods. Be careful, OnCalcBoldDays is called for every day in previous, current and next month.

_______

TXCustomDBGrid.OnCalcImageIndex

Occurs when the grid needs an index to draw bitmap from Images.

type

TCalcImageIndexEvent = procedure(Sender: TObject; Column: TXColumn ; var

Index: Integer) of object;

property OnCalcImageIndex: TCalcImageIndexEvent;

Description

Write an OnCalcImageIndex event handler to change default index for the Images property.

OnCalcImageIndex event is fired for all columns that have assigned Images property. Default value for

Index is depend on field's value. When Column parameter is Nil you may calculate custom Index for

IndicatorImages based upon current record state.

_______

See also: TXCustomDBGrid.IndicatorImages

, TXCustomDBGrid.Indicators

, TXColumn.Images

TXCustomDBGrid.OnCellDblClick

Occurs when the user double-clicks the left mouse button in one of the data cells.

type

TDBGridClickEvent = procedure (Column: TXColumn ) of object;

property OnCellDblClick: TDBGridClickEvent; {* ver. 4.4 *}

Description

Write an OnCellDblClick event handler to take specific action when the user double-clicks in one of the data cells of the data-aware grid (similar to OnCellClick). The Column parameter is the TXColumn object that corresponds to the column where the mouse was when the user double-clicked the left mouse button.

When OnCellDblClick event occurs, OnDblClick event will not occur.

OnCellDblClick will not occur when the user double-clicks in indicator, title or total cell of the column or in the blank area. In that case the standard OnDblClick event will occur.

When OnCellDblClick event is not assigned, OnDblClick event will always occur when the user doubleclicks in any area of the grid (including data cells).

_______

TXCustomDBGrid.OnCellHint

Occurs when the mouse pauses over a cell that can display a Help Hint.

type

THintCell = (hcTitle, hcHeader, hcFiller, hcEditor, hcData, hcIndicator, hcTotal);

TCellHintEvent = procedure(Sender: TObject; Column: TXColumn ; Index:

Integer; HintCell: THintCell; var HintStr: string) of object;

property OnCellHint: TCellHintEvent;

Description

Use OnCellHint to override the default hint that appears when the user pauses the mouse over a cell.

In the event handler, use HintStr to override default value when displaying the hint string in a popup window. Set empty HintStr when the hint should not be shown at all. HintCell indicates kind of cell for

column specified in Column parameter. When HintCell is hcHeader, an Index specifies number of row for column's header.

_______

See also: TXCustomDBGrid.HintOptions

, TXCustomDBGrid.OnCellHint

, TXColumn.EditorHint

, TXColumnTitle.Hint

TXColumnTitle.HeaderHint

Occurs when edited text was changed and stored to dataset.

property OnColTextChanged: TNotifyEvent; {* ver. 6.0 *}

Description

Write an OnColTextChanged event handler to perform any action when edited text was changed and stored to dataset. You can retrieve the changed text by using

TXDBGrid(Sender).SelectedColumn.EditText. This event occurs when Inplace Editor stores new text to dataset. The dataset is then in dsEdit/dsInsert mode.

_______

TXCustomDBGrid.OnColumnMoving

Occurs when a column is about to be moved.

type

TColumnMovingEvent = procedure(Sender: TObject; FromIndex, ToIndex: Longint;

var Accept: Boolean) of object;

property OnColumnMoving: TColumnMovingEvent;

Description

Write an OnColumnMoving event handler to selectively prevent selection from moving column to specific places.

The OnColumnMoving is called when the selection is about to be moved from one place to another. Set

Accept to False, to prevent selection from moving to a new place.

_______

TXCustomDBGrid.OnColumnResize

Occurs when one or more columns is resized.

property OnColumnResize: TNotifyEvent ;

Description

Use OnColumnResize to perform special processing when any column is resized. Read ResizedColumn property to determine which column has been lately resized.

_______

TXCustomDBGrid.OnColumnScroll

Occurs when the user scrolls columns with the mouse or keyboard.

type

TColumnScrollEvent = procedure(Sender: TObject; LeftIndex: Longint) of

object;

property OnColumnScroll: TColumnScrollEvent;

Description

Use OnColumnScroll to perform special processing when columns are scrolled. The LeftIndex parameter contains index of first visible column (except fixed columns).

_______

TXCustomDBGrid.OnExpandClick

Occurs when the user presses the expand button in a column title.

type

TDBGridClickEvent = procedure(Column: TXColumn ) of object;

property OnExpandClick: TDBGridClickEvent;

Description

Write an OnExpandClick event handler to bring up an appropriate list or dialog or drop-down a menu when the user presses the expand button in a column title. This event occurs only when ExpandStyle is cesDropDown or cesDropDownMenu and DropDownMenu is'nt assigned. See also: OnColExpand .

_______

TXCustomDBGrid.OnFillerClick

Occurs when the user releases the mouse in title of indicator.

property OnFillerClick: TNotifyEvent ;

Description

Write an OnFillerClick event handler to take specific action when the user clicks in title of indicator (Filler).

_______

TXCustomDBGrid.OnFilterChanged

Occurs when FilterList or FilterText changed.

property OnFilterChanged: TNotifyEvent ; {* ver. 6.0 *}

Description

Write an OnFilterChanged event handler to self handle FilterList and/or FilterText property. The event is fired only when FilterGrid.AutoUpdate

is False. Otherwise, the internal filter changes are handled by the grid.

_______

See also: TXCustomDBGrid.OnFilterUpdated

TXCustomDBGrid.OnFilterRecord

Points to OnFilterRecord event handler stored in DataSet linked to the grid.

property OnFilterRecord: TFilterRecordEvent ; {* ver. 6.0 *}

Description

OnFilterRecord property points to TDataSet.OnFilterRecord

event handler stored in DataSet linked to

TXDBGrid. When the OnFilterRecord property is changed in TXDBGrid the new event handler is stored in

DataSet property, but the change is controlled by TXDBGrid. If KeyFields are defined, the current record is restored, if the record is still available in filtered record set. If dgAutoKeepSelection option is included in

OptionsEx and grid has multiselected records, still visible selected records are restored.

_______

TXCustomDBGrid.OnFilterUpdated

Occurs when filter confition in DataSet changed.

property OnFilterUpdated: TNotifyEvent ; {* ver. 6.0 *}

Description

Write an OnFilterUpdated event handler to take specific action when filter condition in DataSet linked to the grid was changed. OnFilterUpdated event is triggered by FilterUpdated method when DataSet linked to the grid is automatically updated by the grid ( FilterGrid.AutoUpdate

is True) or when you call

FilterUpdated in your OnFilterChanged event handler.

_______

TXCustomDBGrid.OnHeaderClick

Occurs when the user releases the mouse in one of the title headers.

type

THeaderClickEvent = procedure(Column: TXColumn ; Index: Integer) of object;

property OnHeaderClick: THeaderClickEvent;

Description

Write an OnHeaderClick event handler to take specific action when the user clicks in one of the title headers. The Column parameter is the TColumn object that corresponds to the column where the mouse was when the user released the left mouse button. The Index parameter contains number of header's row.

_______

TXCustomDBGrid.OnIndicatorClick

Occurs when the user releases the mouse in one of the cells of indicator.

property OnIndicatorClick: TNotifyEvent ;

Description

Write an OnIndicatorClick event handler to take specific action when the user clicks in one of the cells of indicator.

_______

TXCustomDBGrid.OnLayout

Occurs when the column layout is retrieved or modified.

type

TXDBGridLayoutEvent = procedure(Sender: TObject; Layout: TStrings ; Apply:

Boolean) of object;

property OnLayout: TXDBGridLayoutEvent;

Description

OnLayout event occurs when the Layout property is reading or setting. Write OnLayout event handler to add additional XDBGrid's properties to Layout parameter when Apply is False and set additional

XDBGrid's properties on the basis of Layout parameter when Apply is True. Layout is a TStrings object designed for store and retrieve column layout settings as name-value pairs. For more information on name-value pairs, refer to Values property.

For example:

with TXDBGrid(Sender) do

if not Apply then Layout.Add( 'FixedStyle=' +IntToStr(Ord(FixedStyle)))

else FixedStyle := TFixedStyle(StrToIntDef(Layout.Values[ 'FixedStyle' ],

Ord(FixedStyle)));

_______

TXCustomDBGrid.OnListCloseUp

Occurs when the editor's drop-down list has been closed.

type

TListCloseUpEvent = procedure (Column: TXColumn ; List: TObject; var Value:

Variant; var Accept: Boolean) of object;

property OnListCloseUp: TListCloseUpEvent; {* ver. 4.3 *}

Description

Write an OnListCloseUp event handler to take specific action when the editor's list has been closed. The

Column parameter indicates the grid's column for the list. The List parameter holds the editor's list. Look at

OnListDropDown to read, how to use List.

The Value parameter contains the value selected by the user. The Accept parameter contains the user's choice result. When Accept is True, the new Value was accepted by the user, when Accept is False, the user cancelled the choice. You can change the user's choice by modifying the Value and/or the Accept parameter.

_______

TXCustomDBGrid.OnListDropDown

Occurs when the editor's drop-down list is dropped-down.

type

TXDataEditor = (dePickList, deDataList, deGridList, deCalendar, deCalculator); {* ver. 6.0 *}

TListDropDownEvent = procedure (Column: TXColumn ; List: TObject) of object;

property OnListDropDown: TListDropDownEvent; {* ver. 4.3 *}

Description

Write an OnListDropDown event handler to take specific action when the editor's list is dropped-down.

OnListDropDown is triggered when the editor's list is ready to appear on the screen, but it's just not visible.

The Column parameter indicates the grid's column for the list. The List parameter holds the editor's list object. The type of List depends on ButtonStyle value for the column.

The class of List depends on internal value of DataEditor. Before using List object you must check is the

List of appropriate class. You have not an access to the final classes of the List. You can use only the ancestor class of the List. If you want to modify the List object, you are doing it on your own risk .

Remember, you must restore your changes in OnListCloseUp event handler.

{* ver. 6.0 *}

Starting from version 6.0 each drop-down list is derived from TXDBGridDropDownList class and declared in XDBDataList unit: TXDBGridDataList , TXDBGridPickList , TXDBGridCalculator , TXDBGridCalendar . If you want to modify the List object, you are still doing it on your own risk .

{* ver. 6.0 *}

_______

TXCustomDBGrid.OnListItemsUpdated

Occurs when the auto-loaded list items have been updated.

property OnListItemsUpdated: TNotifyEvent ; {* ver. 4.3 *}

Description

Write an OnListItemsUpdated event handler to take specific action when the auto-loaded PickList items have been updated. OnListItemsUpdated is triggered when UpdateListItems is finished and all autoloaded PickList's are updated.

_______

See also: TXCustomDBGrid.UpdateListItems

TXCustomDBGrid.OnOrderChanged

Occurs when OrderFields (sorting markers) changed.

property OnOrderChanged: TNotifyEvent ;

Description

Write an OnOrderChanged event handler to synchronize sorting markers in the grid and sorting order in

DataSet linked to the grid. When dgAutoUpdateOrder is included in OptionsEx and DataSet linked to the grid is registered to automatically change order, this event is not triggered. Instead, the

ChangeDataSetOrder is automatically performed.

When you need to modify OrderFields before calling ChangeDataSetOrder you should to exclude dgAutoUpdateOrder from OptionsEx and call ChangeDataSetOrder in this event handler. Then, you can pass modified value of OrderFields as parameter for ChangeDataSetOrder method.

When your DataSet linked to the grid is not registered to automatically change order you can register it by using RegisterChangeOrder or RegisterCustomChangeOrder or either you can call directly in this event one of methods designed to change order in typical DataSets: ChangeIndexFields , ChangeOrderFields or

ChangeSQLOrderFields .

If non of them methods is appropriate to change order in your DataSet, you should perform changing order in DataSet in this event or you can write custom method and register it with using

RegisterCustomChangeOrder procedure to automatically change order in linked DataSet.

See also: KeyFields property, OnOrderUpdated event.

_______

TXCustomDBGrid.OnOrderUpdated

Occurs when the sorting order in dataset was changed.

property OnOrderUpdated: TNotifyEvent ;

Description

Write an OnOrderUpdated event handler to take specific action when sorting order in dataset linked to the grid was changed. OnOrderUpdated event is triggered by OrderUpdated method when dataset linked to the grid is registerd to automatically change order and dgAutoUpdateOrder option is included in OptionsEx or when you call directly in code one of the methods designed to change sorting order

( ChangeDataSetOrder , ChangeIndexFields , ChangeOrderFields or ChangeSQLOrderFields ) and changing order was successfully finished.

TXCustomDBGrid.OnPaintColumnCell

Occurs when the grid needs to paint a cell by using DefaultDrawing.

type

TSelection = (slCellSelected, slRowSelected, slMultiSelected, slCellFixed, slRowStriped);

TSelections = set of TSelection;

TPaintColumnCellEvent = procedure(Sender: TObject; const Rect: TRect;

DataCol: Integer; Column: TXColumn ; Highlight: Boolean; Selections:

TSelections; var Color: TColor ; Font: TFont ; var Image: TPersistent ) of

object;

property OnPaintColumnCell: TPaintColumnCellEvent;

Description

Write an OnPaintColumnCell event handler to modify default drawing for the data in the cells of the grid.

The Rect parameter indicates the location of the cell on the canvas. The DataCol parameter is the index of the column in the Columns array. The Column parameter is the TXColumn object that describes the display attributes and field binding for the cell. The Highlight parameter indicates whether the cell is highlighted. The Selections parameter indicates whether the cell is selected (slCellSelected), whether the cell is in selected row (current record) (slRowSelected), whether the cell is in one of multiselected rows

(slMultiSelected) or whether the cell is fixed (slCellFixed). The slRowStriped value is included in

Selections only when StripeColor is not clNone and when the cell is in even data row. Color, Font and

Image parameters contain default values that may be simple modified by developer depend on current data values.

_______

See also: TCustomDBGrid.OnDrawColumnCell

TXCustomDBGrid.OnRowResize

Occurs when rows in the grid are resized.

property OnRowResize: TNotifyEvent ;

Description

Use OnRowResize to perform special processing when rows in the grid are resized.

_______

TXCustomDBGrid.OnRowSelect

Occurs when the rows selection changed.

type

TSelectAction = (saUnselect, saSelect, saClear, saDelete, saRefresh);

TRowSelectEvent = procedure(Sender: TObject; Action: TSelectAction) of

object;

property OnRowSelect: TRowSelectEvent;

Description

Write an OnRowSelect event to perform special processing when the rows selection changed. Action determines what kind of changes are made. When Action is saUnselect or saSelect current record has been changed. When Action is saClear, saDelete or saRefresh all selected rows have been changed. See also appropriate methods of TXBookmarkList . Caution: this event can be called very often.

_______

TXCustomDBGrid.OnSelectedColsChanged

Occurs when the selected columns changed.

property OnSelectedColsChanged: TNotifyEvent ; {* ver. 4.3 *}

Description

Write an OnSelectedColsChanged event handler to take specific action when SelectedCols have been changed in the grid. This event is triggered after group of changes were made is SelectedCols (eg. when

SelectAll was performed the event is triggered once (when ColsSelection is True) - after all changes in

SelectedCols list. Use BeginSelect & EndSelect statements when group of changes is made in

SelectedCols/SelectedRows list directly in your code. To minimize numbers of calls for this event the dgDelaySelectedRows option should be included in OptionsEx . This option is common for events:

OnSelectedRowsChanged, OnSelectedColsChanged, OnSelectionChanged.

Note. In some cases (eg. when MultiSelect is msCells) after one group of changes the events may are triggered in order: OnSelectedRowsChanged, OnSelectedColsChanged, OnSelectionChanged. You can check RowsChanged flag to determine the OnSelectedRowsChanged event was triggered prior.

_______

See also: TXCustomDBGrid.OnSelectionChanged

, TXCustomDBGrid.OnSelectedRowsChanged

, TXCustomDBGrid.ColsChanged

, ,

TXCustomDBGrid.RowsChanged

, TXCustomDBGrid.PerformDelayed

TXCustomDBGrid.OnSelectedRowsChanged

Occurs when the selected rows changed.

property OnSelectedRowsChanged: TNotifyEvent ;

Description

Write an OnSelectedRowsChanged event handler to take specific action when SelectedRows have been changed in the grid. This event is triggered after group of changes were made is SelectedRows (eg. when

SelectAll was performed the event is triggered once (when RowsSelection is True) - after all changes in

SelectedRows list). Use BeginSelect & EndSelect statements when group of changes is made in

SelectedRows/SelectedCols list directly in your code. To minimize numbers of calls for this event the dgDelaySelectedRows option should be included in OptionsEx . This option is common for events:

OnSelectedRowsChanged, OnSelectedColsChanged, OnSelectionChanged.

Note. In some cases (eg. when MultiSelect is msCells) after one group of changes the events may are triggered in order: OnSelectedRowsChanged, OnSelectedColsChanged, OnSelectionChanged. You can check ColsChanged flag to determine the OnSelectedColsChanged event will be triggered next. {* ver. 4.3

_______

See also: TXCustomDBGrid.OnSelectionChanged

, TXCustomDBGrid.OnSelectedColsChanged

, TXCustomDBGrid.ColsChanged

, ,

TXCustomDBGrid.RowsChanged

, TXCustomDBGrid.PerformDelayed

TXCustomDBGrid.OnSelectionChanged

Occurs when the selected rows or columns changed.

property OnSelectionChanged: TNotifyEvent ; {* ver. 4.3 *}

Description

Write an OnSelectionChanged event handler to take specific action when SelectedRows and/or

SelectedCols have been changed in the grid. This event is triggered after group of changes were made is

SelectedRows or SelectedCols (eg. when SelectAll was performed the event is triggered once - after all changes in SelectedRows and/or SelectedCols list. Use BeginSelect & EndSelect statements when group of changes is made in SelectedCols and/or SelectedRows list directly in your code. To minimize numbers of calls for this event the dgDelaySelectedRows option should be included in OptionsEx . This option is common for events: OnSelectedRowsChanged, OnSelectedColsChanged, OnSelectionChanged.

Note. In some cases (eg. when MultiSelect is msCells) after one group of changes the events may are triggered in order: OnSelectedRowsChanged, OnSelectedColsChanged, OnSelectionChanged. You can check RowsChanged and ColsChanged flag to determine the OnSelectedRowsChanged and

OnSelectedColsChanged events were triggered prior. You should use this event when your code is independent of kind of current selection (eg. CopyToClipboard).

_______

See also: TXCustomDBGrid.OnSelectedColsChanged

, TXCustomDBGrid.OnSelectedRowsChanged

TXCustomDBGrid.ColsChanged

, , TXCustomDBGrid.RowsChanged

, TXCustomDBGrid.PerformDelayed

TXCustomDBGrid.OnSequenceUpdated

Occurs when the sequence numbers have been recalculated.

property OnSequenceUpdated: TNotifyEvent ;

Description

Write an OnSequenceUpdated event handler to take specific action when sequence numbers

( RecNumber , RecCount ) have been recalculated. Sequence numbers must be recalculated when

ForcedSequence is True. OnSequenceUpdated is triggered when UpdateSequence finished calculations and you can use sequence numbers for further actions.

_______

TXCustomDBGrid.OnTotalCalcQuery

Occurs for each record when the grid recalculates total value.

type

TTotalCalcQueryEvent = procedure (Sender: TObject; DataSet: TDataSet ; var

Accept: Boolean) of object;

property OnTotalCalcQuery: TTotalCalcQueryEvent;

Description

Write an OnTotalCalcQuery event handler to take specific action when the grid recalculates total value. A total value appears in total cell when TotalResult is trCalcValue. OnTotalCalcQuery is triggered for each record recalculated by CalcValue 's when UpdateTotals is performed. TXDBGrid object is passed as

Sender.

The DataSet parameter determines recalculated record (current record in DataSet). The Accept parameter is default True. You can set Accept to False if you want to exclude current record from calculation for all

CalcValue functions defined in any total cell. If Accept will be changed to False, OnTotalCalcValue event will be omitted for this record for all total cells. It allows to apply a global filter for calculated totals values.

_______

See also: TXCustomDBGrid.OnTotalCalcValue

, TXCustomDBGrid.OnTotalUpdated

, TXCustomDBGrid.UpdateTotals

TXCustomDBGrid.OnTotalCalcValue

Occurs for each total cell when the grid recalculates total value.

type

TCalcPass = (cpReset, cpCalcRec, cpFinal);

TTotalCalcValueEvent = procedure (Total: TXColumnTotalValue ; Pass:

TCalcPass; var Value: Variant) of object;

property OnTotalCalcValue: TTotalCalcValueEvent;

Description

Write an OnTotalCalcValue event handler to take specific action when the grid recalculates total value. A total value appears in total cell when TotalResult is trCalcValue. OnTotalCalcValue is triggered for all

CalcValue 's when UpdateTotals is performed.

The Total parameter determines the total cell where the result of calculation will be displayed. The Value parameter contains the value that will be processed by CalcValue function. You can modify this value to modify the result of calculation. The Pass parameter determines the pass of calculation. These are the possible values of Pass:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

cpReset The Value parameter contains the initial value for CalcValue function. Default initial Value is Unassigned. cpCalcRec The Value parameter contains Field .Value for current record. This pass is repeated for each processed record in dataset. You can modify this Value to modify result of calculation or set Value to Null to exclude selected records.

See also NullValue property. The temporary result of calculation is stored in

TempValue public property. The count of processed values is stored in

Counter public property. You can use those public property in this event, but you should'nt directly modify Value property. cpFinal The Value parameter contains the final result of calculation. You can modify this Value to modify final result before it appears in total cell.

You can write OnTotalCalcValue event handler to modify result of standard CalcValue function, but in particular you should write this event when CalcValue is cvCustom. Then, you can calculate here any custom function.

OnTotalCalcValue is frequently triggered. To reduce the frequency with which OnTotalCalcValue occurs, set dgDelayUpdateTotals in OptionsEx or set CalcValues property to false when the calculation is not needed. Remember, the code in this event handler should be simple.

To exclude some records for all CalcValue's in the grid (global calculation filter) you should write

OnTotalCalcQuery event handler.

_______

See also: TXCustomDBGrid.OnTotalCalcQuery

, TXCustomDBGrid.OnTotalsUpdated

, TXCustomDBGrid.UpdateTotals

TXCustomDBGrid.OnTotalClick

Occurs when the user releases the mouse in one of the total cells.

type

TTotalClickEvent = procedure (Column: TXColumn ; Index: Integer) of object;

property OnTotalClick: TTotalClickEvent;

Description

Write an OnTotalClick event handler to take specific action when the user clicks in one of the total cells.

The Column parameter is the TXColumn object that corresponds to the column where the mouse was when the user released the left mouse button. The Index parameter corresponds to the number of total row. Use Index property as index of TotalRows or TotalValueRows property to obtain the total cell when the user released the left mouse button.

_______

TXCustomDBGrid.OnTotalGetText

Occurs when the grid retrieves Text for total cell.

type

TTotalGetTextEvent = procedure (Column: TXColumn ; Index: Integer; var Text:

string; TextKind: TTextKind ) of object;

property OnTotalGetText: TTotalGetTextEvent;

Description

Write an OnTotalGetText event handler to change Text retrieved for total cell. OnTotalGetText event is called by TotalGetText protected method when the grid retrieves Text to appear it within total cell. Value of

Text parameter depends on current value of TotalResult property and other TXColumnTotal properties.

The Column parameter determines column of total cell, the Index parameter corresponds to the number of total row. The TextKind parameter is reserved for future use (tkDisplay by default). You can use Index property as index of TotalRows or TotalValueRows property to determine the total cell for which the Text is retrived.

_______

TXCustomDBGrid.OnTotalsUpdated

Occurs when the total values have been recalculated.

property OnTotalsUpdated: TNotifyEvent ;

Description

Write an OnTotalsUpdated event handler to take specific action when all total values have been recalculated. A total value appears in total cell when TotalResult is trCalcValue. OnTotalsUpdated is triggered when UpdateTotals finished calculations and all CalcValue 's are recalculated. Then, you can use results for further actions.

_______

TXDBGridColumns

TXDBGridColumns represents a container for TXColumn objects.

Unit

XDBGrids

Description

Each TXDBGridColumns holds a collection of TXColumn objects in a data grid ( TXDBGrid ).

TXDBGridColumns maintains an index of the columns in its Items array. The Count property contains the number of columns in the collection. At design time, use the data grid's Columns editor to add, remove, or modify columns.

_______

See also: TDBGridColumns , TXColumn , TXCustomDBGrid.Columns

, TXDBGrid

TXDBGridColumns.Grid

Indicates the XDBGrid control to which the TXDBGridColumns instance belongs.

property Grid: TXCustomDBGrid ;

Description

The read-only Grid property indicates which XDBGrid control owns the TXDBGridColumns object.

_______

See also: TXCustomDBGrid.Columns

TXDBGridColumns.Items

Lists the columns in the collection.

property Items[Index: Integer]: TXColumn default;

Description

Use Items to access individual columns. The value of the Index parameter corresponds to the Index property of TXColumn. It represents the position of the column in the XDBGrid.

Items is the default property of TXDBGridColumns. This means that the property name, Items, can be omitted when referring to columns of the TXDBGridColumns object. Thus, the line

FirstCol := XDBGrid1.Columns.Items[0]; can also be written

FirstCol := XDBGrid1.Columns[0];

Creates enumerator for TXDBGridColumns class.

function GetEnumerator: TXDBGridColumnsEnumerator; {* ver. 5.6 *} // For

Delphi 2009 or higher

Description

You not need to call this function directly. It allows you to iterate over all columns in the grid.

type

Column: TXColumn;

begin

for Column in XDBGrid1.Columns do

begin

// Perform action on each column in XDBGrid1.Columns

end;

_______

TXDBGridColumns.RemoveMarkers

Removes all sorting markers from titles.

procedure RemoveMarkers;

Description

Use the RemoveMarkers method to remove all markers from titles.

_______

TXDBGridColumns.UpdateMarkers

Updates all sorting markers in titles.

procedure UpdateMarkers;

Description

Use UpdateMarkers when you made any special changes you need call this method.

_______

TXColumn

TXColumn represents a column in a data grid (TXDBGrid).

Unit

XDBGrids

Description

Each TXDBGrid uses a TXDBGridColumns to maintain a collection of TXColumn objects. Each TXColumn object represents the visual characteristics and data binding of a column in the grid.

_______

See also: TColumn , TCollection , TCollectionItem , TXDBGridColumns , TXDBGrid

TXColumn.AutoNumber

Specifies whether the column is autonumbered column.

property AutoNumber: Boolean;

Description

When AutoNumber is True the column display RecNumber 's value instead FieldName 's value. You may also define additional column with empty FieldName property and set AutoNumber for that.

The AutoNumber values are formatted by AutoNumberStr function. The developer can change

DefAutoNumberFormat or formatted text in OnColGetText event handler. When AutoNumber is True the column can't be edited. Usually the column with AutoNumber is placed in FixedCols range and the property Alignment has set to taRightJustify.

You should use AutoNumber property only when ForcedSequence or IsSequenced is True.

_______

TXColumn.ButtonStyle

Determines whether and how the user can select values for the column from a list, menu or other dropdown editor.

type

TXColumnButtonStyle = (cbsAuto, cbsEllipsis, cbsNone, cbsDropDown, cbsDropDownMenu, cbsCalendar, cbsCalculator);

property ButtonStyle: TXColumnButtonStyle;

Description

The ButtonStyle property determines how users can edit the data of a data-grid column. These are the possible values of ButtonStyle:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

cbsAuto If the column is associated with a lookup field or has a value assigned to its

PickList property, the grid displays a combo box in the column. The user can choose a value from the drop-down list. If the column is associated with

TDateField or TDateTimeField the user can choose date value from the dropdown calendar. Time part of TDateTime value leaves unchanged. See also: cbsCalendar.

cbsEllipsis The column displays an ellipsis button that the user can click to choose a value. Clicking the ellipsis button triggers an OnEditButtonClick event. cbsNone No combo box or ellipsis button is provided. The user cannot select the column's content from a list. cbsDropDown The column displays a drop-down button that the user can click to choose a value. Clicking the drop-down button triggers an OnEditButtonClick event. cbsDropDownMenu The column displays a drop-down button that the user can click to choose a value from drop-down menu. Clicking the drop-down button DropDownMenu is automatically dropped down. cbsCalendar The column displays a drop-down button that the user can click to choose a date from drop-down calendar. Clicking the drop-down button the month calendar is automatically dropped down. The calendar requires date value compatible with ShortDateFormat global variable. You can also use cbsCalendar value when any text field contains date or datetime value. cbsCalculator The column displays a drop-down button that the user can click to calculate input value in drop-down calculator. Clicking the drop-down button the comfortable calculator is automatically dropped down. The calculator is similar in use to Microsoft Calculator.

_______

TXColumn.CalendarActive

Specifies whether the column has a drop-down calendar.

property CalendarActive: Boolean; {* ver. 6.0 *}

Description

Use CalendarActive property to determine the column has defined drop-down calendar.

CalendarActive is a read-only property.

_______

TXColumn.CharCase

Determines the case of the text within the inplace editor.

property CharCase: TEditCharCase ; {* ver. 4.31 *}

Description

Use CharCase to force the contents of the inplace editor to assume a particular case. The possible values of CharCase are as follows:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

ecLowerCase ecNormal

The text is converted to lowercase

The text appears in mixed case. It is not forced into any case. ecUpperCase The text is converted to uppercase.

When CharCase is set to ecLowerCase or ecUpperCase, the case of characters is converted as the user types them into the inplace editor. Changing the CharCase property to ecLowerCase or ecUpperCase changes the actual contents of the text, not just the appearance. Any case information is lost and can't be recaptured by changing CharCase to ecNormal.

_______

TXColumn.CheckBox

Specifies whether the column has check boxes.

property CheckBox: Boolean;

Description

Set CheckBox to True to make check boxes appear in the column. Each row in the grid displays a single check box.

The CheckBox property may be used for any field type that can return value in AsString property. When

FieldName property is empty for the column, state of check boxes correspond to bookmarks collected in

SelectedRows .

_______

TXColumn.CheckBoxKind

Specifies kind of sign in the check box.

type

TCheckBoxKind = (ckCheck, ckCross, cbBox);

property CheckBoxKind: TCheckBoxKind;

Description

Use CheckBoxKind to select a kind of sign drawn in the check box. The CheckBoxKind property is practicable for non-Windows XP styles or either when Images property defines customized checkboxes for the column. These are the possible values of CheckBoxKind:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

ckCheck ckCross

The check box sign is a check sign

The check box sign is a cross sign ckBox

_______

The check box sign is a box sign

See also: TXColumn.CheckBoxTXColumn.CheckBoxThemed

, , TXColumn.CheckBoxValues

, TXColumn.IsCheckBoxValue

TXColumn.ToggleCheckBoxValue

, TXColumn.CheckBoxStyle

, TXColumn.CheckBoxToggle

TXColumn.CheckBoxStyle

Specifies style of check box drawn in the column.

type

TCheckBoxStyle = (cbAuto, cbAutoGray, cbAutoLowered, cbDefault, cbSoft, cbLoweredDark, cbLoweredGray, cbLoweredMild, cbFlat, cbGray, cbMild);

property CheckBoxStyle: TCheckBoxStyle;

Description

Use CheckBoxStyle to select a style of check box drawn in the column. The CheckBoxStyle property is practicable only for non-Windows XP styles. These are the possible values of CheckBoxStyle:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

cbAuto The style of check box is dependent on current FixedStyle value.

cbAutoGray The style of check box is one from Gray styles dependent on current

FixedStyle value. cbAutoLowered The style of check box is one from Lowered styles dependent on current

FixedStyle value. cbDefault cbSoft cbLoweredDark cbLoweredGray cbLoweredMild cbFlat

The style of check box is 3D - suitable for FixedStyle = fsDefault.

The style of check box is 3D - suitable for FixedStyle = fsSoft.

The style of check box is concave - suitable for FixedStyle = fsNice.

The style of check box is concave - suitable for all FixedStyle values.

The style of check box is concave - suitable for FixedStyle = fsFine.

The style of check box is flat - suitable for FixedStyle = fsFlat. cbGray The style of check box is flat - suitable for all FixedStyle values. cbMild

_______

The style of check box is flat - suitable for FixedStyle = fsMild.

See also: TXColumn.CheckBox

, TXColumn.CheckBoxThemed

, TXColumn.CheckBoxValues

, TXColumn.IsCheckBoxValue

TXColumn.ToggleCheckBoxValue

, TXColumn.CheckBoxKind

, TXColumn.CheckBoxToggle

TXColumn.CheckBoxThemed

Specifies whether the column has themed check boxes.

property CheckBoxThemed: Boolean; {* ver. 5.0 *}

Description

Set CheckBoxThemed to True to force themed check boxes in the column.

_______

See also: TXColumn.CheckBox

, TXColumn.CheckBoxToggle

, TXColumn.CheckBoxValues

, TXColumn.IsCheckBoxValue

TXColumn.ToggleCheckBoxValue

, TXColumn.CheckBoxStyle

, TXColumn.CheckBoxKind

TXColumn.CheckBoxToggle

Controls how the state of check box may be toggled by the user.

type

TCheckBoxToggle = (ctCustomToggle, ctKeyPressOnly, ctOnCellClick, ctSelectClick);

property CheckBoxToggle: TCheckBoxToggle;

Description

Set the CheckBoxToggle property to determine how the user may toggle state of check box. These are the possible values of CheckBoxToggle:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

ctCustomToggle ctKeyPressOnly ctOnCellClick

The check box is'nt toggled by the XDBGrid - use custom toggle

The check box is toggled when the user presses Enter or Space

The check box is toggled when the user presses Enter or Space or clicks on the cell ctSelectClick The check box is toggled when the user presses Enter or Space or clicks on the selected cell

_______

See also: TXColumn.CheckBox

, TXColumn.CheckBoxThemed

, TXColumn.CheckBoxValues

, TXColumn.IsCheckBoxValue

TXColumn.ToggleCheckBoxValue

, TXColumn.CheckBoxStyle

, TXColumn.CheckBoxKind

TXColumn.CheckBoxValues

Controls how the field's value is translated to checkbox state.

property CheckBoxValues: string;

Description

Use CheckBoxValues to specify strings you want used to represent checkbox state. Use any pair of phrases, separated by a semicolon. Default phrases for CheckBoxValues are 'True;False' that corresponds to values of Boolean field getting by AsString property. The CheckBox property may be used for any field type that can return value in AsString property.

The string associated with checkbox state can be an empty string. To set the value for True to an empty string, set CheckBoxValues to a string that begins with a semicolon. To associate False with an empty string, set CheckBoxValues to the string for True, with no semicolon at all. For example, to associate True with the string Print, and False with an empty string, set CheckBoxValues to 'Print'.

These strings are also used to setting field's value when checkbox is toggled.

_______

See also: TXColumn.CheckBox

, TXColumn.CheckBoxToggle

, TXColumn.IsCheckBoxValue

, TXColumn.ToggleCheckBoxValue

TXColumn.CheckBoxStyle

, TXColumn.CheckBoxKind

TXColumn.DialogOptions

Specifies additional column's options for TXDBColumnsDialog component.

type

TDialogOption = (doShowColumn, doItemEnabled);

TDialogOptions = set of TDialogOption;

property DialogOptions: TDialogOptions;

Description

Set DialogOptions to include additional options for TXDBColumnsDialog component. These are the possible values of DialogOptions:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

doShowColumn doItemEnabled

The column appears on TXDBColumnsDialog's list.

TXDBColumnsDialog's list item is enabled and Visible property can be changed in dialog.

_______

See also: TXDBColumnsDialog , TXColumnReport.DialogOptions

TXColumn.DisplayText

Represents the column's value as it is displayed in the grid.

property DisplayText: string;

Description

DisplayText is a read-only string representation of a column's value for displaying in the grid. It represents the column's value when it is not being edited. When the cell is being edited, the EditText value is retrieved from dataset.

If the grid has an OnColGetText event handler, DisplayText is the value returned in the Text parameter of the OnColGetText event handler when TextKind parameter is tkDisplay. Otherwise, DisplayText is the value of the field's DisplayText property. See also ShowBlob and AutoNumber property.

_______

TXColumn.DropDownMenu

Identifies the drop-down menu associated with the column.

property DropDownMenu: TPopupMenu ;

Description

Assign a value to DropDownMenu to make a drop-down menu appear when the user clicks the edit button of column. If the ButtonStyle property is cbsAuto when DropDownMenu is assigned, the ButtonStyle property is automatically changed to cbsDropDownMenu and the edit button will be appear in the edited cell of column. If the ButtonStyle is cbsDropDownMenu when DropDownMenu is removed, the ButtonStyle property is automatically changed to cbsAuto. See also: DropDownPoint .

_______

TXColumn.DropDownRows

Specifies the number of lines displayed in the column's drop-down list.

property DropDownRows: Integer;

Description

DropDownRows determines the number of lines of text displayed in the drop-down list associated with the column. This property is used only if ButtonStyle is set to cbsAuto and the column has a lookup field or pick list associated with it.

When DropDownRows property is 0 (default) and drop-down list has more then MaxDropDownRows items, then MaxDropDownRows items is displayed in the drop-down list, otherwise all list items are displayed. {* ver. 4.3 *}

_______

TXColumn.DropDownWidth

Specifies a width of the column's drop-down list.

property DropDownWidth: Integer;

Description

DropDownWidth determines a width of the drop-down list associated with the column. This property is used only if ButtonStyle is set to cbsAuto and the column has a lookup field or pick list associated with it. If

DropDownWidth value is less then column's width the column's width will be used as the width of the dropdown list.

When DropDownWidth property is 0 (default) and auto-calculated width of drop-down list is greater then

MaxDropDownWidth , then displayed width of drop-down list is limited to MaxDropDownWidth. {* ver. 4.3 *}

_______

TXColumn.EditMemo

Determines whether the memo field may be automatically edited in an inplace editor.

property EditMemo: Boolean;

Description

If EditMemo is set to False (default), memo field cannot be edited in the grid by the user unless

OnGetText/OnSetText event handlers are defined for this field. If EditMemo is set to True, memo field can be edited in the grid without this events. Remember, there is'nt enough place to edit multiline memo fields in the inplace editor. You should set this property to True only for single line memo. To edit memo field in the grid the ShowEdit property must be set to True. See also EditText property.

_______

TXColumn.EditorHint

Specifies the text string that can appear when the user moves the mouse pointer over a edited cell.

property EditorHint: string;

Description

Set EditorHint to a string that provides information about the editing of the field. The hint text appears in a

Help Hint window when the user pauses with the mouse over the edited cell if HintOptions includes hoShowEditorHints.

_______

See also: TXCustomDBGrid.HintOptions

, TXCustomDBGrid.OnCellHint

, TXCustomDBGrid.FillerHint

TXCustomDBGrid.IndicatorHint

, TXColumn.Hint

, TXColumnTitle.Hint

TXColumn.EditText

Contains the string to display in an inplace editor when the grid is in edit mode.

property EditText: string;

Description

The inplace editor rely on the EditText property to provide the editing format for each column. For example, by default the EditText property of a currency field omits the thousands separators and currency symbol.

EditText can differ from the DisplayText property if the column uses a different string representation when the value is being edited. To implement two different string representations of a column's value, use the

OnColGetText event handler. If an OnColGetText event handler is assigned, EditText is the value returned in the Text parameter of the event handler when the TextKind parameter is tkEdit. If there is no

OnColGetText event handler, EditText is the value of the field's Text property. See also OnColSetText ,

EditMemo and AutoNumber property.

_______

TXColumn.Ellipsis

Specifies whether the data is completed by ... when it is too long for the width of the column.

property Ellipsis: Boolean;

Description

Set Ellipsis to True to allow the data completed by triple dot. When Ellipsis is True, text that is too wide for the column is completed by triple dot.

When Ellipsis is False, text that is too wide for the column appears truncated. See also WordWrap property.

Indicates the position of the last expanded column.

property ExpandIndex: Integer;

Description

When column is Expandable , ExpandIndex indicates the position of the last Expanded column.

_______

See also: TXColumn.ExpandWidth

, TXColumn.ExpandStyle

, TXColumn.ExpandCols

, TXColumn.Expanded

, TXColumn.Expandable

TADTField

TXColumn.ExpandStyle

Determines whether and how the user can use expand button in column title.

type

TXColumnExpandStyle = (cesAuto, cesNone, cesDropDown, cesDropDownMenu, cesFilterList ); {* ver. 6.0 *}

property ExpandStyle: TXColumnExpandStyle;

Description

The ExpandStyle property determines how users can use expand button in column title. These are the possible values of ExpandStyle:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

cesAuto If the column is Expandable , the grid displays an expand button in the column title. The user can click expand button to expand/contract expandable column.

See also: Expanded . cesNone No expand or drop-down button is provided. The user cannot expand/contract expandable column and cannot drop-down a menu. cesDropDown The column title displays a drop-down button that the user can click to dropdown a menu. Clicking the drop-down button triggers an OnExpandClick event. cesDropDownMenu The column title displays a drop-down button that the user can click to dropdown a menu. Clicking the drop-down button the DropDownMenu is automatically dropped down. cesFilterList automatically dropped down.

{* ver. 6.0 *}

_______

TXColumn.ExpandWidth

Specifies the total width of all expanded columns.

property ExpandWidth: Integer;

Description

When column is Expandable , ExpandWidth specifies the total width of all Expanded columns.

_______

TXColumn.FieldName

Indicates the name of the field represented by the column.

property FieldName: string;

property FieldName: WideString;

// Delphi 2006, 2007 Win32, 2009, 2010, XE only

Description

Setting FieldName changes the Field property so that it points to the dataset field with the same name. If the dataset does not have a field with the same name, Field is set to nil (Delphi), or NULL (C++).

_______

TXColumn.Filtered

Specifies whether the column is filtered.

property Filtered: Boolean; {* ver. 6.0 *}

Description

Filtered returns True when FilterList is not empty or FilterText contains filter condition. Otherwise Filtered returs False.

_______

TXColumn.FilterList

______________________________________________________________________________________________________________________________________________________________________________

idAlignment The image is displayed according to settings.

Alignment and VAlignment properties idOpposite The image is displayed opposite to Alignment and VAlignment properties settings. idCenter The image is centered in the cell. idScaled idStretch

The image is scaled to the cell boundaries.

The image is stretched to the cell boundaries. idTileCell The image is tiled starting from boundaries of each cell. idTileGrid idTileCol idTileRow

The image is tiled starting from boundaries of the grid.

The image is tiled starting from boundary of each column.

The image is tiled starting from boundary of each row.

_______

TXColumn.ImageOffsetX

Specifies horizontal indent in pixels for displayed images.

property ImageOffsetX: Integer;

Description

Use ImageOffsetX to determine how far image is indented from left or/and right boundary of the cell.

Meaning of the ImageOffsetX property is strong connected with value of ImageDraw property.

_______

See also: TXColumn.ImageDraw

, TXColumn.ImageOffsetY

, TXColumn.Transparent

, TXColumn.Wallpaper

TXColumn.ImageOffsetY

Specifies vertical indent in pixels for displayed images.

property ImageOffsetY: Integer;

Description

Use ImageOffsetY to determine how far image is indented from top or/and bottom boundary of the cell.

Meaning of the ImageOffsetY property is strong connected with value of ImageDraw property.

_______

See also: TXColumn.ImageDraw

, TXColumn.ImageOffsetX

, TXColumn.Transparent

, TXColumn.Wallpaper

TXColumn.Images

Determines which image list is associated with the column.

property Images: TImageList ;

Description

Use Images to provide a customized list of bitmaps that can be displayed in the column. Use properties:

ImageDraw , ImageOffsetX , ImageOffsetY , QuickDraw , Transparent , Wallpaper to determine place and method how the image should be displayed in the column. Use OnCalcImageIndex event to change default image index.

Write an OnPaintColumnCell event handler to display image using other graphic format (*.jpg, *.gif, *.wfm, etc.) unsupported by TImageList.

_______

TXColumn.KeyField

Indicates the key field in the dataset to match when doing a lookup.

property KeyField: string; {* ver. 5.0 *}

property KeyField: WideString; // Delphi 2006, 2007 Win32, 2009, 2010, XE only

Description

You can use LookupDataSet , KeyField, LookupKeyField , LookupResultField , LookupListFields to create a lookup list for a fkData field associated with the column. If ButtonStyle is cbsAuto and LookupColumn is defined, the LookupListFields values from LookupDataSet appear in the drop-down list associated with the column.

LookupKeyField is the field in the LookupDataSet which value must match the KeyField associated with column. The field specified in LookupKeyField must be of the same type as the KeyField associated with column, or the lookup list can't work.

Matching the value of the LookupKeyField in the LookupDataSet with the value of KeyField associated with the column determines a specific record in the LookupDataSet when the lookup list is dropped down.

When the lookup list is closed, the value of the LookupResultField in the indicated record is assigned to the field associated with the column.

_______

See also: TXColumn.LookupDataSet

, TXColumn.LookupKeyField

, TXColumn.LookupResultField

, TXColumn.LookupListFields

TXColumn.FieldName

TXColumn.ListOptions

Specifies various pick list, lookup list and other drop-down editors properties of the XDBGrid's column.

type

TXListOption = ( loAutoComplete , loAutoDropDown, loAutoCloseEditor , loSelectNextValue, loAllowClearValue, loShowToday, loShowTodayCircle, loShowWeekNumbers, loAutoTodayClose, loBoldSundays, loShowLookupListTitles, loAllowAdjustOrder, loAllowChangeOrder, loAllowColumnResize, loAllowColumnMoving, loExpandFirstColumn, loFirstColumnExpanded ); {* ver. 4.3 *} {* ver. 5.0 *} {* ver. 6.0 *}

TXListOptions = set of TXListOption;

property ListOptions: TXListOptions;

Description

Set ListOptions to include various pick list and lookup list properties for the column of XDBGrid. These are the possible values of ListOptions:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

loAutoComplete Specifies whether the edit box automatically completes words that the user types by selecting the first item that begins with the currently typed string.

When loAutoComplete is True and

PickList / PickText / LookupDataSet / Field.Lookup

is available for the column, the edit box responds to user keystrokes by searching

PickList/PickText/LookupDataSet/Field.LookupDataSet for the first item that matches the string entered so far. If it finds an item that begins with the prefix typed so far, the edit box selects that item, "completing" the user's typing. If the user continues to type, selection may move to another, later, item, as the currently typed prefix no longer matches the initial loAutoComplete selection. If the user types a string that is not the prefix of a string in the

PickList/PickText/LookupDataSet/Field.LookupDataSet, the string is taken as a unique entry and none of the items in the list are selected. loAutoDropDown The list is automatically dropped down, when the user starts edit the cell. When loAutoDropDown is not included, the user can press F2 key (in EditorMode ) to simply drop down the list or other drop-down editor. This option is allowed for all drop-down editors. loAutoCloseEditor When the list is closed up by using Enter Key or either by mouse click in selected list item, the editor box is automatically closed (when dgAlwaysShowEditor option is not included in Options ). When the list is closed up by F2 or Esc key the editor box is never closed. This option is allowed for all drop-down editors. loSelectNextValue The user can select next/prior value from the list by using Grey Plus/Minus key, when the list is'nt dropped down. When loSelectNextValue is included, next value can be selected by double click too. This option is allowed only for pick

and lookup lists. loAllowClearValue When loAllowClearValue is included, the user can clear value into the cell by using Delete key. This option is especially useful to enter empty value to the lookup field or clear field's value, when poDropDownList option is included to the PickOptions . This option is allowed only for pick and lookup lists. loShowToday Specifies whether today's date is shown in drop-down calendar. See also:

TMonthCalendar.ShowToday

. This option is allowed only for drop-down calendar. loShowTodayCircle Specifies whether today's date is circled on drop-down calendar. See also:

TMonthCalendar.ShowTodayCircle

. This option is allowed only for drop-down calendar. loShowWeekNumbers Specifies whether week numbers are shown to the left of drop-down calendar.

See also: TXColumn.PickList

, TXColumn.PickOptions

, TXColumn.PickText

, TXColumn.ButtonStyle

TXCustomDBGrid.OnCalcBoldDays

TXColumn.LookupActive

Specifies whether the column has a lookup list.

property LookupActive: Boolean; {* ver. 6.0 *}

Description

Use LookupActive property to determine the column has defined lookup list.

LookupActive is a read-only property.

_______

TXColumn.LookupColumn

Determines the kind of the lookup column.

type

TXLookupColumn = (lcNotDefined, lcLookupField, lcLookupKeyField, lcLookupResultField, lcLookupValueField {* ver. 6.2 *} );

property LookupColumn: TXLookupColumn; {* ver. 5.0 *}

Description

Use LookupColumn property to read the kind of lookup column. These are the possible values of

LookupColumn:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

The column is not a lookup column. lcNotDefined lcLookupField lcLookupKeyField

The column shows the lookup field (Column.Field.FieldKind = fkLookup).

The column shows the key field for key).

LookupDataSet (Column.Field is a foreign lcLookupResultField The column shows the result field from LookupDataSet when Column.Field is compatible with Column.

LookupResultField . lcLookupValueField The column shows any result field from LookupDataSet when Column.Field is a foreign key.

{* ver. 6.2 *}

Important notice!

When LookupColumn is lcLookupValueField the Column.Field on DataSet level is still a foreign key field and you should store ID value to the field. On TXDBGrid level the field is presented as LookupResultField including DisplayName, DefaultAlignment, DefaultWidth and DefaultCaption for column's Title.

{* ver.

6.2 *}

When TXDBGrid is sorted by column with lcLookupValueField the sort order is consistent with the order of the key value (retrived from database) not of the result value (presented in the grid). For FilterList and editor's DropDownList the sort order is consistent with the order of the result value. Compare all differences for lcLookupField, lcLookupResultField and lcLookupValueField for three Company columns in

XDBGridsLookups example.

{* ver. 6.2 *}

_______

See also: TXColumn.LookupDataSet

, TXColumn.KeyField

, TXColumn.LookupKeyField

, TXColumn.LookupResultField

TXColumn.LookupListFields

, TXColumn.FieldName

TXColumn.LookupDataSet

Identifies the dataset used to look up values for fkData field associated with the column.

property LookupDataSet: TDataSet ;

Description

You can use LookupDataSet, KeyField , LookupKeyField , LookupResultField , LookupListFields to create a lookup list for a fkData field associated with the column. If ButtonStyle is cbsAuto and LookupColumn is defined, the LookupListFields values from LookupDataSet appear in the drop-down list associated with the column.

Use LookupDataSet to specify the dataset to use for looking up field values in a field (associated with the column) with a FieldKind of fkData. TXColumn.LookupDataSet for a FieldKind of fkData is similar to

TField.LookupDataSet

for a FieldKind of fkLookup.

When the lookup list is dropped down, the record in the LookupDataSet that contains the correct value is found by matching the LookupKeyField in the LookupDataSet with the current value of the KeyField associated with the column.

When the lookup list is dropped down and LookupDataSet is closed, it's automatically opened and then closed, when the lookup list is closed. It allows to use always fresh data in the lookup list. When the lookup list is dropped down and LookupDataSet is early opened, no open/close action is performed. In this case the developer must decide when LookupDataSet should be refreshed.

_______

TXColumn.LookupKeyField

Identifies the field in the lookup dataset to match when doing a lookup.

property LookupKeyField: string;

property LookupKeyField: WideString;

// Delphi 2006, 2007 Win32, 2009, 2010,

XE only

Description

You can use LookupDataSet , KeyField , LookupKeyField, LookupResultField , LookupListFields to create a lookup list for a fkData field associated with the column. If ButtonStyle is cbsAuto and LookupColumn is defined, the LookupListFields values from LookupDataSet appear in the list associated with the column.

When the lookup list is closed, the value of the LookupResultField in the indicated record is assigned to the field associated with the column.

_______

See also: TXColumn.LookupDataSet

, TXColumn.KeyField

, TXColumn.LookupResultField

, TXColumn.LookupListFields

TXColumn.FieldName

TXColumn.LookupListFields

Identifies the field or fields whose values are displayed in the lookup list.

property LookupListFields: string;

property LookupListFields: WideString;

// Delphi 2006, 2007 Win32, 2009, 2010,

XE only

Description

You can use LookupDataSet , KeyField , LookupKeyField , LookupResultField , LookupListFields to create a lookup list for a fkData field associated with the column. If ButtonStyle is cbsAuto and LookupColumn is defined, the LookupListFields values from LookupDataSet appear in the list associated with the column.

LookupListFields is the name of the field or fields in the LookupDataSet that are displayed in the dropdown list. LookupListFields can represent more than one field.

Before specifying LookupListFields, specify the LookupResultField property. If LookupListFields is not set, the lookup list displays LookupResultField field value by default. TXColumn.LookupListFields is similar to

TDBLookupControl.ListField

You can also use LookupListFields property when the field associated with the column is a fkLookup field.

Then, you can specify more than one field (instead of Field.LookupResultField

) displayed in the dropdown list. For a fkLookup field associated with the column the LookupListFields should be specified from

Field.LookupDataSet

_______

See also: TXColumn.LookupDataSet

, TXColumn.KeyField

, TXColumn.LookupResultField

, TXColumn.LookupKeyField

TXColumn.FieldName

TXColumn.LookupListTitles

Specifies the titles for lookup list columns.

property LookupListTitles: string; {* ver. 4.3 *}

Description

When dgGridStyleList option is included in OptionsExt you can show titles for lookup list columns by including loShowLookupListTitles option in ListOptions . The LookupListTitles property specifies titles

(separated by semicolor) for each column (field) specified in LookupListFields . When this property is empty the field name is showing as title for each lookup list column.

_______

See also: TXColumn.LookupDataSet

, TXColumn.LookupKeyField

, TXColumn.LookupListFields

, TXColumn.LookupListWidths

TXColumn.LookupListWidths

Specifies the widths for lookup list columns.

property LookupListWidths: string; {* ver. 4.3 *}

Description

When dgGridStyleList option is included in OptionsExt you can show titles for lookup list columns by including loShowLookupListTitles option in ListOptions . The LookupListWidths property specifies widths

(separated by semicolor) for each column (field) specified in LookupListFields . When this property is empty the default width is setting for each lookup list column.

_______

See also: TXColumn.LookupDataSet

, TXColumn.LookupKeyField

, TXColumn.LookupListFields

, TXColumn.LookupListTitles

TXColumn.LookupResultField

Indicates the result field in the lookup dataset.

property LookupResultField: string; {* ver. 5.0 *}

property LookupResultField: WideString;

// Delphi 2006, 2007 Win32, 2009,

2010, XE only

Description

You can use LookupDataSet , KeyField , LookupKeyField , LookupResultField, LookupListFields to create a lookup list for a fkData field associated with the column. If ButtonStyle is cbsAuto and LookupColumn is defined, the LookupListFields values from LookupDataSet appear in the drop-down list associated with the column.

LookupResultField is the field in the LookupDataSet which value must match the field associated with column. The field specified in LookupResultField must be of the same type as the field associated with column, or the lookup list can't work. These rules are not applied when LookupColumn is lcLookupValueField.

{* ver. 5.0 *}

When the lookup list is closed, the value of the LookupResultField in the indicated record is assigned to the field associated with the column.

_______

See also: TXColumn.LookupDataSet

, TXColumn.KeyField

, TXColumn.LookupKeyField

, TXColumn.LookupListFields

TXColumn.FieldName

TXColumn.ParentColumn

Refers to the TXColumn object that owns the column.

property ParentColumn: TXColumn ;

Description

If the column represents a child column, ParentColumn refers to the column that parents the child column.

_______

See also: TXDBGrid

TXColumn.PickData

Determines a pick list currently used to show values for the column.

property PickData: TStrings ; {* ver. 6.0 *}

Description

The PickData property points to PickList or either PickText or either formatted PickText list defined for the column depending on PickOptions and PickTextFormat properties. The PickData list always contains values currently visible in the grid.

PickData is a read-only property.

_______

TXColumn.PickDataActive

Specifies whether the column has a pick data list.

property PickDataActive: Boolean; {* ver. 6.0 *}

Description

Use PickDataActive property to determine the column has defined a pick data list.

PickDataActive is a read-only property.

_______

TXColumn.PickDataList

Determines a pick list visibled as drop-down list for the column.

property PickDataList: TStrings ; {* ver. 6.0 *}

Description

The PickDataList property points to PickList or either PickText or either formatted PickText list defined for the column depending on PickOptions and PickTextFormat properties. The PickDataList always contains values visibled on drop-down list.

PickDataList is a read-only property.

_______

TXColumn.PickList

Lists values that the user can select for the column.

property PickList: TStrings ;

Description

The PickList property points to a TStrings object. If ButtonStyle is cbsAuto, these strings appear in the drop-down list associated with the column.

_______

TXColumn.PickOptions

Specifies various PickList and PickText properties of the XDBGrid's column.

type

TXPickOption = (poDropDownList, poListItemsOnly, poSelectPickText, poStoreItemIndex, poAcceptPickList, poAcceptItemIndex, poAutoLoadList, poAppendToList, poSortedByText, poFormatPickText, poFormatListOnly ); {* ver. 4.3 *}

TXPickOptions = set of TXPickOption;

property PickOptions: TXPickOptions;

Description

Set PickOptions to include various PickList and PickText properties for the column of XDBGrid. These are the possible values of PickOptions:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

poDropDownList Creates a drop-down list with no edit box. The user cannot enter text manually.

See also ListOptions property. poListItemsOnly The user can enter text manually, but only values from the list are accepted.

You can include this option instead poDropDownList option. poSelectPickText When PickText list is not empty, values from PickText are displayed instead corresponding items values from PickList that are stored in dataset. This option can't be included with poAutoLoadList option. poStoreItemIndex When poSelectPickText option is included, the PickText.ItemIndex + 1 is stored to dataset instead corresponding item value from PickList. The PickList can be then empty. The value stored in dataset is right justified for TStringField to determine order suitable to items order in PickText list. poAcceptPickList When poSelectPickText option is included, the user can also enter values from

PickList in edit box. poAcceptPickIndex When poSelectPickText option is included, the user can also enter ItemIndex values in edit box. For the user, the list items are always numbered starting from 1 (ItemIndex+1). poAutoLoadList When poAutoLoadList option is included, the PickList items are updated on the basis current unique values for this column. The PickList items are automatically updated by using UpdateListItems method when dgAutoUpdateListItems option is included in OptionsExt . See also LoadPickList method. poAppendToList When poAppendToList option is included, the UpdateListItems, LoadPickList

LoadPickText methods appends new values to the PickList/PickText. When

this option is excluded (default), the PickList/PickText is cleared before it's loaded. You should include this option to prevent PickList/PickText items defined in design-time. poSortedByText When poSortedByText option is included, the LoadPickText method (with parameter Sorted = True) loads values pair to the PickList/PickText objects in alphabetical order according to PickText items order, otherwise - according to

PickList items order. poFormatPickText When poFormatPickText option is included, the FormatPickText function is performed before PickText items are displayed. You can define

PickTextFormat string for FormatPickText function. If the string specified by the

PickTextFormat property is empty, the DefPickTextFormat variable will be used. poFormatListOnly When poFormatListOnly option is included, the FormatPickText function is performed only for dropdown list values. The value in edit box is not formatted.

_______

See also: TXColumn.PickList

, TXColumn.PickText

, TXColumn.ListOptions

TXColumn.PickText

Determines text for corresponding PickList's values that the user can select for the column.

property PickText: TStrings ;

Description

The PickText property points to a TStrings object. If poSelectPickText option is included in PickOptions and PickText is not empty, values from PickText are displayed instead corresponding values from PickList

(stored in dataset). If ButtonStyle is cbsAuto, these strings appear in the drop-down list associated with the column.

_______

TXColumn.PickTextFormat

Specifies format string for PickText list formatting.

property PickTextFormat: string; {* ver. 4.3 *}

Description

Use PickTextFormat property to determine format string for PickText items. When poFormatPickText option is included in PickOptions the PickText items are formatted by using FormatPickText function.

If the string specified by the PickTextFormat property is empty, the PickText item value is formatted according to DefPickTextFormat variable.

When PickTextFormat is not empty it must contain format string (any text) with one, two or three argument specifiers. The each argument specifier must be appropriate to expected type according to

SysUtils.Format

function for strings and numeric values in order: string, string, Integer. The result of

FormatPickText function is performed as:

Result := Format(PickTextFormat, [PickTextItem, PickListItem, ListIndex+1];

Use property editor to select one of most popular format for PickTextFormat. These are the most popular formats:

Format Result

______________________________________________________________________________________________________________________________________________________________________________

%0:s - %1:s

%0:s (%1:s)

Kansas - KA

Kansas (KA)

%0:s (%2:d)

%1:s - %0:s

%1:s (%0:s)

%2:2d. %0:s

Kansas (18)

KA - Kansas

KA (Kansas)

18. Kansas

%2:2d. %0:s (%1:s) 18. Kansas (KA)

%2:2d. %1:s (%0:s) 18. KA (Kansas)

______________________________________________________________________________________________________________________________________________________________________________

_______

See also: TXColumn.PickText

, TXColumn.FormatPickText

, TXColumn.PickOptions

, DefPickTextFormat

TXColumn.QuickDraw

Specifies whether the image is displayed using a palette.

property QuickDraw: Boolean;

Description

Set QuickDraw to specify whether a customized palette should be used when displaying field values. If

False, a palette is used, to provide the best possible image quality at the expense of additional processing time. If True, no special palette is used, which is faster, but results in poorer picture quality, especially with

256-color images on a 256-color video driver.

_______

See also: TXColumn.ImageDraw

TXColumn.Report

Indicates the TXColumnReport that determines additional column's properties for reporting.

property Report: TXColumnReport ;

Description

The Report property points to a TXColumnReport object that determines additional attributes of the column needed for XQRGrid component.

_______

TXColumn.ShowBlob

Determines whether graphics and memos can be displayed in the column.

property ShowBlob: Boolean;

Description

If ShowBlob is set to True, ftGraphic, ftMemo and ftFmtMemo fields can be displayed in the column.

_______

See also: TXColumn.ImageDraw

, TXColumn.ShowEdit

TXColumn.ShowEdit

Determines whether data in the column may be displayed in edit mode.

property ShowEdit: Boolean;

Description

If ShowEdit is set to False, data in the column cannot be displayed by the user in edit mode. This property is especially useful for display ftGraphic fields in the grid.

_______

See also: TXColumn.ImageDraw

, TXColumn.ShowBlob

, TXColumn.EditMemo

TXColumn.SuppressRTL

Suppress the bi-directional mode for the column.

property SuppressRTL: Boolean;

Description

When BiDiMode is set to bdRightToLeft this property allow to suppress right to left reading for the column.

_______

TXColumn.Title

Indicates the TXColumnTitle that represents the column's title.

property Title: TXColumnTitle ;

Description

The Title property points to a TXColumnTitle object that determines attributes of the column's title. If

FieldName is set, the value of FieldName becomes the default column title (TXColumnTitle.Caption).

The title (TXColumnTitle.Caption) appears at runtime only if the dgTitles flag is set in the data grid's

Options property.

_______

TXColumn.ToolTips

Specifies whether the cells in the column have tooltips.

property ToolTips: Boolean;

Description

Set ToolTips to True to specify that cells in the column have tooltips (Help Hints). See also HintOptions .

_______

TXColumn.ToolTipsWidth

Specifies how the width of tooltips window is calculated.

type

TToolTipsWidth = (ttAutoWidth, ttFixedWidth);

property ToolTipsWidth: TToolTipsWidth;

Description

Set the ToolTipsWidth property to determine width of tooltips window. These are the possible values of

ToolTipsWidth:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

ttAutoWidth The width of tooltips window is calculated according to width of field's text. ttFixedWidth The width of tooltips window is calculated according to width of column.

Notice. When the column represents memo field (ftMemo or ftFmtMemo) then ToolTipsWidth property is ignored. In that case ttFixedWidth is always used.

_______

TXColumn.TotalFields

Indicates the TXColumnTotalFields object that represents the total cells with fields values retrieved from

Totals.DataSource.

property TotalFields: TXColumnTotalFields ;

Description

The TotalFields property points to a TXColumnTotalFields object that determines attributes of the column's total cells with fields values retrieved from Totals .

DataSource . The TotalFields cells are shown beetwen TotalHeader and TotalFooter cells. Count of TotalFields rows is determined by RecordCount property for Totals.DataSource.DataSet or by Totals.

DataMaxRow property.

The TotalFields cells appear only if the dgTotalFields flag is set in the data grid's OptionsEx property.

_______

TXColumn.TotalFooter

Indicates the TXColumnTotalFooter object that determines the total cell with calculated value for last total row in the column.

property TotalFooter: TXColumnTotalFooter ;

Description

The TotalFooter property points to a TXColumnTotalFooter object that determines attributes of the column's total cell with calculated value for last total row in the column.

The TotalFooter's cells appear only if the dgTotalFooter flag is set in the data grid's OptionsEx property.

_______

TXColumn.TotalHeader

Indicates the TXColumnTotalHeader object that determines the total cell with calculated value for first total row in the column.

property TotalHeader: TXColumnTotalHeader ;

Description

The TotalHeader property points to a TXColumnTotalHeader object that determines attributes of the column's total cell with calculated value for first total row in the column.

The TotalHeader's cells appear only if the dgTotalHeader flag is set in the data grid's OptionsEx property.

_______

TXColumn.TotalRows

Specifies the TXColumnTotal object depend on current total row number.

property TotalRows[Index: Integer]: TXColumnTotal ;

Description

Use TotalRows to retrieve TXColumnTotal object for specified total row number. Index determines current total row number starting from 0. Only visibled total rows are numbered. The result can be nil if Index is outside visibled rows range or when TotalValues for this column has undefined (empty) total cell for specified total row. See also TotalValueRows property.

TotalRows is a read-only property.

_______

TXColumn.TotalValueRows

Specifies the TXColumnTotalValue object depend on current total row number.

property TotalValueRows[Index: Integer]: TXColumnTotalValue ;

Description

Use TotalValueRows to retrieve TXColumnTotalValue object for specified total row number. Index determines current total row number starting from 0. Only visibled total rows are numbered. The result can be nil if Index is outside visibled rows range or when TotalValues for this column has undefined (empty) total cell for specified total row or when Index points to TotalFields cell (not derived from

TXColumnTotalValue). See also TotalRows property.

TotalValueRows is a read-only property.

_______

TXColumn.TotalValues

Indicates the TXColumnTotalFooter object that represents a collection of total cells with calculated values for the column.

property TotalValues: TXColumnTotalValues ;

Description

The TotalValues property points to a TXColumnTotalValues collection of TXColumnTotalValue objects that determine attributes of the column's total cells with calculated values in the column. The TotalValues cells are shown beetwen TotalHeader and TotalFooter cells. Count of TotalValues rows is determined by maximum value of TotalValues.Count property for all columns in the grid.

The TotalValues cells appear only if the dgTotalValues flag is set in the data grid's OptionsEx property.

_______

TXColumn.Transparent

Specifies whether the background of the image is displayed.

property Transparent: Boolean;

Description

Use Transparent to specify that the graphic be drawn transparently. Some descendants of TGraphic such as TIcon and TMetafile are always transparent, so setting the property for those objects does not change their behavior. However, the TBitmap graphic's drawing is affected by this property.

_______

TXColumn.TransparentColor

Determines which color of the bitmap is to be transparent when the bitmap is drawn.

property TransparentColor: TColor ;

Description

Use TransparentColor to determine how to draw the bitmap transparently. When the TransparentColor property is set to clNone (default), the bottom leftmost pixel shown onscreen is using as transparent color.

The TransparentColor property is allowed only for Images property. Value of this property should be according to transparent color using when images were added to ImageList. All images should then have common transparent color.

_______

TXColumn.TrueWidth

Specifies the column width for invisible columns.

property TrueWidth: Integer;

Description

Use TrueWidth to get column width when column's Visible property is False (Width = -1).

TrueWidth is a read-only property.

_______

See also: TColumn.Width

, TXColumn.WidthBase

, TXColumn.WidthMax

, TXColumn.WidthMin

TXColumn.VAlignment

Specifies how text is vertical aligned within the cell.

property VAlignment: TVAlignment ;

Description

Use VAlignment to specify whether the text is top-justified, bottom-justified, or centered.

_______

TXColumn.Visibility

Specifies whether the column is visible in the grid.

property Visibility: Integer;

Description

Use Visibility property to read internal state of column visibility when ParentColumn is contracted and child columns are invisible. The Visibility property returns a future state of the column visibility when

ParentColumn will be Expanded . To show/hide a column in the grid use Visible property. The Showing property reflects the actual displayability of the column based on additional factors.

Visibility is a read-only property.

_______

TXColumn.Wallpaper

Specifies whether the field's text is displayed on the image.

property Wallpaper: Boolean;

Description

Use Wallpaper to specify that the field's text be drawn transparently on the image. This property has affect only when the image is displayed in the cell.

_______

TXColumn.WidthBase

Specifies the base column width.

property WidthBase: Integer;

Description

Use WidthBase to get or set the base column width when StretchMode is True. When StretchMode is

False than value of WidthBase is equal Width.

_______

See also: TColumn.Width

, TXColumn.TrueWidth

, TXColumn.WidthMax

, TXColumn.WidthMin

TXColumn.WidthMax

Specifies the maximum column width.

property WidthMax: Integer;

Description

Use WidthMax to get or set the maximum column width.

_______

See also: TColumn.Width

, TXColumn.TrueWidth

, TXColumn.WidthBase

, TXColumn.WidthMin

TXColumn.WidthMin

Specifies the minimum column width.

property WidthMin: Integer;

Description

Use WidthMin to get or set the minimum column width.

_______

See also: TColumn.Width

, TXColumn.TrueWidth

, TXColumn.WidthBase

, TXColumn.WidthMax

TXColumn.WordWrap

Specifies whether the data wraps when it is too long for the width of the column.

property WordWrap: Boolean;

Description

Set WordWrap to True to allow the data to display multiple line of text. When WordWrap is True, text that is too wide for the column wraps at the right margin and continues in additional lines.

Set WordWrap to False to limit the data to a single line. When WordWrap is False, text that is too wide for the column appears truncated. See also Ellipsis property.

_______

TXColumn.FormatPickText

Formats a PickText item value.

procedure FormatPickText(ListIndex: Integer): string; {* ver. 4.3 *}

Description

FormatPickText formats the PickText item value given by ListIndex using the format given by

PickTextFormat property.

If the string specified by the PickTextFormat property is empty, the PickText item value is formatted according to DefPickTextFormat variable.

When PickTextFormat is not empty it must contain format string (any text) with one, two or three argument specifiers. The each argument specifier must be appropriate to expected type according to

SysUtils.Format

function for strings and numeric values in order: string, string, Integer. The result of

FormatPickText function is performed as:

Result := Format(PickTextFormat, [PickTextItem, PickListItem, ListIndex+1];

_______

See also: TXColumn.PickText

, TXColumn.PickTextFormat

, DefPickTextFormat

TXColumn.IsCheckBoxValue

Indicates whether the field's value is according to checkbox state.

function IsCheckBoxValue(Checked: Boolean): Boolean;

Description

IsCheckBoxValue returns True if the field's value is according to Checked parameter. See

CheckBoxValues property.

_______

See also: TXColumn.CheckBox

, TXColumn.CheckBoxToggle

, TXColumn.CheckBoxValues

, TXColumn.ToggleCheckBoxValue

TXColumn.LoadPickList

Loads unique items from dataset to the PickList.

procedure LoadPickList(PickListField: TField = nil; Sorted: Boolean = True);

{* ver. 4.3 *}

Description

Use LoadPickList method to load all unique values from PickListField's dataset to the PickList object.

When PickListField parameter is nil, the Field linked to this column will be use to load data. You can specify PickListField from any dataset (not only from dataset linked to the grid). When PickListField's dataset is not active, the dataset will be open and close after that.

When Sorted parameter is True, the PickList items are sorted in alphabetical order. When Sorted is False, the PickList items are loaded according to current order in dataset.

Note. When poAppendToList option is included in PickOptions , the LoadPickList appends only new values to the PickList.

_______

See also: TXColumn.PickList

, TXColumn.LoadPickText

TXColumn.LoadPickText

Loads unique items pair from dataset to the PickList and PickText.

procedure LoadPickText(PickListField, PickTextField: TField; Sorted: Boolean =

True); {* ver. 4.3 *}

Description

Use LoadPickText method to load all unique values pair from PickListField/PickTextField's dataset to the

PickList and PickText object. When PickListField or PickTextField parameter is nil, the PickList and

PickText properties are cleared. You can specify PickListField/PickTextField from any dataset (not only from dataset linked to the grid), but both fields must come from the same dataset. When dataset is not active, the dataset will be open and close after that.

When Sorted parameter is True, the PickList/PickText items are sorted in alphabetical order. When poSortedByText option is included in PickOptions the alphabetical order depend on PickText items, otherwise the alphabetical order depend on PickList items. When Sorted is False, the PickList/PickText items are loaded according to current order in dataset.

Note. When poAppendToList option is included in PickOptions, the LoadPickText appends only new values pair to the PickList/PickText.

_______

See also: TXColumn.PickText

, TXColumn.LoadPickList

TXColumn.MoveTo

Moves the column in the Columns collection.

procedure MoveTo(ToIndex: Integer);

Description

Use MoveTo to move the column to the ToIndex position in Columns collection. You can also set the value of Index property to move the column, but MoveTo method moves also appropriate column in

MasterGrid when MasterGrid property is assigned.

_______

TXColumn.OptimalWidth

Returns the optimal width for the column.

function OptimalWidth: Integer;

Description

The value of OptimalWidth is determined by current field values visibled in the grid. When roOptimalWidth option is included in ResizeOption this function is called to calculate current optimal width of the column.

_______

TXColumn.SwitchListOptions

Include or exclude ListOptions depending on State.

procedure SwitchListOptions(Part: TXListOptions ; State: Boolean); {* ver. 6.0

Description

Use SwitchListOptions to include or exclude the Part of ListOptions property. When State is True the Part options are included, otherwise excluded.

_______

TXColumn.SwitchPickOptions

Include or exclude PickOptions depending on State.

procedure SwitchPickOptions(Part: TXPickOptions ; State: Boolean); {* ver. 6.0

Description

Use SwitchPickOptions to include or exclude the Part of PickOptions property. When State is True the

Part options are included, otherwise excluded.

_______

TXColumn.Synchronize

Fits width of the column to width of appropriate column in MasterGrid.

procedure Synchronize;

Description

Use Synchronize when MasterGrid is assigned and you made any special changes for this column you need call this method.

_______

TXColumn.ToggleCheckBoxValue

Changes the state of the check box.

procedure ToggleCheckBoxValue;

Description

Use the ToggleCheckBoxValue method to select or deselect the check box programmatically.

_______

See also: TXColumn.CheckBox

, TXColumn.CheckBoxToggle

, TXColumn.CheckBoxValues

, TXColumn.IsCheckBoxValue

TXColumn.UseRightToLeftAlignment

Specifies whether the column's alignment is in a right-to-left mode.

function UseRightToLeftAlignment: Boolean; {* ver. 6.0 *}

Description

Call UseRightToLeftAlignment to determine whether the column's alignment is in a right-to-left mode.

UseRightToLeftAlignment returns True for middle east locales if the BiDiMode property is bdRightToLeft and SuppressRTL property is False. Otherwise, it returns False.

_______

TXColumnTitle

TXColumnTitle represents the title of a data-grid column (TXColumn).

Unit

XDBGrids

Description

TXDBGrid uses a TXDBGridColumns to maintain a collection of TXColumn objects. Each TXColumn has an associated TXColumnTitle that holds information about its title. The TXColumnTitle instance is stored in the column's Title property.

_______

See also: TColumnTitle , TXColumn , TXColumn.Title

, TXDBGridColumns , TXDBGrid

TXColumnTitle.AutoFilter

Determines whether the column has auto-filter list.

property AutoFilter: Boolean; {* ver. 6.3 *}

Description

Set AutoFilter to True to show auto-filter button in the column title that allows to drop down filter list for the column.

Set AutoFilter to False to prevent showing filter list for the column.

_______

TXColumnTitle.AutoToggle

Determines whether the sorting marker is toggled automatically when the user clicks the title of column.

property AutoToggle: Boolean;

Description

Set AutoToggle to True to cause the sorting marker is toggled automatically when the user clicks the title of column, if Options includes dgMarkerAutoToggle.

Set AutoToggle to False if the sorting marker for this column should be controlled programmatically. To toggle marker when AutoToggle is False, use the ToggleMarker method.

_______

TXColumnTitle.Button

Determines whether the title of column is animated like button when the user clicks on it.

property Button: Boolean;

Description

Set Button to True to cause the title of column is animated like button when the user clicks on the title of column, if Options includes dgTitleButtons.

Set Button to False if the title of this column should'nt be animated and OnTitleClick event should't be fired when the user clicks on this title of column, if Options includes dgTitleButtons.

If Options does'nt include dgTitleButtons this property has no effect.

_______

See also: TXCustomDBGrid.Options

, TCustomDBGrid.OnTitleClick

Specifies the text string that can appear when the user moves the mouse pointer over a header of titles.

property HeaderHint: string;

Description

Set HeaderHint to a string that provides more information about the meaning of the header than the

Header property. The hint text appears in a Help Hint window when the user pauses with the mouse over the header if HintOptions includes hoShowTitleHints. In design time you may provide separate hint for all rows of header by using Header editor. In run-time you should follow a hint for each row by a vertical bar

(|).

_______

TXColumnTitle.HeaderHintRows

Contains the strings that appear in hint window when the user moves the mouse pointer over the rows of header.

property HeaderHintRows[Index: Integer]: string;

Description

Use HeaderHintRows to read hint text for single row of header. The HeaderHintRows property always return part of HeaderHint property. The rows are indexed from 0 to HeaderRowCount -1.

HeaderHintRows is read-only property.

_______

TXColumnTitle.HeaderRowCount

Specifies number of rows for the header.

Indicates which image maintained by the Markers appears to the right side of title's caption.

property MarkerIndex: Integer;

Description

Set MarkerIndex to designate an image that should appear to the right side of title's caption. The

MarkerIndex specifies a zero-offset index into the Markers property. Value of MarkerIndex property can be changed automatically by setting value for Marker or OrderIndex property.

Options dgMarkerAutoSwitch, dgMarkerAutoToggle and dgMarkerAscendOnly included in Options are allowed when the MarkerIndex property is changed.

_______

TXColumnTitle.OrderIndex

Identifies column's position in the OrderFields property.

property OrderIndex: Integer;

Description

Set OrderIndex to add or remove column to/from OrderFields property or to change it's position in the list.

Value of OrderIndex property can be changed automatically by setting value for the Marker or

MarkerIndex property.

Options dgMarkerAutoSwitch and dgMarkerAutoToggle included in Options are allowed when the

OrderIndex property is changed.

_______

TXColumnTitle.PopupMenu

Identifies the pop-up menu associated with the title of column.

property PopupMenu: TPopupMenu ;

Description

Assign a value to PopupMenu to make a pop-up menu appear when the user clicks the right mouse button on the title of column. If the TPopupMenu's AutoPopup property is True, the pop-up menu appears automatically. If the menu's AutoPopup property is False, display the menu with a call to its Popup method.

_______

Changes the state of the sorting markers.

procedure ToggleMarker(NewOrder: Boolean);

Description

Call ToggleMarker to change state of the sorting Marker programmicaly. When NewOrder is True, markers in all other columns are clear.

If Options includes dgMarkerAutoToggle and AutoToggle property is True, ToggleMarker method is called internaly when the user clicks on the title of column. In other way you may call ToggleMarker in

OnTitleClick event handler to change state of the sorting marker using default changing scheme. When you click on a title of column with empty FieldName , the default order is restored (no visible markers).

Default using is:

ToggleMarker(not (ssCtrl in LastShiftState ))

_______

TXColumnTotal

TXColumnTotal represents the base total cell of a data grid column (TXColumn).

Unit

XDBGrids

Description

TXDBGrid has also an associated Totals object that holds common properties for all totals cells.

_______

See also: TXColumnTotalValue , TXColumnTotalFields , TXColumnTotalHeader , TXColumnTotalFooter

TXColumnTotal.Alignment

Specifies how text is aligned within the total cell.

property Alignment: TAlignment ;

Description

Use Alignment to specify whether the total cell is left-justified, right-justified, or centered. See also

DefaultAlignment .

_______

TXColumnTotal.Caption

Specifies the text that appears in the total cell.

property Caption: string;

Description

The Caption property contains a text string that is displayed in total cell. When TotalResult is trCaption the

Caption property holds static text string that is displayed in total cell. You can set different text for dgCalcWholeDataSet and dgCalcSelectedRows modes separeted by "|" char (e.g. "All record(s)|Selected record(s)"). When "|" char is omitted the Caption property holds common text for both modes. See also

SelectedRows property.

When TotalResult is trCalcValue the Caption property holds formated Value as text string that is displayed in total cell. Each time when Value property is changed (recalculated) the Caption property is modified with using FormatValue function. When TotalResult is trCalcValue the Caption property always holds text for both modes. See also CalcApply property.

_______

TXColumnTotal.Color

Specifies the background color for the total cell.

property Color: TColor ;

Description

The Color property determines the background color of the total cell. You can set Color to one of the constants defined in the Graphics unit (such as clBlue), or to an explicit RGB integer value. The default value is determined by DefaultColor .

_______

TXColumnTotal.Column

Specifies the TColumn object that is associated with the total cell.

property Column: TXColumn ;

Description

Use Column to determine the column associated with the total cell.

_______

TXColumnTotal.DisplayText

Represents the total's value as it is displayed in total cell.

property DisplayText: string;

Description

DisplayText is a read-only string representation of a total's value for displaying in total cell. It represents the Caption , Field .

DisplayText or column tkDisplay text depend on current value of TotalResult property.

TXColumnTotal.Ellipsis

Specifies whether the Caption is completed by ... when it is too long for the width of the column.

property Ellipsis: Boolean;

Description

Set Ellipsis to True to allow the Caption completed by triple dot. When Ellipsis is True, text that is too wide for the column is completed by triple dot.

When Ellipsis is False, text that is too wide for the column appears truncated. See also WordWrap property.

_______

TXColumnTotal.Field

Indicates the TField instance represented by the total cell.

property Field: TField ;

Description

Field points to the TField object that corresponds to the dataset field displayed in the total cell. The value of Field will be nil (Delphi) or NULL (C++), if the FieldName does not correspond to a field in the dataset. If

FieldName is empty and TotalResult is trDataField or trCalcValue the Field property points to

Column .

Field object.

_______

TXColumnTotal.FieldName

Indicates the name of the field that appears in total cell.

property FieldName: string;

property FieldName: WideString;

// Delphi 2006, 2007 Win32, 2009, 2010, XE only

Description

depend on value of TotalResult property. See also TotalRecNo property.

_______

TXColumnTotal.Font

Controls the font in which the total value is displayed.

property Font: TFont ;

Description

The Font property points to a TFont object that determines typographic attributes of text displayed in the total cell. The default value is determined by DefaultFont .

_______

TXColumnTotal.Hint

Specifies the text string that can appear when the user moves the mouse pointer over a total cell.

property Hint: string;

Description

Set Hint to a string that provides more information about the meaning of the total value. The hint text appears in a Help Hint window when the user pauses with the mouse over the total cell if HintOptions includes hoShowTotalHints.

_______

TXColumnTotal.ImageIndex

Indicates which image maintained by the Totals.Images appears to the left side of title's caption.

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

tbFalse tbTrue

The box never appears in the total cell.

The box always appears in the total cell. tbAuto

_______

The box appears in the total cell depend on

TXColumnTotal.TotalResult

Specifies what result apperas within the total cell.

type

TTotalResult = (trNone, trCaption, trDataField, trTotalField, trCalcValue);

property TotalResult: TTotalResult;

Description

Use TotalResult to specify what result should be showing within the total cell. These are the possible values of TotalResult:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

No value appears within total cell. trNone trCaption trDataField

Static text string stored in Caption property appears within total cell.

If FieldName is not empty the Field .

DisplayText value appears within total cell.

If FieldName is empty the text displayed in data cell of current Column appears within total cell (See also: ColGetText function with parameter tkDisplay). The

FieldName property must determine Field from main DataSource .DataSet. trTotalField If FieldName is not empty the Field .

DisplayText value appears within total cell.

If FieldName is empty no value appears within total cell. The FieldName property must determine Field from Totals.DataSource

.DataSet. See also

TotalRecNo property. trCalcValue The result of CalcValue function stored into Value variant property and formated with using FormatValue function to the Caption string property appears within total cell. Each time when Value property is changed

(recalculated) the Caption property is modified with using FormatValue function. The FieldName property must determine Field from main

DataSource .DataSet. If FieldName is empty the Field points to Column.Field property. Each CalcValue function always operate on Field.Value variant value.

Creates and initializes a TXColumnTotal object.

constructor Create(Collection: TCollection ); override;

Description

Call Create to instantiate a TXColumnTotal object. Create should take a TXColumnTotalValues instance as its argument.

_______

TXColumnTotal.DefaultAlignment

Returns the default alignment of the total cell.

property DefaultAlignment: TAlignment ;

Description

DefaultAlignment returns the alignment for the total cell that should be used if the Alignment property is not explicitly set. The DefaultAlignment property for TXColumnTotal always returns the Column.

Alignment .

Descendants of TXColumnTotal can override this to compute the default alignment in an appropriate way.

_______

TXColumnTotal.DefaultColor

Returns the default background color for the column total.

property DefaultColor: TColor ;

Description

Use DefaultColor to determine the background color of the total cell if the Color property is not explicitly set. DefaultColor returns the Totals .

Color of the data grid to which the column belongs. If the column has no associated data grid, DefaultColor returns clBtnFace.

_______

TXColumnTotal.DefaultFont

Returns the default font for the total value.

property DefaultFont: TFont ;

Description

Use DefaultFont to determine the font of the total value if the Font property is not explicitly set. DefaultFont returns the Totals .

Font of the data grid to which the column belongs. If the column has no associated data grid, DefaultFont returns the current value of the associated column's Font property.

_______

TXColumnTotal.Destroy

Destroys the column total and frees its memory.

destructor Destroy; override;

Description

Destroy eliminates the TColumnTotal instance along with its associated objects.

_______

See also: TXColumnTotal.Create

TXColumnTotal.RestoreDefaults

Restores the column total's default settings.

procedure RestoreDefaults; virtual;

Description

RestoreDefaults reinitializes layout of column total cell.

_______

TXColumnTotalValue

TXColumnTotalValue represents the base total cell with values calculated in TXDBGrid.

Unit

XDBGrids

Description

TXDBGrid uses a TXDBGridColumns to maintain a collection of TXColumn objects. Each TXColumn can have 3 kinds of totals cells with values calculated in TXDBGrid ( TotalHeader , TotalValues , TotalFooter ).

Each total cell with values calculated in TXDBGrid is derived from TXColumnTotalValue base class.

TXDBGrid has also an associated Totals object that holds common properties for all totals cells.

_______

See also: TXColumnTotal , TXColumnTotalValues , TXColumnTotalHeader , TXColumnTotalFooter

TXColumnTotalValue.CalcApply

Specifies when the calculated value should be processed.

type

TCalcApply = (caWholeDataSet, caSelectedRows, caBoth);

property CalcApply: TCalcApply;

Description

Use CalcApply to determine when the calculated value should be processed. These are the possible values of CalcApply:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

caWholeDataSet caSelectedRows

Calculate total value only when whole dataset is processed.

Calculate total value only when selected rows are processed. caBoth Calculate total value when whole dataset or selected rows are processed.

TXColumnTotalValue.CalcValue

Specifies type of calculated value that appears within the total cell.

type

TCalcValue = (cvSum, cvAvg, cvCount, cvMax, cvMin, cvFirst, cvLast, cvUnique, cvCustom);

property CalcApply: TCalcValue;

Description

Specify CalcValue to determine type of calculated value that appears in the total cell. These are the possible values of CalcValue:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

cvSum Sum of Field .

Value appears within total cell. The field must be numeric. cvAvg Average of Field.Value appears within the total cell. The field must be numeric.

cvCount cvMax cvMin cvFirst

Count of Field.Value appears within the total cell.

Maximum of Field.Value appears the within total cell.

Minimum of Field.Value appears within the total cell.

First Field.Value according to current order appears within the total cell. cvLast cvUnique

Last Field.Value according to current order appears within the total cell.

If all calculated values are identical the value appears within the total cell.

Otherwise, the result is Null. cvCustom By default, the result is Unassigned. You can write OnTotalCalcValue event handler and return any value to apper within the total cell.

TXColumnTotalValue.Counter

Holds counter during calculations.

property Counter: Integer;

Description

Use Counter in OnTotalCalcValue event handler to determine number of processed field's values (number of records) during CalcValue function is performed. The Counter is 0 before cpReset pass and it's incremented during each cpCalcRec pass for each not Null value if NullValue property is nvExclude or for any value in other cases. The final result determines number of processed values and it's valid during cpFinal pass.

_______

TXColumnTotalValue.Format

Specifies format string for total cell value.

property Format: string;

Description

Use Format property to determine format string for Value . Each time the Value property is changed

FormatValue function converts Value to it's string representation and strores formatted value to Caption property.

When Format is empty the default formatting for each type of Value will be performed. When Format is not empty it must contain format string (any text) with one argument specifier. You can set different format for dgCalcWholeDataSet and dgCalcSelectedRows modes separeted by "|" char (e.g. "All record(s):

%d|Selected record(s): %d"). When "|" char is omitted the Format property holds common format for both modes. See also SelectedRows property.

The argument specifier must be appropriate to expected type of Value and according to: SysUtils.Format

function for strings, numeric and currency values, FormatDateTime function for date & time values,

CheckBoxValues format for Boolean values. When the format's argument specifier is not appropriate for current type of Value, format string will be ignored and default formatting will be performed (in design-time you will hear a beep). To use Float format strings for ordinal values (e.g %m for Integer) you should set

True for FormatAsFloat property.

Use property editor to select one of most popular format specifier for expected type of Value. These are the most popular format specifiers:

Format Type Result

______________________________________________________________________________________________________________________________________________________________________________

%True;False%

%Yes;No%

Boolean

(True)

(Yes)

%On;Off%

%1;0% Boolean (1)

______________________________________________________________________________________________________________________________________________________________________________

%c%

%ddddd%

Boolean

Date

(On)

Date&Time

ShortDate

Date LongDate %dddddd%

%t%

%tt%

%ddd%

Date

ShortTime

LongTime

ShortDay

%dddd%

%mmm%

Date

LongDay

ShortMonth

%mmmm% Date LongMonth

______________________________________________________________________________________________________________________________________________________________________________

%dd%

%mm%

Date

Day

Month

%yyyy%

%hh%

%nn%

Date

Year

Hour

Minute

%ss% Date Second

%zzz% Date Milisecond

______________________________________________________________________________________________________________________________________________________________________________

Ordinal

Decimal

Unsigned

(1000)

%x Ordinal Hexadecimal (3E8)

______________________________________________________________________________________________________________________________________________________________________________

%8d Ordinal Decimal ( 1000)

%8u Ordinal Unsigned ( 1000)

%8x Ordinal Hexadecimal ( 3E8)

______________________________________________________________________________________________________________________________________________________________________________

%.8d

%.8u

Ordinal

Decimal

Unsigned

(00001000)

%.8x Ordinal Hexadecimal (000003E8)

______________________________________________________________________________________________________________________________________________________________________________

%.0f Float Fixed (1000)

%.0n

%.0m

Float

Number

Money

(1 000)

(1 000 $)

%.0n%% Float Percent (1 000%)

______________________________________________________________________________________________________________________________________________________________________________

Float

Fixed

General

(1000,10)

(1000,1)

Float

Number

Money

Scientific

(1 000,10)

(1 000,10 $)

(1,00010000000000E+003)

%n%% Float Percent (1 000,10%)

______________________________________________________________________________________________________________________________________________________________________________

%.4f

%.4n

Float

Fixed

Number

(1000,1000)

(1 000,1000)

%.4m

%.4e

%.4n%% Float Percent (1 000,1000%)

______________________________________________________________________________________________________________________________________________________________________________

%12f Float Fixed ( 1000,10)

%12g

%12n

Float

Money

Scientific

General

Number

(1 000,1000 $)

(1,000E+003)

( 1 000,1)

( 1 000,10)

%12m Float Money ( 1 000,10 $)

%12n%% Float Percent ( 1 000,10%)

______________________________________________________________________________________________________________________________________________________________________________

%s String (Text)

%8s String ( Text)

______________________________________________________________________________________________________________________________________________________________________________

_______

See also: TXColumnTotalValue.FormatAsFloat

, TXColumnTotalValue.Value

, TXColumnTotalValue.Caption

TXColumnTotalValue.FormatValue

TXColumnTotalValue.FormatAsFloat

Determines type of formatted total cell's value.

property FormatAsFloat: Boolean;

Description

Use FormatAsFloat to determine using Float format for non-float type of Value . Set True for non-float type of Value to force using float Format string. When FormatAsFloat is True, FormatValue function converts

Value to Float type before the Value will be formatted. It's especially useful to format ordinal values as money.

_______

TXColumnTotalValue.NullValue

Specifies how the Null value is processing during calculation.

type

TNullValue = (nvExclude, nvInclude, nvAsZero);

property NullValue: TNullValue;

Description

Use NullValue to determine how the Null value stored in a field should be processed by CalcValue function. These are the possible values of NullValue:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

nvExclude Null values are excluded during calculations. nvInclude nvAsZero

Null values are respected like any other value.

Null values are converted to 0.

Notice. The result of any CalcValue function may be different depend of state of NullValue. By default,

NullValue is set to nvExclude.

_______

TXColumnTotalValue.TempValue

Holds temporary total value during calculations.

property TempValue: Variant;

Description

Use TempValue in OnTotalCalcValue event handler to determine current state of calculation during

CalcValue function is performed. The TempValue is Unassigned before cpReset pass, it's modified according to CalcValue function during each cpCalcRec pass and final result is stored to Value property after cpFinal pass.

_______

TXColumnTotalValue.TotalRecNo

Indicates the record in the total dataset.

property TotalRecNo: Integer;

Description

Specify TotalRecNo when TotalResult is trTotalField to select record in the Totals.DataSource

.DataSet.

You can specify TotalRecNo property for each DataSet starting from 1 even if RecNo property is not supported by DataSet descendant. Setting FieldName and TotalRecNo you can treat

Totals.DataSource.DataSet as two-dimesional array with totals values.

_______

TXColumnTotalValue.Value

Specifies the value that appears in the total cell.

property Value: Variant;

Description

The Value property contains a variant value that is formatted to the Caption string value and displayed in total cell. When TotalResult is trCaption the Value property can store static variant value that will be automatically formatted to the Caption string value with using FormatValue function.

When TotalResult is trCalcValue the Value property holds result of CalcValue function. Each time when

Value property is changed (recalculated) the Caption property is modified with using FormatValue function.

_______

TXColumnTotalValue.Assign

Copies the contents of the source column total value to a new column total value.

procedure Assign(Source: TPersistent ); override;

Description

Assign copies the published properties of the source object if it is another TXColumnTotalValue object.

Otherwise, it calls the inherited method, which allows properties to be copied from any object that implements its AssignTo method with a target of TXColumnTotalValue.

_______

TXColumnTotalValue.Create

Creates and initializes a TXColumnTotalValue object.

constructor Create(Collection: TCollection ); override;

Description

Call Create to instantiate a TXColumnTotalValue object. Create should take a TXColumnTotalValues instance as its argument.

_______

See also: TXColumnTotal.Create

TXColumnTotalValue.FormatValue

Formats variant value to it's string representation.

function FormatValue(AValue: Variant): string; virtual;

Description

Use FormatValue to format value of any type according to total cell's Format and FormatAsFloat property.

FormatValue is calling automatically when Value property is chanaged and result of this function is stored to Caption property to appear Value within total cell.

_______

TXColumnTotalValues

TXColumnTotalValues represents a collection of total cells with calculated values for data grid column

(TXColumn).

Unit

XDBGrids

Description

TXDBGrid uses a TXDBGridColumns to maintain a collection of TXColumn objects. Each TXColumn can have 4 kinds of totals cells ( TotalHeader , TotalValues , TotalFields , TotalFooter ). TXColumnTotalValues represents a collection of total cells with calculated values for a column. TXColumnTotalValues collection is a container for TXColumnTotalValue objects.

TXDBGrid has also an associated Totals object that holds common properties for all totals cells.

_______

See also: TXColumnTotalValue , TXColumnTotalFooter , TXColumnTotalHeader , TXColumn.TotalValues

TXColumnTotalValues.Column

Specifies the TXColumn object that is associated with the column TotalValues collection.

property Column: TXColumn ;

Description

Use Column to determine the column associated with the TotalValues collection.

_______

TXColumnTotalValues.Items

Lists the total values in the collection.

property Items[Index: Integer]: TXColumnTotalValue ;

Description

Use Items to access individual total values. The value of the Index parameter represents the position of the total value in the TotalValues collection.

Items is the default property of TXColumnTotalValues. This means that the property name, Items, can be omitted when referring to values of the TXColumnTotalValues object. Thus, the line

FirstValue := XDBGrid1.Columns[0].TotalValues.Items[0]; can also be written

FirstValue := XDBGrid1.Columns[0].TotalValues[0];

_______

TXColumnTotalValues.Add

Creates a new TXColumnTotalValue instance and adds it to the Items array.

function Add: TXColumnTotalValue ;

Description

Add returns the new total value. At design time, use the collection's TotalValues editor to add new total value to the collection.

_______

TXColumnTotalValues.Create

Creates and initializes a TotalValues object.

type

TXColumnTotalValueClass = class of TXColumnTotalValue ;

constructor Create(Column: TXColumn ; ValueClass: TXColumnTotalValueClass);

override;

Description

Call Create to instantiate an instance of TXColumnTotalValues. The Create method takes two parameters: a TXColumn instance object and TXColumnTotalValue class (or the name of a class derived from

TXColumnTotalValue). You not need to create this object directly. This is instantiated by each grid's column.

_______

TXColumnTotalValues.GetEnumerator

Creates enumerator for TXColumnTotalValues class.

function GetEnumerator: TXDBGridColumnsEnumerator; {* ver. 5.6 *} // For

Delphi 2009 or higher

Description

You not need to call this function directly. It allows you to iterate over all values in the column total.

type

ColumnTotalValue: TXColumnTotalValue;

begin

for ColumnTotalValue in XDBGrid1[ColumnName].TotalValues do

begin

// Perform action on each total value in XDBGrid1[ColumnName]

end;

_______

TXColumnTotalHeader

TXColumnTotalHeader represents the total cell with calculated value for first total row in data grid column

(TXColumn).

Unit

XDBGrids

Description

TXDBGrid uses a TXDBGridColumns to maintain a collection of TXColumn objects. Each TXColumn can have 4 kinds of totals cells ( TotalHeader , TotalValues , TotalFields , TotalFooter ). TXColumnTotalHeader represents the first of total cells for a column. TXColumnTotalHeader is derived from TXColumnTotalValue base class.

TXDBGrid has also an associated Totals object that holds common properties for all totals cells.

_______

See also: TXColumnTotalValue , TXColumnTotalFooter , TXColumnTotalValues , TXColumn.TotalHeader

TXColumnTotalHeader.Create

Creates and initializes a TotalHeader object.

constructor Create(Column: TXColumn ); reintroduce;

Description

Call Create to instantiate an instance of TXColumnTotalHeader. Create takes a TXCustom instance as its argument. You not need to create this object directly. This is instantiated by each grid's column.

_______

See also: TXColumnTotal.Create

TXColumnTotalFooter

TXColumnTotalFooter represents the total cell with calculated value for last total row in data grid column

(TXColumn).

Unit

XDBGrids

Description

TXDBGrid uses a TXDBGridColumns to maintain a collection of TXColumn objects. Each TXColumn can have 4 kinds of totals cells ( TotalHeader , TotalValues , TotalFields , TotalFooter ). TXColumnTotalFooter represents the last of total cells for a column. TXColumnTotalFooter is derived from TXColumnTotalValue base class.

TXDBGrid has also an associated Totals object that holds common properties for all totals cells.

_______

See also: TXColumnTotalValue , TXColumnTotalHeader , TXColumnTotalValues , TXColumn.TotalFooter

TXColumnTotalFooter.Create

Creates and initializes a TotalFooter object.

constructor Create(Column: TXColumn ); reintroduce;

Description

Call Create to instantiate an instance of TXColumnTotalFooter. Create takes a TXCustom instance as its argument. You not need to create this object directly. This is instantiated by each grid's column.

_______

See also: TXColumnTotal.Create

TXColumnTotalFields

TXColumnTotalFields represents the total cells with fields values retrieved from Totals.DataSource.

Unit

XDBGrids

Description

TXDBGrid uses a TXDBGridColumns to maintain a collection of TXColumn objects. Each TXColumn can have 4 kinds of totals cells ( TotalHeader , TotalValues , TotalFields , TotalFooter ). TXColumnTotalFields represents the total cells with field's values retrieved from Totals .

DataSource . TXColumnTotalFields is derived from TXColumnTotal base class.

TXDBGrid has also an associated Totals object that holds common properties for all totals cells.

_______

See also: TXColumnTotal , TXColumn.TotalFields

TXColumnTotalFields.Create

Creates and initializes a TotalFields object.

constructor Create(Column: TXColumn ); reintroduce;

Description

Call Create to instantiate an instance of TXColumnTotalFields. Create takes a TXCustom instance as its argument. You not need to create this object directly. This is instantiated by each grid's column.

_______

See also: TXColumnTotal.Create

Specifies the background color of the total rows in the grid.

property Color: TColor ;

Description

Set Color to specify the color for the total cells in the grid.

_______

TXDBGridTotals.DataMaxRow

Specifies maximum number of records from total dataset to display in total rows.

property DataMaxRow: Integer;

Description

Use DataMaxRow to prevent loading large total DataSource .DataSet into memory. Default value for

DataMaxRow is set to 5. You can increase this property to reasonable value or set DataMaxRow to 0 to lift this limit, but you should remember that this functionality works successfully for reasonable number of records in total dataset.

_______

TXDBGridTotals.DataSource

Identifies the link to the totals dataset where the grid finds its totals data.

property DataSource: TDataSource ;

Description

Set DataSource to the TDataSource object that links to the totals dataset where the grid should fetch its totals data. This DataSource allows the grid to read totals data from the dataset. To show totals data from dataset in grid's totals rows you should include dgTotalFields in OptionsEx property and select FieldName for selected column's TotalFields properties. When dgTotalFields option is included in OptionsEx the grid create one total row for one record in total dataset. It's especially useful to show totals values calculated by GROUP BY clause in SQL statement.

This functionality works successfully for reasonable number of records in total dataset. Be careful to not open large dataset as total dataset. To prevent loading large dataset into memory DataMaxRow property is default set to 5. Remember that whole dataset must reside in memory to successfully use TotalFields.

You can also show selected fields from selected records from this dataset into any other kind of total rows

( TotalHeader , TotalValues , TotalFooter ). To do this you should set TotalResult property to trTotalField,

FieldName property to selected field and TotalRecNo to RecNo in total dataset (TotalRecNo property can be used for each DataSet starting from 1 even if RecNo property is not supported by DataSet

descendant). In this way you can use any dataset as two-dimensional array of totals values. It's esspecially useful for using a memory table which contains totals values.

_______

Specifies number of lines for multi-line totals of columns in the grid.

property LinesCount: Integer;

Description

Set LinesCount to specify number of lines for multi-line totals of columns in the grid. LinesCount is only meaningful if the OptionsEx property includes dgTotalHeader, dgTotalValues, dgTotalFields or dgTotalFooter.

_______

TXDBGridTotals.Selected

Specifies when SelectedRows list or SelectedCols list is not empty.

property Selected: Boolean; {* ver. 4.3 *}

Description

Use Selected to determine when totals selected rows have calculated values for rows, columns or cells selected in the grid. The Selected property returns True when SelectedRows or SelectedCols returns

True. See also: MultiSelect .

Selected is a read-only property

Specifies whether any total row is visible in the grid.

property Visible: Boolean;

Description

Use the Visible property to control the visibility of total rows at runtime. If Visible is true, one or more total rows appears in the grid. If Visible is false, no total rows is visibled. See also dgTotalHeader, dgTotalValues, dgTotalFields and dgTotalFooter option for OptionsEx property.

Visible is a read-only property.

_______

See also: TXCustomDBGrid.OptionsEx

TXDBGridTotals.Create

Creates and initializes a Totals object.

constructor Create(AGrid: TXCustomDBGrid );

Description

Call Create to instantiate an instance of TXDBGridTotals. Create takes a TXCustomDBGrid instance as its argument. You not need to create Totals object directly. This is instantiated by XDBGrid.

_______

TXDBGridTotals.DefaultSelectedColor

Returns the default background color for the totals selected rows.

function DefaultSelectedColor: TColor ;

Description

Use DefaultSelectedColor to determine the default background color of the totals selected rows if the

SelectedRows property is True. When IsGridThemed is True DefaultSelectedColor determine the default foreground color of the totals selected rows. DefaultSelectedColor will be used only when SelectedColor property is set to clDefault.

_______

TXDBGridTotals.Destroy

Destroys an instance of TXDBGridTotals.

destructor Destroy; override;

Description

Destroy frees the helper objects of the TXDBGridTotals before destroying the instance. The user never need to call this method directly.

_______

TXDBGridTotals.GetEnumerator

Creates enumerator for TXDBGridTotals class.

function GetEnumerator: TXDBGridTotalsEnumerator; {* ver. 5.6 *} // For Delphi

2009 or higher

Description

You not need to call this function directly. It allows you to iterate over all values in the column total.

type

Bookmark: TBookmark;

begin

for Bookmark in XDBGrid1.Totals do

begin

// Perform action on each record into XDBGrid1.Totals.DataSource.DataSet

end;

_______

See also: TXColumnTotalValues.GetEnumerator

TXColumnReport

TXColumnReport represents an extension of a data-grid column (TXColumn) for a report.

Specifies text or expression printed in column's total in the report.

property TotalText: string;

Description

Use TotalText property to specify text or QuickReport's expression printed in column's total depend on

TotalType property setting.

_______

TXColumnReport.TotalType

Specifies type of column's total printed in the report.

type

TTotalType = (ttNone, ttSum, ttCount, ttMax, ttMin, ttAverage, ttText, ttExpression, ttGrowExpression);

property TotalType: TTotalType;

Description

Set the TotalType property to determine type of column's total printed in the report. These are the possible values of TotalType:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

ttNone None total is printed for the column. ttSum ttCount

The sum of field's values is printed for the column.

The count of records is printed for the column. ttMax ttMin

The maximum field's value is printed for the column.

The minimum field's value is printed for the column. ttAverage ttText ttExpression

The avarage field's value is printed for the column.

The text specified in TotalText property is printed for the column.

The QuickReport's expression specified in TotalText is printed for the column.

Value of expression is ResetAfterPrint . ttGrowExpression The QuickReport's expression specified in TotalText is printed for the column.

Value of expression is NOT ResetAfterPrint .

_______

TXColumnReport.Visible

Specifies whether the column may be visible in the report.

property Visible: Boolean;

Description

To hide a column in the report, set Visible to False. If Visible is True, and the column's Visible property is

True, the column will appear in the report. This property only determines whether the column is allowed to be printed.

_______

TXColumnReport.Create

Creates and initializes a column extension for a report.

constructor Create(Column: TXColumn );

Description

Call Create to instantiate an instance of TXColumnReport. Create takes a TXColumn instance as its argument.

Most applications need not create column extesion instances as these are instantiated by the associated column.

_______

TXColumnReport.IsPrinted

Indicates whether the column is printed in the report.

function IsPrinted: Boolean;

Description

IsPrinted returns True if the column is visibled in the grid and Visible property is True.

_______

TXColumnReport.RestoreDefaults

Restores the column extesion's default settings.

procedure RestoreDefaults; virtual;

Description

RestoreDefaults reinitializes all column extesion's properties.

_______

TXDBGridFilter

TXDBGridFilter contains internal filter settings for the grid.

Unit

XDBGrids

Description

TXDBGrid has an associated TXDBGridFilter that holds additional parameters for internal filter settings.

_______

TXDBGridFilter.Active

Specifies whether or not the internal filter is active.

property Active: Boolean; {* ver. 6.0 *}

Description

Use Active to determine whether the internal filter is active. When Active property is True the filtering of

DataSet is controlled by the grid. You should not modify Filter, Filtered and OnFilterRecord property directly in the DataSet linked to the grid when Active property is True, but you can modify Filter , Filtered and OnFilterRecord property of TXDBGrid instead.

The property Active is True when any FilterList is not empty or any FilterText contains filter condition and

AutoUpdate property is True.

_______

TXDBGridFilter.AutoFilter

Specifies whether or not each column has auto-filter drop-down list.

property AutoFilter: Boolean; {* ver. 6.0 *}

Description

Set AutoFilter on to show auto-filter drop-down button in title area of each column. When drop-down button is visible in title area the auto-filter list is available for the column. Auto-filter list allows to check/uncheck values for the column to show/hide selected records in DataSet linked to the grid. Values checked in drop-down auto-filter list are stored in FilterList property. When AutoFilter is False you can populate filter list for selected column with ExpandStyle = cesFilterList only.

_______

TXDBGridFilter.AutoUpdate

Specifies whether or not internal grid filter system is handled by the grid.

property AutoUpdate: Boolean; {* ver. 6.0 *}

Description

When AutoUpdate is True, the internal grid filter system is automatically handled by the grid.

When AutoUpdate is False, each change in FilterList or FilterText property is notified by OnFilterChanged event and the change should be updated in DataSet in your event handler (in any way). After all you should notify the grid by calling FilterUpdated that the filter change was updated in DataSet.

_______

TXDBGridFilter.Columns

Specifies grid columns with active FilterList or FilterText.

property Columns:

TList

; {* ver. 6.0 *}

Description

Use Columns property to examine grid's columns when FilterList is not empty or FilterText has defined filter condition.

_______

TXDBGridFilter.DropDownRows

Specifies the number of rows displayed in the filter's drop-down list.

property DropDownRows: Integer; {* ver. 6.0 *}

Description

DropDownRows determines the number of rows displayed in the filter's drop-down list.

When DropDownRows property is 0 (default) and drop-down list has more then MaxDropDownRows items, then MaxDropDownRows items is displayed in the filter's drop-down list, otherwise all list items are displayed.

_______

TXDBGridFilter.DropDownWidth

Specifies a width of the filter's drop-down list.

property DropDownWidth: Integer; {* ver. 6.0 *}

Description

DropDownWidth determines a width of the filter's drop-down list.

When DropDownWidth property is 0 (default) and auto-calculated width of the filter's drop-down list is greater then MaxDropDownWidth , then displayed width of the filter's drop-down list is limited to

MaxDropDownWidth.

_______

Indicates the grid that contains this object.

property Grid: TXCustomDBGrid ; {* ver. 6.0 *}

Description

Use the Grid property to access the grid that contains this object.

_______

TXDBGridFilter.Options

Specifies various properties of the filter drop-down list.

type

TXDBGridFilterOption = (foAutoApplyList, foListAnimation, foListAlignment, foOverlayedList, foLoadAllItems);

TXDBGridFilterOptions = set of TXDBGridFilterOption;

property Options: TXDBGridFilterOptions; {* ver. 6.0 *}

Description

Set Options to include the desired properties for the filter drop-down list. Options is a set drawn from the following values:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

foAutoApplyList Include foAutoApplyList to automatically apply changes (checked/unchecked values) in DataSet linked to the grid. Exclude foAutoApplyList to show OK and

Cancel button in the filter list. foListAnimation foListAlignment

Include foListAnimation to animate drop-down process of the filter list.

Include foListAlignment to align width of the filter list with the width of the column, if possible. foOverlayedList Include foOverlayedList to drop-down filter list over the column. foLoadAllItems Include foLoadAllItems to show on filter list all possible values for the column even they are excluded by current filter settings in other columns. You can also show/hide excluded values when filter list is visible by click on the left upper checkbox.

_______

TXDBGridFilter.Create

Creates and initializes a FilterGrid object.

constructor Create(AGrid: TXCustomDBGrid ); {* ver. 6.0 *}

Description

Call Create to instantiate an instance of TXDBGridFilter. Create takes a TXCustomDBGrid instance as its argument. You not need to create FilterGrid directly. This is instantiated by XDBGrid.

_______

See also: TXCustomDBGrid , TXDBGridFilter.Destroy

Specifies whether or not the search system is active.

property Active: Boolean; {* ver. 6.2 *}

Description

Use Active to determine whether the search system is active. When Active property is True the search

Text can be visible in the grid and the search panel can be shown in the grid by the user.

_______

See also: TXDBGridSearch.Text

, TXDBGridSearch.Visible

TXDBGridSearch.Color

Specifies the color of the search text.

property Color: TColor ; {* ver. 6.2 *}

Description

Set Color to specify the color of the search text in the grid.

The Color property can handle two special colors: clDefault, clNone.

Select clDefault value to use DefaultColor value.

Select clNone value when the search text should not be highlighted.

_______

See also: TXDBGridSearch.Text

, TXDBGridSearch.DefaultColor

TXDBGridSearch.Grid

Indicates the grid that contains this object.

property Grid: TXCustomDBGrid ; {* ver. 6.2 *}

Description

Use the Grid property to access the grid that contains this object.

_______

TXDBGridSearch.List

Holds list of textes searched by the user.

property List: TStrings ; {* ver. 6.2 *}

Description

Use List property to read or change textes searched by the user in search panel.

_______

See also: TXDBGridSearch.Text

TXDBGridSearch.Options

Specifies various properties of the seaching in the grid.

type

TXSearchOption = (soCaseSensitive, soWholeWords, soWrapAround, soSkipMessage);

TXSearchOptions = set of TXSearchOption;

property Options: TXSearchOptions; {* ver. 6.2 *}

Description

Set Options to include the desired properties for the searching in the grid. The possible values of Options are:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

soCaseSensitive Include soCaveSensitive to search text with differentiating between capital and lowercase letters. soWholeWords soWrapAround

Include soWholeWords to search text occurences only for whole words.

Include soWrapAround to search next text occurence from the beginning after the last. soSkipMessage Include soSkipMessage to skip message when the searched text has not been found.

_______

See also: TXDBGridSearch.Text

TXDBGridSearch.Text

Specifies text to search in the grid.

property Text: string; {* ver. 6.2 *}

Description

The Text property specifies text to search in the grid. Each occurence of text in the grid is highlighted in

Color . Only first occurence in the cell is highlighted. The specified Text is searching with using soCaseSensitive and soWholeWords from Options property.

_______

TXDBGridSearch.Visible

Specifies the search text is visible in the grid.

property Visible: Boolean; {* ver. 6.2 *}

Description

Use Visible to determine the search text is visible in the grid. The Visible is True when Active property is

True and Text property is not empty.

The Visible is a read-only property.

_______

TXDBGridSearch.Create

Creates and initializes a Search object.

constructor Create(AGrid: TXCustomDBGrid ); {* ver. 6.2 *}

Description

Call Create to instantiate an instance of TXDBGridSearch. Create takes a TXCustomDBGrid instance as its argument. You not need to create Search directly. This is instantiated by XDBGrid.

_______

See also: TXCustomDBGrid , TXDBGridSearch.Destroy

TXDBGridSearch.Destroy

Destroys an instance of TXDBGridSearch.

destructor Destroy; {* ver. 6.2 *}

Description

Destroy frees the helper objects of the TXDBGridSearch before destroying the instance. The user never need to call this method directly.

_______

Specifies the left and right margin in pixels for column's total cell.

property TotalColMargin: Integer;

Description

TotalColMargin determines the number of pixels between frame and text in column's total cell for left and right side. The default value is 0 for both vsStandard and vsXPStyle style drawing. See also VisualStyle .

_______

TXGridStyle.TotalRowSpace

Specifies the number of empty lines in pixels for total rows.

property TotalRowSpace: Integer;

Description

TotalRowSpace determines the number of empty lines in pixels in total rows. The default value is 4 pixels for vsStandard style drawing and 8 pixels for vsXPStyle style drawing. See also VisualStyle .

_______

TXGridStyle.VisualStyle

Determines the drawing style for the grid.

type

TVisualStyle = (vsCustom, vsDefault, vsStandard, vsXPStyle);

property VisualStyle: TVisualStyle;

Description

Use VisualStyle property to specify the drawing style. The XDBGrid component has two typical styles. The vsStandard style is compatible with Borland's DBGrid. This style is suitable to non Windows XP platform.

On Windows XP platform, when XDBGrid uses elements from ThemeServices to realize FixedTheme , some elements are greater. To obtain nice look on Windows XP platform, you should select vsXPStyle.

Default value for VisualStyle is vsDefault. This value determines using vsXPStyle, when the application is running on Windows XP platform and XP manifest is present and vsStandard style in other cases (non

Windows XP platform nor XP manifest present).

When you select vsXPStyle value, this style (spacing) will be used on all Windows platform, even when

IsGridThemed return False. When you select vsStandard value, the standard spacing will be used on all

Windows platform, even when IsGridThemed return True (not recomended).

You can also prapare common style suitable for all Windows platform, when you select vsCustom visual style. Then, you can define your own values for other properties in GridStyle . Be sure, the defined values are resonable.

Notice. Since version 3.3 the default value for VisualStyle is vsXPStyle. This value is suitable for all

Windows platform.

_______

TXGridStyle.Assign

Copies the contents of the source grid style to a new grid style object.

procedure Assign(Source: TPersistent ); override;

Description

Assign copies the published properties of the source object if it is another TXGridStyle object. Otherwise, it calls the inherited method, which allows properties to be copied from any object that implements its

AssignTo method with a target of TXGridStyle.

_______

See also: TXCustomDBGrid

TXGridStyle.Create

Creates and initializes a GridStyle object.

Specifies the scroll bar's color.

property Color: TColor ;

Description

Use Color to specify the scroll bar's color. When you explicitly assign a value to Color, the ParentColor property is automatically set to False. If the scroll bar's ParentColor property is True, then the Color property reflects the Windows button highlight color (clBtnHighlight), and changing this color in the

Windows control panel automatically updates the value of Color.

Notice. When FlatSBMode is False the Color property is of no importance.

_______

TXScrollProp.Grid

Indicates the grid that contains this object.

property Grid: TXCustomDBGrid ;

Description

Use the Grid property to access the grid that contains this object.

_______

See also: TXCustomDBGrid

TXScrollProp.ParentColor

Specifies whether the scroll bar should reflect the Windows button highlight color.

property ParentColor: Boolean;

Description

Use ParentColor to indicate that the scroll bar should always reflect the Windows button highlight color.

Using ParentColor differs from setting the Color property to clBtnHighlight in that when ParentColor is

True, changing the button highlight color in the Windows control panel automatically updates the value of

Color. When the value of the Color property is changed, its ParentColor property is automatically set to

False.

_______

TXScrollProp.ParentStyle

Specifies whether the scroll bar style is determined by XDBGrid style.

property ParentStyle: Boolean;

Description

Use ParentStyle to indicate that the scroll bar should always reflect the XDBGrid's FixedStyle . When

ParentStyle is True and FixedStyle is changed, the Style property is automatically updated to achieve best look for the grid. When the value of the Style property is changed, its ParentStyle property is automatically set to False.

_______

TXScrollProp.Style

Specifies a scroll bar style.

property Style: TScrollBarStyle ;

Description

Use Style to specify the scroll bar's style. The style determines whether the scroll bar appears threedimensional, flat, or uses hot tracking. When you explicitly assign a value to Style, the ParentStyle property is automatically set to False.

Notice. When FlatSBMode is False the Style property is of no importance.

_______

TXScrollProp.ThumbBar

Specifies the size of the scroll bar's thumb tab.

property ThumbBar: Boolean;

Description

Use ThumbBar to specify the size of the scroll bar's thumb tab. When ThumbBar is True the thumb tab is a bar. When ThumbBar is False the thumb tab is a box. See also dgThumbTracing option in Options .

Notice. When FlatSBMode is False the ThumbBar property is of no importance.

_______

TXScrollProp.WinXPMode

Specifies whether the grid uses flat scrollbar on Windows XP platform.

property WinXPMode: Boolean;

Description

WinXPMode determines whether the grid uses flat scroll bars when the application is running on Windows

XP platform and Manifest is'nt present. In this case, when WinXPMode is True, the XP style scroll bars appear by default. When you set WinXPMode to False, you can see flat scroll bars even on Windows XP platform. This possibility is especially useful for developers of Delphi 7 and above. When you remove manifest resource and/or manifest file from application, the FlatSBMode will return True even on Windows

XP platform and then, you can test flat scroll bars without running application on non-Windows XP platforms.

When Manifest is present the FlatSBMode is always False on Windows XP platform.

_______

See also: TXCustomDBGrid.ScrollBars

, TXCustomDBGrid.FlatSBMode

TXScrollProp.Create

Creates and initializes a ScrollProp object.

constructor Create(AGrid: TXCustomDBGrid );

Description

Call Create to instantiate an instance of TXScrollProp. Create takes a TXCustomDBGrid instance as its argument. You not need to create ScrollProp object directly. This is instantiated by XDBGrid.

_______

See also: TXCustomDBGrid

TXDBGridSettings

TXDBGridSettings represents a layout management for data grid (TXDBGrid).

Unit

XDBGrids

Description

TXDBGrid has an associated TXDBGridSettings that holds additional properties for columns layout management. They allow to save/load columns layout (width, order, visibility, etc.) to/from registry or *.ini file.

_______

TXDBGridSettings.Active

Specifies whether or not the grid settings are stored and retrieved automatically.

property Active: Boolean;

Description

Use Active to determine or set whether the grid settings are stored and retrieved from ini file or from registry automatically. When Active is False the grid cannot load or save Layout automatically, but the developer can call directly LoadLayout and SaveLayout methods in the code. When Active is True, Layout settings can be load and save automatically according to soLoadLayout/soSaveLayout Options . The

Layout settings are loaded automatically when DataSource linked to XDBGrid is first time opened and saved when XDBGrid is destroyed.

_______

See also: TXDBGridSettings.Layout

, TXDBGridSettings.IniFile

, TXDBGridSettings.Options

, TXDBGridSettings.LoadLayout

TXDBGridSettings.SaveLayout

TXDBGridSettings.DefaultFileName

Specifies default name of the ini file or default name of the registry key.

const

DefaultIniFileName: string = '' ;

DefaultRegistryKey: string = '\Software\X-Files Software\XDBGrid' ;

property DefaultFileName: string;

Description

When IniFile is True, the DefaultFileName property retrieves default FileName from

DefaultIniFileName

global variable. You can initialize DefaultIniFileName variable in the begining of the project file as common ini file name for all instances of XDBGrid in the project. By default,

DefaultIniFileName variable is empty. When DefaultIniFileName variable is empty the DefaultFileName property return name of executable application with an .INI extension as default FileName (e.g.

'PROJECT1.INI'

When IniFile is False, the DefaultFileName property retrieves default registry key from

DefaultRegistryKey

global variable. You can initialize DefaultRegistryKey variable in the begining of the project file as common registry key for all instances of XDBGrid in the project. By default,

DefaultRegistryKey variable is initialized by

'\Software\X-Files Software\XDBGrid'

value. You can change this value, but the variable can not be empty. Remember that TRegistryIniFile reinterprets the

FileName property as a subkey under the system registry's root key (HKEY_CURRENT_USER by default).

_______

TXDBGridSettings.DefaultSection

Specifies default name of the section in ini file or in the registry key.

property DefaultSection: string;

Description

The DefaultSection property retrieves default name of the section in ini file or in the registry key. Default name of the section is composed of parent form name + '.' + grid name (e.g.

'Form1.XDBGrid1'

_______

TXDBGridSettings.FileName

Contains the name of the ini file or the name of the registry key.

property FileName: string;

Description

When IniFile is True, the FileName property should contain the name of the ini file to save/load columns

Layout . When IniFile is False, the FileName property should contain then name of the registry key to save/load columns layout.

The FileName property is passed as parameter when TIniFile or TRegistryIniFile object is created to save/load columns layout. When FileName property is empty the value of DefaultFileName property will be used as default.

_______

TXDBGridSettings.Grid

Identifies the grid that owns this object.

property Grid: TXCustomDBGrid ;

Description

Use the Grid property to access the grid that owns this object.

_______

See also: TXCustomDBGrid

TXDBGridSettings.IniFile

Specifies whether the grid should save/load layout either to/from *.ini file or to/from registry.

property IniFile: Boolean;

Description

Use IniFile to indicate whether the grid should save/load columns Layout either to/from *.ini file (when

IniFile = True) or to/from registry (when IniFile = False).

_______

See also: TXDBGridSettings.Layout

, TXDBGridSettings.FileName

TXDBGridSettings.Layout

Contains the individual lines of text for column layout settings.

property Layout: TStrings ;

Description

Layout is a TStrings object designed for store and retrieve column layout settings as name-value pairs.

For more information on name-value pairs, refer to Values property.

The Layout object contains several lines with base settings ( FieldName , Width , Visible , Expanded ,

Report.Visible

) for each column. Name of each line determine current position of the column in the

XDBGrid (e.g. "Column1", "Column2", ...). The line with name "Columns" contains number of columns in the grid.

When soOrderFields, soLinesCount, soStretchMode Options are included, the additional lines with names:

"OrderFields", "LinesCount", "StretchMode" are added to Layout. When soUserSettings option is included in Options, the additional lines: "AutoLoadLayout", "AutoSaveLayout" are added to Layout. You can also create OnLayout event handler to add additional lines (properties) to the Layout.

This convention corresponds to the format used in many initialization files. For example (gray lines are optional):

AutoLoadLayout=1

AutoSaveLayout=1

Columns=4

Column1=ID,20,0,0,1,1

Column2=FirstName,40,1,0,1,1

Column3=LastName,40,1,0,1,1

Column4=Country,30,1,0,1,1

OrderFields=LastName,FirstName

LinesCount=1

StretchMode=0

The Layout object is designed for store and retrieve column layout to/from ini file or to/from registry but you can also use TStrings methods like: LoadFromFile / SaveToFile , LoadFromStream / SaveToStream ,

GetTextStr / SetTextStr (or Text property) to load/save Layout to text file, any stream or memory variable.

Each time you are reading Layout property the current column settings are retrieved from XDBGrid's properties. Each time you are setting new Layout property the XDBGrid's columns properties are modified but when value of "Columns" name-value pair in the Layout buffer does not correspond to Count of

Columns in the XDBGrid the columns in the grid are not changed.

_______

TXDBGridSettings.Options

Specifies various behavioral properties of the XDBGrid settings.

type

TXSettingsOption = (soLoadLayout, soSaveLayout, soUserSettings, soOrderFields, soLinesCount, soStretchMode);

TXSettingsOptions = set of TXSettingsOption;

property Options: TXSettingsOptions;

Description

Set Options to include the desired properties for the XDBGrid settings. Options is a set drawn from the following values:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

soLoadLayout Load Layout from ini file or from registry always when DataSource linked to

XDBGrid is first time opened. soSaveLayout soUserSettings

Save Layout to ini file or to registry always when XDBGrid is destroyed.

Include soUserSettings in Options when soLoadLayout/soSaveLayout option can be changed by user in run-time and should also be stored and retrieved form ini file or from registry. soOrderFields Add OrderFields property to Layout. soLinesCount Add LinesCount property to Layout. soStretchMode Add StretchMode property to Layout.

_______

See also: TXDBGridSettings.Layout

, TXDBGridSettings.IniFile

, TXDBGridSettings.LoadLayout

, TXDBGridSettings.SaveLayout

TXDBGridSettings.Section

Contains the name of the section in ini file or in the registry.

property Section: string;

Description

When IniFile is True, the Section property should contain the name of the section in FileName ini file to save/load columns Layout . When IniFile is False, the Section property should contain then name of the section in FileName registry key to save/load columns layout.

The Section property is passed as parameter when any method of TIniFile or TRegistryIniFile is used to save/load columns layout. When Section property is undefined the value of DefaultSection property is used as default. The Section property can not be empty.

_______

TXDBGridSettings.ApplyLayout

Applies the column layout stored in Layout buffer.

procedure ApplyLayout;

Description

Use ApplyLayout to apply current Layout buffer in the grid. This procedure is useful after you load new layout to Layout buffer by calling ReadLayout , LoadFromFile , LoadFromStream methods or after you setting new value for Text property.

Notice: When value of "Columns" name-value pair in the Layout buffer does not correspond to Count of

Columns in the XDBGrid the columns in the grid are not changed.

_______

See also: TXDBGridSettings.Layout

, TXDBGridSettings.ReadLayout

, TXDBGridSettings.LoadLayout

TXDBGridSettings.Create

Creates and initializes a Settings object.

constructor Create(AGrid: TXCustomDBGrid );

Description

Call Create to instantiate an instance of TXDBGridSettings. Create takes a TXCustomDBGrid instance as its argument. You not need to create Settings object directly. This is instantiated by XDBGrid.

Loads and applies the column layout from ini file.

procedure LoadLayout(IniFile: TCustomIniFile = nil);

Description

Use LoadLayout to load the column layout from IniFile into Layout buffer and to apply the new layout in the grid. You can specify the existing IniFile object as the parameter.

When IniFile parameter is empty the default IniFile object will be created to perform LoadLayout and the default IniFile will be destroyed after this operation. Default IniFile is created as TIniFile or TRegistryIniFile according to current IniFile and FileName property.

Notice: When value of "Columns" name-value pair in the Layout buffer does not correspond to Count of

Columns in the XDBGrid the columns in the grid are not changed.

_______

See also: TXDBGridSettings.Layout

, TXDBGridSettings.SaveLayout

, TXDBGridSettings.ReadLayout

TXDBGridSettings.ReadLayout

Loads the column layout from ini file to Layout buffer.

function ReadLayout(IniFile: TCustomIniFile = nil): TStrings ;

Description

Use ReadLayout to load the column layout from IniFile into Layout buffer. The new layout is'nt apply in the grid. You can modify the loaded layout (result of ReadLayout function) before you call ApplyLayout to apply new layout in the grid. You can specify the existing IniFile object as the parameter.

When IniFile parameter is empty the default IniFile object will be created to perform ReadLayout and the default IniFile will be destroyed after this operation. Default IniFile is created as TIniFile or TRegistryIniFile according to current IniFile and FileName property.

_______

See also: TXDBGridSettings.Layout

, TXDBGridSettings.ApplyLayout

, TXDBGridSettings.LoadLayout

TXDBGridSettings.SaveLayout

Saves the column layout to ini file.

procedure SaveLayout(IniFile: TCustomIniFile = nil);

Description

Use SaveLayout to save the column layout to IniFile. You can specify the existing IniFile object as the parameter.

When IniFile parameter is empty the default IniFile object will be created to perform SaveLayout and the default IniFile will be destroyed after this operation. Default IniFile is created as TIniFile or TRegistryIniFile according to current IniFile and FileName property.

_______

See also: TXDBGridSettings.Layout

, TXDBGridSettings.LoadLayout

, TXDBGridSettings.ReadLayout

TXDBGridSettings.EraseLayout

, TXDBGridSettings.LayoutExists

TXDBGridSettings.SwitchOptions

Include or exclude Options depending on State.

procedure SwitchOptions(Part: TXSettingsOptions ; State: Boolean); {* ver. 6.0

Description

Use SwitchOptions to include or exclude the Part of Options property. When State is True the Part options are included, otherwise excluded.

_______

See also: TXCustomDBGrid.SwitchOptions

TXDBGridGradient

TXDBGridGradient specifies the gradient drawing style for grid.

Unit

XDBGrids

Description

TXDBGridGradient class is derived from TXFGradientButton class to realize gradient drawing for grid's fixed and data cells.

{* ver. 5.0 *}

_______

TXBookmarkList

TXBookmarkList is a collection of bookmarks that identify a set of records in a dataset.

Unit

XDBGrids

Description

Use TXBookmarkList to manage a set of bookmarks when working with the records in a dataset. Each bookmark identifies a particular record in the dataset, and can be identified by a string.

_______

TXBookmarkList.Count

Indicates the number of bookmarks in the bookmark list.

property Count: Integer;

Description

Read Count to determine the number of entries in the Items array. Use Count as an upper limit when iterating over the strings in the Items array.

_______

TXBookmarkList.CurrentRowSelected

Indicates whether the Bookmark property of the associated XDBGrid's dataset is in the Items array.

property CurrentRowSelected: Boolean;

Description

Read CurrentRowSelected to determine whether the Bookmark property of the associated XDBGrid's dataset specifies a bookmark string in the Items property array. CurrentRowSelected is True when the bookmark string is included, False when it is not. The Bookmark property of the dataset indicates the current record in the dataset.

Set CurrentRowSelected to specify whether the Bookmark string of the associated XDBGrid's dataset should be included in the bookmark list. Setting CurrentRowSelected to True adds the Bookmark property of the dataset to the Items array if it is not already there. Setting CurrentRowSelected to False removes the Bookmark of the dataset from the Items array if it is there. If the Bookmark property of the dataset is an empty string (no bookmark), setting CurrentRowSelected does nothing.

Deletes all bookmarks from the list.

procedure Clear;

Description

Call Clear to empty the Items array and set the Count property to 0 when all rows of the associated

XDBGrid are deselected. Calling Clear invalidates the associated XDBGrid so that the selected rows that were referenced by the bookmarks in the bookmark list can be repainted.

Note: Clear removes the bookmarks from the bookmark list to reflect the fact that the corresponding rows are not selected. To delete the rows from the dataset rather than just deselecting them, call the Delete method instead.

_______

TXBookmarkList.Create

Creates an instance of TXBookmarkList and associates it with a XDBGrid.

constructor Create(AGrid: TXCustomDBGrid );

Description

Applications do not need to call create to instantiate the bookmark list used by XDBGrids to implement their SelectedRows property. XDBGrids call Create from their constructor to create this bookmark list.

Component writers that implement additional properties for descendants of TXCustomDBGrid can create additional bookmark list objects to represent other sets of records in the dataset.

_______

TXBookmarkList.Delete

Deletes all the records specified by the bookmarks in the list from the dataset of the associated XDBGrid.

procedure Delete;

Description

Call Delete to delete the set of records represented by the bookmark list from the dataset. To remove all the bookmarks from the list without changing the dataset, use the Clear method instead.

_______

TXBookmarkList.Destroy

Destroys an instance of TXBookmarkList.

destructor Destroy; override;

Description

Do not call Destroy directly in an application. Instead, call Free. Free verifies that the TXBookmarkList object is not nil, and only then calls Destroy.

Destroy frees the memory used to store the Items property array.

_______

TXBookmarkList.Find

Indicates whether a specified bookmark string is contained in the bookmark list.

function Find(const Item: TBookmarkStr ; var Index: Integer): Boolean;

function Find(const Item: TBookmark ; var Index: Integer): Boolean;

// Delphi

2009, 2010, XE

Description

Call Find to determine whether the string specified by the Item parameter is one of the bookmark strings in the Items property array. Find returns True if the bookmark list contains the bookmark string, False otherwise. If Find returns True, the index of the bookmark string is returned as the value of the Index parameter.

Note: The index of a specific bookmark string can also be obtained by using the IndexOf method. Unlike the IndexOf method, which returns a value of -1 if the bookmark string is not in the Items array, Find does not change the value of the Index parameter if the bookmark string can't be found. Use Find when a default value should be changed only if the bookmark is not in the list.

_______

TXBookmarkList.GetEnumerator

Creates enumerator for TXBookmarkList class.

function GetEnumerator: TXBookmarkListEnumerator; {* ver. 5.6 *} // For Delphi

2009 or higher

Description

You not need to call this function directly. It allows you to iterate over all selected rows in the grid.

type

Bookmark: TBookmark;

begin

for Bookmark in XDBGrid1.SelectedRows do

begin

// Perform action on each record selected in XDBGrid1.SelectedRows

end;

_______

TXBookmarkList.IndexOf

Returns the index of a bookmark string in the Items property array.

function IndexOf(const Item: TBookmarkStr ): Integer;

function IndexOf(const Item: TBookmark ): Integer;

// Delphi 2009, 2010, XE

Description

Call IndexOf to get the index for a bookmark string in the Items array. The first item in the array has index

0, the second item has index 1, and so on. If an item is not in the list, IndexOf returns -1.

_______

TXBookmarkList.Refresh

Removes all invalid bookmarks from the Items property array.

function Refresh: Boolean;

Description

Bookmarks in the bookmark list are not automatically deleted when records in the dataset are deleted. As a result, some bookmarks in the Items array may become invalid. Call Refresh to ensure that every bookmark in the bookmark list is valid. Refresh attempts to locate every record in the dataset that corresponds to a bookmark in the Items property array. All bookmarks that do not correspond to records in the dataset are removed.

If any of the bookmarks in the list are invalid, Refresh returns True, and invalidates the XDBGrid so that it will repaint, reflecting the removal of all invalid records. If all bookmarks in the list are still valid, Refresh returns False.

_______

TXBookmarkList.Restore

Restore bookmarks from the saved list of key fields.

procedure Restore(AKeyFields: string = ''); {* ver. 5.32 *}

Description

Call Restore to restore bookmarks from the list of record's key fields saved by Save method. AKeyFields parameter specifies the field or fields to uniquely identify records in dataset. To use more than one field, separate each field name with a semicolon. When AKeyFields parameter is empty, the KeyFields property will be used. When KeyFields property is empty, an error will be raised. The specified key fields must be of the same types as the corresponding key fields in Save method, or the Restore method fails.

_______

TXBookmarkList.Save

Save bookmarks to the list of key fields.

procedure Save(AKeyFields: string = ''); {* ver. 5.32 *}

Description

Call Save to save bookmarks to the list of record's key fields. AKeyFields parameter specifies the field or fields to uniquely identify records in dataset. To use more than one field, separate each field name with a semicolon. When AKeyFields parameter is empty, the KeyFields property will be used. When KeyFields property is empty, an error will be raised. Each call of Save procedure overrides the saved list of key fields.

_______

TXColumnList

TXColumnList is a collection of columns that are selected in the grid.

Unit

XDBGrids

Description

Use TXColumnList to manage a set of columns that are selected in the grid.

_______

TXColumnList.Columns

Indicates whether any column of the XDBGrid is in the Items array (column is selected).

property Columns[Index: Integer]: Boolean; {* ver. 4.3 *}

Description

Read Columns for specified Index to determine whether the column of the XDBGrid specifies a column in the Items property array. Columns[Index] is True when the column is included (selected), False when it is not.

Set Columns[Index] to specify whether the column of the XDBGrid should be included in the column list.

Setting Columns[Index] to True adds the column of the grid for specifies Index to the Items array if it is not already there. Setting Columns[Index] to False removes the column of the grid for specified Index from the

Items array if it is there.

_______

See also: TXColumnList.CurrentColSelected

, TXColumnList.Items

TXColumnList.Count

Indicates the number of columns in the column list.

property Count: Integer; {* ver. 4.3 *}

Description

Read Count to determine the number of entries in the Items array. Use Count as an upper limit when iterating over the columns in the Items array.

_______

TXColumnList.CurrentColSelected

Indicates whether the SelectedColumn property of the XDBGrid is in the Items array.

property CurrentColSelected: Boolean; {* ver. 4.3 *}

Description

Deletes all columns from the list.

procedure Clear; {* ver. 4.3 *}

Description

Call Clear to empty the Items array and set the Count property to 0 when all columns of the XDBGrid are deselected. Calling Clear invalidates the associated XDBGrid so that the selected columns that were referenced in the column list can be repainted.

Note: Clear removes the columns from the column list only to reflect the fact that the columns are not selected.

_______

TXColumnList.Create

Creates an instance of TXColumnList and associates it with a XDBGrid.

constructor Create(AGrid: TXCustomDBGrid ); {* ver. 4.3 *}

Description

Applications do not need to call create to instantiate the column list used by XDBGrids to implement their

SelectedCols property. XDBGrids call Create from their constructor to create this column list. Component writers that implement additional properties for descendants of TXCustomDBGrid can create additional column list objects to represent other sets of columns in the grid.

_______

TXColumnList.Destroy

Destroys an instance of TXColumnList.

destructor Destroy; override; {* ver. 4.3 *}

Description

Do not call Destroy directly in an application. Instead, call Free. Free verifies that the TXColumnList object is not nil, and only then calls Destroy.

Destroy frees the memory used to store the Items property array.

_______

TXColumnList.Find

Indicates whether a specified column is contained in the column list.

function Find(const Item: TXColumn ; var Index: Integer): Boolean; {* ver. 4.3

Description

Call Find to determine whether the column specified by the Item parameter is one of the column in the

Items property array. Find returns True if the column list contains the column, False otherwise. If Find returns True, the index of the column is returned as the value of the Index parameter.

Note: The index of a specific column can also be obtained by using the IndexOf method. Unlike the

IndexOf method, which returns a value of -1 if the column is not in the Items array, Find does not change the value of the Index parameter if the column can't be found. Use Find when a default value should be changed only if the column is not in the list.

_______

TXColumnList.GetEnumerator

Creates enumerator for TXColumnList class.

function GetEnumerator: TXColumnListEnumerator; {* ver. 5.6 *} // For Delphi

2009 or higher

Description

You not need to call this function directly. It allows you to iterate over all selected columns in the grid.

type

Column: TXColumn;

begin

Specifies string value of Null variants.

Unit

XDBGrids

const

NullValueString: string = '';

Description

NullValueString specifies string that apperas in total cells when result of CalcValue function is Null. By default, NullValueString is the empty string.

_______

Specifies the mouse tracking functionality for drop-down list

Unit

XDBGrids

const

ListMouseTracking: Boolean = True; {* ver. 4.3 *}

Description

When ListMouseTracking is True the mouse tracking functionality is available for drop-down list.

When ListMouseTracking is False this functionality is not available for drop-down list.

Note. This functionallity is available only when dgGridStyleLists option is included in OptionsExt .

_______

DefAutoNumberFormat variable

Specifies the default format for AutoNumber values.

Unit

XDBGrids

const

DefAutoNumberFormat: string = '%d.'; {* ver. 4.3 *}

Description

The DefAutoNumberFormat specifies the default format for AutoNumber values. The format is using by

AutoNumberStr function.

_______

DefAutoNumberTitle variable

Specifies the default title for AutoNumber column.

Unit

XDBGrids

const

DefAutoNumberTitle: string = 'No.'; {* ver. 4.3 *}

Description

When AddAutoNumber function is using the DefAutoNumberTitle value initializes Title.Caption

for the new column.

_______

DefAutoNumberWidth variable

Specifies the default width for AutoNumber column.

Unit

XDBGrids

const

DefAutoNumberWidth: Integer = 48; {* ver. 4.3 *}

Description

When AddAutoNumber function is using the DefAutoNumberWidth value initializes Title.Width

for the new column.

_______

DefAutoSelectTitle variable

Specifies the default title for AutoSelect column.

Unit

XDBGrids

const

DefAutoSelectTitle: string = 'Select'; {* ver. 4.3 *}

Description

When AddAutoSelect function is using the DefAutoSelectTitle value initializes Title.Caption

for the new column.

_______

DefAutoSelectWidth variable

Specifies the default width for AutoSelect column.

Unit

XDBGrids

const

DefAutoSelectWidth: Integer = 48; {* ver. 4.3 *}

Description

When AddAutoSelect function is using the DefAutoSelectWidth value initializes Title.Width

for the new column.

_______

DefPickTextFormat variable

Specifies the default format for PickText list items.

Unit

XDBGrids

const

DefPickTextFormat: string = '%1:s - %0:s'; {* ver. 4.3 *}

Description

When PickTextFormat property is empty, the DefPickTextFormat is using by FormatPickText function.

_______

See also: TXColumn.PickText

, TXColumn.PickTextFormat

, TXColumn.FormatPickText

RegisterChangeOrder procedure

Registers typical DataSet class to automatically change order in the grid.

Unit

XDBGrids

const

AscOnly = True;

AscDesc = False;

type

TChangeOrder = (coChangeIndexFields, coChangeOrderFields, coChangeSQLOrderFields, coCustomChangeOrder);

TValidChangeOrder = function(DataSet: TDataSet ; ChangeOrder: TChangeOrder):

Boolean;

procedure RegisterChangeOrder(ClassName: string; ChangeOrder: TChangeOrder;

AscendOnly: Boolean; IsValid: TValidChangeOrder = nil; PropName: string =

''; Suffix: string = '');

Description

Use RegisterChangeOrder procedure to register typical method of change sorting order in DataSet linked to the grid. TXDBGrid can automatically change sorting order for registered DataSet class when dgAutoUpdateOrder option is included in OptionsEx . When OrderFields (sorting markers) changes in the grid the ChangeDataSetOrder universal method is called. All standard DataSet descendats (except unidirectional) are registered by default to automatically change order (ADO, BDE, CDS, DBX, IBX). To register other typical DataSets you should call this method before.

ClassName parameter determines class name of registered DataSet. Each DataSet is registered exactly for the class (not for descendats). ChangeOrder parameter determines selected method of change sorting order available in registered DataSet. AscendOnly parameter determines that dgMarkerAscendOnly option should be included in Options property to use registered method without Beeps (use

AscOnly/AscDesc constants). See also dgAutoAscendOnly option in OptionsEx .

You can also specify optionally IsValid function, if any other conditions must be meet to can use registered method for registered DataSet. This function will be called each time before using the registered method.

You can also specify PropName parameter, if the name of published property in registered DataSet is different that expected .

{* ver. 4.31 *}

You can also specify optionally Suffix parameter (for coChangeIndexFields only).

When Suffix parameter is omitted (or empty) the default suffix

'ASC;DESC;'

will be used to retrieve and change current sorting order in data set. For other suffixes, you must explicity specify the ASC and DESC modifiers when they are accepted by DataSet. For example, the AnyDAC's data sets accept the modifiers

:A;:D;:N'

. Use semicolon to separate ASC and DESC modifiers. When none modifier is accepted by data set you must register the method with parameter AscOnly.

The following are possible values of ChangeOrder parameter:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

coChangeIndexFields Use ChangeIndexFields registered DataSet.

method to modify IndexFieldNames property in coChangeOrderFields Use ChangeOrderFields registered DataSet.

method to modify CommandText property in coChangeSQLOrderFields Use ChangeSQLOrderFields method to modify SQL property in registered

DataSet.

coCustomChangeOrder Do not use with RegisterChangeOrder procedure. Use

RegisterCustomChangeOrder instead.

You can register more than one method for one ClassName (especially with different IsValid functions).

Last method registered for the ClassName will be used as first (if IsValid returns True). It allows to select methods "on the fly" for any ClientDataSet depend on current conditions. For all pre-registered DataSets the methods with AscendOnly = False are prefered.

Please, open XDBGridsADD.pas unit to add RegisterChangeOrder procedure for additional typical dataset. This unit is fully useful and may be added to your application, if you are using these datasets.

_______

See also: RegisterCustomChangeOrder , UnregisterChangeOrder

RegisterCustomChangeOrder procedure

Registers specific DataSet class to automatically change order in the grid.

Unit

XDBGrids

type

TCustomChangeOrder = procedure(DBGrid: TXDBGrid ; AOrderFields: WideString =

'');

TCustomCurrentOrder = function(DBGrid: TXDBGrid ): WideString;

procedure RegisterCustomChangeOrder(ClassName: string; ChangeOrder:

TCustomChangeOrder; CurrentOrder: TCustomCurrentOrder; AscendOnly: Boolean;

IsValid: TValidChangeOrder = nil);

Description

Use RegisterCustomChangeOrder procedure to register specific method of change sorting order in

DataSet linked to the grid. TXDBGrid can automatically change sorting order for registered DataSet class when dgAutoUpdateOrder option is included in OptionsEx . When OrderFields (sorting markers) changes in the grid the ChangeDataSetOrder universal method is called. All standard DataSet descendats (except unidirectional) are registered by default with using RegisterChangeOrder procedure to automatically change order (ADO, BDE, CDS, DBX, IBX). To register other specific DataSets you should call this method before.

ClassName parameter determines class name of registered DataSet. Each DataSet is registered exactly for the class (not for descendats). ChangeOrder parameter specifies custom procedure which can change sorting order in registered DataSet. CurrentOrder parameter specifies custom function which can retrieve current sorting order from registered DataSet. AscendOnly parameter determines that dgMarkerAscendOnly option should be included in Options property to use registered methods without

Beeps. See also dgAutoAscendOnly option in OptionsEx .

You can also specify optionally IsValid function, if any other conditions must be meet to can use registered

ChangeOrder method for registered DataSet. This function will be called each time before using

ChangeOrder method. Registered CurrentOrder function must always return current sorting order.

You can register more than one method for one ClassName (especially with different IsValid functions).

Last method registered for the ClassName will be used as first (if IsValid returns True). It allows to select methods "on the fly" for any ClientDataSet depend on current conditions.

Please, open XDBGridsADO.pas unit to see an example how to write complete

RegisterCustomChangeOrder procedure. This unit is fully useful and may be added to your application, if you are using TADOQuery . It implements using in run-time Sort public property to automatically change sorting other in TADOQuery.

_______

See also: RegisterChangeOrder , UnregisterChangeOrder

UnRegisterChangeOrder procedure

Unregisters method for DataSet class registered prior to automatically change order in the grid.

Unit

XDBGrids

procedure UnRegisterChangeOrder(ClassName: string; ChangeOrder: TChangeOrder );

Description

Use UnRegisterChangeOrder procedure to unregister method of change sorting order in DataSet linked to the grid. UnregisterChangeOrder procedure unregisters method of ChangeOrder type for ClassName registered prior by using RegisterChangeOrder or RegisterCustomChangeOrder procedure.

You may need to call this procedure if you don't want to modify CommandText property by

ChangeOrderFields method and leave ChangeIndexFields (second) method to automatically change only

IndexFieldNames property in any ClientDataSet.

_______

See also: RegisterChangeOrder , RegisterCustomChangeOrder

AutoNumberStr function

Converts an AutoNumber value to a string.

Unit

XDBGrids

function AutoNumberStr(Value: Integer): string; {* ver. 4.3 *}

Description

AutoNumberStr converts an integer (AutoNumber value) into a string with using DefAutoNumberFormat containing the format of AutoNumber value representation. If Value is less or equal 0, the function returns empty string.

_______

See also: DefAutoNumber , TXColumn.AutoNumber

GetTrueColor function

Converts clDefault/clNone color value to it's true equivalent.

Unit

XDBGrids

function GetTrueColor(Color, DefaultColor: TColor; NoneColor: TColor = clDefault): TColor ; {* ver. 5.1 *}

Description

GetTrueColor function returns Color value, if the value is different than clDefault and clNone. If Color value is clDefault the function returns DefaultColor parameter. If Color value is clNone, the function return

NoneColor parameter (when was specified). This function is useful when you need to use true color value instead clDefault/clNone.

Using:

with XDBGrid1 do

ColorDialog1.Color := GetTrueColor(HighlightText, DefaultHighlightText,

Font.Color);

ScanStr function

Scans string to retrieve substrings separated by delimiter.

Unit

XDBGrids

const

DefaultDelimiter: string = ',' ;

function ScanStr(var S: string; Delimiter: string = '' ): string;

Description

Use ScanStr to retrieve (and return as Result) a left substring of S string separated by Delimiter. The right substring of S string (after Delimiter) is return as new S string. When Delimiter is empty the value of

DefaultDelimiter global variable will be used as Delimiter. This function is useful to split several words separated by any delimiter to separate words.

For example after:

S := 'one,two,three,four,five' ;

while S <> '' do Memo1.Lines.Add(ScanStr(S));

The result in Memo1.Lines is:

'one'

'two'

'three'

'four'

'five'

_______

Converts IndexFields string to OrderFields string.

Unit

XDBGrids

function IndexFieldsToOrderFields(IndexFields: string; Suffix: string = ''):

string; overload; {* ver. 5.0 *}

function IndexFieldsToOrderFields(IndexFields: WideString; Suffix: string =

''): WideString; overload; {* ver. 4.31 *} // C++Builder/Delphi 2006, 2007

Win32 only

Description

Call IndexFieldsToOrderFields to convert IndexFields string to OrderFields string with using Suffix modifier. See also CurrentIndexFields method.

_______

OrderFieldsToIndexFields function

Converts OrderFields string to IndexFields string.

Unit

XDBGrids

function OrderFieldsToIndexFields(OrderFields: string; Suffix: string = ''):

string; overload; {* ver. 5.0 *}

function OrderFieldsToIndexFields(OrderFields: WideString; Suffix: string =

''): WideString; overload; {* ver. 4.31 *} // C++Builder/Delphi 2006, 2007

Win32 only

Description

Call OrderFieldsToIndexFields to convert OrderFields string to IndexFields string with using Suffix modifier. See also ChangeIndexFields method.

_______

ExtractOrderFields function

Parses the SQL statement and returns fields followed by ORDER BY clause.

Unit

XDBGrids

function ExtractOrderFields(SQL: TStrings ): string; overload;

function ExtractOrderFields(SQL: TWideStrings): WideString; overload; //

C++Builder/Delphi 2006 and higher

Description

Call ExtractOrderFields to retrieve fields followed by ORDER BY clause in SQL statement.

ExtractOrderFields work correct when ORDER BY clause fill whole single line in the SQL statement or

ORDER BY is the last clause in the line.

_______

ModifyOrderFields function

Parses the SQL statement and replaces fields followed by ORDER BY clause by OrderFields parameter.

Unit

XDBGrids

procedure ModifyOrderFields(SQL: TStrings ; OrderFields: string); overload;

procedure ModifyOrderFields(SQL: TWideStrings; OrderFields: WideString);

overload; // C++Builder/Delphi 2006 and higher

Description

Call ModifyOrderFields to replace fields followed by ORDER BY clause in SQL statement by OrderFields value. ModifyOrderFields work correct when ORDER BY clause fill whole single line in the SQL statement or ORDER BY is the last clause in the line.

_______

SplitOrderFields function

Splits OrderFields to all and descending index fields.

Unit

XDBGrids

procedure SplitOrderFields(OrderFields: string; var Fields, DescFields:

string); overload; {* ver. 5.0 *} // C++Builder/Delphi 2006 and higher

procedure SplitOrderFields(OrderFields: WideString; var Fields, DescFields:

WideString); overload;

Description

Call SplitOrderFields to split one OrderFields string to Fields and DescFields index fields to store them into

TIndexDef objects.

_______

TXQRGrid can preview and print records basis upon TXDBGrid component's settings.

Unit

XQRGrids

Description

TXQRGrid is a complementary component for TXDBGrid designed for dynamic report creating on the grounds of TXDBGrid current settings. TXQRGrid can print and preview content of TXDBGrid. TXQRGrid create in run-time complete report in QuickReport format. Report may be created in few parts (vertical bands) depend on selected paper size settings.

_______

See also: TXDBGrid

TXQRGrid.AutoRowHeight

Determines automatic row height adjustment for all/selected columns.

type

TXReportHeight = (rhDisabled, rhPartial, rhComplete);

property AutoRowHeight: TReportHeight;

Description

Set AutoRowHeight to rhPartial or rhComplete to cause automatic row height adjustment. When

AutoRowHeight is rhComplete all columns take part in row height adjustment calculations. When

AutoRowHeight is rhPartial only columns marked by AutoHeight take part in row height adjustment calculations. See also: roMultiPartRowHeight option.

Set AutoRowHeight to rhDisabled to create report with using fixed row height determined by LinesCount .

_______

TXQRGrid.CustomCount

Indicates the number of records selected by developer.

property CustomCount: Integer;

Description

Use CustomCount to determine the number of records selected by developer. The value of CustomCount property is printed when you select rdCustomCount or rdCustomNoPerCount SysData . The CustomCount is designed to count records selected by developer. To calculate value of CustomCount the report must be prepared. When Prepare is finished the CustomCount property is initialized by the last value of

CustomNumber . See also PrepareNeeded .

_______

TXQRGrid.CustomNumber

Indicates the ordinal position of record calculated by developer.

property CustomNumber: Integer;

Description

Use CustomNumber to determine the ordinal position of record calculated by developer. The value of

CustomNumber property is printed when you select rdCustomNo or rdCustomNoPerCount SysData . The value of CustomNumber should be incremented by developer for selected records. The CustomNumber is usually incremented in BeforeBandPrint event handler when PrintBand is True and Sender.BandType is rbDetail. The CustomNumber is initialized by "0" each time before BeforePrint event occurs.

_______

TXQRGrid.FixedCols

Specifies the number of columns on the left of the grid that are repeated on each vertical band.

property FixedCols: Integer;

Description

Use FixedCols to specify, how many columns on the left of the grid should be repeated on each vertical band when multi-part report is created. Set FixedCols to -1 to assume current TXDBGrid.

FixedCols value.

Note: Report must include at least one non-fixed column. Do not set FixedCols to a value greater than

Columns.Count - 1. Total width of all fixed columns can not be greater then report's page width (without margins).

_______

TXQRGrid.FixedColsCount

Specifies the current number of columns on the left of the grid that are repeated on each vertical band.

property FixedColsCount: Integer;

Description

Use FixedColsCount to read the current number of columns that are repeated on each vertical band.

FixedColsCount always returns value from range 0 to Columns.Count - 1. See also: FixedCols .

FixedColsCount is a read-only property.

_______

TXQRGrid.Options

Specifies various display and behavioral properties of the XQRGrid.

type

TXReportOption = (roFirstPageHeader, roLastPageFooter, roCompression, roPrintIfEmpty, roShowProgress, roForceTrueTypes, roAllowFixedColor, roModalMode, roAllPagesTitle, roAllPagesLegend, roGroupForceNewPage, roSaveDfmAsText, roAllowVAlignment, roMultiPartAutoHeight, roKeepPrinterSetup, roKeepDesignPrinterSetup, roPreparePrinterSetup, roForceRGBColor, roAutoCalcPageWidth, roPrintHiddenColumns);

TXReportOptions = set of TXReportOption;

property Options: TXReportOptions;

Description

Set Options to include the desired properties for the XQRGrid component. Options is a set drawn from the following values:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

roFirstPageHeader roLastPageFooter

Page header will be printed on the first page.

Page footer will be printed on the last page.

Report will be compressed in memory during generation. roCompression roPrintIfEmpty roShowProgress roForceTrueTypes roAllowFixedColor roModalMode roAllPagesTitle

Page will be also generated if there are no records in the dataset.

Progress form will be displayed during printing of the report.

Bitmap fonts will be automatically replaced by true type fonts.

The FixedColor will be used for first FixedCols columns.

All other windows will be disabled during Preview.

Page title will be printed on all pages. roAllPagesLegend roSaveDfmAsText

Page legend will be printed on all pages. roGroupForceNewPage Each group will be printed on new page (new column).

SaveReport creates *.dfm file as text file. roAllowVAlignment Apply vertical text alignment in cells. roMultiPartAutoHeight roKeepPrinterSetup

Apply AutoRowHeight jointly by all vertical bands.

Save changes made in PrinterSetup dialog in run-time. roKeepDesignPrinterSetup Save changes made in PrinterSetup dialog in design-time. roPreparePrinterSetup Prepare report before calling PrinterSetup dialog. roForceRGBColor Replace system colors to RGB colors. roAutoCalcPageWidth Always fit PrinterPage .Width to the width of ReportDBGrid . roPrintHiddenColumns Print columns invisible in ReportDBGrid, when Report.Visible

= True.

_______

See also: TQuickReportOptions , TCustomQuickRep.Options

, TCustomQuickRep.PrintIfEmpty

, TCustomQuickRep.ShowProgress

Represents the page layout for the report.

property PrinterPage: TQRPage ;

Description

Use the PrinterPage property to set page layout information for the report. See TQRPage for more information.

Notice.

To assign value to PrinterPage.PaperSize in run-time you must add QRPrntr unit to the uses clause.

Then, you can write: PrinterPage.PaperSize := A4;

To assign value to PrinterPage.Orientation in run-time you must add Printers unit to the uses clause.

Then, you can write: PrinterPage.PaperSize := poLandscape;

_______

See also: TQRPage , TCustomQuickRep.Page

TXQRGrid.PrinterSettings

Represents the printer specific options.

type

TXQRPrinterSettings = class( TQuickRepPrinterSettings );

property PrinterSettings: TXQRPrinterSettings;

Description

Use the PrinterSettings property to set printer specific options. See also TQRPrinterSettings for more infomation. The PrinterSettings properties are dependent on installed version of QuickReport. Some properties can be accesible starting from QuickReport 3.6 or 4.0 Professional.

Notice. To assign value to some PrinterSettings properties in run-time you must add QRPrntr unit to the uses clause. Then, you can write e.g.: PrinterSettings.OutputBin := Manual;

_______

See also: TQuickRepPrinterSettings , TCustomQuickRep.PrinterSettings

TXQRGrid.PrintSelectedRows

Determines printing report for selected records only.

property PrintSelectedRows: Boolean;

Description

Set PrintSelectedRows to True to determine printing report only for records marked as SelectedRows in the ReportDBGrid component. See also PrintCurrentRow property.

Set PrintCurrentRow and PrintSelectedRows to False to determine printing report for all records that are shown in the ReportDBGrid component.

_______

TXQRGrid.RecordCount

Indicates the number of printed records.

property RecordCount: Integer;

Description

Use RecordCount to determine the number of printed records. The value of RecordCount property is printed when you select rdRecordCount or rdRecordNoPerCount SysData . The RecordCount count only records that are really printed. To calculate value of RecordCount the report must be prepared. See also

PrepareNeeded .

_______

TXQRGrid.RecordNumber

Indicates the ordinal position of printed record.

property RecordNumber: Integer;

Description

Use RecordNumber to determine the ordinal position of printed record. The value of RecordNumber property is printed when you select rdRecordNo or rdRecordNoPerCount SysData or either when a column has property AutoNumber = True. The value of RecordNumber is incremented only for records that are really printed.

_______

TXQRGrid.ReportAlign

Determines how the report is aligned within the page.

type

TXReportAlign = (raLeft, raRight, raCenter, raStretch, raStretchAll);

property ReportAlign: TXReportAlign;

Description

Use ReportAlign to specify whether the report should be left-justified, right-justified, centered or stretched within the page. These are the possible values of ReportAlign:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

raLeft raRight

Align report to the left side of the page.

Align report to the right side of the page. raCenter Center report horizontally on the page. raStretch Stretch report horizontally on the whole page. raStretchAll

_______

Stretch all DBGrid's columns horizontally on the one page.

TXQRGrid.ReportBands

Describes all bands in the report.

property ReportBands: TXReportBands ;

Description

The ReportBands represents a container for bands created by XQRGrid component.

_______

TXQRGrid.ReportDBGrid

Specifies name of data-grid component to use as a base for report settings.

property ReportDBGrid: TXDBGrid ;

Description

Use ReportDBGrid to specify the name of the TXDBGrid component which will be used as a skeleton for the report.

_______

TXQRGrid.ReportNames

Determines how the report controls are named.

type

TXReportNames = (rnNone, rnClass, rnShort, rnLong);

property ReportNames: TXReportNames;

Description

Use ReportNames to specify naming convention for the report controls created by XQRGrid. These are the possible values of ReportNames:

Value Meaning

StripeColor value.

Select clNone value when the report should not be striped.

_______

TXQRGrid.CalcPageWidth

Calculates printer page with to fit to the width of printed grid.

procedure CalcPageWidth;

Description

Destroys an instance of TXQRGrid.

destructor Destroy; override;

Description

Do not call Destroy directly in an application. Instead, call Free. Free verifies that the component is not nil, and only then calls Destroy. Destroy frees all the helper objects used by the TXQRGrid.

_______

Shows the Printer Setup dialog for the report.

procedure PrinterSetup;

Description

Use PrinterSetup method to show Printer Setup dialog for the report. When roKeepPrinterSetup and/or roKeepDesignPrinterSetup option is included in Options , the changes made in Printer Setup dialog are saved to PrinterPage and PrinterSettings property. The PrinterSetup method is especially useful for designers and it's accessible from TXQRGrid component's popup menu.

_______

TXQRGrid.SaveReport

Saves the report definition to the file specified in FileName.

procedure SaveReport(const FileName: string);

Description

Use the SaveReport method to store report definition to the file(s) specified in FileName parameter. The

SaveReport method stores complete Delphi (ReportUnit.pas + ReportUnit.dfm) or C++Builder

(ReportUnit.cpp + ReportUnit.h + ReportUnit.dfm) module which can be opened in Delphi or C++Builder

IDE and added to the project as standalone unit. When FileName extension is ".pas" SaveReport creates the Delphi module. When FileName extension is ".cpp" SaveReport creates the C++Builder module.

Before you add the saved report to the project, you must change XReportForm.Name, because this class name is internaly used by TXQRGrid. The SaveReport method is especially useful for designers and is accessible from TXQRGrid component's popup menu.

The SaveReport method is available only in registered version of X-Files Components.

_______

TXQRGrid.SaveToFile

Saves the content of the report to the file specified in FileName.

procedure SaveToFile(const FileName: string; FilterClass: TQRExportFilterClass

= nil);

Description

Use the SaveToFile method to save the content of the report to the file specified in FileName parameter with using FilterClass export filter. The SaveToFile method can save content of report in following formats dependent on FilterClass parameter:

Value Format QuickReport unit

______________________________________________________________________________________________________________________________________________________________________________

nil

TQRAsciiExportFilter

QR file (*.qrp)

Text file (*.txt) QRExport - QR 3.x Std.

TQRCommaSeparatedFilter CSV file (*.csv) QRExport - QR 3.x Std.

QRExport - QR 3.x Std. TQRHTMLDocumentFilter HTML file (*.html)

TQRGHTMLDocumentFilter HTML file (*.html)

TQRXLSFilter Excel file (*.xls)

QRWebFilt - QR 3.6 Pro.

QRExport - QR 3.6 Pro.

TQRRTFExportFilter

TQRWMFExportFilter

TQRPDFDocumentFilter

TQRXDocumentFilter

_______

Occurs before the report is generated.

property BeforePrint: TQRReportBeforePrintEvent ;

Description

The BeforePrint event is called before the report is generated. See T

QuickRep.

BeforePrint for more information.

_______

TXQRGrid.OnPrint

Occurs when printable controls will be printed.

type

TQRPrintEvent = procedure(Sender: TObject; var Value: string) of object;

property OnPrint: TQRPrintEvent;

Description

The OnPrint event is called when a control like TQRLabel, TQRDBText, TQRExpr or TQRSysData will be printed. The Sender parameter identifies the control to be printed. You can change the text by changing the Value parameter. See TQRLabel.OnPrint

for more information.

_______

Specifies initial width of preview form.

property FormWidth: Integer;

Description

The FormWidth property represents initial width of preview form. When FormWidth is 0, the initail width of preview form is dependent on screen width.

Notice. The FormWidth property is accesible starting from QuickReport 3.6 Professional. For QuickReport

3.x Standard the FormWidth property are of no importance.

_______

See also: TXQRPreviewSettings.FormHeight

TXQRPreviewSettings.ShowSearch

Determines the search system is available in preview form.

property ShowSearch: Boolean;

Description

The ShowSearch property determines the search system is available in preview form.

Notice. The ShowSearch property is accesible starting from QuickReport 4.0 Professional. For

QuickReport 3.x Standard and Professional the ShowSearch property are of no importance.

_______

See also: TXQRPreviewSettings.ShowThumbs

TXQRPreviewSettings.ShowThumbs

Determines the thumbs are available in preview form.

property ShowThumbs: Boolean;

Description

The ShowThumbs property determines the thumbs are available in preview form.

Notice. The ShowThumbs property is accesible starting from QuickReport 4.0 Professional. For

QuickReport 3.x Standard and Professional the ShowThumbs property are of no importance.

_______

See also: TXQRPreviewSettings.ShowSearch

TXQRPreviewSettings.WindowState

Represents how the preview form appears on the screen.

property WindowState: TWindowState ;

Description

The WindowState property represents initial state of preview form window. Set WindowState to minimize or maximize the preview form window.

Notice. The WindowState property is accesible starting from QuickReport 3.6 Professional. For

QuickReport 3.x Standard the WindowState property are of no importance.

_______

TXQRPreviewSettings.ZoomState

Represents how the report appears in preview form.

type

TXQRZoomState = (zsFullPage, zsPageWidth, zsOriginalSize);

property ZoomState: TXQRZoomState;

Description

The ZoomState property represents initial state of report in preview form. These are the possible values of

ZoomState:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

zsFullPage zsPageWidth

Whole page of report is visible in preview form.

The report is scaled to the width of preview form. zsOriginalSize The report has original size (100 %).

Notice. The ZoomState property is accesible starting from QuickReport 4.0 Professional. For QuickReport

3.x Standard and Professional the ZoomState property are of no importance.

_______

See also: TXQRPreviewSettings.WindowState

TXQRPreviewSettings.Create

Creates and initializes an instance of TXQRPreviewSettings.

constructor Create;

Description

The Create constructor creates an instance of TXQRPreviewSettings. The user never need to call this method directly.

_______

TXReportBands

TXReportBands represents a container for TXReportBand objects.

Unit

Specifies custom settings for report controls which represent grid's titles.

property GridTitles: TXReportGridBand ;

Description

The GridTitles represents a container for custom settings for report controls which represents XDBGrid's titles.

_______

See also: TXReportBands.GridBands

, TXReportBands.GridColumns

, TXReportBands.GridHeaders

, TXReportBands.GridTotals

TXReportBands.GridTotals

Specifies custom settings for report controls which represent grid's totals.

property GridTotals: TXReportGridBand ;

Description

The GridTotals represents a container for custom settings for report controls which represents XDBGrid's totals. The totals of XDBGrid's columns can be specified in Report property.

_______

See also: TXReportBands.GridBands

, TXReportBands.GridColumns

, TXReportBands.GridHeaders

, TXReportBands.GridTitles

TXReportBands.GroupExpression

Determines when the group bands are printed.

Specifies settings for data printed in legend of the report.

property PageLegend: TXReportPageBand ;

Description

The PageLegend represents a container for properties which specify text and layout of report's legend.

The legend of the report is printed below totals of the columns and under page footer. If Options includes roAllPagesLegend, the PageLegend band is printed on all pages, otherwise the band is printed only on the last page.

_______

TXReportBands.PageTitle

Specifies settings for data printed in title of the report.

property PageTitle: TXReportPageBand ;

Description

The PageTitle represents a container for properties which specify text and layout of report's title. If Options includes roAllPagesTitle, the PageTitle band is printed on all pages, otherwise the band is printed only on the first page.

_______

TXReportBands.Create

Creates and initializes an instance of TXReportBands.

constructor Create;

Description

The Create constructor creates an instance of TXReportBands and all helper objects. The user never need to call this method directly.

_______

TXReportBands.Destroy

Destroys an instance of TXReportBands.

destructor Destroy; override;

Description

Destroy frees the helper objects of the TXReportBands before destroying the instance. The user never need to call this method directly.

_______

TXReportBand

TXReportBand represents single band in a report created by TXQRGrid.

Unit

XQRGrids

Description

TXReportBand introduces main properties for any band in a report created by TXQRGrid.

Do not create instances of TXReportBand. Use TXReportBand as a base class when declaring custom grid bands. TXReportBand is a base class for TXReportGridBand and TXReportPageBand .

_______

See also: TXReportBands , TXReportGridBand , TXReportPageBand

TXReportBand.Color

Specifies the background color for all report controls in the band.

property Color: TColor ;

Description

The Color property determines the background color for all report controls in the band. You can set Color to one of the constants defined in the Graphics unit (such as clBlue), or to an explicit RGB integer value.

Set Color to clNone to use default color depend on current ReportDBGrid settings.

_______

TXReportBand.Font

Specifies the font for all report controls in the band.

property Font: TFont ;

Description

The Font property points to a TFont object that determines typographic attributes of text for all report controls in the band. Set Font.Name to 'Default' to use default font depend on current ReportDBGrid settings. The rest of Font properties are ignored then.

_______

Determines when the band is visible in the report.

property Visible: TXReportVisible ;

Description

Set Visible property to determine when the band is visible in the report. Set Visible to rvAuto to set default visibility depend on current ReportDBGrid settings.

_______

TXReportBand.Create

Creates and initializes an instance of TXReportBand.

constructor Create(const AName: string);

Description

The Create constructor creates an instance of TXReportBand and all helper objects and initializes

• Color to clNone.

• Font.Color to clBlack.

• Font.Name to 'Default'.

• Name to AName.

• Visible to rvAuto.

_______

TXReportBand.Destroy

Destroys an instance of TXReportBand.

destructor Destroy; override;

Description

Destroy frees the helper objects of the TXReportBand before destroying the instance.

_______

TXReportGridBand

TXReportGridBand represents grid's band in a report created by TXQRGrid.

Unit

XQRGrids

Description

TXReportGridBand represents XDBGrid's band in the report. TXReportGridBand publishes many of the properties inherited from TXReportBand , but does not introduce any new behavior.

_______

TXReportTextBand

TXReportTextBand represents text band in a report created by TXQRGrid.

Unit

XQRGrids

Description

TXReportTextBand inherits main posibilities from TXReportBand and introduce new Text property.

TXReportTextBand is an ancestor for TXReportGroupBand and TXReportPageBand .

_______

TXReportTextBand.Text

Specifies the text that appears within the band.

property Text: TXReportText ;

Description

The Text represents a container for captions that appears within the band.

_______

TXReportTextBand.Create

Creates and initializes an instance of TXReportTextBand.

constructor Create(const AName: string);

Description

The Create constructor creates an instance of TXReportTextBand and all helper objects, calls inherited

Create constructor and initializes Color to clWhite.

Specifies a margin on the bottom side of the band.

property BandExtend: Integer;

Description

BandExtend specifies, in pixels, the margin that separates the bottom side of the band from the controls within it.

_______

TXReportPageBand.BandIndent

Specifies a margin on the top side of the band.

property BandIndent: Integer;

Description

BandIndent specifies, in pixels, the margin that separates the top side of the band from the controls within it.

_______

TXReportPageBand.Border

Specifies kind of the border drawn around the controls within a band.

type

TXReportBorder = (rbNone, rbSpace, rbFrame, rbTopLine, rbBottomLine);

property Border: TXReportBorder;

Description

Set the Border property to determine kind of border drawn around the controls. These are the possible values of Border:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

rbNone Nothing is drawn around the controls. rbSpace rbFrame

Invisible frame is drawn around the controls.

Rectangular frame is drawn around the controls.

rbTopLine rbBottomLine

_______

TXReportPageBand.Create

Creates and initializes an instance of TXReportPageBand.

constructor Create(const AName: string; AExtend, AIndent: Integer; ABorder:

TXReportBorder );

Description

The Create constructor creates an instance of TXReportPageBand, calls inherited Create constructor and initializes

• BandExtend to AExtend.

• BandIndent to AIndent.

• Border to ABorder.

_______

TXReportBandStyle

TXReportBandStyle represents common properties for all grid's bands.

Unit

XQRGrids

Description

TXReportBandStyle introduces common properties for all grid's bands in a report created by TXQRGrid.

Setting non-default values for any properties in this class override XDBGrid's settings that are used as default for a report creation.

_______

See also: TXReportStyle , TXReportBands.GridBands

TXReportBandStyle.Color

Specifies the background color that overrides default color for controls in all grid's bands.

property Color: TColor ;

Description

The Color property overrides default background color for controls in all grid's bands. You can set Color to one of the constants defined in the Graphics unit (such as clBlue), or to an explicit RGB integer value. Set

Color to clNone to return to default color depend on current ReportDBGrid settings.

_______

TXReportBandStyle.FontCharset

Specifies the character set of the font that overrides default character set for controls in all grid's bands.

TXReportText represents left, center and right captions in TXReportTextBand.

Unit

XQRGrids

Description

TXReportText introduces properties for captions that appears within the band.

_______

TXReportText.Caption

Specifies the captions that appear in the band.

property Caption[Index: Integer]: string;

Description

The Caption property contains text strings that appear at the left side (Index=0), at the right side (Index=1) and in the centre (Index=2) of the band. Instead Caption array property you may use LeftCaption ,

RightCaption or CenterCaption property. All specified captions are drawn transparently. Each Caption may follow a appropriate SysData .

_______

See also: TXReportText.SysData

, TXReportText.CenterCaption

, TXReportText.LeftCaption

, TXReportText.RightCaption

TXReportText.CenterCaption

Specifies the text that is centered in the band.

property CenterCaption: string;

Description

The CenterCaption property contains a text string that is centered in the band. See Caption property for more information.

_______

See also: TXReportText.Caption

, TXReportText.LeftCaption

, TXReportText.RightCaption

TXReportText.CenterSysData

Specifies the system information that is centered in the band.

property CenterSysData: TXReportSysData ;

Description

The CenterSysData property contains the system information that is centered in the band. See SysData property for more information.

_______

See also: TXReportText.SysData

, TXReportText.LeftSysData

, TXReportText.RightSysData

TXReportText.LeftCaption

Specifies the text that appears at the left side of the band.

property LeftCaption: string;

Description

The LeftCaption property contains a text string that appears at the left side of the band. See Caption property for more information.

_______

See also: TXReportText.Caption

, TXReportText.CenterCaption

, TXReportText.RightCaption

TXReportText.LeftSysData

Specifies the system information that appears at the left side of the band.

property LeftSysData: TXReportSysData ;

Description

The LeftSysData property contains the system information that appears at the left side of the band. See

SysData property for more information.

_______

See also: TXReportText.SysData

, TXReportText.CenterSysData

, TXReportText.RightSysData

TXReportText.QRField

Identifies the QuickReport's control when the report is created.

property QRField[Index: Integer]: TQRCustomLabel ;

Description

The QRField property is used internaly by TXQRGrid to identify QuickReport's control created upon

Caption and SysData definition. You may use this property only inside XQRGrid's event handler.

_______

See also: TXReportText.Caption

, TXReportText.SysData

TXReportText.RightCaption

Specifies the text that appears at the right side of the band.

property RightCaption: string;

Description

The RightCaption property contains a text string that appears at the right side of the band. See Caption property for more information.

_______

See also: TXReportText.Caption

, TXReportText.CenterCaption

, TXReportText.LeftCaption

TXReportText.RightSysData

Specifies the system information that appears at the right side of the band.

property RightSysData: TXReportSysData ;

Description

The RightSysData property contains the system information that appears at the right side of the band. See

SysData property for more information.

_______

See also: TXReportText.SysData

, TXReportText.CenterSysData

, TXReportText.LeftSysData

TXReportText.SysData

Specifies the system informations that appear in the band.

type

TXReportSysData = (rdTime, rdDate, rdDateTime, rdPageNumber, rdReportTitle, rdDetailCount, rdDetailNo, rdNone, rdPartNo, rdPartCount, rdPartNoPerCount, rdExpression, rdGrowExpression, rdRecordNo, rdRecordCount, rdRecordNoPerCount, rdPageCount, rdPageNoPerCount, rdCustomNo, rdCustomCount, rdCustomNoPerCount);

property SysData[Index: Integer]: TXReportSysData;

Description

The SysData property contains system informations that appear at the left side (Index=0), at the right side

(Index=1) and in the centre (Index=2) of the band. Instead SysData array property you may use

LeftSysData , RightSysData or CenterSysData property. All specified system informations are drawn transparently. Each SysData may be followed by appropriate Caption . These are the possible values of

SysData:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

rdTime Current time.

Current date. rdDate rdDateTime rdPageNumber rdReportTitle

Current date and time.

Number of page that is printed.

Value of ReportTitle property. rdDetailCount rdDetailNo rdNone

Count of records in the DataSet.

Number of record that is printed.

Nothing.

rdPartNo rdPartCount rdPartNoPerCount rdExpression

Number of vertical band that is printed.

Count of vertical bands in the report.

Number of vertical band per count of bands.

The QuickReport's expression specified in Caption . Value of expression is

ResetAfterPrint . rdGrowExpression The QuickReport's expression specified in Caption . Value of expression is

NOT ResetAfterPrint . rdRecordNo rdRecordCount rdRecordNoPerCount rdPageCount

Ordinal position of printed record (

Count of printed records (

Count of printed pages (

RecordNumber

RecordCount

PageCount ).

Ordinal position of printed record per count of printed records. rdPageNoPerCount rdCustomNo

Number of page that is printed per count of printed pages.

Number of record selected by developer ( CustomNumber ). rdCustomCount Count of records selected by developer ( CustomCount ). rdCustomNoPerCount Number of record per count of records selected by developer.

_______

See also: TXReportText.Caption

, TXReportText.CenterSysData

, TXReportText.LeftSysData

, TXReportText.RightSysData

TXReportText.Create

Creates and initializes an instance of TXReportText.

constructor Create;

Description

The Create constructor creates an instance of TXReportText and initializes

• Caption array to ''.

• SysData array rdNone.

_______

TXReportStyle

TXReportStyle represents common properties for all controls in the report created by TXQRGrid.

Unit

• TextColIndent to 1.

• TextColExtend to 1.

• TextRowIndent to 1.

• TextRowExtend to 0.

• ColLines to rvAuto.

• RowLines to rvAuto.

_______

TXReportVisible type

Determines whether an element is visibled in the report.

Unit

XQRGrids

type

TXReportVisible = (rvFalse, rvTrue, rvAuto);

Description

The following are possible values of TXReportVisible:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

rvFalse rvTrue

Element is never visibled in the report.

Element is always visibled in the report. rvAuto Element is visibled in the report if it's just visibled in ReportDBGrid component.

_______

TXDBColumnsDialog

TXDBColumnsDialog displays a column-selection dialog.

Unit

XDBLists

Description

TXDBColumnsDialog displays a modal dialog box for selecting columns. The dialog does not appear at runtime until it is activated by a call to the Execute method. When the user clicks OK or Apply, the dialog closes and the selected columns are marked as "Visible" in the linked DBGrid component. See also

DialogOptions .

_______

See also: TXDBPrintColumnsDialog , TXColumn.DialogOptions

TXDBColumnsDialog.BorderStyle

Determines whether the dialog has a single line border around the columns list.

property BorderStyle: TBorderStyle ;

Description

Use BorderStyle to affect the sharpness. BorderStyle can have a value of either bsSingle or bsNone. If

BorderStyle is bsSingle, the dialog has a single-line border around the columns list. If BorderStyle is bsNone, there will be no border.

_______

TXDBColumnsDialog.ButtonsTitles

Specifies the titles that appear on the buttons.

property ButtonsTitles: string;

Description

Use ButtonsTitles to specify the titles that appear on the buttons in dialog box. Each caption is separated by semicolon. The default value for ButtonsTitles is

'OK;Cancel;&Apply;&Help'.

_______

See also: TXDBColumnsDialog.ColumnsTitle

, , TXDBColumnsDialog.SortedTitle

, TXDBColumnsDialog.Title

TXDBColumnsDialog.ColumnsTitle

Specifies the title caption for the columns list.

property ColumnsTitle: string;

Description

Use ColumnsTitle to set the title caption for the columns list.

_______

See also: TXDBColumnsDialog.ButtonsTitles

, , TXDBColumnsDialog.SortedTitle

, TXDBColumnsDialog.Title

TXDBColumnsDialog.DBGrid

Specifies name of data-grid component to use in columns dialog.

property DBGrid: TXDBGrid ;

Description

Use DBGrid to specify the name of the TXDBGrid component which columns should appear on list in dialog box.

_______

See also: TXDBGrid

TXDBColumnsDialog.DefaultCount

Specifies the default count of list items that are visibled in the dialog box.

property DefaultCount: Integer;

Description

Use DefaultCount to specify count of list items visibled in the dialog box. DefaultCount can't be less then

MinimumCount .

_______

See also: TXDBColumnsDialog.DefaultWidth

, TXDBColumnsDialog.MinimumCount

TXDBColumnsDialog.DefaultWidth

Specifies the default width for the dialog box.

property DefaultWidth: Integer;

Description

Use DefaultWidth to specify width of dialog box. If DefaultWidth is 0, width of dialog box is depend on buttons that are visibled in dialog box. DefaultWidth can't be less then MinimumWidth .

_______

See also: TXDBColumnsDialog.DefaultCount

, TXDBColumnsDialog.MinimumWidth

TXDBColumnsDialog.HelpContext

Specifies the context number for online Help

property HelpContext: THelpContext ;

Description

The HelpContext property is an integer value that determines which Help screen appears when the user requests context-sensitive online Help.

_______

TXDBColumnsDialog.MinimumCount

Specifies the minimum count of list items that are visibled in the dialog box.

property MinimumCount: Integer;

Description

Use MinimumCount to specify then minimum count of list items visibled in the dialog box. MinimumCount must be less then DefaultCount and can't be less then 4 items.

_______

See also: TXDBColumnsDialog.MinimumWidth

, TXDBColumnsDialog.DefaultCount

TXDBColumnsDialog.MinimumWidth

Specifies the minimum width for the dialog box when it's resized.

property MinimumWidth: Integer;

Description

Use MinimumWidth to specify then minimum width of dialog box. If MinimumWidth is 0, the minimum width of dialog box is depend on buttons that are visibled in dialog box. MinimumWidth must be less then

DefaultWidth .

_______

See also: TXDBColumnsDialog.MinimumCount

, TXDBColumnsDialog.DefaultWidth

TXDBColumnsDialog.Options

Determines the appearance and behavior of the column-selection dialog.

type

TXDBColumnsOption = (coAllowMoving, coAutoUpdate, coCancelButton, coApplyButton, coHelpButton, coMarkPrintedCols, coMarkVisibleCols, coShowEmptyCols, coShowFixedCols, coShowHeaders, coShowSorted ); {* ver.

6.1 *}

TXDBColumnsOptions = set of TXDBColumnsOption;

property Options: TXDBColumnsOptions;

Description

Use the Options property to customize the appearance and functionality of the dialog. See also

DialogOptions property. The possible values of Options are:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

coAllowMoving User can move items on columns list. coAutoUpdate All changes made on columns list are automatically moved to the DBGrid component. coCancelButton Displays a Cancel button in the dialog.

Displays an Apply button in the dialog. coApplyButton coHelpButton coMarkPrintedCols coMarkVisibleCols coShowEmptyCols coShowFixedCols coShowHeaders

Displays a Help button in the dialog.

Columns

Visibled

in the report are initialy checked on columns list.

in the DBGrid are initialy checked on columns list.

Columns with empty FieldName property also appear on columns list.

Fixed columns appear on columns list.

Columns captions are followed by headers captions. coShowSorted Columns list can be sorted. Sorted check box is visible.

{* ver. 6.1 *}

_______

TXDBColumnsDialog.SortedTitle

Specifies the title caption for the sorted check box.

property SortedTitle: string; {* ver. 6.1 *}

Description

Use SortedTitle to set the caption for the sorted check box.

_______

See also: TXDBColumnsDialog.ButtonsTitles

, TXDBColumnsDialog.ColumnsTitle

, TXDBColumnsDialog.Title

TXDBColumnsDialog.Title

Specifies the title caption for the dialog box.

property Title: string;

Description

Use Title to set the title caption for the dialog box.

_______

See also: TXDBColumnsDialog.ButtonsTitles

, TXDBColumnsDialog.ColumnsTitle

, TXDBColumnsDialog.SortedTitle

TXDBColumnsDialog.Create

Creates and initializes a TXDBColumnsDialog instance.

constructor Create(AOwner: TComponent );

Description

Call Create to instantiate a columns dialog component at runtime. Dialogs added to forms at design time are created automatically. The dialog box does not appear on the screen at runtime until the Execute method is called.

_______

TXDBColumnsDialog.Execute

Displays the column-selection dialog.

function Execute: Boolean;

Description

Execute opens the column-selection dialog, returning True when the user clicks OK. If the user clicks

Cancel, Execute returns False.

After the dialog box opens captions of DBGrid 's columns appear on list. User can click on checkbox to select or unselect a column. User can also move a column to other place by using drag & drop or by using arrows with Shift key. When the user clicks OK or Apply button the changes made in column-selection dialog are moved to the DBGrid component. When the user clicks Cancel button no changes are made in

DBGrid component.

The current functionality of column-selection dialog depend on Options property.

_______

TXDBColumnsDialog.OnApply

Occurs when the user clicks OK or Apply button.

property OnApply: TNotifyEvent ;

Description

Use an OnApply event handler to apply changes the user made in additional controls added to the dialog box in OnCreate event handler. The OnApply event occurs when changes should be stored in DBGrid component.

The functions maintained by this dialog are stored automatically before OnApply event occurs. When coAutoUpdate option is included in Options the OnApply event handler is called every time when the user made any changes. See Demo1 example to know more.

Notice! As Sender is passed dialog form (TXDBColumnsForm).

_______

TXDBColumnsDialog.OnClose

Occurs when the dialog closes.

property OnClose: TNotifyEvent ;

Description

Write an OnClose event handler to perform special processing when the dialog closes.

Notice! As Sender is passed dialog form (TXDBColumnsForm).

_______

TXDBColumnsDialog.OnCreate

Occurs when a XDBColumnsDialog component instantiates a dialog box.

property OnCreate: TNotifyEvent ;

Description

Write an OnCreate event handler to take specific actions when a XDBColumnsDialog component instantiates a dialog box. For example, you may add in run-time a custom controls to the CustomPanel in the dialog box. See Demo1 example to know more.

Notice! As Sender is passed dialog form (TXDBColumnsForm).

_______

TXDBColumnsDialog.OnShow

Occurs when the dialog opens.

property OnShow: TNotifyEvent ;

Description

Write an OnShow event handler to perform special processing when the dialog box is displayed. For example, you can made any changes on columns list. See XFilesDemo1 example to know more.

Notice! As Sender is passed dialog form (TXDBColumnsForm).

_______

TXDBPrintColumnsDialog

TXDBPrintColumnsDialog displays a print-column-selection dialog.

Unit

XDBLists

Description

TXDBPrintColumnsDialog displays a modal dialog box for selecting columns. The dialog does not appear at runtime until it is activated by a call to the Execute method. When the user clicks OK, the dialog closes and the selected columns are marked as "Printed" in the linked DBGrid component. See also

DialogOptions .

_______

See also: TXDBColumnsDialog , TXColumnReport.DialogOptions

TXBlobField

TXBlobField represents an extended TBlobField.

Unit

XDBFields

Description

TXBlobField extends functionality of TBlobField to achieve assignment compatibility between BLOB field and TPicture class for another graphic formats.

TBlobField supports only TBitmap graphic assignment. TXBlobField can assign from TPicture (and

AssignTo TPicture) additionally TIcon , TMetafile , TJPEGImage and any other TGraphic class descendant recognized by GraphicClass .

The new functionality allows directly using TImage , TDBImage , TQRImage , TQRDBImage with any graphic format stored in BLOB fields (*.bmp, *.ico, *.wmf, *.emf, *.jpg and other supported by

GraphicClass).

TXBlobField is the direct ancestor of TXGraphicField .

Notice. To can using TXBlobField as default BLOB field you must have Professional version of the package (with source) recompiled with

{$DEFINE XDBFIELDS}

switch in XDBFields.pas unit. All new

BLOB fields added in Fields Editor will be created then as TXBlobField, but you must to replace

TBlobField with TXBlobField in existing *.dfm & *.pas files.

_______

TXBlobField.Assign

Copies a value to the BLOB field.

procedure Assign(Source: TPersistent ); override;

Description

Use Assign to copy data to the BLOB field. TXBlobField.Assign extends TBlobField.

Assign .

TBlobField supports only TBitmap graphic assignment. TXBlobField can assign from TPicture (and

AssignTo TPicture) additionally TIcon , TMetafile , TJPEGImage and any other TGraphic class descendant recognized by GraphicClass .

The new functionality allows directly using TImage , TDBImage , TQRImage , TQRDBImage with any graphic format stored in BLOB fields (*.bmp, *.ico, *.wmf, *.emf, *.jpg and other supported by

GraphicClass).

_______

TXBlobField.GraphicClass

Recognizes graphic stored in BLOB field.

function GraphicClass: TGraphicClass ;

Description

GraphicClass function return the class reference for TGraphic appropriate to the current contents of the

BLOB field. GraphicClass return result of FieldGraphicClass global function.

_______

TXGraphicField

TXGraphicField represents an extended TGraphicField.

Unit

XDBFields

Description

TXGraphicField extends functionality of TGraphicField to achieve assignment compatibility between graphic BLOB field and TPicture class for another graphic formats.

TGraphicField supports only TBitmap graphic assignment. TXGraphicField can assign from TPicture (and

AssignTo TPicture) additionally TIcon , TMetafile , TJPEGImage and any other TGraphic class descendant recognized by GraphicClass .

The new functionality allows directly using TImage , TDBImage , TQRImage , TQRDBImage with any graphic format stored in graphic BLOB fields (*.bmp, *.ico, *.wmf, *.emf, *.jpg and other supported by

GraphicClass). Starting from RAD Studio 2010 the graphic format *.png and *.gif are also supported without using of GraphicEx library.

{* ver. 5.4 *}

TXGraphicField differs from its immediate ancestor TXBlobField only in having a DataType of ftGraphic.

Notice. To can using TXGraphicField as default graphic BLOB field you must have Professional version of the package (with source) recompiled with

{$DEFINE XDBFIELDS}

switch in XDBFields.pas unit. All new graphic BLOB fields added in Fields Editor will be created then as TXGraphicField, but you must to replace TGraphicField with TXGraphicField in existing *.dfm & *.pas files.

_______

TXGraphicField.Create

Creates an instance of TXGraphicField.

constructor Create(AOwner: TComponent );

Description

Create sets the DataType property to ftGraphic. The AOwner parameter specifies the component, typically a dataset, that becomes the new field's Owner. The Owner is responsible for freeing the component.

_______

FieldGraphicClass function

Recognizes graphic stored in BLOB field.

Unit

XDBFields

function FieldGraphicClass(Field: TField ): TGraphicClass ;

Description

FieldGraphicClass function return the class reference for TGraphic appropriate to the current contents of the BLOB field. When the type of graphic (bitmap, icon, metafile or jpeg) is known, FieldGraphicClass return its specific type object ( TBitmap , TIcon , TMetafile or TJPEGImage ). Otherwise, FieldGraphicClass return Nil.

TXDBGrid component can directly display graphics (stored in BLOB fields) of any format supported by this function (when DataType of BLOB field is ftGraphic). FieldGraphicClass function supports by default

*.bmp, *.ico, *.wmf, *.emf & *.jpg graphics. Starting from RAD Studio 2010 the graphic format *.png and

*.gif are also supported without using of GraphicEx library.

{* ver. 5.4 *}

If you have Professional version of the package, you can recompile the package with

{$DEFINE

GraphicEx}

switch in XDBFields unit. It allows you to store and recognize in BLOB field other graphic formats supported by GraphicEx library (*.png, *.pcx, *.scr, *.gif, *.tif, *.eps, etc.). This library was written by Mike Lischke and is distributed under Mozilla Public Licence. You can download GraphicEx library from http://www.soft-gems.net/ .

You can also use the functionality of FieldGraphicClass for TImage , TDBImage , TQRImage ,

TQRDBImage components, but first you must to replace TBlobField & TGraphicField with TXBlobField &

TXGraphicField classes.

_______

TXFGradient

TXFGradient specifies the gradient drawing style for a control.

Unit

XFSGraph

Description

TXFGradient class is a fundamental class of gradient drawing style. It holds all properties and methods needed to realize gradient drawing for X-Files controls.

_______

See also: TXFGradientButton , TXFGradientBackground , TXFGradientProgress

TXFGradient.Active

Specifies whether or not the gradient drawing should be in use.

property Active: Boolean;

Description

Use Active to determine or set whether the gradient drawing should be in use. When Active is True

(default) gradient drawing may be in use. When Active is False gradient drawing is disabled. See also

IsActive function to read when gradient drawing is really in use.

_______

TXFGradient.Cells

Specifies the grid's data cells for gradient drawing.

type

TXFGradientCell = (gcSelectedCell, gcSelectedRow, gcMultiSelected, gcStripedRows);

TXFGradientCells = set of TXFGradientCell;

property Cells: TXFGradientCells; {* ver. 5.0 *}

Description

Use the Cells property to customize the appearance of the grid's data cells with using gradient color. The possible values of Cells are:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

gcSelectedCell Draw gradient color for selected (focused) cell in the grid. See also:

SelectCellColor

Draw gradient color for selected (current) row. See also: SelectRowColor gcSelectedRow gcMultiSelected gcStripedRows

_______

TXFGradient.Direction

Specifies the direction of gradient drawing.

type

TXFGradientDirection = (gdHorizontal, gdVertical);

// For

C++Builder/Delphi 5, 6, 7

TXFGradientDirection = GraphUtil.TGradientDirection;

// For Delphi 8 or higher

property Direction: TXFGradientDirection;

Description

Use Direction to determine direction of gradient drawing. When Direction is gdHorizontal the gradient is filling from top to botton of an area. When Direction is gdVertical the gradient is filling from left to right of an area. You can revert the direction of gradient filling (from bottom to top or from right to left) by using

SwapColors property.

_______

TXFGradient.EndColor

Specifies the final color for gradient area.

property EndColor: TColor ;

Description

Set EndColor to determine final color for gradient area when gradient drawing IsActive . The default value of EndColor property is clDefault. It means that original color of the area will be used as gradient

EndColor. Change EndColor property only when you want to use different colors for gradient and nongradient drawing. The initial color of gradient area is determined by StartColor property.

_______

See also: TXFGradient.HotColor

, TXFGradient.StartColor

, TXFGradient.StepColor

TXFGradient.HotColor

Specifies the color for gradient hot buttons.

property HotColor: TColor ;

Description

Set HotColor to determine hot color for gradient buttons when gradient hot button drawing IsHotActive .

The default value of HotColor property is clDefault. It means that DefaultHotColor will be used as gradient

HotColor. The initial hot color for gradient hot buttons is determined by StartColor property.

_______

TXFGradient.Options

Determines the appearance of gradient elements.

type

TXFGradientOption = (goGradient, goHotButton, goHotTrack, goHotColor);

TXFGradientOptions = set of TXFGradientOption;

property Options: TXFGradientOptions;

Description

Use the Options property to customize the appearance of gradient elements. The possible values of

Options are:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

goGradient Draw gradient element. goHotButton goHotTrack

Draw gradient hot button.

Draw hot track around element. goHotColor

_______

Use HotColor for hot button and/or hot track.

TXFGradient.ShadowFactor

Specifies the shadow factor for gradient drawing.

property ShadowFactor: Integer; {* ver. 5.1 *}

Description

Set ShadowFactor to determine luminance for gradient drawing. The default value of ShadowFactor is -

25. The value of ShadowFactor determines the final color of gradient for EndColor , HotColor and

StepColor property. Set ShadowFactor to 0, to use directly base color as final color of gradient.

_______

TXFGradient.StartColor

Specifies the initial color for gradient area.

property StartColor: TColor ;

Description

Set StartColor to determine initial color for gradient area when gradient drawing IsActive . The default value of StartColor property is clWindow. The final color of gradient area is determined by EndColor ,

HotColor or StepColor property.

_______

See also: TXFGradient.HotColor

, TXFGradient.EndColor

, TXFGradient.StepColor

TXFGradient.StepColor

Specifies the color for gradient progress bars.

property StepColor: TColor ;

Description

Set StepColor to determine final color for gradient progress bar when gradient drawing IsActive . The default value of StepColor property is clDefault. It means that original progress bar color will be used as gradient StepColor. Change StepColor property only when you want to use different colors for gradient and non-gradient progress bar drawing. The initial color of gradient progress bar is determined by

See also: TXFGradient.HotColor

, TXFGradient.IsHotActive

TXFGradient.FillBack

Fills background of the specified rectangle on the canvas using gradient colors.

procedure FillBack(Canvas: TCanvas ; Rect: TRect ; Color: TColor ; BevelWidth,

SpaceWidth: Integer; HotButton: Boolean = False; DownButton: Boolean =

False; SoftButton: Boolean = False); virtual;

Description

Use FillBack to fill background of a rectangular region on the Canvas using gradient colors. The Rect region decreased by BevelWidth is filled from top to boottom ( Direction =gdVertical) or from left to right

(Direction=gdHorizontal) with using StartColor and EndColor . When EndColor is clDefault the Color parameter will be used instead EndColor. The Rect region decreased by BevelWidth + SpaceWidth is treats as transparent area. It means, that only the background of this area is filled with using gradient colors. The foreground pixels are not changed. The Color parameter determines the background color.

When HotBotton parameter is True the "hot" Options will be respected. When DownButton is True the shadow color will be used for hot button.

_______

TXFGradient.FillCanvas

Fills the specified rectangle on the canvas using gradient colors.

class procedure FillCanvas(Canvas: TCanvas ; StartColor, EndColor: TColor ;

const Rect: TRect ; Direction: TXFGradientDirection ); {* ver. 5.1 *}

Description

Use FillCanvas to fill a rectangular region on the Canvas using gradient colors. The Rect region is filled from top to boottom (Direction=gdVertical) or from left to right (Direction=gdHorizontal) with using

StartColor and EndColor parameters.

_______

TXFGradient.FillCell

Fills background of the specified rectangle on the canvas using gradient colors.

procedure FillCell(Canvas: TCanvas ; Rect: TRect ; Color: TColor ; Flat: Boolean

= False {* ver. 5.1 *} ); virtual; {* ver. 5.0 *}

Description

Use FillCell to fill background of a rectangular region on the Canvas using gradient colors. The Rect region is always filled from top to bottom with using Color parameter. When Flat parameter is True, the region is filled with using regular color.

_______

See also: TXFGradient.FillBack

, TXFGradient.FillRect

, TXFGradient.FillStep

TXFGradient.FillRect

Fills the specified rectangle on the canvas using gradient colors.

procedure FillRect(Canvas: TCanvas ; Rect: TRect ; Color: TColor ; HotButton:

Boolean = False; DownButton: Boolean = False); virtual;

Description

Use FillRect to fill a rectangular region on the Canvas using gradient colors. The Rect region is filled from top to boottom ( Direction =gdVertical) or from left to right (Direction=gdHorizontal) with using StartColor and EndColor . When EndColor is clDefault the Color parameter will be used instead EndColor.

When HotBotton parameter is True the "hot" Options will be respected. When DownButton is True the shadow color will be used for hot button.

_______

See also: TXFGradient.FillBack

, TXFGradient.FillCell

, TXFGradient.FillStep

, TXFGradient.Options

, TXFGradient.EndColor

TXFGradient.StartColor

TXFGradient.FillStep

Fills parts of the specified rectangle on the canvas using gradient colors.

procedure FillStep(Canvas: TCanvas ; Rect: TRect ; Color: TColor ; BevelWidth,

SpaceWidth: Integer; HotButton: Boolean = False; DownButton: Boolean =

False; SoftButton: Boolean = False); virtual;

Description

Use FillStep to fill parts of a rectangular region on the Canvas using gradient colors. The Rect region decreased by BevelWidth is filled from top to boottom ( Direction =gdVertical) or from left to right

(Direction=gdHorizontal) with using StartColor and StepColor . When StepColor is clDefault the Color parameter will be used instead StepColor. The Rect region decreased by BevelWidth + SpaceWidth is treats as transparent area. It means, that only the parts of this area are filled with using gradient colors.

The other pixels are not changed. The Color parameters determines the color of these areas.

When HotBotton parameter is True the "hot" Options will be respected. When DownButton is True the shadow color will be used for hot button.

_______

See also: TXFGradient.FillBack

, TXFGradient.FillCell

, TXFGradient.FillRect

, TXFGradient.StepColor

, TXFGradient.StartColor

TXFGradient.FillStyleBack

Fills background of the specified rectangle on the canvas using gradient colors of Custom Style.

procedure FillStyleBack(Canvas: TCanvas ; Rect: TRect ; Color: TColor ;

BevelWidth, SpaceWidth: Integer; HotButton: Boolean = False; DownButton:

Boolean = False; SoftButton: Boolean = False); virtual; {* ver. 5.1 *} //

For C++Builder/Delphi XE2 or higher

Description

Use FillStyleBack to fill background of a rectangular region on the Canvas using gradient colors of Custom

Style. The Rect region decreased by BevelWidth is filled from top to boottom ( Direction =gdVertical) or from left to right (Direction=gdHorizontal) with using colors corresponding to selected Custom Style. The

Rect region decreased by BevelWidth + SpaceWidth is treats as transparent area. It means, that only the background of this area is filled with using gradient colors. The foreground pixels are not changed. The

Color parameter determines the background color.

The HotBotton and DownButton parameters determine "hot" and "pressed" state of gradient colors in

StyleServices.

_______

See also: TXFGradient.FillBack

, TXFGradient.FillStyleRect

TXFGradient.FillStyleRect

Fills the specified rectangle on the canvas using gradient colors of Custom Style.

procedure FillStyleRect(Canvas: TCanvas ; Rect: TRect ; Color: TColor ); virtual;

{* ver. 5.1 *} // For C++Builder/Delphi XE2 or higher

Description

Use FillStyleRect to fill a rectangular region on the Canvas using gradient colors of Custom Style. The

Rect region is filled from top to boottom ( Direction =gdVertical) or from left to right (Direction=gdHorizontal) with using Color parameter corresponding to the selected Custom Style.

_______

TXFGradient.IsActive

Specifies whether or not the gradient drawing is in use.

function IsActive(AllowForThemes: Boolean = False): Boolean;

Description

Check IsActive to determine when the gradient drawing is in use. IsActive return True when gradient library IsAvailable , GradientEnabled global variable is True and Active property is True. If

AllowForThemes parameter is False the result of this function can be True only when ThemesEnabled is

False. When IsActive return False the gradient drawing is currently disabled for the control.

_______

TXFGradient.IsAvailable

Specifies whether or not the gradient library is available.

function IsAvailable: Boolean;

Description

Check IsAvailable to determine the gradient library is available. TXFGradient class uses system

GradientFill procedure from msimg32.dll

library. This library may be not available on Windows 95 and

Windows NT. In that case IsAvailable function return False and gradient drawing is disabled but the application can properly work.

_______

TXFGradient.IsHotActive

Specifies whether or not the gradient hot button is in use.

function IsHotActive(AllowForThemes: Boolean = False) {* ver. 5.1 *} : Boolean;

Description

Check IsHotActive to determine is gradient hot button in use. This function return True when IsActive is

True and one (or more) of the following option is included in Options : goHotButton, goHotTrack, goHotColor. When AllowForThemes parameter is True, it means that gradient drawing is used also when

ThemesEnabled is True.

_______

TXFGradient.ShadowColor

Returns the shadow color with a specific factor.

class function ShadowColor(Color: TColor; Factor: Integer): TColor ; {* ver.

5.1 *}

Description

ShadowColor function returns the shadow color with a specific factor. Color parameter represents the base color. Factor parameter represents the luminance. The negative value of Factor determines a darker color. The positive value of Factor determines a brighter color.

_______

TXFGradient.SwitchOptions

Include or exclude Options depending on State.

procedure SwitchOptions(Part: TXFGradientOptions ; State: Boolean); {* ver. 6.0

Description

Use SwitchOptions to include or exclude the Part of Options property. When State is True the Part options are included, otherwise excluded.

_______

See also: TXCustomDBGrid.SwitchOptions

Determines gradient drawing style using for all X-Files controls.

Unit

XFSGraph

var

GradientEnabled: Boolean = True;

Description

GradientEnabled global variable determines using gradient drawing style for all X-Files controls in whole application. By default gradient drawing style is enabled. You can set GradientEnabled to False in main module of application to suppress gradient drawing in whole application. When GradientEnabled is False the IsActive function always return False for each TXFGradient object.

_______

See also: ThemesEnabled , TXFGradient.IsActive

IsVista function

Determines Windows Vista (or newer) platform.

Unit

XFSGraph

function IsVista: Boolean;

Description

IsVista function determines Windows Vista platform. The result is True when you run an application on

Windows Vista (or newer) platform otherwise the function returns False.

_______

StylesEnabled function

Determines using Custom Styles in an application.

Unit

XFSGraph

function StylesEnabled: Boolean; inline; {* ver. 5.1 *} // For

C++Builder/Delphi XE2 or higher

Description

StylesEnabled function determines using Custom Styles in an application. This function is available starting from RAD Studio XE2. Result of StylesEnabled is depend on current result of

TStyleManager.IsCustomStyleActive function and

{$DEFINE STYLES}

conditional switch using to build the package. When

{$UNDEF STYLES}

switch was defined, StylesEnabled function always return False.

You can change

{$DEFINE STYLES}

switch in Conditionals.pas include file and rebuild package when you have the professional version of the package. By default this switch is defined starting from RAD

Studio XE2.

_______

ThemesEnabled function

Determines using Windows Themes for specified control.

Unit

XFSGraph

function ThemesEnabled(Control: TControl = nil): Boolean;

Description

ThemesEnabled function determines using Windows Themes for specified control. When Control parameter is nil the result of ThemesEnabled is depend on current result of

ThemeServices.ThemesEnabled function and

{$DEFINE THEMES}

conditional switch using to build the package. When

{$UNDEF THEMES}

switch was defined, ThemesEnabled function always return False.

Since Delphi 2007 the Control parameter is required to obtain correct result in design-time for specified

Control. The result depends on "Enable runtime themes" check box state in Project Options -> Application settings. In run-time or when Control parameter is nil the function always returns result of

ThemeServices.ThemesEnabled function.

You can change

{$UNDEF THEMES}

switch in Conditionals.pas include file and rebuild package when you have the professional version of the package. By default this switch is undefined for

Delphi/C++Builder 5 & 6 and defined for Delphi 7 or higher.

_______

See also: GradientEnabled , TXFGradient.IsActive

TButtonDrawingStyle type

Specifies using drawing style for a button.

Unit

XFSGraph

type

TButtonDrawingStyle = (bdsClassic, bdsThemed, bdsGradient); {* ver. 5.1 *}

Description

The following are possible values of TButtonDrawingStyle:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

bdsClassic bdsThemed

The button control uses the standard, unthemed style.

The button control uses the current operating system theme. bdsGradient

_______

TFineTheme type

Specifies using additional themes under Windows XP.

Unit

XFSGraph

type

TFineTheme = (ftNoChange, ftBorder, ftUnderline);

Description

The following are possible values of TFineTheme:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

ftNoChange ftBorder

Do not change default theme.

Use ToolButton's theme with yellow border for hot state. ftUnderline

_______

ClearBackground function

Clears background of the control.

Unit

XFSGraph

function ClearBackground(Control: TWinControl ; DC: HDC): HGDIOBJ;

Description

ClearBackground performs clear background when the Control is paint. You not need to call this function directly.

_______

SetupParentBackground function

Specifies csParentBackground control style.

Unit

XFSGraph

procedure SetupParentBackground(Control: TControl ; Value: Boolean = True);

Description

SetupParentBackground includes (Value=True) or excludes (Value=Fale) csParentBackground attribute to

ControlStyle characteristics of the Control. You not need to call this procedure directly.

_______

ControlNeedsInvalidate function

Determines does the control needs Invalidate for gradient background.

Unit

XFSGraph

function ControlNeedsInvalidate(Control: TControl ): Boolean;;

Description

ControlNeedsInvalidate determines does the Control needs Invalidate when the control's parent is using gradient drawing style. For ThemesEnable =True, the result of this function is True when csParentBackground attribute is included in ControlStyle . For ThemesEnabled =False, the result of this function is True when the Control has Transparent published property or either the Control has Gradient and ParentBackground published property and the value of ParentBackground is True. You not need to call this function directly.

_______

NeedsInvalidate variable

Points to currently using ControlNeedsInvalidate function.

Unit

XFSGraph

type

TControlNeedsInvalidate = function(Control: TControl ): Boolean;

var

NeedsInvalidate: TControlNeedsInvalidate = ControlNeedsInvalidate ;

Description

NeedsInvalidate variable points to currently using ControlNeedsInvalidate function. X-Files controls call this function to check does the Control needs Invalidate when the control's parent is using gradient drawing style.

_______

TXFButton

TXFButton is a gradient push button control.

Unit

XFSCtrls

Description

Use TXFButton to put a gradient push button on a form. TXFButton is derrived from the standard TButton control. TXFButton introduces several properties to control border and gradient style.

To use a gradient button that displays a bitmap instead of a label, use TXFBitBtn . To use a gradient button that can remain in a depressed position, use TXFSpeedButton .

_______

See also: TButton , TXFBitBtn , TXFSpeedButton , TXFUpDown

TXFButton.ApplyTheme

Determines whether the Windows Theme is used for the button.

property ApplyTheme: Boolean; {* ver. 5.1 *}

Description

Set ApplyTheme to true, to draw themed button with using Windows Themes. This property is respected only when XP Manifest is added to the application.

_______

TXFButton.DrawingStyle

Specifies the drawing style of the button.

property DrawingStyle: TButtonDrawingStyle ; {* ver. 5.1 *}

Description

Use DrawingStyle to select drawing style for the button. The DrawingStyle is a master property for

ApplyTheme and Gradient .Active property.

_______

TXFButton.Fine

Determines whether the button has a semi-flat or semi-3D border that provides a raised or lowered look.

property Fine: Boolean;

Description

Set Fine to true to change the raised border when the button is unselected and the lowered border when the button is clicked. The Fine property introduces two new borders (semi-flat or semi-3D) depend on value of Flat property. This property is respected only when the Gradient IsActive .

_______

TXFButton.Flat

Determines whether the button has a 3D border that provides a raised or lowered look.

property Flat: Boolean;

Description

Set Flat to true to remove the raised border when the button is unselected and the lowered border when the button is clicked. This property is respected only when the Gradient IsActive . See also Fine property.

Destroys the gradient push button object.

destructor Destroy; override;

Description

Do not call Destroy directly in an application. Instead, call Free. Free checks that the gradient push button is not nil, and only then calls Destroy.

_______

TXFButton.OnMouseEnter

Occurs when the mouse pointer moves over the button.

property OnMouseEnter: TNotifyEvent ;

Description

Write an OnMouseEnter event handler to take specific action when the user moves the mouse over the button. For example, you can use this event to change the font color when the mouse is over the button, and then use the OnMouseLeave event to change it back when the mouse moves off the button.

_______

TXFButton.OnMouseLeave

Occurs when the mouse pointer moves off from over the button.

property OnMouseLeave: TNotifyEvent ;

Description

Write an OnMouseLeave event handler to take specific action when the user moves the mouse off the button. For example, you can use this event to undo changes that were made in an OnMouseEnter event handler.

_______

TXFBitBtn

TXFBitBtn is a gradient push button control that can include a bitmap on its face.

Unit

XFSCtrls

Description

Use TXFBitBtn to put a gradient bitmap button on a form. TXFBitBtn is derrived from the standard TBitBtn control. TXFBitBtn introduces several properties to control border and gradient style.

To use a gradient button that not displays a bitmap, use TXFButton . To use a gradient button that can remain in a depressed position, use TXFSpeedButton .

_______

See also: TBitBtn , TXFButton , TXFSpeedButton , TXFUpDown

TXFBitBtn.ApplyTheme

Determines whether the Windows Theme is used for the button.

property ApplyTheme: Boolean; {* ver. 5.1 *}

Description

Set ApplyTheme to true, to draw themed button with using Windows Themes. This property is respected only when XP Manifest is added to the application.

_______

TXFBitBtn.DrawingStyle

Specifies the drawing style of the button.

property DrawingStyle: TButtonDrawingStyle ; {* ver. 5.1 *}

Description

Use DrawingStyle to select drawing style for the button. The DrawingStyle is a master property for

ApplyTheme and Gradient .Active property.

_______

TXFBitBtn.Fine

Determines whether the button has a semi-flat or semi-3D border that provides a raised or lowered look.

property Fine: Boolean;

Description

_______

TXFBitBtn.Flat

Determines whether the button has a 3D border that provides a raised or lowered look.

property Flat: Boolean;

Description

_______

TXFBitBtn.Gradient

Specifies the gradient drawing style for the button.

property Gradient: TXFGradient ;

Description

The Gradient property holds TXFGradientButton object that determines gradient drawing style for the button. The gradient drawing style IsActive for button only when ThemesEnabled is False.

_______

TXFBitBtn.WordWrap

Specifies whether the button text wraps to fit the width of the control.

property WordWrap: Boolean;

Description

Set WordWrap to true to allow the label to display multiple line of text. When WordWrap is true, text that is too wide for the control wraps at the right margin.

Set WordWrap to false to limit the label to a single line. When WordWrap is false, text that is too wide for the label appears truncated.

This property works now effective in all the versions of Delphi/C++Builder supported by X-Files

Components.

_______

TXFBitBtn.Create

Creates and initializes a TXFBitBtn instance.

constructor Create(AOwner: TComponent ); override;

Description

Use Create to programmatically instantiate a gradient bitmap button. Buttons added in the form designer are created automatically.

AOwner is the component that is responsible for freeing the button instance. It becomes the value of the

Owner property.

_______

TXFBitBtn.Destroy

Destroys the gradient bitmap button object.

destructor Destroy; override;

Description

Do not call Destroy directly in an application. Instead, call Free. Free checks that the gradient bitmap button is not nil, and only then calls Destroy.

_______

TXFBitBtn.OnMouseEnter

Occurs when the mouse pointer moves over the button.

property OnMouseEnter: TNotifyEvent ;

Description

_______

TXFBitBtn.OnMouseLeave

Occurs when the mouse pointer moves off from over the button.

property OnMouseLeave: TNotifyEvent ;

Description

_______

TXFSpeedButton

TXFSpeedButton is a gradient button that is used to execute commands or set modes.

Unit

XFSCtrls

Description

Use TXFSpeedButton to add a gradient button to a group of buttons in a form. TXFSpeedButton is derrived from the standard TSpeedButton control. TXFSpeedButton introduces several properties to control border and gradient style.

To use a gradient push button that displays a bitmap, use TXFBitBtn . To use a gradient button that not displays a bitmap, use TXFButton .

_______

See also: TSpeedButton , TXFButton , TXFBitBtn , TXFUpDown

TXFSpeedButton.ApplyTheme

Determines whether the Windows Theme is used for the button.

property ApplyTheme: Boolean; {* ver. 5.1 *}

Description

Set ApplyTheme to true, to draw themed button with using Windows Themes. This property is respected only when XP Manifest is added to the application.

_______

TXFSpeedButton.DrawingStyle

Specifies the drawing style of the button.

property DrawingStyle: TButtonDrawingStyle ; {* ver. 5.1 *}

Description

Use DrawingStyle to select drawing style for the button. The DrawingStyle is a master property for

ApplyTheme and Gradient .Active property.

_______

TXFSpeedButton.Fine

Determines whether the button has a semi-flat or semi-3D border that provides a raised or lowered look.

property Fine: Boolean;

Description

_______

TXFSpeedButton.FineTheme

Determines whether the button has a special look under Windows XP.

property FineTheme: TFineTheme ;

Description

Set FineTheme to true to change the default theme under Windows XP. The FineTheme property introduces two new themes when the Fine property is true. When the Fine property is False or either

FineTheme is ftNoChange the default themes leave unchanged.

_______

TXFSpeedButton.Gradient

Specifies the gradient drawing style for the button.

property Gradient: TXFGradient ;

Description

The Gradient property holds TXFGradientButton object that determines gradient drawing style for the button. The gradient drawing style IsActive for button only when ThemesEnabled is False and Transparent property is not effective.

_______

TXFSpeedButton.Create

Creates and initializes a TXFSpeedButton instance.

constructor Create(AOwner: TComponent ); override;

Description

Use Create to programmatically instantiate a gradient button. Buttons added in the form designer are created automatically.

AOwner is the component that is responsible for freeing the button instance. It becomes the value of the

Owner property.

_______

TXFSpeedButton.Destroy

Destroys the gradient button object.

destructor Destroy; override;

Description

Do not call Destroy directly in an application. Instead, call Free. Free checks that the gradient button is not nil, and only then calls Destroy.

_______

TXFSpeedButton.OnMouseEnter

Occurs when the mouse pointer moves over the button.

property OnMouseEnter: TNotifyEvent ;

Description

Creates and initializes a TXFLabel instance.

constructor Create(AOwner: TComponent ); override;

Description

Use Create to programmatically instantiate a transparent label. Labels added in the form designer are created automatically.

AOwner is the component that is responsible for freeing the label instance. It becomes the value of the

Owner property.

_______

TXFCustomStaticText

TXFCustomStaticText is the base class for TXFStaticText.

Unit

XFSCtrls

Description

TXFCustomStaticText is the base class for TXFStaticText , a windowed control that displays text on a gradient background.

_______

See also: TCustomStaticText , TXFStaticText

TXFCustomStaticText.Transparent

Specifies whether the background of the caption is transparent.

property Transparent: Boolean;

Description

Use Transparent to specify whether the background of the caption is transparent. This property is default

True and works effective on gradient background.

_______

TXFCustomStaticText.Create

Creates and initializes a TXFCustomStaticText instance.

constructor Create(AOwner: TComponent ); override;

Description

Use Create to programmatically instantiate a transparent static text. Static text added in the form designer are created automatically.

AOwner is the component that is responsible for freeing the static text instance. It becomes the value of the Owner property.

_______

TXFStaticText

TXFStaticText is a windowed control that displays text on a gradient background.

TXFGroupCheckBox represents a check box for a caption of group box.

Unit

XFSCtrls

Description

TXFGroupCheckBox represents a check box for a caption of group box. This class is used by

TXFCustomGroupBox .

_______

TXFGroupCheckBox.Action

Specifies the action associated with the check box.

type

TXFCheckBoxAction = (caNone, caDisable, caEnable);

property Action: TXFCheckBoxAction; {* ver. 5.11 *}

Description

Action is the action associated with the check box. When check box is Visible and Checked state is changed the associated action is performed. The possible values of Action are:

Value Meaning

______________________________________________________________________________________________________________________________________________________________________________

caNone caDisable

No special action is performed.

When check box is unchecked, all child controls in group box are disabled.

When check box is checked, the disabled child controls in group box are reenabled. caEnable When check box is checked, all child controls in group box are enabled. When check box is unchecked, the enabled child controls in group box are redisabled.

_______

TXFGroupCheckBox.Checked

Specifies whether the check box control is checked.

property Checked: Boolean; {* ver. 5.11 *}

Description

Use Checked to determine whether a check box control is checked.

_______

Destroys the group check box object.

property Destroy: Boolean; {* ver. 5.11 *}

Description

Do not call Destroy directly in an application. The group check box is automatically destroyed by group box.

_______

TXFCustomGroupBox

TXFCustomGroupBox is the base class for all gradient group box components.

Unit

XFSCtrls

Description

TXFCustomGroupBox is the class from which all gradient group box components - including

TXFGroupBox , TXFRadioGroup , TXFCheckGroup and TXDBRadioGroup - descend.

TXFCustomGroupBox is derrived from the standard TCustomGroupBox control. TXFCustomGroupBox introduces several properties to control gradient style and parent's background.

_______

TXFCustomGroupBox.CheckBox

Specifies whether the group box has a check box.

property CheckBox: TXFGroupCheckBox ; {* ver. 5.11 *}

Description

The CheckBox property holds TXFGroupCheckBox object that determines check box control for the group box. When check box is visible it appears near a caption of group box. The check box control may be used to perform any action on all child controls for the group box.

_______

See also: TXFCustomGroupBox.OnCheckBoxChanged

TXFCustomGroupBox.Gradient

Specifies the gradient drawing style for the group box.

property Gradient: TXFGradient ;

Description

The Gradient property holds TXFGradientBackground object that determines gradient drawing style for the group box. The gradient drawing style IsActive for group box only when ParentBackground is False.

_______

TXFCustomGroupBox.ParentBackground

Determines whether the group-box uses parent's background.

property ParentBackground: Boolean;

Description

If ParentBackground is true, the group-box uses the parent's background to draw its own background.

ParentBackground has effect for both ThemesEnabled is True or False.

_______

See also: TXFCustomPanel.ParentBackground

TXFCustomGroupBox.PartialBackground

Determines whether the group-box uses partial parent's background.

property PartialBackground: Boolean; {* ver. 5.1 *}

Description

If PartialBackground is true, the group-box uses the partial parent's background to draw its own background. The PartialBackground property has effect when parent control has not csParentBackground option in ControlStyle (Parent.ParentBackground = False). This means that the property may not work for all parent controls.

Notice. If you want to make sure that the property PartialBackground to be effective, the group-box control should be placed on TForm or on any class derived from TXFCustomGroupBox or TXFCustomPanel with

ParentBackground = False.

_______

See also: TXFCustomGroupBox.ParentBackground

TXFCustomGroupBox.Create

Creates and initializes a TXFCustomGroupBox instance.

constructor Create(AOwner: TComponent ); override;

Description

Use Create to programmatically instantiate a gradient group box. Group box added in the form designer are created automatically.

AOwner is the component that is responsible for freeing the group box instance. It becomes the value of the Owner property.

_______

TXFCustomGroupBox.Destroy

Destroys the gradient group box object.

destructor Destroy; override;

Description

Do not call Destroy directly in an application. Instead, call Free. Free checks that the gradient group box is not nil, and only then calls Destroy.

_______

TXFCustomGroupBox.OnCheckBoxChanged

Occurs immediately after checked state of check box changes.

property OnCheckBoxChanged: TNotifyEvent ; {* ver. 5.11 *}

Description

Write an OnCheckBoxChanged event handler to respond to changes checked state of check box. This event is generated only when check box is visible in group box. If CheckBox.Action

is specified the action is performed before the event occurs.

_______

TXFGroupBox

TXFGroupBox represents a gradient group box.

Unit

XFSCtrls

Description

The TXFGroupBox component represents a gradient group box. TXFGroupBox is similar to the standard

TGroupBox control, but introduces several properties to control gradient style and parent's background.

_______

TXFCustomRadioGroup

TXFCustomRadioGroup is the base class for gradient radio-group components.

Unit

XFSCtrls

Description

TXFCustomRadioGroup is the class from which gradient radio-group components - including

TXFRadioGroup and TXDBRadioGroup - descend. TXFCustomRadioGroup is derrived from the

TXFCustomGroupBox control. TXFCustomGroupBox introduces several properties to control gradient style and parent's background.

_______

See also: TXFCustomCheckGroup , TXFCustomGroupBox

TXFRadioGroup

TXFRadioGroup represents a gradient group of radio buttons that function together.

Unit

XFSCtrls

Description

The TXFRadioGroup component represents a gradient group of radio buttons. TXFRadioGroup is similar to the standard TRadioGroup control, but introduces several properties to control gradient style and parent's background.

_______

TXFCustomCheckGroup

TXFCustomCheckGroup is the base class for check-group components.

Unit

XFSCtrls

Description

Check groups are collections of check buttons in a single group box. TXFCustomCheckGroup is the class from which gradient check-group components - including TXFCheckGroup - descend.

TXFCustomCheckGroup is similar to TXFCustomRadioGroup , but introduces Checked property to maintain state of check buttons. TXFCustomCheckGroup is derrived from the TXFCustomGroupBox control. TXFCustomGroupBox introduces several properties to control gradient style and parent's background.

_______

See also: TXFCustomRadioGroup , TXFCustomGroupBox

TXFCustomCheckGroup.Buttons

Access individual TXFCheckBox objects.

property Buttons[Index: Integer]: TXFCheckBox ;

Description

Buttons provides direct access to the individual TXFCheckBox objects created by the control. Buttons is a read-only property. This means you can access individual TXFCheckBox objects, but you cannot add or delete TXFCheckBox objects. To modify the button list, change the Items property.

Index is the zero-origin button index. If Index is equal to or greater than the number of buttons, an error is raised.

_______

TXFCustomCheckGroup.Checked

Indicates which check buttons are checked.

property Checked: Integer;

Description

For each item of the Items list, one bit in the Checked property is set if a check mark appears in the item's check box. Checked corresponds to the set of TCheckBox.Checked

state. The first check button corresponds to first bit in Checked. It's useful to edit a value of any set type.

The value of Checked changes at runtime as the user selects check buttons. If you want one or more of the buttons to appear checked when the application starts, assign a set of that buttons to Checked at design time; otherwise, leave Checked set to the default value of 0, which means that no button is checked.

Hint. If you want all of the buttons to appear checked, assign value of -1 to Checked. If you want to assign a value of any set type, you can use typecasting e.g. Checked := Byte(Anchors); Anchors :=

TAnchors(Byte(Checked));

Checked can save state for first 32 check buttons. If you really need more than 32 check buttons you can set and examine in run-time a Checked property in Buttons array.

_______

TXFCustomCheckGroup.ItemIndex

Indicates which check button in the group was lately checked/unchecked.

property ItemIndex: Boolean;

Description

ItemIndex holds the index of the lately selected check button in the Items list. (The first button is 0.) The value of ItemIndex changes at runtime as the user selects check buttons. You can not assign a value to

ItemIndex directly, but you can examine ItemIndex in OnClick event handler. Initially, ItemIndex has default value of -1, which means that no button was checked.

_______

TXFCheckGroup

TXFCheckGroup represents a gradient group of check buttons that function together.

Unit

XFSCtrls

Description

The TXFCheckGroup component represents a gradient group of check buttons. TXFCheckGroup is similar to the TRadioGroup control, but introduces Checked property to maintain state of check buttons and several properties to control gradient style and parent's background.

_______

TXFCustomPanel

TXFCustomPanel is the base class for all gradient panel components.

Determines whether the up-down control has a semi-flat or semi-3D border that provides a raised or lowered look.

property Fine: Boolean;

Description

Set Fine to true to change the raised border when the buttons are unselected and the lowered border when the button is clicked. The Fine property introduces two new borders (semi-flat or semi-3D) depend on value of Flat property. This property is respected only when the Gradient IsActive .

_______

TXFUpDown.Flat

Determines whether the up-down control has a 3D border that provides a raised or lowered look.

property Flat: Boolean;

Description

Set Flat to true to remove the raised border when the buttons are unselected and the lowered border when the button is clicked. This property is respected only when the Gradient IsActive . See also Fine property.

_______

TXFUpDown.Gradient

Specifies the gradient drawing style for the up-down control.

property Gradient: TXFGradient ;

Description

The Gradient property holds TXFGradientButton object that determines gradient drawing style for the buttons. The gradient drawing style IsActive for up-down control only when ThemesEnabled is False.

_______

TXFUpDown.Create

Creates and initializes a TXFUpDown instance.

constructor Create(AOwner: TComponent ); override;

Description

Use Create to programmatically instantiate a gradient up-down control. Up-Down added in the form designer are created automatically.

AOwner is the component that is responsible for freeing the up-down instance. It becomes the value of the

Owner property.

_______

TXFUpDown.Destroy

Destroys the gradient up-down object.

destructor Destroy; override;

Description

Do not call Destroy directly in an application. Instead, call Free. Free checks that the gradient up-down control is not nil, and only then calls Destroy.

_______

TXFUpDown.OnMouseEnter

Occurs when the mouse pointer moves over the control.

property OnMouseEnter: TNotifyEvent ;

Description

Write an OnMouseEnter event handler to take specific action when the user moves the mouse over the control. For example, you can use this event to change the associate control when the mouse is over the control, and then use the OnMouseLeave event to change it back when the mouse moves off the control.

_______

TXFUpDown.OnMouseLeave

Occurs when the mouse pointer moves off from over the control.

property OnMouseLeave: TNotifyEvent ;

Description

Write an OnMouseLeave event handler to take specific action when the user moves the mouse off the control. For example, you can use this event to undo changes that were made in an OnMouseEnter event handler.

_______

TXFStatusBar

TXFStatusBar represents a gradient status bar.

Unit

XFSCtrls

Description

The TXFStatusBar component represents a gradient status bar. TXFStatusBar is similar to the standard

TStatusBar control, but introduces several properties to control gradient style.

_______

TXFStatusBar.Gradient

Specifies the gradient drawing style for the status bar.

property Gradient: TXFGradient ;

Description

The Gradient property holds TXFGradientBackground object that determines gradient drawing style for the status bar. The gradient drawing style IsActive for status bar only when ThemesEnabled is False.

_______

TXDBNavigator represents a gradient database navigator.

Unit

XDBCtrls

Description

TXDBNavigator represents a gradient database navigator. TXDBNavigator is derrived from the standard

TDBNavigator control. TXDBNavigator introduces several properties to control border, gradient style and parent's background.

_______

TXDBNavigator.ApplyTheme

Determines whether the Windows Theme is used for the buttons.

property ApplyTheme: Boolean; {* ver. 5.1 *}

Description

Set ApplyTheme to true, to draw themed buttons with using Windows Themes. This property is respected only when XP Manifest is added to the application.

_______

TXDBNavigator.Captions

Provides a way to customize the captions for the buttons on the database navigator.

property Captions: TStrings;

Description

Use the Captions property to supply captions of your choosing for the individual navigator buttons. Each button has a default caption. Captions allow the values of any or all of these default captions to be replaced by customized captions.

Captions is a string list. Each caption is a string. The first string in the string list becomes the caption for the first button on the navigator (the First button). The seventh hint becomes the caption for the seventh button (the Edit button).

When specifying Captions at runtime, enter an empty string for any caption that should keep the default value. Simply leave the line blank when using the string list property editor of the Object Inspector for the

Captions property.

Note: To have the Captions appear at runtime, set the ShowCaptions property to true.

_______

TXDBNavigator.DrawingStyle

Specifies the drawing style of the buttons of navigator.

property DrawingStyle: TButtonDrawingStyle ; {* ver. 5.1 *}

Description

Use DrawingStyle to select drawing style for the buttons of navigator. The DrawingStyle is a master property for ApplyTheme and Gradient .Active property.

_______

TXDBNavigator.Fine

property Layout: TButtonLayout ;

Description

Layout indicates whether the text appears on the left of the button (blGlyphLeft), the right of the button

(blGlyphRight), the top (blGlyphTop) or the bottom (blGlyphBottom).

_______

See also: TXDBNavigator.Captions

, TXDBNavigator.Margin

, TXDBNavigator.Spacing

TXDBNavigator.Margin

Specifies the number of pixels between the edge of the image and the edge of the button.

property Margin: Integer;

Description

The margin is the space between the image edge and the button edge. The format of the edges depends on the Layout of the image and text. For example, if Layout is blGlyphLeft, the margin appears between the left edge of the image and the left edge of the button. If Margin is 3, three pixels separate the image and the button edges. If Margin is 0, there is no space between the image and the button edges.

If Margin is -1 (the default value), the image and text (specified in the Captions property) are centered.

The number of pixels between the image and button edge is equal to the number of pixels between the opposite edge of the button and the text.

_______

See also: TXDBNavigator.Captions

, TXDBNavigator.Layout

, TXDBNavigator.Spacing

TXDBNavigator.ParentBackground

Determines whether the navigator's panel uses parent's background.

property ParentBackground: Boolean;

Description

If ParentBackground is true, the navigator's panel uses the parent's background to draw its own background. ParentBackground has effect for both ThemesEnabled is True or False.

_______

See also: TXDBNavigator.ParentBackground

TXDBNavigator.ParentFont

Specifies where a navigator looks for its font information.

property ParentFont: Boolean; {* ver. 5.1 *}

Description

Set ParentFont to true to have a navigator which uses the same font as its parent control. If ParentFont is false, the navigator uses its own Font property. When the value of a control's Font property changes,

ParentFont becomes false automatically.

_______

TXDBNavigator.ShowCaptions

Determines whether the database navigator displays captions.

property ShowCaptions: Boolean;

Description

Use ShowCaptions to determine whether Captions appear for the database navigator. To appear captions for the control the property must be true.

_______

See also: TXDBNavigator.Captions

TXDBNavigator.Spacing

Determines where the image and text appear on a buttons.

property Spacing: Integer;

Description

Spacing determines the number of pixels between the image and the text (specified in the Captions property). The default value is 4 pixels.

If Spacing is a positive number, its value is the number of pixels between the image and text. If Spacing is

0, no pixels will be between the image and text. If Spacing is -1, the text appears centered between the

image and the button edge. The number of pixels between the image and text is equal to the number of pixels between the text and the button edge opposite the glyph.

_______

See also: TXDBNavigator.Captions

, TXDBNavigator.Margin

, TXDBNavigator.Layout

TXDBNavigator.Create

Creates and initializes a TXDBNavigator instance.

constructor Create(AOwner: TComponent ); override;

Description

Use Create to programmatically instantiate a gradient database navigator. Navigator added in the form designer are created automatically.

AOwner is the component that is responsible for freeing the navigator instance. It becomes the value of the Owner property.

_______

TXDBNavigator.Destroy

Destroys the gradient database navigator object.

destructor Destroy; override;

Description

Do not call Destroy directly in an application. Instead, call Free. Free checks that the gradient navigator control is not nil, and only then calls Destroy.

_______

TXDBNavButton

TXDBNavButton represents a gradient navigator's button.

Unit

XDBCtrls

Description

TXDBNavButton represents a gradient navigator's button. TXDBNavButton is similar to the

TXFSpeedButton control, which introduces several properties to control gradient style. TXDBNavButton is a control designed for TXDBNavigator .

_______

See also: TXFSpeedButton , TXDBNavigator

TXDBText

TXDBText represents a data-aware control that displays the value of a field on a gradient background.

Unit

XDBCtrls

Description

Use TXDBText to display the contents of a field in the current record of a dataset on a gradient background. TXDBText is derrived from the standard TDBText control, but Transparent property is default

True.

_______

TXDBText.Transparent

Specifies whether the background of the text is transparent.

property Transparent: Boolean;

Description

Use Transparent to specify whether the background of the text is transparent. This property is default

True.

_______

TXDBText.Create

Creates and initializes a TXDBText instance.

constructor Create(AOwner: TComponent ); override;

Description

Use Create to programmatically instantiate a transparent data-aware text control. Data-aware text added in the form designer are created automatically.

AOwner is the component that is responsible for freeing the text control instance. It becomes the value of the Owner property.

_______

TXDBCheckBox

TXDBCheckBox represents a data-aware transparent check box.

Unit

XDBCtrls

Description

Use TXDBCheckBox to place a data-aware transparent check box on gradient background.

TXDBCheckBox is derived from the standard TDBCheckBox control, but works effecive on gradient background.

_______

TXDBCheckBox.Transparent

Specifies whether the background of the check box is transparent.

property Transparent: Boolean;

Description

Use Transparent to specify whether the background of the caption is transparent. This property is default

True and works effective on gradient background.

_______

TXDBCheckBox.Create

Creates and initializes a TXDBCheckBox instance.

constructor Create(AOwner: TComponent ); override;

Description

Use Create to programmatically instantiate a transparent data-aware check box. Data-aware check box added in the form designer are created automatically.

AOwner is the component that is responsible for freeing the check box control instance. It becomes the value of the Owner property.

_______

TXDBRadioGroup

TXDBRadioGroup represents a gradient group of radio buttons connected to a database.

Unit

XDBCtrls

Description

Use TXDBRadioGroup to group a set of data-aware radio buttons on a gradient background.

TXDBRadioGroup is similar to the standard TDBRadioGroup control, but introduces several properties to control gradient style and parent's background.

_______

Key features

Powerful DBGrid extension
Windows themes and custom styles
Gradient drawing variations
Proportional scrolling
Auto-calculated totals
Integrated filtering system
Dynamic report creation

Frequently asked questions

The components support Delphi 5, 6, 7, 2005, 2006, 2007, 2009, 2010, XE, XE2, XE3, XE4, XE5, XE6, XE7, XE8, 10 Seattle, 10.1 Berlin and C++Builder 5, 6, 2006, 2007, 2009, 2010, XE, XE2, XE3, XE4, XE5, XE6, XE7, XE8, 10 Seattle, 10.1 Berlin. Details on specific versions and updates needed are provided in the guide.

The installation process involves running the provided installer. Previous versions should be uninstalled first. The installer automatically adjusts the Library Path and can also install the Context Help File. Specific instructions are detailed in the guide.

The components implement support for the bdRightToLeft BiDiMode for Middle Eastern locales. However, there are some known bugs regarding fixed columns and row resizing. The guide provides instructions on how to fix these issues.

User questions

Jennifer B.

How can I customize cell drawing in a TXDBGrid?

Use the OnPaintColumnCell event to customize cell rendering. This event provides access to the cell's data and a TCanvas for drawing custom content. You can control aspects like background color, font, and images.

Jennifer B.

What is the function of the OnPaintColumnCell event in the TXDBGrid component?

The OnPaintColumnCell event is a feature of the TXDBGrid component that allows developers to customize cell rendering. It provides complete control over the appearance of each cell, including background, colors, fonts, and custom drawing logic, by utilizing the TCanvas object provided in the event parameters.

X-Files Software

Developer’s Guide

Table of Contents

X-Files Components - Overview

X-Files Components - Requirements

X-Files Components - Installation

X-Files Components - Support

XDBGrids unit

TXDBGrid

TXCustomDBGrid

TXDBGridColumns

TXColumn

TXColumnTitle

TXColumnTotal

TXColumnTotalValue

TXColumnTotalValues

TXColumnTotalHeader

TXColumnTotalFooter

TXColumnTotalFields

TXDBGridTotals

TXColumnReport

TXDBGridFilter

TXDBGridSearch

TXGridStyle

TXScrollProp

TXDBGridSettings

TXDBGridGradient

TXBookmarkList

TXColumnList

XQRGrids unit

TXQRGrid

TXQRPreviewSettings

TXReportBands

TXReportBand

TXReportGridBand

TXReportTextBand

TXReportGroupBand

TXReportPageBand

TXReportBandStyle

TXReportText

TXReportStyle

XDBLists unit

TXDBColumnsDialog

TXDBPrintColumnsDialog

XDBFields unit

TXBlobField

TXGraphicField

XFSGraph unit

TXFGradient

TXFGradientBackground

TXFGradientButton

TXFGradientProgress

XFSCtrls unit

TXFButton

TXFBitBtn

TXFSpeedButton

TXFLabel

TXFCustomStaticText

TXFStaticText

TXFCustomCheckBox

TXFCheckBox

TXFRadioButton

TXFGroupCheckBox

TXFCustomGroupBox

TXFGroupBox

TXFCustomRadioGroup

TXFRadioGroup

TXFCustomCheckGroup

TXFCheckGroup

TXFCustomPanel

TXFPanel

TXFUpDown

TXFStatusBar

TXFTrackBar

TXFProgressBar

XDBCtrls unit

TXDBNavigator

TXDBNavButton

TXDBText

TXDBCheckBox