Express Cross Platform Library

Known Issues and Important Changes List
All entries in the following list are grouped by Builds, in reverse order. Build v2011 vol 1.2 1. Breaking Change Function dxUnitsLoader has been moved from unit dxGDIPlusClasses to the dxCore unit. In applications with custom skins, specify the dxCore unit in the uses clause. 2. Breaking Change The dxGdiPlusInitialize and dxGdiPlusFinalize procedures have been moved from the dxGDIPlusClasses unit to the dxCore unit, and renamed to dxInitialize and dxFinalize. In applications with custom skins, specify the dxCore unit in the uses clause. Build v2011 vol 1.1 1. Breaking Change Function cxContainerGetBorderWidthByPainter has been removed from the cxContainer unit. Use the painters GetContainerBorderWidth method instead. 2. Breaking Change Function cxEditGetBorderWidthBySkinPainter has been removed from the cxEditUtils unit. Use the painters GetContainerBorderWidth method instead. 3. Breaking Change The TcxTimer class has been moved from the cxControls unit to the cxClasses unit. 4. Breaking Change The cxLookAndFeelPainters.GetExtendedStylePainters function has been removed. Use the cxLookAndFeels.RootLookAndFeel function instead, as shown in the following example: //Delphi //... uses //... cxLookAndFeels, dxSkinInfo; //... var ASkinInfo: TdxSkinInfo; begin // the painter's GetPainterData method returns True for skins, False for traditional styles if RootLookAndFeel.Painter.GetPainterData(ASkinInfo) then Caption := ASkinInfo.Skin.DisplayName; end; Build 54 1. Breaking Change Functions dxGpDrawImage, dxGpFillRect, dxGpFillRectByGradient, dxGpIsRectVisible, dxGpTilePart, dxGpTilePartEx, dxGpRoundRect, dxGpRoundRectEx have been moved from the dxGDIPlusApi unit to the dxGDIPlusClasses unit. 2. Breaking Change The HexToByte function has been moved from the cxClasses unit to the dxCore unit. 3. Breaking Change The cxContainerMaxBorderWidth constant and the TcxContainerBorderStyle type have been moved from the cxContainer unit to the cxLookAndFeelPainters unit. 4. Breaking Change Unit cxControls Function DragDetect has been renamed to cxDragDetect. Its parameter list has been changed. 5. Breaking Change:
Page 1 of 629
l l
The WM_DX message has been moved from the cxClasses unit to the dxMessages unit. The CM_CLOSEPOPUPWINDOW message has been removed from the cxContainer unit. Use the dxMessages.DXM_CLOSEPOPUPWINDOW message instead. The CM_SHOWPOPUPWINDOW message has been removed from the cxContainer unit. Use the dxMessages.DXM_SHOWPOPUPWINDOW message instead. The CM_SHORTREFRESHCONTAINER message has been removed from the cxContainer unit. Use the dxMessages.DXM_SHORTREFRESHCONTAINER message instead. The CM_UPDATESCROLLBARS message has been removed from the cxContainer unit. Use the dxMessages.DXM_UPDATESCROLLBARS message instead. The CM_BUFFEREDPAINTONGLASS message has been removed from the cxContainer unit. Use the dxMessages.DXM_BUFFEREDPAINTONGLASS message instead. The CM_NCSIZECHANGED message has been removed from the cxControls unit. Use the dxMessages.DXM_NCSIZECHANGED message instead. The WM_SYNCHRONIZETHREADS message has been removed from the cxControls unit. Use the dxMessages.DXM_SYNCHRONIZETHREADS message instead. The DXM_CONTAINERSETFOCUS message has been removed from the cxControls unit. Use the dxMessages.DXM_CONTAINERSETFOCUS message instead.
Build 52 1. Breaking Change The TdxRGBColors array has been removed from the dxGDIPlusClasses unit. Use the dxCore.TRGBColors array instead. 2. Breaking Change Function GetBitmapBits has been moved from the cxGraphics to the dxCore unit. Its parameter list and return type have been changed. 3. Breaking Change Routine SetBitmapBits has been moved from the cxGraphics to the dxCore unit. Build 50 Breaking Change The GetStartOfWeek function has been removed from the cxDateUtils unit. Use the dxGetStartOfWeek function from the dxCore unit instead. Build 45 1. Breaking Change The AEnabled Boolean parameter has been added into the TcxCustomLookAndFeelPainter.GroupBoxTextColor class function. Pass True to this parameter to indicate that the TcxGroupBox control is enabled. 2. Breaking Change The AHasTextArea Boolean variable parameter has been added into the TcxCustomLookAndFeelPainter.SchedulerNavigationButtonSizes class method. To retain the SchedulerNavigationButtonSizes functionality as in previous Builds, pass True to this parameter. Build 44 1. Breaking Change In the dxCore unit, the cxBinToHex and cxHexToBin functions have been renamed dxBinToHex and dxHexToBin, respectively. 2. Breaking Change In the cxGraphics unit, the TcxCustomBitmap and TcxBitmap classes have been renamed TcxBitmap and TcxBitmap32, respectively. Build 43 1. Breaking Change The cxColorToRGBQuad global function has been removed from the cxGraphics unit. Use the dxColorToRGBQuad global function from the dxCore unit instead. 2. Breaking Change The dxBuildNumber global constant has been moved from the cxClasses unit to the dxCore unit. 3. Breaking Change The TcxComponentEditor class has been renamed to TdxComponentEditor, and moved from the cxLibraryReg unit to the dxCoreReg unit.
Page 2 of 629
Build 42 1. Breaking Change The following global functions were moved from the cxControls unit to the dxCore unit:
l l l l l l
IsWin95X IsWin2K IsWin2KorXP IsWinNT IsWinVista IsWinXP
2. Breaking Change A number of global functions were removed from product units. You need to use the following code equivalents from the dxCore unit: Product Express Cross Platform Library ExpressPrinting System IsWin2KOrXP IsWinXP IsWinNT IsWin95Or98 IsWinMeOr2K ExpressLayout Control ExpressSpreadSheet 3. Breaking Change The TcxContainer.InnerControlDefaultHandler function is no longer virtual. Now, instead of overriding this function, override the TcxContainer.DoInnerControlDefaultHandler function in your TcxContainer descendants. 4. A generic exception class for our controls EdxException was introduced in the dxCore unit. This class is used for all generic exceptions, and as the base class for all custom exception classes declared in the following VCL controls:
l l l l l l l l l l
Function
Code Equivalent
IsWindowsXPOrLater
IsWinXPOrLater
IsWinXPOrLater IsWinXP IsWinNT IsWin9X (IsWinMe or IsWin2KorLater)
IsWin98Or2000
(not IsWin95)
IsWinNT
IsWinNT
ExpressQuantumGrid v6 ExpressBars v6 ExpressScheduler v3 ExpressPivotGrid v2 ExpressQuantumTreeList v4 ExpressVerticalGrid ExpressNavBar v2 ExpressPrinting System v3 ExpressLayout Control ExpressSpellChecker
Page 3 of 629
l l l l l l
ExpressSpreadSheet ExpressEditors Library ExpressPageControl ExpressDocking Library ExpressMemData Express Cross Platform Library.
This allows you to easily filter and accurately handle exceptions raised in your applications. Build 41 1. The TdxResourceStringsRepository.UpdateDependentComponents method has been replaced by the TdxResourceStringsRepository.NotifyListeners method. The TdxResourceStringsRepository is declared in the dxCore unit, and it is implicitly used by the TcxLocalizer component. 2. Now, standard and third-party controls that use the IdxLocalizerListener interface for localization purposes must be explicitly registered and unregistered as the TcxLocalizers listeners using the TdxResourceStringsRepository.AddListener and TdxResourceStringsRepository.RemoveListener methods. To learn how to translate the controls UI using the IdxLocalizerListener interface, refer to the How To Localize an Application Using the TcxLocalizer help topic. 3. Breaking Change In the cxContainer unit, the SetWindowShadowRegion global function was extended with an AShadowBoundsExtent parameter, which specifies how a shadow is stretched. Previously, TRect passed as the R parameter specified the region that casts a shadow. Now, this region should be passed as the AShadowBounds parameter. To retain the SetWindowShadowRegion functionality as in previous Builds, pass this region as the AShadowBounds parameter and pass cxEmptyRect as the AShadowBoundsExtent parameter. 4. Breaking Change A TcxOwnedInterfacedCollection class has been introduced as a common ancestor for collections containing information about their owners. As a result, the following classes now inherit from the TcxOwnedInterfacedCollection class:
l l l l
TdxBarCaptionButtons in the dxBar unit. TcxGridBands in the cxGridBandedTableView unit. TcxCheckListBoxItems in the cxCheckListBox unit. TcxButtonGroupItems in the cxGroupBox unit.
5. Breaking Change The TcxInterfacedCollectionItem class was moved from the cxInplaceContainer unit to the cxClasses unit. The following classes now inherit from the TcxInterfacedCollectionItem class:
l l l l l
TcxLookupGridColumn in the cxLookupGrid unit. TcxFilterItem in the cxDBFilterControl unit. TcxGridBand in the cxGridBandedTableView unit. TcxPropertiesStoreComponent in the cxPropertiesStore unit. TdxBarCaptionButton and TdxBarItemLink in the dxBar unit.
Build 40 1. The following methods have been moved from the dxMdaSet unit to the dxCore unit:
l l l l l l
ReadBufferFromStream ReadBoolean ReadByte ReadInteger ReadWord WriteBoolean

Page 4 of 629
l l l l l l l l l
WriteByte WriteInteger WriteWord WriteCharToStream WriteDoubleToStream WriteIntegerToStream WriteSmallIntToStream WriteStringToStream WriteBufferToStream
2. The following methods have been moved from the cxClasses unit to the dxCore unit:
l l l l l l l l l l l l l l
cxZeroMemory cxAllocMem cxFreeMem cxCopyData ReadBoolean ReadByte ReadInteger ReadWord WriteBoolean WriteByte WriteInteger WriteWord cxBinToHex cxHexToBin
3. The FillZeroData and CopyData methods have been removed from the dxMdaSet unit. Use the cxZeroMemory and cxCopyData methods from the dxCore unit instead. Build 37 1. The TcxStorageType type has been moved from the cxPropertiesStore unit to the cxStorage unit. 2. By default, the ExpressNavBar and ExpressDocking Library create device-dependent bitmaps. Due to hardware acceleration, these bitmaps are painted faster than device-independent bitmaps. So, to improve performance, device-dependent bitmaps are created. However, displaying large device-dependent bitmaps may lead to EOutOfResources exceptions. To help overcome these problems when using large bitmaps in the aforementioned products, we introduced a cxDoubleBufferedBitmapPixelFormat global variable in the cxGraphics unit. By default, this variable is set to pfDevice indicating that device-dependent bitmaps are created. To create device-independent bitmaps, set this variable to pf32bit before creating problematic forms. Build 31 1. TcxImageList save format to .dfm files has been changed. Loading forms that contain TcxImageList components from Build 31 or later, fails when using older Builds. As a result, image lists will be empty. To properly load these forms, do the following:
l l
Install Build 31. Add {$DEFINE cxImageListOldSaveFormat} to the cxGraphics unit as shown below:
//Delphi // ... {$DEFINE cxImageListOldSaveFormat} unit cxGraphics; // ...

Page 5 of 629

l l
Run the Express Install in Recompile mode. Save the forms. Now TcxImageList controls will be saved to .dfm files using old format.
After this, you can install Build 30 or earlier, and load the forms correctly. 2. In the cxGraphics unit, the TcxImageList.Replace function has been re-declared as a procedure. Now, no resulting value indicating whether image replacement was successful is returned. Build 30 1. Now, all message identifiers for Developer Express products are based on the WM_DX constant, which is declared as follows: WM_DX = WM_APP + 100; To avoid conflicts with our message identifiers, define your own message identifiers between WM_APP and WM_DX. 2. In the cxClasses unit, the TTag type has been renamed to TcxTag. This eliminates conflicts with the standard HTTPProd.TTag type. Build 28 In the cxGraphics unit, the cxBitmapToTrueColorBitmap global procedure has been renamed to cxMakeTrueColorBitmap. A new parameter to return the resulting bitmap has been added to this procedure.
Page 6 of 629
Using the cxPropertiesStore component

When writing a complex application with a large number of settings, you may need to restore component properties. The ExpressQuantumGrid Suite provides the cxPropertiesStore component implementing this functionality. By default, the cxPropertiesStore component allows restoring settings upon application creation and saving settings upon application shutdown. Of course, you can perform saving/restoring whenever you like. This topic covers all aspects of the cxPropertiesStore functionality. Lets consider the use of cxPropertiesStore. This topic contains two examples of using cxPropertiesStore at design time and via code. The cxPropertiesStore will be used to save/restore cxGrid properties. Perform the following steps to follow the examples of this topic. Create an empty application. Place a cxGrid component on a form. Create a table view and bind it to the Films table from the VideoCatalodDB.mdb demo database. Setup the grid control as described in the table view tutorial. Next, add another level with an associated table view, name them lvFilmsCheck and tvFilmsCheck and repeat the tutorial steps for the new view. Place the cxPropertiesStore component on the form and name it cxStore. The result is shown by the following screenshot:
1. DESIGN TIME USAGE This chapter shows how to use cxPropertiesStore at design time and describes its default functionality. This implies that the settings are saved when the application is closed and restored when it is restarted. The example will operate on the settings of the tvFilms view and the tvFilmsCOLOR & tvFilmsYEAR columns. Double-click on the cxPropertiesStore components icon. This invokes the PropertiesStore Editor:
Page 7 of 629
The editor displays a tree structure of all the components residing on the form containing the cxPropertiesStore. The Editor buttons functions are listed below: Button Groups the Editor tree by components. Groups the Editor tree by properties. Restores the last saved selection. The current Properties/components grouping option is saved when the dialog is closed (by pressing the OK button). Selects all components/properties within the tree. Clears all selected rows. Inverts row selections. If you need to select most items, select just the ones you dont need and then click on this button. Click the plus sign next to the cxGrid component and examine the properties available:
Page 8 of 629
Function
You can select all the components properties you want to save/restore by right-clicking the component name within the tree. The following image demonstrates how to select all the properties of the tvFilmsYEAR and tvFilmsCOLOR columns:
Page 9 of 629
Also, you can select individual component properties by right-clicking these property names within the tree. The following image demonstrates how to select the tvFilms view options:
Having selected the required components and their properties, you need to specify the StorageType and StorageName property
Page 10 of 629
values. For the purposes of this example, set the StorageType property value to stRegistry and the StorageName property value to "View Storage":
This tells the cxPropertiesStore component to store settings within the registry in the View Storage key. Ensure that the Active property of the cxPropertiesStore component is set to True. Otherwise, cxPropertiesStore will not save/restore the selected settings automatically. Run the application. Ungroup the tvFilms and tvFilmsCheck views by dragging the Release Year column header to the column panel. Close the application and run it again. Runtime changes are restored for the tvFilms view and its columns. The tvFilmsCheck view appears with the design time settings, because its properties were not selected for saving. The following screenshot demonstrates the View Storage registry key structure:
Another way of selecting the properties for saving/restoring is by using the Components property. Select the cxPropertiesStore component. Invoke the Object Inspector and click the ellipsis button next to the Components property. This invokes the Components collection editor:
Page 11 of 629
This collection contains references to all components, which you have previously selected. Select the first component reference (corresponding to the tvFilms view) and switch to the Object Inspector. Click the ellipsis button next to the Properties property. This displays the list of properties selected for saving/restoring:
Go to the "OptionsCustomize" line and add the ColumnGrouping options name, by changing the line to "OptionsCustomize.ColumnGrouping":
Page 12 of 629
The following screenshot demonstrates the result of saving after this change:
As you can see, now only the ColumnGrouping option value is saved instead of the whole OptionsCustomize set. You can also save/restore properties at design time. For this purpose, select the required properties via the cxPropertiesStore editor. Then right-click the cxPropertiesStore component and choose the Save or Restore item from the context menu:
Page 13 of 629
The StorageType and StorageName properties specify the storage used for design time saving/restoring. 2. USING VIA CODE This chapter describes how to use cxPropertiesStore by code and this approach provides more flexibility. There are two features of cxPropertiesStore only available when writing code: 1. Saving/restoring individual components from the Components collection. 2. Saving/restoring individual Components items from a storage, different from the one specified by the StorageType and StorageName properties. The code below handles the OnCreate event of the form to save the properties of a footer summary item. It selects the Column, Kind and Format properties of the first footer summary item for saving. The Active property must be set to False before saving is performed. This disables the default functionality of the cxPropertiesStore component. Saving is implemented Call the StoreToIniFile method to save the required item of the Components collection. Note that this method saves footer summary item properties to an INI file, though the StorageName and StorageType properties of the cxStore component specify a registry key as a storage. The RestoreButtonClick event handler restores the footer summary item settings by calling the RestoreFromIniFile method: //Delphi var PSComponent: TcxPropertiesStoreComponent; //... procedure TForm1.FormCreate(Sender: TObject); begin //disabling the default functionality of the cxPropertiesStore component cxGridStore.Active := False; //adding an item to the Components collection PSComponent := TcxPropertiesStoreComponent(cxGridStore.Components.Add); with PSComponent do begin //setting a table view for saving Component := tvFilms; //selecting the Column, Kind and Format property values of the first footer summary item for
Page 14 of 629
saving Properties.Add('DataController.Summary.FooterSummaryItems.0.Column'); Properties.Add('DataController.Summary.FooterSummaryItems.0.Kind'); Properties.Add('DataController.Summary.FooterSummaryItems.0.Format'); //saving the selected properties to an INI file (note that design time settings designate the registry key as a storage). The storage file is recreated upon saving StoreToIniFile('c:\store.ini', True); end; end; //... procedure TForm1.RestoreButtonClick(Sender: TObject); begin //restoring the footer summary item settings without involving any other Components collection items PSComponent.RestoreFromIniFile('c:\store.ini'); end; //... //C++ Builder TcxPropertiesStoreComponent *PSComponent; //... void __fastcall TForm1::FormCreate(TObject *Sender) { //disabling the default functionality of the cxPropertiesStore component cxGridStore->Active = false; //adding an item to the Components collection PSComponent = (TcxPropertiesStoreComponent*)cxGridStore->Components->Add(); //setting a table view for saving PSComponent->Component = tvFilms; //selecting the Column, Kind and Format property values of the first footer summary item for saving PSComponent->Properties->Add("DataController.Summary.FooterSummaryItems.0.Column"); PSComponent->Properties->Add("DataController.Summary.FooterSummaryItems.0.Kind"); PSComponent->Properties->Add("DataController.Summary.FooterSummaryItems.0.Format"); //saving the selected properties to an INI file (note that design time settings designate the registry key as a storage). The storage file is recreated upon saving PSComponent->StoreToIniFile("c:\\store.ini", true); } //... void __fastcall TForm1::RestoreButtonClick(TObject *Sender) { //restoring the footer summary item settings without involving any other Components collection items PSComponent->RestoreFromIniFile("c:\\store.ini"); } //... The result of the code execution (store.ini file contents) is demonstrated below: [tvFilms: TcxPropertiesStoreComponent] = DataController.Summary.FooterSummaryItems.0.Column=tvFilmsRUNTIME DataController.Summary.FooterSummaryItems.0.Kind=skMax DataController.Summary.FooterSummaryItems.0.Format=MAX=0 minutes
Page 15 of 629
DataController.Summary.FooterSummaryItems.0.Format=MAX=0 minutes
Page 16 of 629
Using the Image List Editor

See Also
The Express Cross Platform Library provides an image list component TcxImageList. Unlike the standard image list, it allows you to store 32-bit images (including PNG images) and paint them with alpha blending. In this topic, you will learn how to use this components design-time editor. How to Invoke the Image List Editor To invoke this editor, double-click the TcxImageList component or choose Edit from its context menu.
Image List Editor UI
Element Images section Displays all the images stored within the image list. As with the standard TImageList Editor, you can select multiple images within the list using the mouse and by holding the Shift and Ctrl keys. The last image in the selection is displayed within the Selected Image section. Description
Selected Image section Displays the selected image. The transparency checkerboard allows you to detect transparent areas and evaluate alpha blending parameters of the image.
Page 17 of 629
Transparent Color
Displays the transparent color for the selected image. When an image is added or imported from other image lists, its bottom-left pixel specifies the transparent color. You can change this color via the dropdown list or by clicking directly on a pixel in the selected image. Note:You cannot modify the transparent color for images with alpha channel and icons. Its always clNone.
Add Image Invokes the File Open dialog to load images from files. Note that you can select multiple files in this dialog. Selected images may be cut into pieces depending on the image lists Width and Height properties. Resulting images are appended to the list.
Replace Image Delete Image Clear List Export Images Import Images This button is enabled when there is at least one image list (a TCustomImageList descendant) with image dimensions matching the current image list. Click this button to display a dropdown list populated with all suitable image lists. Choose an item in the dropdown list to append all images from the corresponding image list to the current image list. Invokes the Save As dialog to save the selected images to a bitmap or PNG file. Use the dialog to specify the file name and location. Removes all images from the list. Removes the selected images from the list. Similar to Add Image. The only difference is that the last image in the selection is replaced with the images loaded from files.
Image Size Combo Box OK Cancel Apply Applies all pending changes to the image list. Discards all pending changes to the image list and closes the Image List Editor. Applies all pending changes to the image list and closes the Image List Editor. Allows you to assign the image dimensions by selecting one of the standard dimensions listed in a dropdown window.
Page 18 of 629
Localizer Editor UI
See Also
The Localizer Editor is used to translate resource strings that will then be used for application localization.
The Localizer Editor provides a grid containing a list of resource strings for all Developer Express products. The first grid band Resource Strings contains the following columns:
l l
Resource String Name lists resource string identifiers. Original Value lists resource string values as they were defined in Developer Express libraries.
Other bands are created dynamically for each language specified in the editor. A language band contains the following columns:
l l
Resource String Value lists resource string values that correspond to the specified language. Translated provides check boxes indicating that resource strings are translated. A check box is checked automatically if the corresponding Resource String Value item has been changed. To restore the default value (as it was specified in a Developer Express library), uncheck the check box.
The Localizer Editors main menu allows you to perform the following operations: File:
l l l l
New creates a new resource strings file. Open opens an existing resource strings file. Reopen opens a previously opened resource strings file. Save or Save As saves localized resource strings to .INI and .PAS files (a .PAS file contains custom resource strings). Build Resource File saves localized resource strings to a .RES file. This file is a storage alternative to .INI and .PAS files.
Page 19 of 629
The Localizer Editor allows you to convert the content in the .INI format into the .RES format. For this purpose, open an .INI file in the editor, and then save the content in the .RES file using this menu.
l l
Close closes a file. Exit closes the Localizer Editor.
View:
l
Expand All or Collapse All expands or collapses all rows in the grid.
Languages:
l
Add or Delete invokes the Choose Languages dialog. Use the dialog to add or remove languages to / from the file.
Options:
l
Save As Unicode if checked, the content is saved in the Unicode format. Otherwise, resource strings are stored in the ANSI format. The Unicode format is supported by platforms starting from version Delphi 2009. Platforms prior to Delphi 2009 only support the ANSI format. By default, the check box is unchecked. To save the file as Unicode encoded, make certain that the check box is checked. Note that this option is ignored if resource strings are to be stored in the .RES file.
Autosave Custom Resource Unit if checked, custom resource strings are automatically saved to a .PAS file.
Custom Resource Strings:

l
l l
Add adds custom resource strings to the file. If Add is clicked for the first time, the editor creates a Custom Resource Strings group row, and adds a blank data row, in which you can enter a custom resource string identifier, and the corresponding values for each language. Delete removes custom resource strings from the file. Build Custom Resource Unit saves custom resource strings to a .PAS file. This is only used if the storage for localized resource strings is an .INI file.
Page 20 of 629
How To Create Localized Strings Using the Localizer Editor

See Also
This topic describes how you can use the Localizer Editor to prepare localized strings for the German language. To learn how to localize an application using localized strings and the TcxLocalizer component, refer to the How To Localize an Application Using the TcxLocalizer help topic. Follow the steps below: 1. Run the Localizer Editor application. 2. Click File | New to create a new resource strings file that will contain all the specified resource strings. 3. Click Languages | Add to open the Choose languages dialog. In the dialog, check the German (Germany) check box, and press the OK button to add the German language to the file.
4. For the cxSDatePopupClear and cxSDatePopupToday resource identifiers (which are defined in the ExpressEditors Library for the TcxDBDateEdit controls Clear and Today button captions), specify the translated string in the Resource String Value column located in the German (Germany) band. Once specified, the corresponding check box in the Translated column is checked automatically. It informs the Localizer Editor that a localized string for German is provided.
Page 21 of 629
5. Specify the custom resource string for the forms caption of an application, which will be translated to German. To do this, click Custom Resource Strings | Add. A Custom Resource Strings category row and an empty data row are added to the grid. Enter the sAppName string in the Resource String Name column, the Localization Demo string in the Original Value of the Resource Strings band, and the Lokalisierung Demo string in the German (Germany) bands Resource String Value column.
6. Save localized resource strings in the storage.

l
If the .INI file is used for the translation, click File | Save. This also saves custom resource strings in the .PAS file (in the example, files are named Languages.INI and LocalizationResUnit.PAS). If the .RES file is used for the translation, click File | Build Resource File. This file contains both standard and custom resource strings.
Page 22 of 629
The following example shows the Languages.INI files content: [1031] cxSDatePopupClear="Lschen" cxSDatePopupToday="Heute" sAppName="Lokalisierung Demo" [Custom Resource Strings] sAppName="Localization Demo" Number 1031 in square brackets indicates the German languages locale. The following example shows the LocalizationResUnit.PAS files content: // Delphi unit LocalizationDemoResUnit; interface uses dxCore; resourcestring sAppName = 'Localization Demo'; implementation procedure AddResourceStringNames(AProduct: TdxProductResourceStrings); begin AProduct.Add('sAppName', @sAppName); end; initialization dxResourceStringsRepository.RegisterProduct('Custom Resource Strings', @AddResourceStringNames); finalization dxResourceStringsRepository.UnRegisterProduct('Custom Resource Strings'); end. Now these files can be used with the TcxLocalizer component for application localization. Refer to the How To Localize an Application Using the TcxLocalizer help topic, to learn how to translate the application.
Page 23 of 629
How To Localize an Application Using the TcxLocalizer

See Also
This topic describes how you can translate the TcxDBDateEdit controls (from the ExpressEditors Library) and the standard forms user interface to German using the TcxLocalizer component. To follow this lesson's steps, you need to first go through the following tutorial: How To Create Localized Strings Using the Localizer Editor. Follow the steps below:
1. Drop the TcxLocalizer component ( ) onto a form from the Component Palettes Dev Express page. 2. Specify the resource strings file created with the Localizer Editor: If the .INI file is used in the Object Inspector, click the ellipsis button next to the TcxLocalizer.FileName property, to specify the path to the .INI resource strings file (in the example, the Languages.INI file). Set the TcxLocalizer.StorageType property to lstIni.
If the .RES file is used specify it in the implementation clause, as shown in the following example: // Delphi // ... implementation {$R Languages.RES} // ... Set the TcxLocalizer.StorageType property to lstResource.
3. Make certain that the TcxLocalizer.Active property is True. If the .RES file is a resource strings store, and this file was compiled not to an executable file, but to a DLL file, then use the TcxLocalizer.LoadFromResource method instead. 4. Using the TcxLocalizer.Locale property, select the German (Germany) locale into which the application will be translated.
Page 24 of 629
Note that by default, the TcxLocalizer.Locale property is English (Original translation). This value means that the TcxLocalizer will use resource strings specified in Developer Express libraries. These strings do not correspond to any qualified locale. 5. To translate an application form using localized custom resource strings, do the following:
l l
Specify the .PAS file in the uses clause (in the example, the LocalizationResUnit unit). Specify the IdxLocalizerListener interface in the form declaration, register the form with the TdxResourceStringsRepository instance (this instance is referenced by the built-in dxResourceStringsRepository variable) as a listener, and obtain values from the corresponding custom resource strings in the interfaces TranslationChanged method.
The following example demonstrates how to translate the forms caption using the sAppName custom resource string: // Delphi // ... uses cxLocalization, dxCore, cxClasses, <LocalizationResUnit>; type TForm1 = class(TForm, IdxLocalizerListener) cxLocalizer1: TcxLocalizer; constructor Create(AOwner: TComponent); override; destructor Destroy; override; // ... public procedure TranslationChanged; end; // ... procedure TForm1.Create(AOwner: TComponent); begin dxResourceStringsRepository.AddListener(Self); inherited Create(AOwner); end; procedure TForm1.Destroy; begin dxResourceStringsRepository.RemoveListener(Self); inherited; end; procedure TForm1.TranslationChanged; begin Caption := cxGetResourceString(@sAppName); // ... end; Run the application to see the result.
Page 25 of 629
Page 26 of 629
TcxCanvas Object
Hierarchy Properties Methods
An enhanced device context wrapper compared with the standard VCL canvas. Unit cxGraphics TcxCanvas = class(TObject) Description The TCanvas class enables you to use device contexts in a convenient and easy to understand OOP style. The TcxCanvas class also provides access to the device context API. But in comparison with TCanvas, it provides additional useful functions such as DrawFocusRect and DrawFrame. The class is not derived from TCanvas, but it uses a TCanvas class instance to store data. This canvas can be accessed via the TcxCanvas.Canvas property.
Page 27 of 629
TcxComponentCollection Object
Represents a collection of components. Unit cxClasses TcxComponentCollection = class(TPersistent) Description The TcxComponentCollection class introduces members that allow you to:
l l l l
determine the number of elements in the collection (Count property); access a particular element (Items property); check whether a given component is in a collection (FindItemByID method); manage elements in the collection (the Add, Insert, Delete, and Clear methods).
Page 28 of 629
TcxComponentCollectionItem Object
The TcxComponentCollectionItem class implements an element of the TcxComponentCollection collection. Unit cxClasses TcxComponentCollectionItem = class(TComponent) Description The goal of designing the TcxComponentCollectionItem class as the TComponents descendant is to make the Delphi IDE aware of a collection element as a component. The TcxComponentCollectionItem class allows the unique identifier of the current element to be determined (see the ID property) and its index in the collection (see the Index property).
Page 29 of 629
TcxCustomContainerStyle Object
Hierarchy Properties Methods Events
Represents the style settings which can be applied to the associated container control. Unit cxContainer TcxCustomContainerStyle = class(TPersistent) Description The TcxCustomContainerStyle class introduces properties that control the appearance of the associated container control. The following style characteristics can be modified:
l l l l l
Border color, style and displayed edges (see the BorderColor, BorderStyle and Edges properties); Background color (see the Color property); Font (see the Font property); Displaying shadow (see the Shadow property); Look & feel (see the LookAndFeel property) - you can either use the native style defined by the operating system or apply one of the three predefined styles; Color and style for the text (see the TextColor and TextStyle properties).
The TcxCustomContainerStyle class is a base class for the container control and editor styles.
Page 30 of 629
TcxCustomLookAndFeelPainter Object
Hierarchy
Represents a library for drawing primitives. Unit cxLookAndFeelPainters TcxCustomLookAndFeelPainter = class(TObject); Description The TcxCustomLookAndFeelPainter class represents a library for drawing primitives used by other controls to render themselves on a graphic surface. It provides numerous functions to draw borders, buttons, and different graphic glyphs. TcxCustomLookAndFeelPainter is an abstract class that implements base functionality. Its descendants override library functions to draw primitives using a specific look & feel style. For instance, the TcxWinXPLookAndFeelPainter class implements drawing primitives using the Windows XP look & feel. Controls are not aware of a particular painter class used to render them. They only know the interface of the TcxCustomLookAndFeelPainter class and call its virtual functions. These functions are used to draw different control elements:
l l l l
buttons: DrawButton, DrawButtonBorder, DrawExpandButton, DrawCheckButton, etc.; headers: DrawHeader, DrawHeaderBorder, DrawHeaderPressed, etc.; indicators: DrawIndicatorItem; etc.
This concept provides flexibility when implementing various styles.
Page 31 of 629
TcxCustomPropertiesStore Object
Hierarchy Properties Methods Example See Also
Represents the base class for the TcxPropertiesStore object. Unit cxPropertiesStore TcxCustomPropertiesStore = class(TComponent) Description The TcxCustomPropertiesStore class is the base class for the TcxPropertiesStore object. It defines the basic functionality for the TcxPropertiesStore component. The TcxCustomPropertiesStore class defines properties and methods required for saving and restoring properties of selected components to a specific storage (registry, INI file or stream). It is possible to store/restore published properties of all components placed on the same form as a TcxPropertiesStore component. If the property, selected for saving/restoring, represents a TPersistent descendant, all its sub-properties can be stored/restored. For instance, if you specify the controls Font property to store, all its published sub-properties (Charset, Color, Height, Name, Pitch, Size and Style) will be saved. You can insert the "Font.Style" string into the TcxPropertiesStoreComponent.Properties list instead of "Font". This will save only the Style property of the TFont object associated with the Font property. The cxPropertiesStore component enables you to save/restore properties of TCollection elements. For instance, this can be used to save summary items (TcxDataSummary.FooterSummaryItems, TcxDataSummary.DefaultGroupSummaryItems, TcxDataSummary.SummaryGroups), bands in a grid control (TcxGridBandedTableView.Bands), etc. At design time, the cxPropertiesStore only allows you to select entire collections for storing/restoring. Using code though, allows saving individual items from collections, as well as the properties of a particular collection item. When restoring elements from a storage, the collection must contain the same number of items as in the storage. The PropertiesStore object does not allow you to store/restore sub-properties of the properties derived from the TComponent class. When a property references a TComponent descendant, only the objects Name is saved. To select components to store/restore using the TcxPropertiesStore object, you should add items to its Components collection. Every element in the collection represents a TcxPropertiesStoreComponent instance referring to the component and its properties. The component and its properties are specified by the TcxPropertiesStoreComponent.Component and TcxPropertiesStoreComponent.Properties attributes respectively. If you do not specify any properties via the Properties list, no properties will be stored to/restored from the storage. The TcxPropertiesStore component automatically restores properties of selected components when the form owning the component is created. On destroying the form, the TcxPropertiesStore automatically overwrites (or creates) the storage and saves the properties of selected components. This default behavior may be disabled by setting the Active property to False. In this case, the selected components settings can still be saved/restored by calling the StoreTo/RestoreFrom methods manually. The storage used for saving component settings is specified by two properties: StorageType and StorageName. The StoreTo/RestoreFrom methods allow you to save/restore properties for all selected components. To operate on individual components, you need to call the StoreTo.../RestoreFrom... methods (for instance, StoreToRegistry or RestoreFromStream) of the corresponding TcxPropertiesStoreComponent instances within the Components collection.
Page 32 of 629
TcxCustomStyle Object
Hierarchy Properties Methods See Also
Represents a base class for styles which notify listeners about attribute changes. Unit cxStyles TcxCustomStyle = class(TComponent); Description The TcxCustomStyle class implements the functionality required by listeners to notify them about changes to style attribute using their StyleChanged and StyleRemoved methods. The TcxStyle class is a descendant of the TcxCustomStyle class which introduces style attributes that are shared by all components, namely the background color, font details and text color. When any of the style attributes are changed, all listeners are notified. TcxCustomStyles supports an abstract collection of styles, each of which is presented by the TcxCustomStyle class. Descendants of the TcxCustomStyles class declare appropriate styles for different control elements depending upon the controls type. TcxCustomStyles receives notifications about style attribute changes via its StyleChanged and StyleRemoved methods. When such notifications are received, the corresponding control elements are repainted.
Page 33 of 629
TcxCustomStyles Object
Represents a collection of style links for various component elements. Unit cxStyles TcxCustomStyles = class(TcxInterfacedPersistent); Description The TcxCustomStyles class supports an abstract collection of style links for various component elements. Descendants of the TcxCustomStyles class declare appropriate styles for different control elements depending upon the controls type. The style of each control element is represented by an object of the TcxCustomStyle class. The style of every element is represented by an instance of the TcxCustomStyles or TcxStyle class. Its possible to assign the same styles to several elements and even to different TcxCustomStyles objects. TcxCustomStyles provides the StyleChanged and StyleRemoved methods which are used to respond to style changes and adds itself as a listener of its TcxCustomStyle elements. When any of the TcxCustomStyle attributes are changed, TcxCustomStyles receives a notification and updates the corresponding control elements. The StyleSheet property specifies the style sheet applied to the current collection of style links. A style sheet represents a collection of styles for the elements of controls supporting Styles technology (for instance, a grid view). Instead of specifying individual styles for each control element, you can assign it a style sheet, thus providing values for all style properties.
Page 34 of 629
TcxCustomStyleSheet Object
Represents the base class for all style sheets. Unit cxStyles TcxCustomStyleSheet = class(TcxComponent); Description A style sheet represents a collection of styles for elements of controls supporting Styles technology (for instance, a grid view). Instead of specifying individual styles for a control element, you can assign it a style sheet, thus providing values for all style properties. To assign a style sheet to a control element, use the StyleSheet property inherited from the TcxCustomStyles class. The TcxCustomStyleSheet object implements functionality common to all style sheets. It is the base class and does not actually provide any style properties. Descendants of the class publish style properties specific to a control element for which style sheets are designed. For instance, the TcxGridTableViewStyleSheet class declares styles specific to a grid table view. Styles and style sheets are usually stored within a style repository (a TcxStyleRepository component) that provides WYSIWYG styles and style sheet editing facilities. The style repository editor gives you the ability to create a style sheet of a specific type, adjust its properties, add predefined style sheets, load from and save style sheets to an INI file. You can also load/save style sheets to an INI file programmatically via the LoadStyleSheetsFromIniFile and SaveStyleSheetsToIniFile procedures respectively.
Page 35 of 629
TcxDialogMetricsInfo Object
Hierarchy Properties See Also
The TcxDialogMetricsInfo represents the dialog information. Unit cxClasses TcxDialogMetricsInfo = class(TObject) Description The dialog information built-in layout settings and custom settings (provided by the IcxDialogMetricsInfoData implementer) is stored with the TcxDialogsMetricsStore for further use during the application session. This class implements multiple properties that store built-in layout settings. The dialogs custom information is stored with the TcxDialogMetricsInfo.Data property. The TcxDialogMetricsInfo is used internally by the TcxDialogsMetricsStore.
Page 36 of 629
TcxDialogsMetricsStore Object
The TcxDialogsMetricsStore implements storage for dialog settings. Unit cxClasses TcxDialogsMetricsStore = class(TObject) Description The TcxDialogsMetricsStore is used to store information on the dialog (dialog layout built-in settings and custom information) during the application session. By default, the TcxDialogsMetricsStore stores dialog built-in layout settings. To store custom settings, the dialog class needs to implement the IcxDialogMetricsInfoData interface. The TcxDialogsMetricsStore can be instantiated using the cxDialogsMetricsStore routine. The following example demonstrates how to use the TcxDialogsMetricsStore, in order to provide the same dialog settings for different dialog sessions: // Delphi // ... uses // ... cxClasses; TDialogForm = class(TForm) public function ShowModal: Integer; override; end; // ... function TDialogForm.ShowModal: Integer; begin cxDialogsMetricsStore.InitDialog(Self); Result := inherited ShowModal; cxDialogsMetricsStore.StoreMetrics(Self); end;
Page 37 of 629
TcxImageCollectionItem Object
The TcxImageCollectionItem represents an image in the image collection. Unit cxGraphics TcxImageCollectionItem = class(TcxComponentCollectionItem) Description The TcxImageCollectionItem class provides the Picture property to load the image, and the Draw method to paint the image. All other members are used to provide details about the stored image. The TcxImageCollectionItem object is referenced by the TcxImageCollectionItems.Items property.
Page 38 of 629
TcxImageCollectionItems Object
The TcxImageCollectionItems represents a collection of images that are stored in the TcxImageCollection component. Unit cxGraphics TcxImageCollectionItems = class(TcxComponentCollection) Description The TcxImageCollectionItems object is referenced by the TcxImageCollection.Items property.
Page 39 of 629
TcxInterfacedPersistent Object
Hierarchy
Represents a base class for objects implementing interfaces which support loading and saving of properties from/to a stream. Unit cxClasses TcxInterfacedPersistent = class({$IFDEF DELPHI6}TInterfacedPersistent {$ELSE}TPersistent, IUnknown {$ENDIF}); Description The TcxInterfacedPersistent class is designed to provide support for persistent objects implementing interfaces via different versions of the IDE. If you use an IDE prior to Delphi 6, it provides the members necessary to implement the functionality for working with interfaces. Additionally, it overrides the GetOwner method so it returns the class passed as the parameter to the constructor.
Page 40 of 629
TcxLanguage Object
Hierarchy Properties
Represents a user interface language used for the corresponding locale. Unit cxLocalization TcxLanguage = class(TCollectionItem) Description The TcxLanguage object is referenced by the localizers Languages.Items property. A Dictionary stores localized strings associated with the current language.
Page 41 of 629
TcxLanguages Object
Represents a collection of languages. Unit cxLocalization TcxLanguages = class(TCollection) Description The TcxLanguages object is referenced by the localizers Languages property.
Page 42 of 629
TcxLockedStateImageOptions Object
The base class for classes that provide display settings for a "Locked View" image. Unit cxControls TcxLockedStateImageOptions = class(TPersistent) Description Settings include: Property AssignedValues Color Effect Enabled Font ShowText Text Specifies message box settings that override global settings. Specifies the background color of the message box. Specifies the visual effect for a "Locked View" image. Specifies whether to display a "Locked View" image. Specifies the font of the message string. Specifies whether to display a message box over a "Locked View" image. Specifies the message string. Description
Page 43 of 629
TcxLookAndFeel Object
Specifies a TcxControl descendants appearance and behavior when it interacts with a user. Unit cxLookAndFeels TcxLookAndFeel = class(TcxInterfacedPersistent, IcxLookAndFeelNotificationListener); Description Each Developer Express control has its own look and feel implemented via the TcxLookAndFeel class. This class has three properties Kind, NativeStyle, and SkinName that determine a controls appearance and the manner in which the control visually responds to user actions (focus, mouse move, clicks etc.) The NativeStyle property specifies whether to use the native windows style for control painting. This property has a higher priority than the Kind or SkinName property. If the NativeStyle property is set to True, the control is painted according to the native windows style (Currently, this feature only supported on Windows XP or later). Otherwise, the Kind or SkinName property specifies the paint style for the control. If any of the properties mentioned above is modified, the corresponding flag is set in the AssignedValues property and the OnChanged event is raised. To reset all the flags in the AssignedValues property, call the Reset method. Importing/Exporting Look and Feel Settings Every Developer Express control can export its look and feel to other Developer Express controls. The MasterLookAndFeel property determines the imported look and feel of any Developer Express control. Any control, which imports the look and feel of the current control, is defined as a listener. It listens to changes within the current control via the IcxLookAndFeelNotificationListener interface. The IcxLookAndFeelNotificationListener interface listens for two events:
l l
Any look and feel setting change via the MasterLookAndFeelChanged method. The TcxLookAndFeel class instance destruction via the MasterLookAndFeelDestroying method.
Listener controls reflect all changes within the current control. If an imported TcxLookAndFeel class instance is destroyed, a listener control obtains its look and feel settings from the cxDefaultLookAndFeelKind, cxDefaultLookAndFeelNativeStyle, and cxDefaultLookAndFeelSkinName global constants. Note: The look and feel properties of TcxControl descendants have a higher priority and override master look and feel settings. To access the painter that is used to paint the control according to the look and feel settings, use the Painter property. Root Look and Feel Settings The root look and feel (a TcxLookAndFeel class instance) is automatically created on the application startup. Its Kind, NativeStyle, and SkinName properties contain values of the cxDefaultLookAndFeelKind, cxDefaultLookAndFeelNativeStyle, and cxDefaultLookAndFeelSkinName global constants, respectively. At design and runtime, the root look and feel can be customized via the TcxLookAndFeelController and TdxSkinController components. At runtime, you can access the root look and feel via the RootLookAndFeel global function. When an instance of the TcxLookAndFeel class is created, it automatically becomes a listener of the root look and feel controller. You can change its broadcaster by assigning another look and feel to the MasterLookAndFeel property.
Page 44 of 629
TcxOwnedInterfacedCollection Object
Represents a collection that maintains information about its owner. Unit cxClasses TcxOwnedInterfacedCollection = class(TOwnedCollection, IUnknown) Description This class introduces the OnChange event, which enables you to respond to changes to the collection.
Page 45 of 629
TcxStyle Object
Specifies style attributes for an element of some control. Unit cxStyles TcxStyle = class(TcxCustomStyle); Description TcxStyle declares properties controlling the appearance of a control element. These attributes are background color, font details and text color. The AssignedValues property determines whether to use these attributes when rendering control elements. When you assign a specific style attribute, the corresponding flag is set in AssignedValues. Controls usually have to publish styles for several elements such as background, buttons, panels, etc. In this case, controls can declare a class derived from the TcxStyles class publishing specific style properties. Each property of this type represents an object of the TcxStyle class. It is possible to assign the same styles to multiple properties. When any attribute of a particular style is changed, all TcxStyles objects owning a property with this style assigned receive notification and update the corresponding control elements. You can use a style repository (TcxStyleRepository) to create and store individual styles. When a repository is destroyed, it deletes all styles it owns. The StyleRepository property indicates the repository object which owns the current style.
Page 46 of 629
TcxStyleController Object
Represents the base class for objects managing style attributes common to several components. Unit cxContainer TcxStyleController = class(TComponent); Description A style controller manages style properties common to several components. When a style is assigned a style controller, it is automatically registered as a listener of this style controller. Thus, when you change properties via a style controller, all style objects will receive corresponding notifications and repaint their components as necessary. Use the Styles property to access a specific style and call the RestoreStyles method to restore the default values to all the style attributes of every style object. The TcxStyleController is the base class for TcxEditStyleController which allows you to define style properties common to several editors.
Page 47 of 629
TcxStyles Object
Represents an abstract collection of styles which control the appearance of specific control elements. Unit cxStyles TcxStyles = class(TcxCustomStyles); Description The TcxStyles class represents an abstract collection of styles for different control elements. It doesnt introduce any new style properties, but instead provides the ability to access styles by their indexes. Each style is of the TcxStyle class and declares general style attributes, such as the background color, font details and text color. Descendants of the TcxStyles class declare appropriate styles for different control elements depending upon the controls type. Since TcxStyles is inherited from the TcxCustomStyles class it receives notifications about style attribute changes via its StyleChanged and StyleRemoved methods. TcxStyles adds itself as a listener to all its TcxStyle elements and receives notification when any of the TcxStyle attributes are changed and the corresponding control elements are then repainted as a result.
Page 48 of 629
TdxBMPImage Object
A BMP format. Unit dxGDIPlusClasses TdxBMPImage = class(TdxGPImage) Description This type is used indirectly. Use the TdxSmartImage, as a generic type to allow automatic type cast when processing the image.
Page 49 of 629
TdxCustomScreenTipBand Object
The TdxCustomScreenTipBand class is the base class for classes implementing sections in the ScreenTip window. Unit dxScreenTip TdxCustomScreenTipBand = class(TPersistent) Description A ScreenTip window can be split into three sections: header (see the ScreenTips Header property), description (see the ScreenTips Description property) and footer (see the ScreenTips Footer property).
These sections are represented by the TdxCustomScreenTipBands derived classes. The TdxCustomScreenTipBand class provides an interface common to its descendants:
l l l
Glyph property specifies an explanatory image. Text property specifies a descriptive text. TextAlign property specifies the horizontal alignment of text in the section.
Additionally, the Font property is provided to identify font options that are currently applied to a descriptive text in a particular section. Do not use the TdxCustomScreenTipBand class directly. Use its descendants instead.
Page 50 of 629
TdxFader Object
Represents an object that controls fading animation effects within an application. Unit dxFading TdxFader = class(TObject); Description This class introduces properties that allow you to:
l l
Enable or disable fading animation effects within an application (State). Limit the number of animations to be played at one time (MaxAnimationCount).
To access the TdxFader object within an application, use the dxFader function. Use the dxFadeInDefaultAnimationFrameCount, dxFadeInDefaultAnimationFrameDelay, dxFadeOutDefaultAnimationFrameCount, and dxFadeOutDefaultAnimationFrameDelay global constants to customize the animation speed and smoothness. Important Note: Fading animation effects require the Microsoft GDI+ library to be installed. Gdiplus.dll is included with Windows XP. GDI+ is available as a redistributable file for Windows NT 4.0 SP6, Windows 2000, Windows 98, and Windows Me. To download the latest redistributable, see http://www.microsoft.com/downloads/details.aspx?FamilyID=6a63ab9c-df12-4d41-933cbe590feaa05a&DisplayLang=en.
Page 51 of 629
TdxGIFImage Object
A GIF format. Unit dxGDIPlusClasses TdxGIFImage = class(TdxGPImage) Description This type is used indirectly. Use the TdxSmartImage, as a generic type to allow automatic type cast when processing the image.
Page 52 of 629
TdxJPEGImage Object
A JPEG format. Unit dxGDIPlusClasses TdxJPEGImage = class(TdxGPImage) Description This type is used indirectly. Use the TdxSmartImage, as a generic type to allow automatic type cast when processing the image.
Page 53 of 629
TdxPNGImage Object
A PNG format. Unit dxGDIPlusClasses TdxPNGImage = class(TdxGPImage) Description This type is used indirectly. Use the TdxSmartImage, as a generic type to allow automatic type cast when processing the image.
Page 54 of 629
TdxScreenTip Object
The TdxScreenTip class implements a ScreenTip. Unit dxScreenTip TdxScreenTip = class(TcxComponentCollectionItem) Description The TdxScreenTip class represents an enhanced ScreenTip. A ScreenTip window can contain three sections header (see the Header property), description (see the Description property) and footer (see the Footer property).
Each section can display an explanatory image (see the sections Glyph property), a descriptive text (see the sections Text property) and a keyboard shortcut. To display a common footer across a number of different ScreenTips, specify footer information via the ScreenTip repositorys StandardFooter property and toggle the UseStandardFooter property of specific ScreenTips. If there are no specific details to be shown in the ScreenTips header, toggle the ScreenTips UseHintAsHeader property to display a hint in this section specified by the controls Hint property. To customize the width of the ScreenTips window, use the ScreenTips Width property. From the ScreenTip instance you can access other ScreenTips via the ScreenTips Collection property.
Page 55 of 629
TdxScreenTipBand Object
The TdxScreenTipBand class implements a section in the ScreenTip window. Unit dxScreenTip TdxScreenTipBand = class(TdxCustomScreenTipBand) Description A ScreenTip window can be split into three sections: header (see the ScreenTips Header property), description (see the ScreenTips Description property) and footer (see the ScreenTips Footer property).
Each section is represented by TdxScreenTipBand. With the TdxScreenTipBands properties, you can specify the following for each section:
l l
An explanatory image (see the Glyph property). A descriptive text (see the Text property).
You can also specify the horizontal alignment of text in the section (see the TextAlign property). Note: to specify common footer information for a number of ScreenTips, use the ScreenTip repositorys StandardFooter property instead of the ScreenTips Footer property to avoid replication. To specify which ScreenTip displays this information, toggle the UseStandardFooter property of the specific ScreenTip.
Page 56 of 629
TdxScreenTipCollection Object
Represents the ScreenTip collection. Unit dxScreenTip TdxScreenTipCollection = class(TcxComponentCollection) Description TdxScreenTipCollection stores ScreenTips created both at design and run-time. At design-time (within the Object Inspector) click the ellipsis button next to the ScreenTip repositorys Items property to invoke a design-time editor for adding or removing ScreenTips from the repository (see TdxScreenTipRepository). At run-time, you can add a new ScreenTip to the collection using the collections Add method. Indexed access to an individual ScreenTip can be obtained via the Items property. The TdxScreenTipCollection object is referenced by the ScreenTip repositorys Items property.
Page 57 of 629
TdxScreenTipLink Object
A link between a hinted control and an associated ScreenTip. Unit dxScreenTip TdxScreenTipLink = class(TCollectionItem) Description The link maps the hinted control and associated ScreenTip using the Control and ScreenTip properties. The TdxScreenTipLink object is referenced by the ScreenTip link collections Items property.
Page 58 of 629
TdxScreenTipLinks Object
A collection of ScreenTip links. Unit dxScreenTip TdxScreenTipLinks = class(TCollection) Description The collection stores links established between hinted controls (see the links Control property) and associated ScreenTips (see the links ScreenTip property). The TdxScreenTipLinks object is referenced by the ScreenTip styles ScreenTipLinks property.
Page 59 of 629
TdxScreenTipStyle Object
Style settings for ScreenTips controlled by the TcxHintStyleController component. Unit dxScreenTip TdxScreenTipStyle = class(TcxCustomHintStyle) Description The TdxScreenTipStyle object is referenced by the hint style controllers HintStyle property.
Page 60 of 629
TdxSmartImage Object
A universal image format. Unit dxGDIPlusClasses TdxSmartImage = class(TdxGPImage) Description This type is used as a generic to automatically determine the actual image format, when processing the image.
Page 61 of 629
TdxTIFFImage Object
A TIFF format. Unit dxGDIPlusClasses TdxTIFFImage = class(TdxGPImage) Description This type is used indirectly. Use the TdxSmartImage, as a generic type to allow automatic type cast when processing the image.
Page 62 of 629
TcxImageCollection Object
The TcxImageCollection component implements a collection capable of storing images of different formats and sizes. Unit cxGraphics TcxImageCollection = class(TComponent) Description The component uses the TPicture type (see the collection items Picture property) in order to store images of different formats and sizes. You can perform the following operations with the TcxImageCollection component:
l
Paint the stored images using the collections Draw overloads. When drawing, you can apply image sizing and antialiasing. Dynamically synchronize the state of the control (that uses images in the image collection) with the collections state using a notification mechanism (see the AddListener and RemoveListener methods, and the IcxImageCollectionListener interface).
Images can be added to the component in the following ways:

l l
At design-time using the IDEs Collection Editor. In code via the components Items property.
Page 63 of 629
TcxImageList Object
Hierarchy Properties Methods Events See Also
An enhanced image list control. Unit cxGraphics TcxImageList = class(TDragImageList) Description Unlike the standard TImageList, TcxImageList allows you to store 32-bit images (including PNG images) and paint them using alpha blending. In addition to the settings inherited from the base TDragImageList class, the TcxImageList class introduces members that allow you to:
l l l l l
Specify whether the alpha channel information is used to draw stored images (AlphaBlending). Improve performance by postponing sending notifications of image list changes (BeginUpdate and EndUpdate). Paint stored images using various image adjustment options (Draw). Copy stored images to another image list (CopyImages). Retrieve image and transparency mask bitmaps of stored images (GetImage, GetImageInfo, and GetMask).
At design time, the TcxImageList allows you to easily retrieve the dimensions of images (the Height and Width properties) and load images from any image list (a TCustomImageList descendant) on a form. To do this, click Assign From in the components context menu and select the desired list image. Note that prior to loading images from the selected image list, the TcxImageList clears its contents. The TcxImageList also provides a design-time editor, which allows you to load images into the image list, manage stored images within the list, and export them into files. Refer to the Using the Image List Editor topic, to learn more about this editor. Note:To retrieve bitmaps of 32-bit images stored in the TcxImageList, call the GetImage or GetImageInfo method, instead of the GetBitmap method. Important Note:Image lists depend on Comctl32.dll. Make sure you have the latest version of this file installed, to avoid problems displaying images.
Page 64 of 629
TcxLocalizer Object
The localization component. Unit cxLocalization TcxLocalizer = class(TComponent) Description Use the TcxLocalizer component to create localized applications. To learn how to translate applications with the TcxLocalizer, refer to the How To Localize an Application Using the TcxLocalizer help topic.
Page 65 of 629
TcxLookAndFeelController Object
Represents a component providing a convenient way to manipulate common look and feel settings for all Developer Express controls (TcxControl descendants) at design time. Unit cxLookAndFeels TcxLookAndFeelController = class(TComponent, IcxLookAndFeelNotificationListener) Description The default look and feel of any TcxControl descendant is determined by the root look and feel. The root look and feel is a TcxLookAndFeel class instance that is created on application startup. You can access it at runtime via the RootLookAndFeel global function. The default values of the root look & feels Kind, NativeStyle, and SkinName properties are specified by the cxDefaultLookAndFeelKind, cxDefaultLookAndFeelNativeStyle, and cxDefaultLookAndFeelSkinName global constants, respectively. To customize the root look and feel settings at design time, use the TcxLookAndFeelController or TdxSkinController component. Drop any of these components onto a form and access root look and feel settings via the components Kind, NativeStyle, and SkinName properties in the Object Inspector. To programmatically revert these settings to default values, call the components Reset method. Unlike the TcxLookAndFeelController, the TdxSkinController allows you to apply skins both to forms and any Developer Express controls on them. TcxControl descendants allow you to set their own look and feel. The controls own look and feel is also a TcxLookAndFeel class instance that can be accessed via the controls LookAndFeel property.
Page 66 of 629
TcxPropertiesStore Object
Hierarchy Properties Methods Example See Also
Represents a TcxPropertiesStore component. Unit cxPropertiesStore TcxPropertiesStore = class(TcxCustomPropertiesStore) Description The TcxPropertiesStore component is used to save and restore component-specific information to a storage of a specific type. It allows you to store/restore required published properties of selected components on the form containing the PropertiesStore component. The PropertiesStore component provides a design-time editor to choose components and their properties to save/restore using the storage.
The TcxPropertiesStore supports the following storage types: registry (VCL only), INI file and stream. To enable the TcxPropertiesStore object: 1.Place a TcxPropertiesStore component on a form 2.Specify the components and their properties to be stored/restored using the storage 3.Specify the storage name and type via the StorageName and StorageType properties When the form is opened, TcxPropertiesStore attempts to read settings of the selected components from the storage. If the
Page 67 of 629
storage exists, its property settings replace the settings of existing components. When the form is destroyed, the storage is recreated and properties of the selected components are saved. Disable this automatic functionality by setting its Active property to False. Manual operation is also available by calling the StoreTo and RestoreFrom methods to store/restore selected component settings to the current storage at any time. The cxPropertiesStore allows the saving and restoring of properties at design time. The storage for design time saving/restoring is identified by the StorageName and StorageType properties. Refer to the TcxCustomPropertiesStore description for information on property types which can be stored/restored.
Page 68 of 629
TcxStyleRepository Object
Represents an object managing collections of styles and style sheets. Unit cxStyles TcxStyleRepository = class(TComponent); Description A style repository represents organized storage of styles applicable to Developer Express controls supporting Styles technology. The TcxStyleRepository class allows you to create, store and access individual styles where each is presented by the TcxCustomStyle class (or its descendant). TcxCustomStyle is an abstract class. Use the TcxStyle class to create items in a repository. Most Developer Express controls supporting Styles technology declare a Styles member. This supports a collection of style properties defining the appearance of particular control elements. Usually you have to create a style, initialize its attributes as appropriate and assign the style to the controls style property. Using style sheets is another way of initializing style properties of a control element. A specific style sheet represents a set of styles suitable for a particular control (for instance, a TcxGridTableViewStyleSheet class specify styles for a grid view). Instead of specifying individual styles for a control element, you can assign it a style sheet thus specifying values for all style properties. To assign a style sheet to a control element, use its Styles.StyleSheet property. You can create a style sheet programmatically using the CreateStyleSheet method. All style sheets are supported by the StyleSheets property. The style repository editor provides you a convenient way to manipulate styles and style sheets at design time. The next image demonstrates the Style Sheets tab of the style repository editor:
Page 69 of 629
TdxScreenTipRepository Object
The TdxScreenTipRepository class represents the ScreenTip repository component. Unit dxScreenTip TdxScreenTipRepository = class(TComponent) Description A ScreenTip repository is a component used for storing information on control ScreenTips. It wraps the ScreenTip collection (see the repositorys Items property) and provides the following ScreenTip-specific settings:
l
l l
l l
DescriptionFont property represents font settings for a descriptive string displayed in the ScreenTip windows description section. FooterFont property represents font settings for a descriptive string displayed in the ScreenTip windows footer section. HeaderFont property represents font settings for a descriptive string displayed in the ScreenTip windows header section. AssignedFonts property activates font settings specified by the above properties. ShowDescription property specifies whether to show an enhanced ScreenTip.
StandardFooter property provides settings for a ScreenTip windows footer section common to a number of ScreenTips. To apply settings specified by this property to a particular ScreenTip, set the ScreenTips UseStandardFooter property to True.
Page 70 of 629
TcxContainer Object
Represents a class that clips child windowed controls within a specified region. Unit cxContainer TcxContainer = class(TcxControl, IcxMouseTrackingCaller); Description The TcxContainer class is the base class for TcxCustomEdit which provide the base functionality for ExpressQuantumEditors. The TcxContainer class implements the clipping of a windowed control. When placing child windowed controls onto the client region of a TcxContainer, only the region defined by the client rectangle is painted. The TcxContainer class introduces the style attributes (see the Style, StyleDisabled, StyleFocused and StyleHot properties) which control the appearance of the container control in various states such as normal, disabled, focused and hot-tracked (highlighted), respectively. The TcxContainer class provides the RestoreStyles method to restore the default style attributes values for a container control. A custom editor has to implement the IcxContainerInnerControl interface in order to provide a link to the container control associated with it (see the GetcxContainer function).
Page 71 of 629
TcxControl Object
The TcxControl object is the base class designed by Developer Express Inc. for its cross-platform windowed controls. Unit cxControls TcxControl = class(TCustomControl); Description The TcxControl object is used to create native cross-platform windowed controls that do not correspond to standard Windows components. The TcxControl object is the common ancestor for all native cross-platform windowed controls. As a direct descendant of the TCustomControl class, the TcxControl object provides ActiveCanvas and Canvas properties to help native control drawing easier and to manage the drawing surface. These properties provide access to a TcxCanvas object representing a drawing surface for cross-platform windowed controls.
Page 72 of 629
TcxControlChildComponent Object
Represents a child component of a control. Unit cxControls TcxControlChildComponent = class(TComponent); Description The TcxControlChildComponent represents a base class for a child component of a control (for instance, grid views in the ExpressQuantumGrid4 control). The parent control is passed as a parameter in the constructor.
Page 73 of 629
cxContainerMaxBorderWidth global constant

Specifies the maximum width of the container controls border. Unit cxLookAndFeelPainters cxContainerMaxBorderWidth = 2;
Page 74 of 629
cxContainerShadowWidth global constant

Specifies the width of the shadow painted for container controls. Unit cxContainer cxContainerShadowWidth = 3; Description Container controls (for instance, the TcxListBox control) use the TcxContainerStyle object to control their appearance. This objects Shadow property specifies whether the shadow is displayed. The width of the shadow is specified by the cxContainerShadowWidth global constant which is equal to 3 by default.
Page 75 of 629
cxDefaultAutoCompleteDelay global constant

Specifies the time interval (in milliseconds) during which any additional key presses that are made will be treated as an addition to the filter string used in the incremental search. Unit cxContainer cxDefaultAutoCompleteDelay = 500; Description The cxDefaultAutoCompleteDelay global constant is used by the container controls which support incremental search (for instance, the TcxListBox, TcxCheckListBox, and TcxMCListBox controls) to specify the time interval during which any additional key presses that are made will be treated as an addition to the filter string used in the incremental search. When the number of milliseconds specified by cxDefaultAutoCompleteDelay has passed, the filter string is reset so that it consists only of the last key pressed. The default value of the cxDefaultAutoCompleteDelay global constant is equal to 500 (which means a half second delay).
Page 76 of 629
cxDefaultLookAndFeelKind global constant

Determines the default value of the Kind property for all look and feel classes. Unit cxLookAndFeels cxDefaultLookAndFeelKind = lfUltraFlat;
Page 77 of 629
cxDefaultLookAndFeelNativeStyle global constant

Determines the default value of the NativeStyle property for all look and feel classes. Unit cxLookAndFeels cxDefaultLookAndFeelNativeStyle = False;
Page 78 of 629
cxDefaultLookAndFeelSkinName global constant

Determines the default value of the SkinName property for all look and feel classes. Unit cxLookAndFeels cxDefaultLookAndFeelSkinName = '';
Page 79 of 629
cxDialogsMetricsStore Function
See Also
Instantiates a TcxDialogsMetricsStore object that stores a dialogs settings. Unit cxClasses Declaration function cxDialogsMetricsStore: TcxDialogsMetricsStore; Description The cxDialogsMetricsStore routine returns a reference to the TcxDialogsMetricsStore instance.
Page 80 of 629
cxExportGraphicClass global constant

Specifies which type of graphics class to use to generate the images, which are applied to the exported data.
Unit cxExport
cxExportGraphicClass : TGraphicClass = TBitmap;
Description The DX controls (such as TcxGrid, TcxTreeList and TcxVerticalGrid) provide the means for exporting their data to various formats. To reflect the appearance of those controls in the exported formats different types of images are used. To minimize the storage requirement for the generated images the TMetafile or TJPEGImage types can be applied. Use the cxExportGraphicClass constant to specify the type of the graphics class that will be used to generate the images when the DX controls export routines are invoked.
Page 81 of 629
cxGetResourceString Function
See Also
Retrieves a resource string for the specified resource identifier. Unit cxClasses Declaration function cxGetResourceString(const ResString: Pointer): string; Description The cxGetResourceString function retrieves a resource string for the resource identifier specified by the ResString parameter. You pass the address of the resource string as the identifier String constants for Express products are stored as resources. The cxGetResourceString function is used internally to retrieve strings for specific control elements. For instance, a date editor determines the caption to be displayed on the Clear button within the dropdown calendar by reading the value of the cxSDatePopupClear resource string as follows: cxGetResourceString(@cxSDatePopupClear); By default, it displays Clear. For the purpose of localization, you can change the resource strings depending on the language and the regional settings. To do so, call the cxSetResourceString procedure passing a resource identifier and the new value of the resource string as parameters. This procedure substitutes the value of the resource string during execution only. For instance, the following code specifies a new value for the cxSDatePopupClear resource string in the German language: //Delphi cxSetResourceString(@cxSDatePopupClear, 'Lschen'); //C++ Builder cxSetResourceString(&_cxSDatePopupClear, "Lschen"); Note:To easily localize applications that use standard, DevExpress or other third-party controls to any language supported by Windows, use the TcxLocalizer component.
Page 82 of 629
cxSetResourceString Procedure
See Also
Substitutes a value of the resource string retrieved by the cxGetResourceString function. Unit cxClasses Declaration procedure cxSetResourceString(const ResString: Pointer; const Value: string); Description String constants for Express products are stored as resources. The cxGetResourceString function is used internally to retrieve strings for specific control elements. You might use the cxSetResourceString procedure to substitute a value of a specific resource string during the program execution for localization purposes. Note that a new value does not replace a resource in an executable file. The ResString argument specifies a resource string identifier. You should pass an address of the resource string as the ResString parameter. A new value of the resource string is determined by Value. In the cxEditConsts unit, the cxSDatePopupClear resource string is declared. By default, it identifies the Clear string displayed in a button within the dropdown calendar of the date editor. To display the German equivalent of the string, you can use the cxSetResourceString procedure. //Delphi cxSetResourceString(@cxSDatePopupClear, 'Lschen'); //C++ Builder cxSetResourceString(&_cxSDatePopupClear, "Lschen"); This code changes the caption of the Clear button for all date editors in the current application. Note:To easily localize applications that use standard, DevExpress or other third-party controls to any language supported by Windows, use the TcxLocalizer component.
Page 83 of 629
dxFadeInDefaultAnimationFrameCount global constant

See Also
Determines the default number of frames for a fade-in animation effect. Unit dxFading dxFadeInDefaultAnimationFrameCount: Integer = 4; Description Possible values are 1 through 32.
Page 84 of 629
dxFadeInDefaultAnimationFrameDelay global constant

See Also
Determines the default frame delay (in milliseconds) for a fade-in animation effect. Unit dxFading dxFadeInDefaultAnimationFrameDelay: Integer = 20; Description Possible values are 10 through 300.
Page 85 of 629
dxFadeOutDefaultAnimationFrameCount global constant

See Also
Determines the default number of frames for a fade-out animation effect. Unit dxFading dxFadeOutDefaultAnimationFrameCount: Integer = 12; Description Possible values are 1 through 32.
Page 86 of 629
dxFadeOutDefaultAnimationFrameDelay global constant

See Also
Determines the default frame delay (in milliseconds) for a fade-out animation effect. Unit dxFading dxFadeOutDefaultAnimationFrameDelay: Integer = 20; Description Possible values are 10 through 300.
Page 87 of 629
dxFader global function

Provides access to an object that controls fading animation effects within an application. Unit dxFading function dxFader: TdxFader; Description Refer to the TdxFader class description, to learn about available settings.
Page 88 of 629
GetcxContainer Function
Obtains the container control for a particular control. Unit cxContainer Declaration function GetcxContainer(AControl: TWinControl): TcxContainer; Description The GetcxContainer method obtains the container control of the TcxContainer type for the control specified by the AControl parameter. This function performs the appropriate cast for the TcxContainer descendant. If an object implements the IcxContainerInnerControl interface the function retrieves the container control via the IcxContainerInnerControl.ControlContainer property.
Page 89 of 629
LoadStyleSheetsFromIniFile Procedure
See Also
Loads style sheets from an INI file. Unit cxStyles type TcxCustomStyleSheetClass = class of TcxCustomStyleSheet; procedure LoadStyleSheetsFromIniFile(const AIniFileName: string; AStyleRepository: TcxStyleRepository; AStyleSheetClass: TcxCustomStyleSheetClass; const AStyleSheetNames: TStrings = nil; AOwner: TComponent = nil; const AStyleSheetList: TList = nil; AStyleGetName: TcxStyleGetName = nil); Description The LoadStyleSheetsFromIniFile method loads style sheets into a style repository determined by the AStyleRepository parameter from the INI file with the name specified by the AIniFileName parameter. The AStyleSheetClass parameter determines the class of style sheet(s) to create when loading from a file. Using the AStyleSheetNames parameter, you can specify the names of the style sheets to load. If it is set to nil, all style sheets are loaded from the file. Note: all style sheets created by the LoadStyleSheetsFromIniFile procedure will be the same class as defined by AStyleSheetClass. The INI file stores information on a style sheet in the following format: [Style Sheet Caption] Style1=Values Style2=Values ... If the class defined by AStyleSheetClass does not contain specific styles loaded from a particular section of the INI file, these styles are ignored. All other styles are used to set values for style properties of a new style sheet. You can use the AStyleSheetList parameter to add all loaded style sheets to an external list, but this is used at design time mainly. The AStyleGetName parameter is for internal use only.
Page 90 of 629
SaveStyleSheetsToIniFile Procedure
See Also
Saves style sheets to an INI file. Unit cxStyles procedure SaveStyleSheetsToIniFile(const AIniFileName: string; const AList: TList); Description The SaveStyleSheetsToIniFile method saves the style sheet list specified by the AList parameter into the INI file with its name specified by the AIniFileName parameter. SaveStyleSheetsToIniFile saves only the caption of a style sheet and its assigned values. The class name of a style sheet is not saved.
Page 91 of 629
IcxContainerInnerControl Interface
Properties Methods
Unit cxContainer Description Every inner Developer Express control, which is placed in the TcxContainer control, has to implement the IcxContainerInnerControl interface to provide a link to its container via the ControlContainer property.
Page 92 of 629
IcxDialogMetricsInfoData Interface
Hierarchy Methods See Also
Allows a dialog to store custom settings when used with TcxDialogsMetricsStore. Unit cxClasses IcxDialogMetricsInfoData = interface(IUnknown) Description To persist custom dialog settings, a dialog class must implement the IcxDialogMetricsInfoData interface, so that TcxDialogMetricsInfo (which is used by the TcxDialogsMetricsStore) can save and restore the required custom information for a given dialog.
Page 93 of 629
IcxImageCollectionListener Interface
Hierarchy Methods
Allows a listener registered with the TcxImageCollection component to update itself when changes are made to the TcxImageCollection. Unit cxGraphics IcxImageCollectionListener = interface(IUnknown) Description The IcxImageCollectionListener interface is used to dynamically bind an interested listener to the TcxImageCollection component, in order to be notified of the TcxImageCollection modifications.
Page 94 of 629
IcxLookAndFeelNotificationListener Interface
Hierarchy Methods
Unit cxLookAndFeels IcxLookAndFeelNotificationListener = interface(IUnknown); Description Every Developer Express control can export its look and feel to other Developer Express controls. The MasterLookAndFeel property of the TcxLookAndFeel class determines the imported look and feel of any Developer Express control. Any control, which imports the look and feel of the current control, is a listener. It listens to changes within the current control via the IcxLookAndFeelNotificationListener interface. Note that a control only listens to its MasterLookAndFeel property when its AssignedValues of the TcxLookAndFeel class property is not set. The IcxLookAndFeelNotificationListener interface listens for two events:
l l
Any look and feel property change via the MasterLookAndFeelChanged method. The TcxLookAndFeel class instance destruction via the MasterLookAndFeelDestroying method.
Listener controls reflect all changes within the current control. If an imported TcxLookAndFeel class instance is destroyed, a listener control obtains its look and feel from the cxDefaultLookAndFeelKind, cxDefaultLookAndFeelNativeStyle, and cxDefaultLookAndFeelSkinName global constants.
Page 95 of 629
TcxBorder type
Specifies the cell border. Unit cxGraphics type TcxBorder = (bLeft, bTop, bRight, bBottom); Description Possible TcxBorder values include: Kind bLeft bTop bRight bBottom Specifies the left border. Specifies the top border. Specifies the right border. Specifies the bottom border. Description
Page 96 of 629
TcxBorders type
Specifies a set of cell borders. Unit cxGraphics type TcxBorder = (bLeft, bTop, bRight, bBottom); TcxBorders = set of TcxBorder; Description The TcxBorders is used to specify a set of cell borders. This type can contain any combination of TcxBorder values.
Page 97 of 629
TcxCalcButtonKind type
Enumerates calculator buttons types. Unit cxLookAndFeelPainters TcxCalcButtonKind = (cbBack, cbCancel, cbClear, cbMC, cbMR, cbMS, cbMP, cbNum0, cbNum1, cbNum2, cbNum3, cbNum4, cbNum5, cbNum6, cbNum7, cbNum8, cbNum9, cbSign, cbDecimal, cbDiv, cbMul, cbSub, cbAdd, cbSqrt, cbPercent, cbRev, cbEqual, cbNone); Description TcxCalcButtonKind enumerates the calculator button types. TcxCalcButtonKind is used in methods and events of the TcxCustomCalculator class to identify a specific button.
The following table describes the button types. Value cbBack cbCancel cbClear cbMC cbMR cbMS cbMP cbNum0 cbNum1 cbNum2 cbNum3 cbNum4 cbNum5 cbNum6 The 'Back' button. The 'CE' button. The 'C' button. The 'MC' button. The 'MR' button. The 'MS' button. The 'M+' button. The '0' button. The '1' button. The '2' button. The '3' button. The '4' button. The '5' button. The '6' button. cbNum7 cbNum8 cbNum9 cbSign cbDecimal cbDiv cbMul cbSub cbAdd cbSqrt cbPercent cbRev cbEqual cbNone The '7' button. The '8' button. The '9' button. The '+/-' button. The , button. The / button. The * button. The - button. The + button. The sqrt button. The % button. The 1/x button. The = button. Does not identify any of calculator buttons. Meaning Value Meaning
Page 98 of 629
TcxCheckBoxState type
Represents states for the TcxCustomCheckBox editor. Unit cxLookAndFeelPainters type TcxCheckBoxState = (cbsUnchecked, cbsChecked, cbsGrayed); Description The TcxCheckBoxState class enumerates possible values for the check box state. The check box state is set via the TcxCustomCheckBox.State property, which affects the look & feel of the check box. The following table describes TcxCheckBoxState values (screenshots are made using standard and Windows XP look & feel): Value cbsUnchecked The check box has no check mark, indicating that the user has not selected the option. Meaning
cbsChecked
The check box has a check mark in it, indicating that the user has selected the option.
cbsGrayed
The check box has a check mark in it, but it is grayed.
Page 99 of 629
TcxContainerBorderStyle type
Specifies the border style of an associated container control. Unit cxLookAndFeelPainters TcxContainerBorderStyle = (cbsNone, cbsSingle, cbsThick, cbsFlat, cbs3D, cbsUltraFlat, cbsOffice11); Description Values include: Value cbsNone No border is painted around the control. Description Image
cbsSingle
A single-pixel border is painted around the control. Its color is specified by the BorderColor property. A thick border is painted around the control. Its color is specified by the BorderColor property. A flat border is painted around the control.
cbsThick
cbsFlat
cbs3D
A 3D lowered border is painted around the control.
cbsUltraFlat
An ultra flat border is painted around the control.
cbsOffice11
A border is painted around the control in the Office 2003 control style.
Page 100 of 629
TcxContainerStateItem type
Specifies the state of the control. type TcxContainerStateItem = (csNormal, csActive, csDisabled, csHotTrack); Description Represents the state of the control. The following table lists the possible states of a control. Value csNormal csActive csDisabled csHotTrack The normal state of the control. The control is active, i.e. has focus. The control is disabled. The control is highlighted, i.e. hot-tracked. Meaning
Page 101 of 629
TcxContainerStyleValue type
Enumerates the flags that describe which control style attributes are assigned. Unit cxContainer TcxEditStyleValue = (csvBorderColor, csvBorderStyle, csvColor, csvEdges, csvFont, csvHotTrack, csvShadow, csvTextColor, csvTextStyle, csvTransparentBorder); Description The TcxContainerStyleValue type enumerates the flags that indicate which control style attributes are assigned to the TcxCustomContainerStyle object. These flags are set via the TcxCustomContainerStyle.AssignedValues property. Value csvBorderColor csvBorderStyle csvColor csvEdges csvFont csvHotTrack csvShadow csvTextColor csvTextStyle csvTransparentBorder Indicates that the TcxCustomContainerStyle.BorderColor property is assigned a value. Indicates that the TcxCustomContainerStyle.BorderStyle property is assigned a value. Indicates that the TcxCustomContainerStyle.Color property is assigned a value. Indicates that the TcxCustomContainerStyle.Edges property is assigned a value. Indicates that the TcxCustomContainerStyle.Font property is assigned a value. Indicates that the TcxCustomContainerStyle.HotTrack property is assigned a value. Indicates that the TcxCustomContainerStyle.Shadow property is assigned a value. Indicates that the TcxCustomContainerStyle.TextColor property is assigned a value. Indicates that the TcxCustomContainerStyle.TextStyle property is assigned a value. Indicates that the TcxCustomContainerStyle.TransparentBorder property is assigned a value. Meaning
Page 102 of 629
TcxContainerStyleValues type
Represents a set of flags indicating which container style attributes are assigned. Unit cxContainer TcxContainerStyleValues = set of TcxContainerStyleValue; Description Each container control provides the Style, StyleDisabled, StyleFocused and StyleHot properties which present style attributes for various states of a control. The TcxCustomContainerStyle.AssignedValues member of the TcxContainerStyleValues type describes which style attributes are explicitly assigned to these style properties.
Page 103 of 629
TcxEditPopupBorderStyle type
Enumerates the styles of popup window borders. Unit cxLookAndFeelPainters TcxEditPopupBorderStyle = (epbsDefault, epbsSingle, epbsFrame3D, epbsFlat); Description Values include: Value epbsDefault Popup borders are drawn in the manner in which editor borders are currently painted. That is determined by the TcxCustomEditStyle.BorderStyle and TcxCustomEditStyle.HotTrack properties of the editor with which the popup is associated. Popup borders are thin. The following image displays the popup window with PopupBorderStyle set to epbsSingle. Meaning
epbsSingle
epbsFrame3D
Popup borders are three-dimensional. The following image displays the popup window with PopupBorderStyle set to epbsFrame3D.
epbsFlat
Popup-borders are flat with a slight three-dimensional effect. The following image displays the popup window with PopupBorderStyle set to epbsFlat.
Page 104 of 629
TcxLockedStateImageEffect type
See Also
Enumerates visual effects for a "Locked View" image. Unit cxControls TcxLockedStateImageEffect = (lsieNone, lsieLight, lsieDark); Description Values include: Value lsieNone lsieLight lsieDark A visual effect is not applied. A "Locked View" image is painted light. A "Locked View" image is painted dark. Meaning
Page 105 of 629
TdxFader.State
TdxFader See Also
Enables fading animation effects within an application. type TdxFaderAnimationState = (fasDefault, fasEnabled, fasDisabled); property State: TdxFaderAnimationState; Description Values include: Value fasDefault Fading animation effects are enabled if transition effects are enabled for menus and tooltips in the Operating System. See the corresponding option in the Effects window available via Display Properties | Appearance | Effects. In Windows Vista, these effects are always enabled. Fading animation effects are enabled. Fading animation effects are disabled. Description
fasEnabled fasDisabled
Note:Fading animation effects can only be applied if the Microsoft GDI+ library is installed and the color depth is greater than 16bit. The default value of the State property is fasDefault.
Page 106 of 629
TdxImageDataFormat type
See Also
Enumerates image formats. Unit dxGDIPlusClasses TdxImageDataFormat = (dxImageUnknown, dxImageBitmap, dxImageJpeg, dxImagePng, dxImageTiff, dxImageGif); Description Values include: Value dxImageUnknown dxImageBitmap dxImageJpeg dxImagePng dxImageTiff dxImageGif An image format is unknown. A BMP image format. A JPEG image format. A PNG image format. A TIFF image format. A GIF image format. Meaning
Page 107 of 629
TdxScreenTipBandTextAlign type
See Also
Enumerates available horizontal alignment options for the ScreenTips descriptive text. Unit dxScreenTip type TdxScreenTipBandTextAlign = (stbtaLeft, stbtaRight); Description Values include: Value stbtaLeft The descriptive text is aligned to the left of the ScreenTip window Meaning
stbtaRight The descriptive text is aligned to the right of the ScreenTip window
Page 108 of 629
TdxSkinName type
See Also
Represents a skin name. Unit cxClasses type TdxSkinName = type string;
Page 109 of 629
cxClasses Unit
Classes TcxComponentCollection TcxComponentCollectionItem TcxDialogMetricsInfo TcxDialogsMetricsStore TcxInterfacedPersistent TcxMRUItem TcxMRUItems TcxOwnedInterfacedCollection Interfaces IcxDialogMetricsInfoData Other Types TdxSkinName Routines cxDialogsMetricsStore cxGetResourceString cxSetResourceString
Page 110 of 629
cxContainer Unit
Classes TcxContainer TcxContainerStyle TcxContainerStyleEx TcxCustomContainerStyle TcxStyleController Interfaces IcxContainerInnerControl Global Constants cxContainerShadowWidth cxDefaultAutoCompleteDelay Other Types TcxContainerStateItem Routines GetcxContainer
Page 111 of 629
cxControls Unit
Classes TcxControl TcxControlChildComponent TcxLockedStateImageOptions Other Types TcxLockedStateImageEffect
Page 112 of 629
cxExport Unit
Global Constants cxExportGraphicClass
Page 113 of 629
cxGraphics Unit
Classes TcxCanvas TcxImageCollectionItem TcxImageCollectionItems Components TcxImageCollection TcxImageList Interfaces IcxImageCollectionListener Other Types TcxBorder TcxBorders TcxViewParams
Page 114 of 629
cxLocalization Unit
Classes TcxLanguage TcxLanguages TcxLocalizer Other Types TcxLocalizerStorageType
Page 115 of 629
cxLookAndFeelPainters Unit
Classes TcxCustomLookAndFeelPainter Other Types TcxCalcButtonKind TcxCheckBoxState TcxContainerBorderStyle TcxEditPopupBorderStyle Global Constants cxContainerMaxBorderWidth
Page 116 of 629
cxLookAndFeels Unit
Classes TcxLookAndFeel TcxLookAndFeelController Interfaces IcxLookAndFeelNotificationListener Other Types TcxLookAndFeelKind TcxLookAndFeelValue TcxLookAndFeelValues Routines RootLookAndFeel Global Constants cxDefaultLookAndFeelKind cxDefaultLookAndFeelNativeStyle cxDefaultLookAndFeelSkinName cxDefaultUseSkins cxUseSkins
Page 117 of 629
cxPropertiesStore Unit
Classes TcxCustomPropertiesStore TcxPropertiesStore TcxPropertiesStoreComponent TcxPropertiesStoreComponents
Page 118 of 629
cxStyles Unit
Classes TcxCustomStyle TcxCustomStyles TcxStyle TcxStyleRepository TcxStyles Other Types TcxStyleValue TcxStyleValues
Page 119 of 629
dxCustomHint Unit
Classes TcxCustomHintStyle TcxCustomHintStyleController
Page 120 of 629
dxFading Unit
Classes TdxFader Other Types TdxFaderAnimationState Routines dxFader Global Constants dxFadeInDefaultAnimationFrameCount dxFadeInDefaultAnimationFrameDelay dxFadeOutDefaultAnimationFrameCount dxFadeOutDefaultAnimationFrameDelay
Page 121 of 629
dxGDIPlusClasses Unit
Classes TdxBMPImage TdxGIFImage TdxGPImage TdxJPEGImage TdxPNGImage TdxSmartImage TdxTIFFImage Other Types TdxImageDataFormat
Page 122 of 629
dxScreenTip Unit
Classes TdxCustomScreenTipBand TdxScreenTip TdxScreenTipBand TdxScreenTipCollection TdxScreenTipFooterBand TdxScreenTipLink TdxScreenTipLinks TdxScreenTipRepository TdxScreenTipStyle Other Types TdxScreenTipBandTextAlign TdxScreenTipBandType TdxScreenTipRepositoryFonts
Page 123 of 629
Hierarchy IUnknown | IcxDialogMetricsInfoData
Page 124 of 629
TcxMRUItem Object
Methods See Also
Represents an item in the lists of most recently used items. Unit cxClasses TcxMRUItem = class Description A list of most recently used items is used to maintain the choices (such as filtering options in the ExpressQuantumGrid) made by end-users for future use or tracking activities. The TcxMRUItem class is the base class for classes which represent this kind of items. The Equals abstract function is the only member which is introduced by the TcxMRUItem class. When implemented in descendant classes this function determines whether the item which is represented by an instance of the TcxMRUItem class is equal to the specified item.
Page 125 of 629
TcxMRUItems Object
Properties Methods
Represents a list of most recently used items. Unit cxClasses TcxMRUItems = class Description A list of most recently used items (MRU list for short) is used to maintain the choices (such as filtering options in the ExpressQuantumGrid) made by end-users for future use or tracking activities. The TcxMRUItems class is the base class for classes which represent MRU lists. Each item in MRU lists is represented by an instance of the TcxMRUItem class. The TcxMRUItems class provides the Add and ClearItems methods and, the Count and MaxCount properties for managing the MRU lists contents. Use the Items property to access the contents (items). Call the IndexOf function to determine the position of a specific item within the MRU list.
Page 126 of 629
IcxDialogMetricsInfoData.GetInfoData
IcxDialogMetricsInfoData See Also
Returns a pointer to a value object that contains a dialogs custom settings. function GetInfoData: Pointer;
Page 127 of 629
IcxDialogMetricsInfoData.GetInfoDataSize
Returns the size, in bytes, of memory occupied by a value object that contains a dialogs custom settings. function GetInfoDataSize: Integer;
Page 128 of 629
IcxDialogMetricsInfoData.SetInfoData
Populates the AData value object with a dialogs custom settings. procedure SetInfoData(AData: Pointer);
Page 129 of 629
TcxComponentCollectionItem.AddToCollection
TcxComponentCollectionItem See Also
Adds the current collection element to a collection. procedure AddToCollection(ACollection: TcxComponentCollection); Description Call the AddToCollection method to add the current collection element to the collection specified by the ACollection parameter. Firstly the collection element is removed from the collection that owns it and then added as the last element to the specified collection (thus the elements ID and Index properties are modified accordingly). Note:If nil is passed as the ACollection parameter then the current collection element is simply removed from the collection that owns it.
Page 130 of 629
TcxComponentCollectionItem.Collection
Specifies the collection containing the current element. property Collection: TcxComponentCollection; Description Assigning this property removes the current element from the collection that contains it and then adds this element to a specified collection. Call the SetParentComponent method to add the current element to a collection associated with a certain component.
Page 131 of 629
TcxComponentCollectionItem.GetParentComponent
Returns the parent component of the current items collection. function GetParentComponent: TComponent; override; Description A collection and its items have the same parent component. Use the GetParentComponent function to access the parent component of the current collection item and its collection. If the current item does not belong to any collection, the GetParentComponent function returns nil. Call the SetParentComponent method to add the current element to a collection associated with a certain component.
Page 132 of 629
TcxComponentCollectionItem.ID
Gets the unique identifier of the current collection element. property ID: Integer; ReadOnly Property
Page 133 of 629
TcxComponentCollectionItem.Index
Specifies the zero-based index of the current element in the collection. property Index: Integer;
Page 134 of 629
TcxComponentCollectionItem.RemoveFromCollection
Removes the current collection element from a collection. procedure RemoveFromCollection(ACollection: TcxComponentCollection); Description Call the RemoveFromCollection method to remove the current collection element from the collection specified by the ACollection parameter.
Page 135 of 629
TcxComponentCollectionItem.SetParentComponent
Adds the current element to a collection associated with a specified component. procedure SetParentComponent(Value: TComponent); override; Description This method assigns to the Collection property, the collection associated with a component passed as the Value parameter. Call the GetParentComponent function to access the parent component containing the current collection element.
Page 136 of 629
TcxComponentCollection.Add
TcxComponentCollection See Also
Creates a new TcxComponentCollectionItem instance and appends it to the collection. function Add: TcxComponentCollectionItem; Description The Add method creates a new TcxComponentCollectionItem instance and adds it to the end of the collection. A reference to the TcxComponentCollectionItem instance that was added is returned.
Page 137 of 629
TcxComponentCollection.BeginUpdate
TcxComponentCollection
Acquires a lock on the collection. procedure BeginUpdate; virtual; Description Use the BeginUpdate method, if bulk changes are to be made to the collection. This method is used in combination with the EndUpdate method to wrap a block of statements, which update the collection. Note: since the execution of the block of statements can exit with either a normal or exception state, these statements and the EndUpdate method should be contained within try finally blocks following the BeginUpdate method to ensure that the lock will be released in all cases.
Page 138 of 629
TcxComponentCollection.Clear
Deletes all the TcxComponentCollectionItem instances from the collection and destroys them. procedure Clear; Description Use the Clear method to remove all the TcxComponentCollectionItem objects from the collection.
Page 139 of 629
TcxComponentCollection.Count
Gets the number of elements in the collection. property Count: Integer; ReadOnly Property
Page 140 of 629
TcxComponentCollection.Delete
Removes the specified TcxComponentCollectionItem instance from the collection and destroys it. procedure Delete(AIndex: Integer); Description The zero-based AIndex parameter specifies the position of the TcxComponentCollectionItem object which is to be removed in the collection.
Page 141 of 629
TcxComponentCollection.EndUpdate
Releases a lock and updates the collection. procedure EndUpdate; virtual; Description Use the EndUpdate method paired with the BeginUpdate method to enclose a block of statements, which make bulk updates to the collection. Note: since the execution of a block of statements can exit in either a normal or exception state, the enclosed statements and the EndUpdate method should be contained within try finally blocks following the BeginUpdate method to ensure that the lock will be released in all cases.
Page 142 of 629
TcxComponentCollection.FindItemByID
Returns a reference to a collection element, by its unique identifier. function FindItemByID(ID: Integer): TcxComponentCollectionItem; Description The FindItemID method returns a value of nil, if there are no elements with ids that match the specified id. The zero-based ID parameter specifies the unique identifier of the required element.
Page 143 of 629
TcxComponentCollection.Insert
Creates a new TcxComponentCollectionItem instance and inserts it into the collection at the position specified by the zero-based AIndex parameter. function Insert(AIndex: Integer): TcxComponentCollectionItem; Description The Insert method returns a reference to the TcxComponentCollectionItem instance that was inserted.
Page 144 of 629
TcxComponentCollection.Items
Provides indexed access to the collection elements. property Items[AIndex: Integer]: TcxComponentCollectionItem; Description Use the Items property to get the element at the position specified by the zero-based Index parameter.
Page 145 of 629
TcxComponentCollection.Update
Updates a collection to reflect any changes made. procedure Update(AItem: TcxComponentCollectionItem); virtual; Description The Update method has an empty implementation and is intended to allow developers to provide appropriate functionality in the TcxComponentCollection subclasses. The Update method is called automatically after the changes to the collection elements have been completed. The AItem parameter specifies the TcxComponentCollectionItem instance that was changed. If an argument of nil is passed, then more than one collection element was updated.
Page 146 of 629
TcxDialogMetricsInfo.ClientHeight
TcxDialogMetricsInfo See Also
Returns the height of the dialog's client area, in pixels. property ClientHeight: Integer; ReadOnly Property
Page 147 of 629
TcxDialogMetricsInfo.ClientWidth
Returns the width of the dialog's client area, in pixels. property ClientWidth: Integer; ReadOnly Property
Page 148 of 629
TcxDialogMetricsInfo.Data
Returns a pointer to a value object that contains custom dialog information. property Data: Pointer; ReadOnly Property
Page 149 of 629
TcxDialogMetricsInfo.DialogClass
TcxDialogMetricsInfo
Returns a dialog class type. property DialogClass: TClass; ReadOnly Property
Page 150 of 629
TcxDialogMetricsInfo.Left
Returns the horizontal coordinate of the dialogs top-left corner. property Left: Integer; ReadOnly Property
Page 151 of 629
TcxDialogMetricsInfo.Maximized
TcxDialogMetricsInfo
Returns whether the dialog window is maximized. property Maximized: Boolean; Description If the dialog window is maximized, the Maximized property returns True. ReadOnly Property
Page 152 of 629
TcxDialogMetricsInfo.Top
Returns the vertical coordinate of the dialogs top-left corner. property Top: Integer; ReadOnly Property
Page 153 of 629
TcxDialogsMetricsStore.DefaultPosition
TcxDialogsMetricsStore See Also
Specifies the dialogs default position. property DefaultPosition: TPosition; Description The specified position is used for the dialog that doesnt have stored dialog settings. The default value of the DefaultPosition property is poMainFormCenter. The following example demonstrates how to specify that the default position of the dialog is the center of the screen: // Delphi // ... uses // ... cxClasses; initialization cxDialogsMetricsStore.DefaultPosition := poDesktopCenter;
Page 154 of 629
TcxDialogsMetricsStore.InitDialog
Applies settings to the AForm dialog. procedure InitDialog(AForm: TForm); Description The InitDialog method first determines whether settings (previously saved using the StoreMetrics method) exist for the specified dialog. If they do exist, the method simply applies them to the dialog. Otherwise, the default position (specified by the DefaultPosition property) is only applied to the dialog.
Page 155 of 629
TcxDialogsMetricsStore.StoreMetrics
Saves the AForm dialogs settings. procedure StoreMetrics(AForm: TForm); Description Use the StoreMetrics method to store dialog settings for further use during the application session.
Page 156 of 629
TcxMRUItems.Add
TcxMRUItems
Adds an item to the current MRU list. procedure Add(AItem: TcxMRUItem); Description Prior to adding the item specified by the AItem parameter to the current MRU list, the Add method determines whether the item is already in the list. When the list contains the item, it is moved to the topmost position (with index equal to 0). Otherwise, the item is added to the MRU list at the topmost position thus enlarging the number of items within it. This takes place until the number of items reaches the MaxCount propertys value. Furthermore, adding an item results in this item being added to the top of the MRU list and deleting the bottom item in that list. Use the Count property to determine the number of items within the current MRU list. Call the IndexOf function to determine the position of a specific item within the MRU list.
Page 157 of 629
TcxMRUItems.ClearItems
TcxMRUItems See Also
Removes all items from the current MRU list. procedure ClearItems; Description Call the ClearItems method to clear the current MRU list by removing all its items.
Page 158 of 629
TcxMRUItems.Count
TcxMRUItems
Specifies the number of items within the current MRU list. property Count: Integer; Description Use the Count to determine the number of items within the current MRU list. You can decrease the number of items by setting the Count property to the value which is less than the current value. This results in deleting all the items up to the item (inclusive) with the index specified by the new Count propertys value. Use the MaxCount property to limit the maximum number of items within the current MRU list.
Page 159 of 629
TcxMRUItems.IndexOf
TcxMRUItems See Also
Determines the position (index) of an item within the current MRU list. function IndexOf(AItem: TcxMRUItem): Integer; Description Call the IndexOf function to determine the position (index) of the item specified by the AItem parameter within the current MRU list. This function returns -1 when the specified item does not exist within the current MRU list.
Page 160 of 629
TcxMRUItems.Items
TcxMRUItems
Provides indexed access to the items within the current MRU list. property Items[Index: Integer]: TcxMRUItem; Description Use the Items property to access the items within the current MRU list using the index. To determine the index of a specific item, call the IndexOf function. Use the Count property to get and set the number of items within the current MRU list. Use the MaxCount property to limit the maximum number of items within the list. To add new items to the current MRU list, call the Add method. ReadOnly Property
Page 161 of 629
TcxMRUItems.MaxCount
TcxMRUItems
Specifies the maximum number of items within the current MRU list. property MaxCount: Integer; Description To limit the maximum number of items within the current MRU list up to a specific value, set the MaxCount property to the value which is greater than 0. That is adding the items via the Add method does not enlarge the number of items within the list since it is limited to the MaxCount propertys value. Setting the MaxCount property to 0 indicates that the current MRU lists capacity is unlimited. Use the Count property to determine the number of items within the current MRU list. You can decrease the number of items by setting the MaxCount property to the value which is less than the current Count propertys value. This results in deleting all the items up to the item (inclusive) with the index specified by the new MaxCount propertys value.
Page 162 of 629
TcxMRUItem.Equals
TcxMRUItem
Determines whether the current item is equal to the specified item. function Equals(AItem: TcxMRUItem): Boolean; virtual; abstract; Description This function is abstract. Descendants of the TcxMRUItem class have to implement the Equals function to return whether the current item is equal to the item which is specified by the AItem parameter. When the items are the same, this function returns True. Otherwise, False is returned.
Page 163 of 629
TcxOwnedInterfacedCollection.OnChange
TcxOw nedInterfacedCollection
Fires after the current collection has been modified (a collection item is added, inserted, removed, etc.). type TcxCollectionNotifyEvent = procedure(Sender: TObject; AItem: TCollectionItem) of object; property OnChange: TcxCollectionNotifyEvent;
Page 164 of 629
TcxOwnedInterfacedCollection Events
TcxOw nedInterfacedCollection Legend
In TcxOwnedInterfacedCollection OnChange
Page 165 of 629
TcxComponentCollection Methods
TcxComponentCollection Legend
In TcxComponentCollection Add BeginUpdate Clear Delete EndUpdate FindItemByID Insert Update
Page 166 of 629
TcxComponentCollectionItem Methods
TcxComponentCollectionItem Legend
In TcxComponentCollectionItem AddToCollection GetParentComponent RemoveFromCollection SetParentComponent
Page 167 of 629
TcxDialogsMetricsStore Methods
TcxDialogsMetricsStore Legend
In TcxDialogsMetricsStore InitDialog StoreMetrics
Page 168 of 629
TcxMRUItem Methods
TcxMRUItem Legend
In TcxMRUItem Equals
Page 169 of 629
TcxMRUItems Methods
TcxMRUItems Legend
In TcxMRUItems Add ClearItems IndexOf
Page 170 of 629
TcxOwnedInterfacedCollection Methods
Derived from TCollection Add Assign BeginUpdate Clear Delete EndUpdate FindItemID GetNamePath Insert Owner
Page 171 of 629
TcxComponentCollection Properties
TcxComponentCollection Legend
In TcxComponentCollection Count Items
Page 172 of 629
TcxComponentCollectionItem Properties
TcxComponentCollectionItem Legend
In TcxComponentCollectionItem Collection ID Index
Page 173 of 629
TcxDialogMetricsInfo Properties
TcxDialogMetricsInfo Legend
In TcxDialogMetricsInfo ClientHeight ClientWidth Data DialogClass Left Maximized Top
Page 174 of 629
TcxDialogsMetricsStore Properties
TcxDialogsMetricsStore Legend
In TcxDialogsMetricsStore DefaultPosition
Page 175 of 629
TcxMRUItems Properties
TcxMRUItems Legend
In TcxMRUItems Count Items MaxCount
Page 176 of 629
TcxOwnedInterfacedCollection Properties
Derived from TCollection Count ItemClass Items
Page 177 of 629
IcxDialogMetricsInfoData Methods
IcxDialogMetricsInfoData Legend
In IcxDialogMetricsInfoData GetInfoData GetInfoDataSize SetInfoData
Page 178 of 629
Hierarchy TComponent | TcxComponentCollectionItem
Page 179 of 629
Hierarchy TPersistent | TcxComponentCollection
Page 180 of 629
Hierarchy TObject | TcxDialogMetricsInfo
Page 181 of 629
Hierarchy TObject | TcxDialogsMetricsStore
Page 182 of 629
Hierarchy TInterfacedPersistent | TcxInterfacedPersistent
Page 183 of 629
Hierarchy TOwnedCollection | TcxOwnedInterfacedCollection
Page 184 of 629
TcxContainerStyle Object
Contains the style settings applied to the associated container control. Unit cxContainer TcxContainerStyle = class(TcxCustomContainerStyle) Description The TcxContainerStyle class does not introduce any new properties or methods that control the appearance of the associated container control, instead it merely publishes the properties of the TcxCustomContainerStyle class instead. The TcxContainerStyle class represents the type of the Style property in the TcxContainer class which provides the base functionality for all ExpressQuantumEditors.
Page 185 of 629
TcxContainerStyleEx Object
Contains the style settings which are applied to the associated container control for special states such as disabled, focused or hot-tracked. Unit cxContainer TcxContainerStyleEx = class(TcxCustomContainerStyle) Description The TcxContainerStyleEx class, like the TcxContainerStyle class does not introduce new properties and methods that control the appearance of the associated container control, instead it publishes the properties of the TcxCustomContainerStyle class. The set of published properties is determined by the TcxContainerStyleEx classs functionality, i.e. only border, background color and text style attributes can be used to show that the control is in a special state such as disabled, focused or hot-tracked. The TcxContainerStyleEx class represents the type of the StyleDisabled, StyleFocused and StyleHot properties in the TcxContainer class which provides base functionality for all ExpressQuantumEditors.
Page 186 of 629
IcxContainerInnerControl.ControlContainer
IcxContainerInnerControl
Gets the container control which is returned by the GetControlContainer function. property ControlContainer: TcxContainer read GetControlContainer; ReadOnly Property
Page 187 of 629
IcxContainerInnerControl.GetControlContainer
IcxContainerInnerControl
Returns the container control associated with the current inner control. function GetControlContainer: TcxContainer;
Page 188 of 629
TcxContainer.RestoreStyles
TcxContainer
Restores the default values to the style attributes of all the styles provided by the current container control. procedure RestoreStyles; Description The RestoreStyles method merely calls the RestoreDefaults method for each style defined in the container control (see the Style, StyleDisabled, StyleFocused and StyleHot for details).
Page 189 of 629
TcxContainer.Style
TcxContainer
Provides access to the TcxContainerStyle object containing the normal state settings for the container control. property Style: TcxContainerStyle; Description The Style property provides access to the TcxContainerStyle object that contains the style settings applied to the container control in the normal state. You can use its properties to specify the border color, border style, background color, font settings and look & feel of the container which are accessible via the corresponding properties. Note:To customize the style settings that are used for drawing the container control in states other than the normal one, such as disabled, focused or hot-tracked, use the StyleDisabled, StyleFocused and StyleHot properties, respectively.
Page 190 of 629
TcxContainer.StyleDisabled
TcxContainer
Provides access to the TcxContainerStyleEx object containing the disabled state settings for the container control. property StyleDisabled: TcxContainerStyleEx; Description The StyleDisabled property provides access to the TcxContainerStyleEx object that contains the style settings applied to the disabled container control. You can use its properties to specify the border color, border style, background color and font settings which are accessible via the corresponding properties. Note:To customize the style settings that are used for drawing the container control in states other than the disabled one, such as normal, focused or hot-tracked, use the Style, StyleFocused and StyleHot properties, respectively.
Page 191 of 629
TcxContainer.StyleFocused
TcxContainer
Provides access to the TcxContainerStyleEx object containing the focused state settings for the container control. property StyleFocused: TcxContainerStyleEx; Description The StyleFocused property provides access to the TcxContainerStyleEx object that contains the style settings applied to the focused container control. You can use its properties to specify the border color, border style, background color and font settings which are accessible via the corresponding properties. Note:To customize the style settings that are used for drawing the container control in states other than the focused one, such as normal, disabled or hot-tracked, use the Style, StyleDisabled and StyleHot properties, respectively.
Page 192 of 629
TcxContainer.StyleHot
TcxContainer
Provides access to the TcxContainerStyleEx object containing the highlighted state settings for the container control. property StyleHot: TcxContainerStyleEx; Description The StyleHot property provides access to the TcxContainerStyleEx object that contains the style settings applied to the highlighted (hot-tracked) container control (when the mouse cursor hovers over it). You can use its properties to specify the border color, border style, background color and font settings which are accessible via the corresponding properties. Note:To customize the style settings that are used for drawing the container control in states other than the highlighted one, such as normal, disabled or focused, use the Style, StyleDisabled and StyleFocused properties, respectively.
Page 193 of 629
TcxContainer.Styles
TcxContainer
Provides access to the styles assigned to the current container control. procedure Styles[AState: TcxContainerStateItem]: TcxCustomContainerStyle; Description Each style corresponds to a particular container controls state such as normal, disabled, etc. (see the TcxContainerStateItem type description for details). The Styles property provides an access to the specific style which is assigned to the current container control and matches the control state specified by the AState parameter.
Page 194 of 629
TcxCustomContainerStyle.ActiveStyleController
TcxCustomContainerStyle
Identifies the style controller which manages the appearance of the associated container control. property ActiveStyleController: TcxStyleController; Description Use the ActiveStyleController property to get the style controller (TcxEditStyleController or TcxDefaultEditStyleController component) which manages the style of the associated container control and defines the style properties common to several controls. See the Editor Style and StyleController topic for detailed information about the style controllers. ReadOnly Property
Page 195 of 629
TcxCustomContainerStyle.Assign
Assigns settings of one TcxContainerStyle object to another. procedure Assign(Source: TPersistent); override; Description Use the Assign method to copy the settings of one TcxContainerStyle object to the another. The Source parameter represents the source object. The caller is the destination object. Use this method if you want to assign the same or slightly different style settings to several controls.
Page 196 of 629
TcxCustomContainerStyle.AssignedValues
Specifies which style properties are assigned via the TcxCustomContainerStyle class. property AssignedValues: TcxContainerStyleValues; Description The AssignedValues property is a set of flags demonstrating which style properties were set by a user at design time or programmatically. The AssignedValues property controls whether values for style properties are obtained from the current TcxCustomContainerStyle instance or from the style controller, which can be set via the StyleController property. In this case, the assignment of the property values using the specified style controller is not tracked via the controls AssignedValues property, you should use the style controllers AssignedValues property instead. The RestoreDefaults method restores the default values of the assigned style attributes and clears all the flags in the AssignedValues property of the current TcxCustomContainerStyle object.
Page 197 of 629
TcxCustomContainerStyle.BeginUpdate
Prevents the associated container control from updating due to style changes. procedure BeginUpdate; Description Each time a property of the TcxContainerStyle object is changed, the associated container control is updated. This behavior is undesirable when you want to perform sequential style changes, since the control will be repainted several times. The BeginUpdate and EndUpdate methods allow you to avoid this. Each time the BeginUpdate method is called, it increments the internal counter. The control is notified of style changes only when this counter is zero (its initial value). Thus, you can perform any style changes after the BeginUpdate method call and they will not affect the control. When calling the EndUpdate method, the counter is decremented, and the control is updated to reflect all style changes performed.
Page 198 of 629
TcxCustomContainerStyle.BorderColor
Specifies the border color for the associated container control. property BorderColor: TColor; Description Use the BorderColor property to change the border color of the associated container control. Note that this property is in effect only if the BorderStyle property's value is either cbsSingle or cbsThick. The image below shows the list box control when the BorderColor property is set to clActiveCaption while the BorderStyle property's value is cbsThick.
Note: the BorderColor property is not in effect if the LookAndFeel.NativeStyle property is set to True (the border color and style is specified by the operating system's settings). When the BorderColor property is assigned, the csvBorderColor flag is set to the AssignedValues property. The default value of the BorderColor property is clWindowFrame.
Page 199 of 629
TcxCustomContainerStyle.BorderStyle
Specifies the border style of the associated container control. property BorderStyle: TcxContainerBorderStyle; Description Use the BorderStyle property to change the border style applied to the associated container control. The Edges property specifies which border sides are to be displayed. See the TcxContainerBorderStyle type's description for the list of available values for the BorderStyle property. Note: if the BorderStyle property is set to a value other than cbsNone this property is not in effect while the LookAndFeel.NativeStyle property is set to True. The border style in this case is specified by the operating system's settings. When the BorderStyle property is assigned, the csvBorderStyle flag is set to the AssignedValues property. The default value of the BorderStyle property is cbsDefault.
Page 200 of 629
TcxCustomContainerStyle.Color
Specifies the background color of the associated container control. property Color: TColor; Description Use the Color property to specify the background color of the control. The image below displays the list box control, when the Color property is set to clWhite and clInactiveCaptionText, respectively.
When the Color property is assigned, the csvColor flag is set to the AssignedValues property. The default value of the Color property is clWindow.
Page 201 of 629
TcxCustomContainerStyle.Container
Gets the associated container control. property Container: TcxContainer; Description The TcxCustomContainerStyle object specifies the style settings for bound controls. For instance, it is used to control the style of the TcxListBox control and can be accessed via its Style property. The Container property returns the associated container control to which style settings are applied. Normally, you will not need to use this property in your applications. ReadOnly Property
Page 202 of 629
TcxCustomContainerStyle.Create
Creates a new instance of the TcxContainerStyle object. procedure Create(AOwner: TPersistent; ADirectAccessMode: Boolean); virtual; Description The constructor is used to create a new TcxContainerStyle object with default style settings. The AOwner parameter represents the associated container control. The ADirectAccessMode parameter is used to indicate whether the control accesses the style settings directly, or the style object should notify it of changes performed. It must be set to False to enable automatic notification. Commonly, you will have no need to create TcxContainerStyle objects in applications. They are created automatically by controls that use them.
Page 203 of 629
TcxCustomContainerStyle.Destroy
Destroys the TcxContainerStyle object. procedure Destroy; override; Description The destructor is used to dispose the TcxContainerStyle object and free any allocated memory. Commonly, you will have no need to destroy such objects manually in applications. Objects of this type are automatically destroyed by controls that use them.
Page 204 of 629
TcxCustomContainerStyle.Edges
Specifies which border edges are to be displayed. type TcxBorder = (bLeft, bTop, bRight, bBottom); TcxBorders = set of TcxBorder; property Edges: TcxBorders; Description Use the Edges property to specify which borders are displayed around the control. This property can contain a set of values corresponding to border edges. The table below lists the available values and describes them. Value bLeft bTop bRight bBottom If this value is in the set, the left border edge is displayed. If this value is in the set, the top border edge is displayed. If this value is in the set, the right border edge is displayed. If this value is in the set, the bottom border edge is displayed. Description
The image below displays the list box control when the Edges property is set to [bLeft, bTop] and the BorderStyle property value is cbsSingle.
When the Edges property is assigned, the csvEdges flag is set to the AssignedValues property. The default value of the Edges property is [bLeft,bTop,bRight,bBottom].
Page 205 of 629
TcxCustomContainerStyle.EndUpdate
Updates the associated container control with respect to style changes made after the BeginUpdate method call. procedure EndUpdate; Description The BeginUpdate and EndUpdate methods are used in combination. The first one increments the internal counter, while the second decrements it and updates the control. The internal counter is initially zero and must be zero for the control to update. So you can implement sequential style changes between the BeginUpdate and EndUpdate method calls and the control will be repainted only once.
Page 206 of 629
TcxCustomContainerStyle.Font
Specifies the font used to display the text content of the associated container control. property Font: TFont; Description Use the Font property to change the font used to paint the controls content. When the Font property is assigned, the csvFont flag is set to the AssignedValues property. The image below shows the list box with a standard and custom font applied.
Note:The values of the Font, TextColor and TextStyle properties comprise the font settings used to paint the controls content and can be obtained via the GetVisibleFont function.
Page 207 of 629
TcxCustomContainerStyle.GetVisibleFont
Retrieves the font settings that the current style specified for displaying the container controls text. function GetVisibleFont: TFont; Description Retrieves the font settings of the TFont type the current style specified via the Font, TextColor and TextStyle properties for displaying the container controls text.
Page 208 of 629
TcxCustomContainerStyle.HotTrack
Specifies whether the associated container control changes its border style when the mouse pointer enters or leaves its area. property HotTrack: Boolean; Description If the HotTrack property is set to True, the associated container control is hot-tracked when the mouse pointer enters its area. Note that when this control has focus, it doesnt respond to mouse movements. Controls are only hot-tracked if another control is currently focused. Controls are hot-tracked by changing their border style. Note, that the HotTrack property is not in effect when the border is painted in 3D or thick style. The border style depends on the BorderStyle and LookAndFeel.Kind property values. When the HotTrack property is assigned, the csvHotTrack flag is set to the AssignedValues property. The default value of the HotTrack property is True.
Page 209 of 629
TcxCustomContainerStyle.LookAndFeel
Specifies the look & feel settings of the associated container control. property LookAndFeel: TcxLookAndFeel; Description Use the LookAndFeel property to specify the painting style for the control and the way it responds to user actions. You can use the system-defined painting style and behavior by setting the LookAndFeel.NativeStyle property to True. If so, most of the style settings specified by the TcxCustomContainerStyle objects properties are ignored. Otherwise, the look & feel of the associated container control is specified by the LookAndFeel.Kind or LookAndFeel.SkinName property taking into account the specified style settings. The image below shows the list box control when the LookAndFeel.NativeStyle property's value is True (The image assumes that the Windows XP operating system is used).
The next image displays the same control when the LookAndFeel.Kind property's value is lfFlat, lfStandard, lfUltraFlat, and lfOffice11 respectively (the LookAndFeel.NativeStyle property value is False).
Page 210 of 629
TcxCustomContainerStyle.OnChanged
Occurs when any property of the TcxCustomContainerStyle class is changed. type TNotifyEvent = procedure(Sender: TObject) of object; property OnChanged: TNotifyEvent; Description The OnChanged event occurs every time any property of the TcxCustomContainerStyle class is changed.
Page 211 of 629
TcxCustomContainerStyle.ParentStyle
Retrieves the parent style for the current style of the associated container control. property ParentStyle: TcxCustomContainerStyle; Description Use the ParentStyle property to get the style used as a base style for various painting styles (disabled, focused, hot-tracked). ReadOnly Property
Page 212 of 629
TcxCustomContainerStyle.RestoreDefaults
Applies default look & feel to the control. procedure RestoreDefaults; virtual; Description The RestoreDefaults method assigns an empty set to the LookAndFeel.AssignedValues property. Thus, the LookAndFeel property doesnt affect the style of the associated container control. Values of other properties are preserved and specify the appearance of the control.
Page 213 of 629
TcxCustomContainerStyle.Shadow
Specifies whether a shadow is displayed for the associated container control. property Shadow: Boolean; Description Set the Shadow property to True to display the controls shadow. The width of the shadow is specified by the cxContainerShadowWidth global constant. When the Shadow property is assigned, the csvShadow flag is set to the AssignedValues property. The image below shows the list box control when the Shadow property is set to False and True respectively.
Note: Setting the Shadow property to True has no effect if the LookAndFeel.NativeStyle property is set to True. The default value of the Shadow property is False.
Page 214 of 629
TcxCustomContainerStyle.State
Indicates the state which the current style represents. property State: TcxContainerStateItem; Description Use the State property to determine the state of the associated container control which the current style represents. See the TcxContainerStateItem for a list of the possible control states. ReadOnly Property
Page 215 of 629
TcxCustomContainerStyle.StyleController
Identifies the style controller for the current TcxCustomContainerStyle object. property StyleController: TcxStyleController; Description Use the StyleController property to assign a style controller which defines style attributes common to several controls. See the Editor Style and StyleController topic for detailed information about style controllers.
Page 216 of 629
TcxCustomContainerStyle.TextColor
Specifies the color of the text which is displayed by the associated container control. property TextColor: TColor; Description The TextColor defines the color of the text (in contrast to the background color determined by the Color property). When the TextColor property is assigned, the csvTextColor flag is set to the AssignedValues property. For an unassigned TextColor property, the return value is equal to the Font.Color propertys value. Note:The values of the Font, TextColor and TextStyle properties comprise the font settings used to paint the controls content and can be obtained via the GetVisibleFont function.
Page 217 of 629
TcxCustomContainerStyle.TextStyle
Specifies the style of the text which is displayed by the associated container control. property TextStyle: TFontStyles; Description There are four styles available: Bold, Italic, Underline and StrikeOut. When the TextStyle property is assigned, the csvTextStyle flag is set to the AssignedValues property. For an unassigned TextStyle property, the return value is equal to the Font.Style propertys value. Note:The values of the Font, TextColor and TextStyle properties comprise the font settings used to paint the controls content and can be obtained via the GetVisibleFont function.
Page 218 of 629
TcxCustomContainerStyle.TransparentBorder
Specifies whether a transparent border is drawn around the associated container control. property TransparentBorder: Boolean; Description Set the TransparentBorder property to True to draw a transparent border around the control. Otherwise, it will not be drawn. The width of a transparent border depends on the current borders width specified by the BorderStyle property. The aggregate transparent borders and current borders width cannot exceed 2 pixels. For instance, a transparent border is 2 pixels wide for a container control with its BorderStyle property set to cbsNone and 1 pixel wide for a container control with the BorderStyle property set to cbsSingle, cbsUltraFlat or cbsOffice11. For a control which uses native windows style for its painting the transparent border is drawn when its BorderStyle property is set to cbsNone. When the TransparentBorder property is assigned, the csvTransparentBorder flag is set to the AssignedValues property.
Page 219 of 629
TcxStyleController.RestoreStyles
TcxStyleController
Restores the default values to all the style attributes associated with the current style controller. procedure RestoreStyles; Description The RestoreStyles method merely calls the RestoreDefaults method for each style defined in the container control (see the Style, StyleDisabled, StyleFocused and StyleHot for details) which is associated with the current style controller.
Page 220 of 629
TcxStyleController.Styles
TcxStyleController
Provides access to the styles assigned to the current style controller. procedure Styles[AState: TcxContainerStateItem]: TcxCustomContainerStyle; Description Each style corresponds to a particular control state such as normal, disabled, etc. (see the TcxContainerStateItem type description for details). The Styles property provides access to the specific style which is assigned to the current style controller and matches the control state specified by the AState parameter.
Page 221 of 629
TcxCustomContainerStyle Events
TcxCustomContainerStyle Legend
In TcxCustomContainerStyle OnChanged
Page 222 of 629
TcxContainer Methods
TcxContainer Legend
In TcxContainer RestoreStyles Derived from TcxControl Create Destroy
Page 223 of 629
TcxContainerStyle Methods
TcxContainerStyle Legend
Derived from TcxCustomContainerStyle Assign BeginUpdate Create Destroy EndUpdate RestoreDefaults
Page 224 of 629
TcxContainerStyleEx Methods
TcxContainerStyleEx Legend
Derived from TcxCustomContainerStyle Assign BeginUpdate Create Destroy EndUpdate RestoreDefaults
Page 225 of 629
TcxCustomContainerStyle Methods
In TcxCustomContainerStyle Assign BeginUpdate Create Destroy EndUpdate GetVisibleFont RestoreDefaults
Page 226 of 629
TcxStyleController Methods
TcxStyleController Legend
In TcxStyleController RestoreStyles
Page 227 of 629
TcxContainer Properties
TcxContainer Legend
In TcxContainer Style StyleDisabled StyleFocused StyleHot Styles Derived from TcxControl BorderStyle Bounds Canvas ClientBounds FocusOnClick IsDesigning IsDestroying IsFocused IsLoading LookAndFeel PopupMenu
Page 228 of 629
TcxContainerStyle Properties
TcxContainerStyle Legend
Derived from TcxCustomContainerStyle ActiveStyleController AssignedValues BorderColor BorderStyle Color Container Edges Font HotTrack LookAndFeel Shadow State StyleController TextColor TextStyle TransparentBorder
Page 229 of 629
TcxContainerStyleEx Properties
TcxContainerStyleEx Legend
Derived from TcxCustomContainerStyle ActiveStyleController AssignedValues BorderColor BorderStyle Color Container Edges Font HotTrack LookAndFeel Shadow State StyleController TextColor TextStyle TransparentBorder
Page 230 of 629
TcxCustomContainerStyle Properties
In TcxCustomContainerStyle ActiveStyleController AssignedValues BorderColor BorderStyle Color Container Edges Font HotTrack LookAndFeel ParentStyle Shadow State StyleController TextColor TextStyle TransparentBorder
Page 231 of 629
TcxStyleController Properties
TcxStyleController Legend
In TcxStyleController Styles
Page 232 of 629
IcxContainerInnerControl Methods
IcxContainerInnerControl Legend
In IcxContainerInnerControl GetControlContainer
Page 233 of 629
IcxContainerInnerControl Properties
IcxContainerInnerControl Legend
In IcxContainerInnerControl ControlContainer
Page 234 of 629
Hierarchy TPersistent | TcxCustomContainerStyle |
Page 235 of 629
Hierarchy TPersistent | TcxCustomContainerStyle |
Page 236 of 629
Hierarchy TCustomControl | TcxControl |
Page 237 of 629
Hierarchy TPersistent |
Page 238 of 629
Hierarchy TComponent |
Page 239 of 629
TcxControlChildComponent.Control
TcxControlChildComponent
Specifies the parent control of the current component. property Control: TcxControl; Description Use the Control property to access the parent of the current component. It is initialized by a parameter passed in the CreateEx constructor.
Page 240 of 629
TcxControlChildComponent.CreateEx
Creates a new child component. constructor CreateEx(AControl: TcxControl; AAssignOwner: Boolean = True); Description CreateEx calls the constructor inherited from TComponent passing a specific owner as a parameter. If the AAssignOwner parameter is True then the owner of AControl becomes the owner of the new child component. Otherwise, no owner is passed. The AControl parameter specifies the parent of the new child component.
Page 241 of 629
TcxControlChildComponent.Destroy
Destroys the current component. destructor Destroy; override; Description The destructor destroys the current instance of the TcxControlChildComponent class, removes itself from the parent component and calls the inherited destructor.
Page 242 of 629
TcxControlChildComponent.IsDestroying
Specifies whether the component is currently being destroyed. property IsDestroying: Boolean; Description The IsDestroying property specifies whether the ComponentState property inherited from TComponent contains the csDestroying flag thus indicating that the component is being destroyed. ReadOnly Property
Page 243 of 629
TcxControlChildComponent.IsLoading
Specifies whether the current component is being loaded. property IsLoading: Boolean; Description The IsLoading property returns True, if the ComponentState property inherited from TComponent contains the csLoading flag. This indicates that the component (including its children) is being loaded from a file. ReadOnly Property
Page 244 of 629
TcxControl.ActiveCanvas
TcxControl See Also
Provides access to the current controls drawing surface. property ActiveCanvas: TcxCanvas; Description If a handle to a device context is allocated to the controls drawing surface, this property provides access to the Canvas property value. Otherwise, a drawing surface is recreated (if necessary), and then returned as a property value. ReadOnly Property
Page 245 of 629
TcxControl.BorderStyle
TcxControl
Specifies the border style of the associated control. type TcxControlBorderStyle = (cxcbsNone, cxcbsDefault); property BorderStyle: TcxControlBorderStyle; Description Use the BorderStyle property to change the border style applied to the associated control. The table below lists values available for the BorderStyle property and provides their description: Value cxcbsNone cxcbsDefault No border is painted around the control. The border style is specified by the look and feel applied to the control (see the LookAndFeel property). Meaning
Page 246 of 629
TcxControl.Bounds
TcxControl
Returns the bound rectangle for a control in pixels. property Bounds: TRect; Description Use the Bounds property to access the TRect type that specifies the rectangular region occupied by a control. The horizontal and vertical size of this rectangle is equal to the Width and Height property values of the TcxControl object. ReadOnly Property
Page 247 of 629
TcxControl.Canvas
TcxControl See Also
Provides access to the current controls drawing surface. property Canvas: TcxCanvas; Description This property provides a library of functions to perform primitive graphic operations such as drawing lines, rectangles, images, text, etc. The TcxCanvas class is designed to provide proper working in VCL and CLX applications. ReadOnly Property
Page 248 of 629
TcxControl.ClientBounds
TcxControl
Returns the rectangle of a controls client area (in pixels). property ClientBounds: TRect; Description Read the ClientBounds property to obtain the size of a controls client area. Client area size is obtained by subtracting the border (and scrollbars, if any) size from the size of the area occupied by a control (returned by the Bounds property). ReadOnly Property
Page 249 of 629
TcxControl.Create
TcxControl
Creates a new TcxControl object instance. procedure Create(AOwner: TComponent); override; Description Call the Create method to instantiate a control at runtime. After calling the inherited constructor, the Create method creates a canvas and scrollbars for the control and initializes its properties and variables. The canvas is provided by the TcxCanvas object which provides a drawing surface for cross-platform windowed controls.
Page 250 of 629
TcxControl.Destroy
TcxControl
Destroys a TcxControl object instance. procedure Destroy; override; Description The Destroy method is used to free any memory or resources allocated in the Create method.
Page 251 of 629
TcxControl.FocusOnClick
TcxControl
Specifies whether the control gets a focus when it has been clicked. property FocusOnClick: Boolean; Description Set the FocusOnClick property to True to acquire a focus when the control has been clicked. The default value of the FocusOnClick property is True.
Page 252 of 629
TcxControl.InvalidateRect
TcxControl
Adds the region occupied by a control rectangle to a specified window's update region. The update region represents a portion of the control client area that must be redrawn. procedure InvalidateRect(const R: TRect; EraseBackground: Boolean); Description Call the InvalidateRect method when the area occupied by a control rectangle will need to be repainted. The R parameter points to the TRect that contains client coordinates of the control rectangle to be added to the update region. If this parameter is NULL, the entire client area is added to the update region. The EraseBack ground parameter specifies whether the background within the control rectangle region specified by the R parameter is to be erased when processing the update region. If this parameter is True, the background is erased when redrawing the control rectangle region. If this parameter is False, the background remains unchanged.
Page 253 of 629
TcxControl.IsDesigning
TcxControl
Specifies whether the control is currently being manipulated by the form designer. property IsDesigning: Boolean; Description IsDesigning returns True if the ComponentState property inherited from the TComponent class contains the csDesigning flag indicating that the form designer is manipulating the control. Otherwise, False is returned. ReadOnly Property
Page 254 of 629
TcxControl.IsDestroying
TcxControl
Specifies whether the control is being destroyed. property IsDestroying: Boolean; Description The state of a control is determined by the ComponentState property inherited from the TComponent class. The IsDestroying property returns True if a control is about to be destroyed (the ComponentState contains the csDestroying flag). Otherwise, the property returns False. ReadOnly Property
Page 255 of 629
TcxControl.IsFocused
TcxControl
Indicates whether a control has focus. property IsFocused: Boolean; Description Read the IsFocused property to determine if a control currently receives input from the user. The IsFocused property is set to True if the control has focus; otherwise, False. ReadOnly Property
Page 256 of 629
TcxControl.IsLoading
TcxControl
Specifies whether the current control is being loaded. property IsLoading: Boolean; Description The ComponentState property, inherited from the TComponent class, determines the state of a control. If it contains the csLoading flag meaning that a control and all its children are being loaded from a file, the IsLoading property returns True. Otherwise, False is returned. ReadOnly Property
Page 257 of 629
TcxControl.LookAndFeel
TcxControl
Specifies the default look and feel of a control. property LookAndFeel: TcxLookAndFeel; Description LookAndFeel controls the default look and feel of a control (tab panels, dropdown buttons) and the style behavior in response to user actions. The LookAndFeel.NativeStyle attribute determines whether the controls elements (borders, buttons and background) are drawn using the display settings determined by the operating system. For instance, in Windows XP the current XP theme is used if LookAndFeel.NativeStyle is set to True. If LookAndFeel.NativeStyle is set to False, then the LookAndFeel.Kind or LookAndFeel.SkinName property specifies the default look and feel of a control. Four styles (standard, flat, ultra flat, and Office 2003) determine the manner in which a grid is painted and responds to user events.
Page 258 of 629
TcxControl.OnMouseEnter
TcxControl See Also
Occurs when the mouse pointer moves over a control. type TNotifyEvent = procedure(Sender: TObject) of object; property OnMouseEnter: TNotifyEvent; Description Handle the OnMouseEnter event to perform specific actions when an end-user moves the mouse over the control. For example, you can use this event to change the controls appearance (font, color, border width, etc.) when the mouse pointer hovers over the control, and then use the OnMouseLeave event to reverse its appearance back to the default when the mouse leaves the control.
Page 259 of 629
TcxControl.OnMouseLeave
TcxControl See Also
Occurs when the mouse pointer leaves a control. type TNotifyEvent = procedure(Sender: TObject) of object; property OnMouseLeave: TNotifyEvent; Description Handle the OnMouseLeave event to perform specific actions when an end-user moves the mouse pointer off the control. For example, you can use this event to undo any changes that were made in the OnMouseEnter event handler.
Page 260 of 629
TcxControl.PopupMenu
TcxControl
Specifies the popup menu that is associated with a control. property PopupMenu: TComponent; Description The PopupMenu property specifies the popup menu that is associated with the current control.
Page 261 of 629
TcxLockedStateImageOptions.AssignedValues
TcxLockedStateImageOptions
Specifies message box settings that override global settings. type TcxLockedStateImageAssignedValue = (lsiavFont, lsiavColor); TcxLockedStateImageAssignedValues = set of TcxLockedStateImageAssignedValue; property AssignedValues: TcxLockedStateImageAssignedValues; Description Values include: Value lsiavFont lsiavColor If True, the Font overrides the global Font setting. If True, the Color overrides the global Color setting. Meaning
The default value of the AssignedValues property is [].
Page 262 of 629
TcxLockedStateImageOptions.Color
Specifies the background color of the message box. property Color: TColor; Description If the Color property is clNone, the parents color is used. The default value of the Color property is clNone.
Page 263 of 629
TcxLockedStateImageOptions.Effect
Specifies the visual effect for a "Locked View" image. type TcxLockedStateImageEffect = (lsieNone, lsieLight, lsieDark); property Effect: TcxLockedStateImageEffect; Description Refer to the TcxLockedStateImageEffect description, for details. The default value of the Effect property is lsieNone.
Page 264 of 629
TcxLockedStateImageOptions.Enabled
Specifies whether to display a "Locked View" image. property Enabled: Boolean; Description Set the Enabled property to True, to make the image visible. The default value of the Enabled property is True.
Page 265 of 629
TcxLockedStateImageOptions.Font
Specifies the font of the message string. property Font: TFont; Description If the Font property is not specified, the grids Font setting is used.
Page 266 of 629
TcxLockedStateImageOptions.ShowText
Specifies whether to display a message box over a "Locked View" image. property ShowText: Boolean; Description The default value of the ShowText property is False. The default value of the ShowText property is False.
Page 267 of 629
TcxLockedStateImageOptions.Text
Specifies the message string. property Text: string;
Page 268 of 629
TcxControl Events
TcxControl Legend
In TcxControl OnMouseEnter OnMouseLeave Derived from TControl {$IFDEF DELPHI14} OnGesture {$ENDIF}
Page 269 of 629
TcxControl Methods
TcxControl Legend
In TcxControl Create Destroy InvalidateRect
Page 270 of 629
TcxControlChildComponent Methods
TcxControlChildComponent Legend
In TcxControlChildComponent CreateEx Destroy
Page 271 of 629
TcxControl Properties
TcxControl Legend
In TcxControl ActiveCanvas BorderStyle Bounds Canvas ClientBounds FocusOnClick IsDesigning IsDestroying IsFocused IsLoading LookAndFeel PopupMenu Derived from TControl Hint ShowHint {$IFDEF DELPHI14} Touch {$ENDIF}
Page 272 of 629
TcxControlChildComponent Properties
TcxControlChildComponent Legend
In TcxControlChildComponent Control IsDestroying IsLoading
Page 273 of 629
TcxLockedStateImageOptions Properties
TcxLockedStateImageOptions Legend
In TcxLockedStateImageOptions AssignedValues Color Effect Enabled Font ShowText Text
Page 274 of 629
Page 275 of 629
Hierarchy TComponent | TControl | TWinControl | TCustomControl | TcxControl
Page 276 of 629
Hierarchy TPersistent | TcxLockedStateImageOptions
Page 277 of 629
Hierarchy IUnknown | IcxImageCollectionListener
Page 278 of 629
IcxImageCollectionListener.ImageCollectionChanged
IcxImageCollectionListener
Notifies a registered listener that the TcxImageCollection component has been changed. procedure ImageCollectionChanged; Description Implement the ImageCollectionChanged method to perform specific actions after changes have been made to the image collection.
Page 279 of 629
IcxImageCollectionListener.ImageCollectionDestroyed
IcxImageCollectionListener
Notifies a registered listener that the TcxImageCollection component is destroyed. procedure ImageCollectionDestroyed; Description When an image collection is being destroyed, the listeners reference is automatically removed from the image collections list of registered listeners. Implement the ImageCollectionDestroyed method to perform specific actions when the image collection is being destroyed.
Page 280 of 629
API
Application Programming Interface (API) is an interface between an operating system and an application. It enables applications to communicate with the operating system and its services. For example, an API may make it possible for programs to create windows, display message boxes and use subsystems such as GDI.
Page 281 of 629
Device Context
One of the chief features of the Microsoft Win32 application programming interface (API) is device independence. Win32-based applications can draw and print output on a variety of devices. The software supporting this device independence is contained in two dynamic-link libraries. The first, GDI32.DLL, is referred to as the graphics device interface (GDI); the second is referred to as a device driver. The name of the second depends on the device where an application draws output. For example, if an application draws output in the client area of its window on a VGA display, this library is VGA.DLL; if it prints output on an Epson FX-80 printer, this library is EPSON9.DLL. An application must inform GDI of loading a particular device driver and, once the driver is loaded, to prepare a device for drawing operations (such as selecting the line color and width, the brush pattern and color, the font typeface and clipping region, etc.) This can be accomplished by creating and maintaining a device context. The device context is a structure that defines a set of graphic objects and their associated attributes, and the graphic modes affecting output. Graphic objects include: a pen for line drawing a brush for painting and filling a bitmap for copying or scrolling screen sections a palette for defining a set of available colors a region for clipping and other operations a path for painting and drawing operations Unlike most of the Win32 structures, applications do not have direct access to the device context; instead, they operate indirectly by calling various functions.
Page 282 of 629
GDI
Graphics Device Interface (GDI) is a subsystem of the Microsoft Windows family of operating systems (since Microsoft Windows 95) and it is responsible for displaying information on screens and printers. GDI is an API that is exposed through a set of functions exported from the DLL (GDI32.DLL). A graphics device interface, such as GDI, allows application programmers to display information on a screen or printer without having to be concerned about the details of particular display devices. An application programmer makes calls to the methods provided by GDI, which in turn make appropriate calls to specific device drivers. GDI insulates applications from graphics hardware, thus allowing developers to create device-independent applications. The Microsoft Windows XP operating system provides a graphics subsystem which extends the drawing facilities far beyond the common GDI functions. It is called GDI+. As its name suggests, GDI+ is a successor to GDI.
Page 283 of 629
TcxCanvas.Brush
TcxCanvas
Determines the color and pattern for filling graphical shapes and backgrounds. property Brush: TBrush; Description Set the Brush property to specify the color and pattern to use when drawing the background or filling in graphical shapes. The value of the Brush property is a TBrush object. Set the properties of the TBrush object to specify the color and pattern or the bitmap to use when filling in spaces on a canvas. Note: When assigning the Brush property, all source brush settings are copied to the TcxCanvas brush.
Page 284 of 629
TcxCanvas.Canvas
TcxCanvas
Provides access to the standard VCL canvas. property Canvas: TCanvas; Description The TcxCanvas class is a VCL canvas wrapper that extends its facilities with a set of drawing methods. The TcxCanvas class uses a TCanvas class instance to store data. This canvas can be accessed by the Canvas property. ReadOnly Property
Page 285 of 629
TcxCanvas.CopyMode
TcxCanvas
Specifies the manner in which a graphical image is copied onto a canvas. property CopyMode: TCopyMode; Description Set CopyMode to affect the manner in which graphical images are drawn on a canvas. The CopyMode property value represents a type of Raster Operation. Use raster operations to achieve a variety of effects when rendering an image. For example, merged images and making parts of a bitmap transparent by combining multiple images with different raster operations. Although there are 256 possible raster operations, only 15 are worth mentioning here. The following table explains their meanings: Value cmBlackness cmDstInvert cmMergeCopy cmMergePaint cmNotSrcCopy Fills the destination using the color associated with index 0 in the physical palette. (This color is black for the default physical palette.) Inverts the destination bitmap colors and ignores the source. Merges the colors of the source with the brush color of the destination by using the Boolean AND operator. Combines the inverted source bitmap with the image on the canvas by using the Boolean OR operator. Copies the inverted source bitmap onto a canvas. Meaning
cmNotSrcErase Combines the image on the canvas and the source bitmap by using the Boolean OR operator and inverts the result. cmPatCopy cmPatInvert cmPatPaint Copies the source pattern onto a canvas. Combines the source pattern with the image on the canvas using the Boolean XOR operator. Combines the inverted source bitmap with the source pattern by using the Boolean OR operator. Combines the result of this operation with the image on a canvas by using the Boolean OR operator. Combines the image on the canvas and the source bitmap by using the Boolean AND operator. Copies the source bitmap onto a canvas. Inverts the image on the canvas and combines the result with the source bitmap by using the Boolean AND operator. Combines the image on the canvas and the source bitmap by using the Boolean XOR operator. Combines the image on the canvas and the source bitmap by using the Boolean OR operator. Fills the destination using the color associated with index 1 in the physical palette. (This color is white for the default physical palette.)
cmSrcAnd cmSrcCopy cmSrcErase cmSrcInvert cmSrcPaint cmWhiteness
The following table shows the results of some raster operations: Value Source Destination Result
Page 286 of 629
cmBlackness* cmDstInvert cmMergeCopy cmMergePaint cmNotSrcCopy cmNotSrcErase cmPatCopy cmPatInvert cmPatPaint cmSrcAnd cmSrcCopy cmSrcErase cmSrcInvert cmSrcPaint cmWhiteness* * - Depends on the system palette settings. The CopyMode property value is used internally by the CopyRect and Draw methods to achieve various effects while drawing.
Page 287 of 629
TcxCanvas.CopyRect
TcxCanvas
Copies a portion of an image from one canvas onto another. procedure CopyRect(const Dest: TRect; ACanvas: TCanvas; const Source: TRect); Description Use the CopyRect method to transfer a portion of an image from one canvas to the image of the TCanvas object. The Dest parameter specifies the rectangle on the canvas where the source image will be copied. The ACanvas parameter specifies the canvas with the source image. The Source parameter specifies the rectangle bounding the portion of the source canvas to be copied. So if you need to copy an image from one TcxCanvas to another, you should implement the following code: //the following code copies ARect2 from cxCanvas2 to ARect1 of cxCanvas1 cxCanvas1.CopyRect(ARect1, cxCanvas2.Canvas, ARect2); The copy uses the mode specified by the CopyMode property.
Page 288 of 629
TcxCanvas.Draw
TcxCanvas
Renders a graphic object on a canvas. procedure Draw(X, Y: Integer; Graphic: TGraphic); Description Call the Draw method to draw a graphic object (specified by the Graphic parameter) on a canvas. The position to place the upperleft corner of the object is specified by the X and Y parameters. Graphics can be bitmaps, icons, or metafiles. If it is a TBitmap object, the bitmap is rendered using the CopyMode property value.
Page 289 of 629
TcxCanvas.DrawComplexFrame
TcxCanvas
Draws a two-color border around a rectangle. procedure DrawComplexFrame(const R: TRect; ALeftTopColor, ARightBottomColor: TColor; ABorders: TcxBorders = [bLeft, bTop, bRight, bBottom]; ABorderWidth: Integer = 1); Description The DrawComplexFrame method draws a two-color border around a rectangle. The ALeftTopColor parameter provides the color for the top and left border sides and the ARightBottomColor parameters - for the bottom and right. Optionally, you can specify the border width. You can also determine which border sides to draw (the ABorders and ABorderWidth parameters). This method lets you draw a complex border in a single operation (without having to manipulate pen and brush colors or to perform excessive calculations.) The following code shows how to draw grid view's Group By box in 3D style using the DrawComplexFrame method (The code is implemented in the TcxCustomGridTableView.OnCustomDrawPartBackground event handler): procedure TViewTableSimpleDemoMainForm.cxgFilmsDBTableViewCustomDrawPartBackground( Sender: TcxGridTableView; ACanvas: TcxCanvas; AViewInfo: TcxCustomGridCellViewInfo; var ADone: Boolean); var FOldColor: TColor; FBounds: TRect; begin if (AViewInfo is TcxGridGroup ByBoxViewInfo) then begin FOldColor := ACanvas.Brush.Color; ACanvas.Brush.Color := clBtnFace; FBounds := AViewInfo.Bounds; ACanvas.FillRect (AViewInfo.Bounds); ACanvas.DrawComplexFrame(FBounds, clWhite, cl3DDkShadow, cxBordersAll, 1); InflateRect(FBounds, -1, -1); ACanvas.DrawComplexFrame(FBounds, cl3DLight, clGray, cxBordersAll, 1); ACanvas.Brush.Color := FOldColor; ADone := True; end; end; The following images illustrate the above code. Standard drawing (the above code is NOT implemented):
Custom drawing (the above code is implemented):
Page 290 of 629
TcxCanvas.DrawEdge
TcxCanvas
Draws one or more edges of a rectangle. procedure DrawEdge(const R: TRect; ASunken, AOuter: Boolean; ABorders: TcxBorders = [bLeft, bTop, bRight, bBottom]); Description The DrawEdge method draws one or more edges of the rectangle specified by the R parameter. Set the ASunk en parameter to True to draw the edge sunken, otherwise it will be drawn raised. If the AOuter parameter is True, the edge will be drawn outside the rectangle, otherwise, it is drawn within the rectangle. To specify the edges to draw, you should use the ABorders parameter. The following code shows how to draw edges above and below the grid view's Group By box caption using the DrawEdge method (The code is implemented in the TcxCustomGridTableView.OnCustomDrawPartBackground event handler): procedure TViewTableSimpleDemoMainForm.cxgFilmsDBTableViewCustomDrawPartBackground( Sender: TcxGridTableView; ACanvas: TcxCanvas; AViewInfo: TcxCustomGridCellViewInfo; var ADone: Boolean); var FBounds: TRect; begin FBounds := AViewInfo.Bounds; ACanvas.FillRect(FBounds); InflateRect(FBounds, 0, -9); ACanvas.DrawEdge(FBounds, True, True, [bTop, bBottom]); ADone := True; end;
Page 291 of 629
TcxCanvas.DrawFocusRect
TcxCanvas
Draws a rectangle using the style indicating that it has focus. procedure DrawFocusRect(const R: TRect); Description The DrawFocusRect method draws a rectangle using the style indicating that it has focus. Since the DrawFocusRect method is an XOR function, calling it for the second time with the same rectangle removes the rectangle from screen. The image below shows the grid view's Group By box caption surrounded by the focus rectangle:
Page 292 of 629
TcxCanvas.DrawImage
TcxCanvas
Renders a graphic object from a VCL image list on a canvas. procedure DrawImage(Images: TImageList; X, Y, Index: Integer; Enabled: Boolean = True); Description Call the Draw method to draw a graphic object on a canvas using an image from the Images image list. The Index parameter provides the reference to the image used. The X and Y parameters provide the location of the upper-left corner of the image within the canvas. If you want your image to be drawn as disabled, set the Enabled parameter to False. The image below shows the grid view's the enabled image drawn in the Group By box:
and that shows the disabled one:
Page 293 of 629
TcxCanvas.DrawText
TcxCanvas
Draws formatted text within a specific rectangle. procedure DrawText(const Text: string; R: TRect; Flags: Integer; Enabled: Boolean = True); Description The DrawText method draws formatted text (specified by the Text parameter) within a rectangle (the R parameter). It formats the text based on the flag values provided (expanding tabs, justifying characters, breaking lines, etc.). The DrawText method uses the selected font, text color, and background color to draw text within a canvas. Unless the cxDontClip flag is used, the DrawText method clips the text so that it does not appear outside the rectangle provided. The text will be presented via multiple lines when needed unless the cxSingleLine flag is specified. If the selected font is too large for the rectangle, the DrawText method does not attempt to replace it with a smaller one. If you want your text to be drawn as disabled, set the Enabled parameter to False. Value cxAlignBottom Justifies the text to the bottom of the rectangle. This value must be combined with cxSingleLine. cxAlignBottom corresponds to the DT_BOTTOM flag value of the DrawText API function. Centers the text within the rectangle. This value represents a combination of the cxAlignHCenter and cxAlignVCenter values. Centers the text horizontally within the rectangle. This value corresponds to the DT_CENTER flag value of the DrawText API function. Aligns the text to the left. This value corresponds to the DT_LEFT flag value of the DrawText API function. Aligns the text to the right. This value corresponds to the DT_RIGHT flag value of the DrawText API function. Top-justifies the text (single line only). This value corresponds to the DT_TOP flag value of the DrawText API function. Centers the text vertically (single line only). This value corresponds to the DT_VCENTER flag value of the DrawText API function. If not set, a partially visible last text line is not displayed. Otherwise, the text is displayed as is. This value applies only in combination with the cxWordBreak flag value. The case when the cxDontBreakChars flag value is not set corresponds to calling the DrawText API function with the DT_EDITCONTROL flag value. Draws without clipping. The DrawText method is somewhat faster when cxDontClip is used. This value corresponds to the DT_NOCLIP flag value of the DrawText API function. Calculates the rectangle required to display the entire text. The text wont be drawn. This value corresponds to the DT_CALCRECT flag value of the DrawText API function. Meaning
cxAlignCenter cxAlignHCenter
cxAlignLeft
cxAlignRight
cxAlignTop cxAlignVCenter
cxDontBreakChars
cxDontClip
cxDontPrint
Page 294 of 629
cxExpandTabs
Expands tab characters. The default number of characters per tab is eight. This value corresponds to the DT_EXPANDTABS flag value of the DrawText API function. Characters at the end of the text are replaced with ellipses, if necessary, so that it fits into the specified rectangle. This value corresponds to the DT_END_ELLIPSIS flag value of the DrawText API function. Switches on the processing of prefix characters. By specifying cxShowPrefix, DrawText method interprets the mnemonic-prefix character & as a directive to underscore the character that follows, and the mnemonicprefix characters && as a directive to print a single &. Normally, this processing is deactivated. Setting cxShowPrefix turns off the DT_NOPREFIX flag value of the DrawText API function. Characters in the middle of the text are replaced with an ellipsis, if necessary, so that it fits into the specified rectangle. If the string contains backslash (\) characters, the DrawText preserves as much as possible of the text after the last backslash. cxShowPathEllipsis corresponds to the DT_PATH_ELLIPSIS flag value of the DrawText API function. Displays the text in a single line only. Carriage returns and linefeeds do not break the line. This value corresponds to the DT_SINGLELINE flag value of the DrawText API function. Breaks words. Lines are automatically broken between words if a word extends past the edge of the rectangle specified by the R parameter. A carriage return-linefeed sequence also breaks the line. Use the cxDontBreakChars flag value to specify whether a partially visible last line of the text is displayed. cxWordBreak corresponds to the DT_WORDBREAK flag value of the DrawText API function.
cxShowEndEllipsis
cxShowPrefix
cxShowPathEllipsis
cxSingleLine
cxWordBreak
The following code shows how to custom paint the grid view's Group By box caption using the DrawText method (The code is implemented in the TcxCustomGridTableView.OnCustomDrawPartBackground event handler). The caption is multi-line with the end ellipsis: procedure TViewTableSimpleDemoMainForm.cxgFilmsDBTableViewCustomDrawPartBackground( Sender: TcxGridTableView; ACanvas: TcxCanvas; AViewInfo: TcxCustomGridCellViewInfo; var ADone: Boolean); var FBounds: TRect; begin FBounds := AViewInfo.Bounds; ACanvas.FillRect(FBounds); InflateRect(FBounds, -150, -4); OffsetRect(FBounds, -140, 0); ACanvas.DrawText('This is the Group By Box. ' + 'It is used to group records by field values. ' + 'Drag a column header here to group by that field.', FBounds, cxWordBreak or cxShowEndEllipsis); ADone := True; end; The result is shown on the image below:
Page 295 of 629
Page 296 of 629
TcxCanvas.FillRect
TcxCanvas
Fills a rectangle on a canvas using the current brush. procedure FillRect(const R: TRect); procedure FillRect(const R: TRect; ABitmap: TBitmap); Description Use the FillRect method to fill the specified rectangular region. The region is filled including the top and left sides of the rectangle, but excluding the bottom and right edges. The rectangle to be filled is specified by the R parameter. If the ABitmap parameter is not omitted, the rectangle is filled with the image specified by it. Otherwise, it is filled using the current brush settings.
Page 297 of 629
TcxCanvas.Font
TcxCanvas
Specifies the font to use when writing text on a canvas. property Font: TFont; Description Set the Font property to specify the font to use for writing text on a canvas. The Font property value is a TFont object. Set the properties of the TFont object to specify the font face, color, size, style etc. Note: When assigning the Font property, all source font settings are copied to the TcxCanvas font.
Page 298 of 629
TcxCanvas.FontHeight
TcxCanvas
Returns the height of a string rendered in the current font in pixels. function FontHeight(AFont: TFont): Integer; Description Use the FontHeight method to determine the height of a string written with the current font (the AFont parameter). Other image elements such as lines, boxes, or additional text lines can then be positioned to accommodate the text height.
Page 299 of 629
TcxCanvas.FrameRect
TcxCanvas
Draws a border around a rectangle. procedure FrameRect(const R: TRect; Color: TColor = clDefault; ALineWidth: Integer = 1; ABorders: TcxBorders = cxBordersAll); Description The FrameRect method draws a color border around a rectangle. The Color parameter specifies the border color. Optionally you can specify the border sides to draw and the border width (the ABorders and ALineWidth parameters).
Page 300 of 629
TcxCanvas.Handle
TcxCanvas
Specifies the handle for a canvas. property Handle: HDC; Description The Handle property specifies the Windows GDI handle to the device context for a canvas. Read the Handle property to supplement the drawing services provided by the TcxCanvas object with API calls that require a handle to the device context. Most of the Windows GDI calls require a device context handle. ReadOnly Property
Page 301 of 629
TcxCanvas.LineTo
TcxCanvas
Draws a line from the current pen position to the point specified by X and Y and updates the pen position. procedure LineTo(X, Y: Integer); Description Use the LineTo method to draw a line from the current pen position up to, but not including the point specified by the X and Y coordinates. The LineTo method changes the pen positions value to (X,Y). To set the pen position's value without drawing a line, use the MoveTo method. Note: If the current pen does not have a style of psSolid, the line is drawn with the background specified by the current brush.
Page 302 of 629
TcxCanvas.MoveTo
TcxCanvas
Changes the current drawing position to the point specified by the X and Y coordinates. procedure MoveTo(X, Y: Integer); Description Use the MoveTo method to set the pen position before calling the LineTo method.
Page 303 of 629
TcxCanvas.Pen
TcxCanvas
Specifies the pen type the canvas uses for drawing lines and outlining shapes. property Pen: TPen; Description Set the Pen property to specify the pen to use for drawing lines and outlining shapes on a canvas. The Pen property value is a TPen object. Set the properties of the TPen object to specify the color, style, width, and mode of the pen. Note: When assigning the Pen property, all source pen settings are copied to the TcxCanvas pen.
Page 304 of 629
TcxCanvas.Pixels
TcxCanvas
Specifies the color of pixels within the current clipping rectangle of a canvas. property Pixels[X, Y: Integer]: TColor; Description Read the Pixels property to learn the color of the drawing surface at a specific pixel position within the current clipping region. If the position is outside the clipping rectangle, the Pixels property value is -1. Write the Pixels property to change the color of individual pixels within the drawing surface. Note: Getting and setting the Pixels property is a very slow operation. Use it only when it is unavoidable.
Page 305 of 629
TcxCanvas.Polygon
TcxCanvas
Draws a series of lines on a canvas to create a filled shape. procedure Polygon(const Points: array of TPoint); Description Use the Polygon method to draw a closed, many-sided shape on a canvas, using the current pen. Having completed the shape, the Polygon method fills it with the help of the current brush. The Points parameter is an array of points that specify the vertices of a polygon. The last point is always connected to the first point automatically, so you do not need to supply the first one twice. To draw a polygon without filling it, use the Polyline method.
Page 306 of 629
TcxCanvas.Polyline
TcxCanvas
Draws a series of connected lines with the current pen. procedure Polyline(const Points: array of TPoint); Description Use the Polyline method to connect a set of points on a canvas. If you specify only two points, the Polyline method draws a single line. The Points parameter is an array of points to be connected. To draw a polygon and fill it with the current brush, use the Polygon method instead.
Page 307 of 629
TcxCanvas.TextExtent
TcxCanvas
Returns the width and height of a string in pixels in pixels, rendered in the current font. Overloaded Variants function TextExtent(const Text: string): TSize; procedure TextExtent(const Text: string; var R: TRect; Flags: Integer); Description Use the TextExtent method to determine the space a string will occupy within an image. Overload 1: Other image elements such as lines, boxes, or additional text lines can be positioned to accommodate the size of text. The TextExtent method returns the width and height of the rectangle that bounds the supplied text within a canvas. Overload 2: The Flags parameter specifies the string format. The flags are the same as in the DrawText method. The R parameter returns the texts bounding rectangle. Other image elements such as lines, boxes, or additional text lines can be positioned to accommodate the size of the text.
Page 308 of 629
TcxCanvas.TextHeight
TcxCanvas
Returns the height of a string in pixels, rendered in the current font. function TextHeight(const Text: string): Integer; Description Use the TextHeight method to determine the height a string will occupy within an image. Other image elements such as lines, boxes, or additional text lines can be positioned to accommodate the texts height. To determine the texts width, use the TextWidth property. Also, see the TextExtent method for enhanced text measuring facilities.
Page 309 of 629
TcxCanvas.TextWidth
TcxCanvas
Returns the width of a string rendered in the current font (in pixels). function TextWidth(const Text: string): Integer; Description Use the TextWidth method to determine the length a string will occupy within an image. Other graphical image elements such as lines or additional strings can be positioned to accommodate the texts width. To determine the texts height, use the TextHeight property. Also, see the TextExtent method for enhanced text measuring facilities.
Page 310 of 629
TcxImageCollectionItems.Add
TcxImageCollectionItems
Adds a new TcxImageCollectionItem instance to the end of the collection. function Add: TcxImageCollectionItem; Description The Add method returns a newly created instance.
Page 311 of 629
TcxImageCollectionItems.FindItemByID
Returns the TcxImageCollectionItem instance by its unique identifier. function FindItemByID(ID: Integer): TcxImageCollectionItem; Description The FindItemByID method returns nil, if the ID doesnt match the corresponding identifier in the collection.
Page 312 of 629
TcxImageCollectionItems.FindItemByName
Searches for the TcxImageCollectionItem instance by its name. function FindItemByName(const AName: string; out AItem: TcxImageCollectionItem): Boolean; Description If an instance was found, the FindItemByName method assigns it to AItem and returns True. Otherwise, nil is assigned and False is returned. AName specifies the name of an instance to match. AItem returns the found instance.
Page 313 of 629
TcxImageCollectionItems.Insert
Inserts a new TcxImageCollectionItem instance into the collection at the position specified by the zero-based Index parameter. function Insert(Index: Integer): TcxImageCollectionItem; Description The Insert method returns a newly created instance.
Page 314 of 629
TcxImageCollectionItems.Items
Provides indexed access to the images in the TcxImageCollection component. property Items[Index:Integer]: TcxImageCollectionItem; Description Use the Items property to obtain an image at the position specified by the zero-based Index parameter.
Page 315 of 629
TcxImageCollectionItem.ClientRect
TcxImageCollectionItem See Also
Returns the images bounding rectangle, in pixels. property ClientRect: TRect; ReadOnly Property
Page 316 of 629
TcxImageCollectionItem.Draw
TcxImageCollectionItem
Paints the image on ACanvas. Overloaded Variants procedure Draw(ACanvas: TCanvas; X, Y: Integer); procedure Draw(ACanvas: TCanvas; const R: TRect; AStretch: Boolean = True; ASmoothResize: Boolean = False; AEnabled: Boolean = True); Description The second overload paints the image within the R rectangle, using image adjustment options. ACanvas specifies the canvas on which the image will be painted. X and Y specify the coordinates of the images top-left corner. R specifies the rectangle within which the image will be painted. AStretch specifies whether the image will fit R. Set AStretch to True, to zoom the image within R boundaries. Otherwise, it will be centered in the rectangle. ASmoothResize specifies whether anti-aliasing will be applied when the image is zoomed in. Set ASmoothResize to True, to smooth the resulting image, when its scaled to the size of R. AEnabled specifies whether the image is painted in full color or grayed out. Set AEnabled to False, to paint the image grayed out.
Page 317 of 629
TcxImageCollectionItem.Height
Returns the images height, in pixels. property Height: Integer; ReadOnly Property
Page 318 of 629
TcxImageCollectionItem.Picture
Specifies the image to be stored in the image collection. property Picture: TPicture; Description The stored image can be of any format that is supported by the TPicture type.
Page 319 of 629
TcxImageCollectionItem.Tag
Specifies the value that can be used for image identification purposes. type TcxTag = Longint; property Tag: TcxTag; The default value of the Tag property is 0.
Page 320 of 629
TcxImageCollectionItem.Width
Returns the images width, in pixels. property Width: Integer; ReadOnly Property
Page 321 of 629
TcxImageCollection.AddListener
TcxImageCollection See Also
Registers a listener to be notified when the component changes. procedure AddListener(AListener: IcxImageCollectionListener);
Page 322 of 629
TcxImageCollection.Count
TcxImageCollection
Returns the number of images that are stored in the component. property Count: Integer; ReadOnly Property
Page 323 of 629
TcxImageCollection.Draw
TcxImageCollection
Paints the image on ACanvas. Overloaded Variants procedure Draw(ACanvas: TCanvas; X, Y, AIndex: Integer); procedure Draw(ACanvas: TCanvas; const R: TRect; AIndex: Integer; AStretch: Boolean = True; ASmoothResize: Boolean = False; AEnabled: Boolean = True); Description The second overload paints the image within the R rectangle, using image adjustment options. ACanvas specifies the canvas on which the image will be painted. X and Y specify the coordinates of the images top-left corner. R specifies the rectangle within which the image will be painted. AIndex specifies the images index in the image collection. AStretch specifies whether the image will fit R. Set AStretch to True, to zoom the image within R boundaries. Otherwise, it will be centered in the rectangle. ASmoothResize specifies whether anti-aliasing will be applied when the image is zoomed in. Set ASmoothResize to True, to smooth the resulting image, when its scaled to the size of R. AEnabled specifies whether the image is painted in full color or grayed out. Set AEnabled to False, to paint the image grayed out.
Page 324 of 629
TcxImageCollection.Items
TcxImageCollection
Specifies the collection of images that are stored in the component. property Items: TcxImageCollectionItems;
Page 325 of 629
TcxImageCollection.RemoveListener
TcxImageCollection
Deletes a listener from the collection of listeners registered using the AddListener method. procedure RemoveListener(AListener: IcxImageCollectionListener);
Page 326 of 629
TcxImageList.AlphaBlending
TcxImageList
Determines whether alpha channel information is used to draw images. property AlphaBlending: Boolean; Description By default this property is set to True, which indicates that images are drawn using alpha channel information. Otherwise, this information is ignored as with the standard TImageList.Draw method. Call the Draw method to paint images on a specific canvas. Note:To improve performance in Windows XP and Windows Vista, put a TXPManifest component onto a form, and set the AlphaBlending property to False.
Page 327 of 629
TcxImageList.BeginUpdate
TcxImageList
Postpones sending notifications about changes to the image list until the matching EndUpdate method is called. procedure BeginUpdate; Description To improve performance and prevent all listeners from refreshing their contents during bulk updates, enclose the code performing the updates within BeginUpdate/EndUpdate blocks. Note:The OnChange event wont fire unless all EndUpdate methods are executed.
Page 328 of 629
TcxImageList.CompressData
TcxImageList
Specifies whether stored images are to be compressed. property CompressData: Boolean; Description Set the CompressData property to True, to reduce the size of the stored images. The default value of the CompressData property is False.
Page 329 of 629
TcxImageList.CopyImages
TcxImageList
Copies a set of images from the AImageList to the current image list. procedure CopyImages(AImageList: TCustomImageList; AStartIndex: Integer = 0; AEndIndex: Integer = -1); Description A range of images is determined by the AStartIndex and AEndIndex parameters, which correspond to the indexes of the first and last images in the range. When the AEndIndex parameter is set to a negative value or exceeds the index of the last image, the last image is considered to be the last element in the range.
Page 330 of 629
TcxImageList.Draw
TcxImageList
Paints the image specified by the AIndex parameter on ACanvas. Overloaded Variants type TDrawingStyle = (dsFocus, dsSelected, dsNormal, dsTransparent); TImageType = (itImage, itMask); procedure Draw(ACanvas: TCanvas; X, Y, AIndex: Integer; ADrawingStyle: TDrawingStyle; AImageType: TImageType; AEnabled: Boolean = True); overload; procedure Draw(ACanvas: TCanvas; const ARect: TRect; AIndex: Integer; AStretch: Boolean = True; ASmoothResize: Boolean = False; AEnabled: Boolean = True); overload; Description The first overloaded variant allows you to draw the image or its associated transparency mask (as specified by the AImageType parameter) using various drawing styles. The ADrawingStyle parameter specifies the drawing style of the image to be painted. Pass False as the AEnabled parameter to paint the image grayed out. The X and Y parameters specify the location where the top-left corner of the image should appear on ACanvas. The second overloaded variant represents an extended version of the first one, and allows you to paint the image within the ARect rectangle using image adjustment options. Set the AStretch parameter to True to scale the image to stretch or fit ARect. Otherwise, the image will be centered within this rectangle. Set the ASmoothResize parameter to True to smooth the resulting image when its scaled to the size of ARect. As with the first overloaded variant, the AEnabled parameter indicates whether the image is painted grayed out or not.
Page 331 of 629
TcxImageList.EndUpdate
TcxImageList
Enables sending notifications about changes to the image list locked by the matching BeginUpdate method. procedure EndUpdate(AForceUpdate: Boolean = True); Description To improve performance and prevent all listeners to image list changes from refreshing their contents during bulk updates, enclose the code performing the updates within BeginUpdate/EndUpdate blocks. Note:The OnChange event wont fire unless all EndUpdate methods are executed. To prevent this event from being raised after the last EndUpdate method is executed, pass False as its AForceUpdate parameter.
Page 332 of 629
TcxImageList.GetImage
TcxImageList See Also
Retrieves the bitmap of an image by its index in the current image list. procedure GetImage(AIndex: Integer; AImage: TBitmap); Description The index of the image to retrieve is passed as the AIndex parameter. A value of 1 indicates that the bitmap of all images in the image list will be retrieved. The image bitmap is returned via the AImage parameter. Note:To retrieve bitmaps of 32-bit images stored in the TcxImageList, call the GetImage or GetImageInfo method, instead of the GetBitmap method.
Page 333 of 629
TcxImageList.GetImageInfo
Retrieves the bitmap and transparency mask bitmap of a specific image or all images in the current image list. Overloaded Variants procedure GetImageInfo(AIndex: Integer; AImage, AMask: TBitmap); overload; class procedure GetImageInfo(AHandle: HIMAGELIST; AIndex: Integer; AImage, AMask: TBitmap); overload; Description The index of the image is passed as the AIndex parameter. A value of 1 indicates that bitmap information about all images in the image list will be retrieved. An image bitmap and transparency mask bitmap are returned via the AImage and AMask parameters. The second overloaded variant requires the handle of the image list that is passed as the AHandle parameter. Use the Handle property to get the handle of the current image list. Note:To retrieve bitmaps of 32-bit images stored in the TcxImageList, call the GetImage or GetImageInfo method, instead of the GetBitmap method.
Page 334 of 629
TcxImageList.GetMask
Retrieves the transparency mask bitmap of a specific image. procedure GetMask(AIndex: Integer; AMask: TBitmap); Description The index of the image is passed as the AIndex parameter. A value of 1 indicates that the transparency mask bitmap of all images in the image list will be retrieved. The transparency mask bitmap is returned via the AMask parameter.
Page 335 of 629
TcxViewParams type
Specifies attributes controlling the objects appearance. Unit cxGraphics type TcxViewParams = record Bitmap: TBitmap; Color: TColor; Font: TFont; TextColor: TColor; end; Description The Bitmap field denotes the objects background bitmap; The Color field denotes the objects background color; The Font field denotes the font of the output text in the object; The TextColor field denotes the output text color in the object and should be used instead of the TFont.Color property.
Page 336 of 629
TcxImageList Events
TcxImageList Legend
Derived from TCustomImageList OnChange
Page 337 of 629
TcxCanvas Methods
TcxCanvas Legend
In TcxCanvas CopyRect Draw DrawComplexFrame DrawEdge DrawFocusRect DrawImage DrawText FillRect FontHeight FrameRect LineTo MoveTo Polygon Polyline TextExtent TextHeight TextWidth
Page 338 of 629
TcxImageCollection Methods
TcxImageCollection Legend
In TcxImageCollection AddListener Draw RemoveListener
Page 339 of 629
TcxImageCollectionItem Methods
TcxImageCollectionItem Legend
In TcxImageCollectionItem Draw
Page 340 of 629
TcxImageCollectionItems Methods
TcxImageCollectionItems Legend
In TcxImageCollectionItems Add FindItemByID FindItemByName Insert
Page 341 of 629
TcxImageList Methods
TcxImageList Legend
In TcxImageList BeginUpdate CopyImages EndUpdate Draw GetImage GetImageInfo GetMask Derived from TDragImageList BeginDrag DragLock DragMove DragUnlock EndDrag GetHotSpot HideDragImage Initialize SetDragImage ShowDragImage Derived from TCustomImageList Add AddIcon AddImages AddMasked Assign Clear Create CreateSize Delete Destroy Draw DrawOverlay FileLoad GetBitmap GetIcon GetImageBitmap GetInstRes GetMaskBitmap GetResource HandleAllocated Insert InsertIcon InsertMasked Move Overlay RegisterChanges Replace
Page 342 of 629
ReplaceIcon ReplaceMasked ResInstLoad ResourceLoad UnRegisterChanges
Page 343 of 629
TcxCanvas Properties
TcxCanvas Legend
In TcxCanvas Brush Canvas CopyMode Font Handle Pen Pixels
Page 344 of 629
TcxImageCollection Properties
TcxImageCollection Legend
In TcxImageCollection Count Items
Page 345 of 629
TcxImageCollectionItem Properties
TcxImageCollectionItem Legend
In TcxImageCollectionItem ClientRect Height Picture Tag Width
Page 346 of 629
TcxImageCollectionItems Properties
TcxImageCollectionItems Legend
In TcxImageCollectionItems Items
Page 347 of 629
TcxImageList Properties
TcxImageList Legend
In TcxImageList AlphaBlending CompressData Derived from TDragImageList DragCursor Dragging Derived from TCustomImageList AllocBy BkColor BlendColor Count DrawingStyle Handle Height ImageType Masked ShareImages Width
Page 348 of 629
IcxImageCollectionListener Methods
IcxImageCollectionListener Legend
In IcxImageCollectionListener ImageCollectionChanged ImageCollectionDestroyed
Page 349 of 629
Hierarchy TObject |
Page 350 of 629
Hierarchy TcxComponentCollection | TcxImageCollectionItems
Page 351 of 629
Hierarchy TcxComponentCollectionItem | TcxImageCollectionItem
Page 352 of 629
Hierarchy TComponent | TcxImageCollection
Page 353 of 629
Hierarchy TDragImageList | TcxImageList
Page 354 of 629
Hierarchy TObject | TcxCustomLookAndFeelPainter
Page 355 of 629
TcxLanguages.Add
TcxLanguages
Adds a language to the collection. function Add: TcxLanguage; Description The method adds an empty item to the collection and returns it. To specify a language for this newly created item, use the TcxLanguage.LocaleID property.
Page 356 of 629
TcxLanguages.GetLanguageByName
TcxLanguages See Also
Finds a language with a specified name and returns this language's index within the collection. function GetLanguageByName(AName: string): Integer; Description AName specifies the language name to be found. This value is compared to the TcxLanguage.Name property when searching. If the specified name is not found, the method returns 1.
Page 357 of 629
TcxLanguages.Items
TcxLanguages
Provides indexed access to languages. property Items[Index:Integer]: TcxLanguage; Description Index specifies the languages position in the collection.
Page 358 of 629
TcxLanguage.Dictionary
TcxLanguage
Contains localized strings. property Dictionary: TStrings; Description Each string contains a pair of a resource string identifier and the corresponding resource string value delimited by the equals sign delimiter.
Page 359 of 629
TcxLanguage.LocaleID
TcxLanguage
Specifies the languages locale ID, according to the Windows system specification. property LocaleID: Cardinal; Description To learn the locale id that corresponds to the required language, refer to the list of supported locales at the following address: http://www.microsoft.com/globaldev/reference/lcid-all.mspx. This information is also available in the MSDN install.
Page 360 of 629
TcxLanguage.Name
TcxLanguage See Also
Returns a locale name. property Name: string; Description While the LocaleID property specifies the locale in a numeric format, the Name property provides the corresponding display name containing a language, and a country or a region (this value is provided for some languages). This value is used for display purposes. ReadOnly Property
Page 361 of 629
TcxLocalizer.Active
TcxLocalizer See Also
Specifies whether the localization component is active. property Active: Boolean; Description Set the Active property to True, to activate the localizer. If active, the localizer implicitly loads resource strings from a store based on the StorageType setting. If a resource strings file is a .RES file, and this file was compiled to a DLL file, use the LoadFromResource method instead of the Active property. If a language has been dynamically changed at runtime, the localizer is automatically deactivated (the Active property is set to False). Set the Active property to True, to reactivate the localizer. The default value of the Active property is False.
Page 362 of 629
TcxLocalizer.FileName
TcxLocalizer
Specifies the resource strings files location. property FileName: TFileName; Description The resource strings file is an .INI file created using the Localizer Editor tool. The files content is separated into sections by languages. Each section is started with the language identifier represented as a decimal value in square brackets. In the section, each line contains a pair of a resource string identifier and the corresponding value delimited by the equals sign. If the files content has been modified at runtime, invoke the LoadFromFile method to update the components cache. Use this property to supply a different file with translations. If resource strings for the current language haven't been specified, default values will be used instead.
Page 363 of 629
TcxLocalizer.Language
TcxLocalizer
Specifies the applications language. property Language: string; Description Use this property to translate the application's UI into another language. If resource strings for this language haven't been specified, default values will be used instead. The Language, LanguageIndex and Locale properties are interchangeable, and mutually influence each other. If a language has been dynamically changed at runtime, the localizer is automatically deactivated (the Active property is set to False). Set the Active property to True, to reactivate the localizer.
Page 364 of 629
TcxLocalizer.LanguageIndex
Specifies the applications language by its index in the Languages collection. property LanguageIndex: Integer; Description The LanguageIndex, Language and Locale properties are interchangeable, and mutually influence each other. If a language has been dynamically changed at runtime, the localizer is automatically deactivated (the Active property is set to False). Set the Active property to True, to reactivate the localizer.
Page 365 of 629
TcxLocalizer.Languages
TcxLocalizer
Specifies a set of languages that will be available for localization. property Languages: TcxLanguages; Description Use this property to determine languages that are available for localization, and access a language which will be used for localization. You can also use this property to add a language dynamically via code. ReadOnly Property
Page 366 of 629
TcxLocalizer.LoadFromFile
Reads localized strings from the specified file into the localization components cache. procedure LoadFromFile(const AFileName: TFileName = ''); Description The localization component stores localized strings in the .INI file. Use the SaveToFile method, for instance, to create these files. AFileName specifies the source file.
Page 367 of 629
TcxLocalizer.LoadFromResource
Reads localized strings from a specified resource file into the localization components cache. procedure LoadFromResource(AHandle: Cardinal); Description Use the LoadFromResource method if a RES file is not compiled to an executable file, but to a DLL. This method is used as an alternate to the Active property. AHandle specifies the source files handle.
Page 368 of 629
TcxLocalizer.LoadFromStream
TcxLocalizer
Reads localized strings from the specified stream into the localization components cache. procedure LoadFromStream(AStream: TStream); Description Localized strings are stored in the .INI format. Use the SaveToStream method, for instance, to persist localized strings with streams. AStream specifies the source stream.
Page 369 of 629
TcxLocalizer.Locale
Specifies the applications locale, according to the Windows system specification. property Locale: Cardinal; Description To learn the locale id that corresponds to the required language, refer to the list of supported locales at the following address: http://www.microsoft.com/globaldev/reference/lcid-all.mspx. This information is also available in the MSDN install. Use this property to translate the application's UI to another language. The Locale, Language and LanguageIndex properties are interchangeable, and mutually influence each other. If a language has been dynamically changed at runtime, the localizer is automatically deactivated (the Active property is set to False). Set the Active property to True, to reactivate the localizer.
Page 370 of 629
TcxLocalizer.OnTranslate
Allows you to customize localized strings when a new localization is about to be performed. type TcxLocalizerTranslateEvent = procedure(const AResStringName: string; var AResStringValue: string; out AHandled: Boolean) of object; property OnTranslate: TcxLocalizerTranslateEvent; Description When an application's UI is being translated, this event fires for each individual resource string, allowing you to substitute default translations. AResStringName specifies the resource string identifier. AResStringValue specifies the resource string value. AHandled specifies whether the default behavior is required. Set AHandled to True, to prevent the addition of a default localized string.
Page 371 of 629
TcxLocalizer.SaveToFile
TcxLocalizer
Writes localized strings from the localization components cache to the specified file. procedure SaveToFile(const AFileName: TFileName{$IFDEF DELPHI12}; AIsAnsiSaveFormat: Boolean {$ENDIF}); Description The SaveToFile method saves localized strings in the .INI file. AFileName specifies the target file. AIsAnsiSaveFormat specifies whether strings will be saved as ANSI or Unicode encoded, if the Delphi 12 platform is used. Set AIsAnsiSaveFormat to True, to store the data in a ANSI encoded file.
Page 372 of 629
TcxLocalizer.SaveToStream
TcxLocalizer
Writes localized strings from the localization components cache to the specified stream. procedure SaveToStream(AStream: TStream{$IFDEF DELPHI12}; AIsAnsiSaveFormat: Boolean {$ENDIF}); Description The SaveToStream method saves localized strings in the .INI format. AStream specifies the target stream. AIsAnsiSaveFormat specifies whether strings are to be ANSI or Unicode encoded, if the Delphi 12 platform is used. Set AIsAnsiSaveFormat to True, to stream the data as ANSI encoded.
Page 373 of 629
TcxLocalizer.StorageType
TcxLocalizer
Specifies the type of the storage that contains localized resource strings. type TcxLocalizerStorageType = (lstResource, lstIni); property StorageType: TcxLocalizerStorageType; Description Use the StorageType property to specify the type of the storage (.RES or .INI) that will be used for the translation.
Page 374 of 629
TcxLocalizer.Translate
TcxLocalizer
Performs localization. procedure Translate; Description The Translate method is automatically invoked if a localizers language has been changed (see the localizers Locale, Language and LanguageIndex properties). Since the Translate method generates the OnTranslate event, invoke this method directly if you need to customize localized strings, or load localized strings from an alternate storage.
Page 375 of 629
TcxLocalizerStorageType type
See Also
Enumerates storage types for localized resource strings. Unit cxLocalization TcxLocalizerStorageType = (lstResource, lstIni); Description Values include: Value lstResource lstIni Localized resource strings are loaded from a .RES file. Localized resource strings are loaded from an .INI file. Meaning
Page 376 of 629
TcxLocalizer Events
TcxLocalizer Legend
In TcxLocalizer OnTranslate
Page 377 of 629
TcxLanguages Methods
TcxLanguages Legend
In TcxLanguages Add GetLanguageByName
Page 378 of 629
TcxLocalizer Methods
TcxLocalizer Legend
In TcxLocalizer LoadFromFile LoadFromResource LoadFromStream SaveToFile SaveToStream Translate
Page 379 of 629
TcxLanguage Properties
TcxLanguage Legend
In TcxLanguage Dictionary LocaleID Name
Page 380 of 629
TcxLanguages Properties
TcxLanguages Legend
In TcxLanguages Items
Page 381 of 629
TcxLocalizer Properties
TcxLocalizer Legend
In TcxLocalizer Active FileName Language LanguageIndex Languages Locale StorageType
Page 382 of 629
Hierarchy TCollection | TcxLanguages
Page 383 of 629
Hierarchy TCollectionItem | TcxLanguage
Page 384 of 629
Hierarchy TComponent | TcxLocalizer
Page 385 of 629
Hierarchy IUnknown |
Page 386 of 629
cxDefaultUseSkins global constant

Determines the default value of the TdxSkinController.UseSkins property. Unit cxLookAndFeels cxDefaultUseSkins = True;
Page 387 of 629
cxUseSkins global constant

See Also
Determines whether skin support is enabled in an application. Unit cxLookAndFeels cxUseSkins: Boolean = cxDefaultUseSkins; Description The default value of this constant is specified by the cxDefaultUseSkins global constant.
Page 388 of 629
RootLookAndFeel Function
Provides access to the root look and feel at runtime. Unit cxLookAndFeels function RootLookAndFeel: TcxLookAndFeel; Description The RootLookAndFeel method allows you to access to the root look and feel at runtime. The root look and feel is a TcxLookAndFeel class instance that is created on application startup. The default values of the root look & feels Kind, NativeStyle, and SkinName properties are specified by the cxDefaultLookAndFeelKind, cxDefaultLookAndFeelNativeStyle, and cxDefaultLookAndFeelSkinName global constants, respectively. TcxControl descendants allow you to set their own look and feel. The controls look and feel is also a TcxLookAndFeel class instance that can be accessed via the controls LookAndFeel property. You can also customize the root look and feel via the TcxLookAndFeelController and TdxSkinController components.
Page 389 of 629
IcxLookAndFeelNotificationListener.GetObject
IcxLookAndFeelNotificationListener
Returns the object implementing this interface. function GetObject: TObject; Description The GetObject method implementing this interface is usually a TcxLookAndFeel or TcxLookAndFeelController class instance.
Page 390 of 629
IcxLookAndFeelNotificationListener.MasterLookAndFeelChanged
Notifies all current look and feel listeners that its kind or native style property has changed. type TcxLookAndFeelValue = (lfvKind, lfvNativeStyle, lfvSkinName); TcxLookAndFeelValues = set of TcxLookAndFeelValue; procedure MasterLookAndFeelChanged(Sender: TcxLookAndFeel; AChangedValues: TcxLookAndFeelValues); Description The MasterLookAndFeelChanged method is called every time the Kind, NativeStyle, or SkinName property of the current look and feel changes. This method notifies all current look and feel listeners. A listener is a TcxControl descendant whose MasterLookAndFeel property is set to the current look and feel. If this property is not set, the TcxControl descendant listens to the root look and feel. To determine what properties of the master look and feel has changed, use the AChangedValues parameter. Note: The look and feel properties of the TcxControl descendants override the master look and feel property settings.
Page 391 of 629
IcxLookAndFeelNotificationListener.MasterLookAndFeelDestroying
Notifies all current look and feel listeners that it is being destroyed. procedure MasterLookAndFeelDestroying(Sender: TcxLookAndFeel); Description The MasterLookAndFeelDestroying method is called on current look and feel destruction. To access the root look and feel at design time, you should use the TcxLookAndFeelController component. This component notifies all current look and feel listeners. A listener is a TcxControl control descendant whose MasterLookAndFeel property is set to the current look and feel. If this property is not set, the TcxControl descendant listens to the root look and feel. After the master root look and feel is destroyed, the TcxControl descendant becomes the root look and feel listener. The root look and feel cannot be destroyed. Note: The look and feel properties of TcxControl descendants override the master look and feel property settings.
Page 392 of 629
TcxLookAndFeelController.Create
TcxLookAndFeelController
Creates and initializes a TcxLookAndFeelController class instance. procedure Create(AOwner: TComponent); override; Description Use the Create method to instantiate a look and feel controller. Controllers added in the form designer are created automatically.
Page 393 of 629
TcxLookAndFeelController.Destroy
Destroys an instance of TcxLookAndFeelController class. procedure Destroy; override; Description Do not call Destroy directly in an application. Instead, call Free. Free verifies that the TcxLookAndFeelController reference is not nil, and only then calls Destroy.
Page 394 of 629
TcxLookAndFeelController.Kind
TcxLookAndFeelController See Also
Specifies the default look for TcxControl descendants and how they visually respond to user actions (focus, mouse move, clicks etc.) within the current application. type TcxLookAndFeelKind = (lfFlat, lfStandard, lfUltraFlat, lfOffice11); property Kind: TcxLookAndFeelKind; Description The NativeStyle and SkinName properties have a higher priority than the Kind property. The LookAndFeel.Kind property value of TcxControl descendants overrides the Kind property. The default value of the Kind property is cxDefaultLookAndFeelKind.
Page 395 of 629
TcxLookAndFeelController.NativeStyle
Determines whether TcxControl descendants within the current application use the native windows paint style by default. property NativeStyle: Boolean; Description The NativeStyle property has a higher priority than the Kind or SkinName property. The LookAndFeel.NativeStyle property value of TcxControl descendants overrides the NativeStyle property. The default value of the NativeStyle property is cxDefaultLookAndFeelNativeStyle.
Page 396 of 629
TcxLookAndFeelController.Reset
Reverts look and feel settings to their default values. procedure Reset; virtual; Description Call this method to revert the controllers Kind, NativeStyle, and SkinName properties to their default values. To reset look and feel settings that are specified via the TdxSkinController, call the TdxSkinController.Reset method.
Page 397 of 629
TcxLookAndFeelController.SkinName
Specifies the name of a skin to be applied to all TcxControl descendants within the current application by default. type TdxSkinName = type string; property SkinName: TdxSkinName; Description The SkinName property has a higher priority than the Kind property, but it can be overridden by the NativeStyle property. The LookAndFeel.SkinName property value of TcxControl descendants overrides the SkinName property. The default value of the SkinName property is cxDefaultLookAndFeelSkinName.
Page 398 of 629
TcxLookAndFeel.AssignedValues
TcxLookAndFeel
Represents a set of assigned look and feel options. type TcxLookAndFeelValue = (lfvKind, lfvNativeStyle, lfvSkinName); TcxLookAndFeelValues = set of TcxLookAndFeelValue; property AssignedValues: TcxLookAndFeelValues; Description Changing a controls Kind, NativeStyle, or SkinName properties sets the corresponding flag in the AssignedValues property. When a flag is set, it forces the control to use the corresponding option in the controls LookAndFeel property. When a flag is not set or reset, the corresponding look and feel setting is obtained from the MasterLookAndFeel property (if set) or the cxDefaultLookAndFeelKind, cxDefaultLookAndFeelNativeStyle, and cxDefaultLookAndFeelSkinName global constants. Value lfvKind Corresponds to the controls LookAndFeel.Kind property. Description
lfvNativeStyle Corresponds to the controls LookAndFeel.NativeStyle property. lfvSkinName Corresponds to the controls LookAndFeel.SkinName property. To reset the AssignedValues property, call the Reset method.
Page 399 of 629
TcxLookAndFeel.Create
TcxLookAndFeel
Creates an instance of the TcxLookAndFeel class and the list to hold potential listener controls. procedure Create(AOwner: TPersistent); o v e r r i d e ;
Page 400 of 629
TcxLookAndFeel.Destroy
TcxLookAndFeel
Destroys an instance of the TcxLookAndFeel class. procedure Destroy; override; Description This method does the following:
l l l
notifies all listener controls via the IcxLookAndFeelNotificationListener.MasterLookAndFeelDestroying method; destroys the list of listener controls; destroys the TcxLookAndFeel class instance.
Page 401 of 629
TcxLookAndFeel.Kind
TcxLookAndFeel See Also
Determines how a control is painted. type TcxLookAndFeelKind = (lfFlat, lfStandard, lfUltraFlat, lfOffice11); property Kind: TcxLookAndFeelKind; Description The Kind property specifies the look of the control and how the control visually responds on user actions (focus, mouse move, clicks etc.). Generally the Kind property determines how the control is painted. Modifying this property sets the lfvKind flag in the AssignedValues property and raises the OnChanged event. The NativeStyle and SkinName properties have a higher priority than the Kind property. The default value of the Kind property is cxDefaultLookAndFeelKind.
Page 402 of 629
TcxLookAndFeel.MasterLookAndFeel
TcxLookAndFeel
Specifies the imported look and feel. property MasterLookAndFeel: TcxLookAndFeel; Description Every Developer Express control can export its look and feel to other Developer Express controls. The MasterLookAndFeel property determines the imported look and feel of any Developer Express control. Any control that imports look and feel of the current control is a listener. It listens to changes within the current control via the IcxLookAndFeelNotificationListener interface. Note that a control only listens to its MasterLookAndFeel property when its AssignedValues property is not set. The IcxLookAndFeelNotificationListener interface listens for two events:
l l
Any look and feel property change via the MasterLookAndFeelChanged method. The TcxLookAndFeel class instance destruction via the MasterLookAndFeelDestroying method.
Listener controls reflect all changes within the current control. If an imported TcxLookAndFeel class instance is destroyed, a listener control obtains its look and feel from the cxDefaultLookAndFeelKind, cxDefaultLookAndFeelNativeStyle, and cxDefaultLookAndFeelSkinName global constants.
Page 403 of 629
TcxLookAndFeel.NativeStyle
Determines whether to use the native windows style for control painting. property NativeStyle: Boolean; Description Set this property to True to paint the control using the native windows style. Otherwise, the Kind or SkinName property specifies the paint style for the control.
Modifying the NativeStyle property sets the lfvNativeStyle flag in the AssignedValues property and raises the OnChanged event. The NativeStyle property has a higher priority than the Kind or SkinName property. Note:The NativeStyle property is currently only supported for the Windows XP operating system. The default value of the NativeStyle property is cxDefaultLookAndFeelNativeStyle.
Page 404 of 629
TcxLookAndFeel.OnChanged
TcxLookAndFeel
Occurs on any property change of the TcxLookAndFeel class. Unit cxLookAndFeels type TcxLookAndFeelValue = (lfvKind, lfvNativeStyle, lfvSkinName); TcxLookAndFeelValues = set of TcxLookAndFeelValue; TcxLookAndFeelChangedEvent = procedure(Sender: TcxLookAndFeel; AChangedValues: TcxLookAndFeelValues) of object; property OnChanged: TcxLookAndFeelChangedEvent; Description The OnChanged event occurs every time any property of the TcxLookAndFeel class is changed.
Page 405 of 629
TcxLookAndFeel.Painter
TcxLookAndFeel
Provides access to the control painter. property Painter: TcxCustomLookAndFeelPainterClass; Description Every TcxLookAndFeel class instance has a painter to paint the control according to the look and feel settings. To access the painter use the Painter property. ReadOnly Property
Page 406 of 629
TcxLookAndFeel.Reset
Resets look and feel properties. procedure Reset; Description This method clears all flags in the AssignedValues property.
Page 407 of 629
TcxLookAndFeel.SkinName
Specifies the name of a skin to be used for control painting. type TdxSkinName = type string; property SkinName: TdxSkinName; Description Assigning an empty string to the SkinName property indicates that skin support is disabled for the control. Modifying the SkinName property sets the lfvSkinName flag in the AssignedValues property and raises the OnChanged event.
The SkinName property has a higher priority than the Kind property, but it can be overridden by the NativeStyle property. The default value of the SkinName property is cxDefaultLookAndFeelSkinName.
Page 408 of 629
TcxLookAndFeelKind type
Determines the manner in which a control is painted. Unit cxLookAndFeels type TcxLookAndFeelKind = (lfFlat, lfStandard, lfUltraFlat, lfOffice11); Description There are four kinds of control painting: Kind lfFlat lfStandard lfUltraFlat lfOffice11 Description
Page 409 of 629
TcxLookAndFeel Events
TcxLookAndFeel Legend
In TcxLookAndFeel OnChanged
Page 410 of 629
TcxLookAndFeel Methods
In TcxLookAndFeel Create Destroy Reset
Page 411 of 629
TcxLookAndFeelController Methods
TcxLookAndFeelController Legend
In TcxLookAndFeelController Create Destroy Reset
Page 412 of 629
TcxLookAndFeel Properties
In TcxLookAndFeel AssignedValues Kind MasterLookAndFeel NativeStyle Painter SkinName
Page 413 of 629
TcxLookAndFeelController Properties
TcxLookAndFeelController Legend
In TcxLookAndFeelController Kind NativeStyle SkinName
Page 414 of 629
IcxLookAndFeelNotificationListener Methods
IcxLookAndFeelNotificationListener Legend
In IcxLookAndFeelNotificationListener GetObject MasterLookAndFeelChanged MasterLookAndFeelDestroying
Page 415 of 629
Page 416 of 629
Hierarchy TcxInterfacedPersistent |
Page 417 of 629
Example TcxPropertiesStore.StoreTo
The following example demonstrates how to use the cxPropertiesStore component. Consider storing the Color property value of the cxStyle object. This object (cxTabStyle) is assigned to the RootLevelStyles.Tab property of a cxGrid control. The cxPropertiesStore component does not allow you to save/restore sub-properties of the properties referring to TComponent descendants. So, saving the Color property of a cxStyle object needs a special approach. The following code shows the correct method of saving the Color property of the cxTabStyle style: //Delphi //... //setting the level tabs painting style to cxTabStyle cxGrid1.RootLevelStyles.Tab := cxTabStyle; with cxPropertiesStore1 do begin //adding a reference to the cxGrid1 control into the Components collection with TcxPropertiesStoreComponent(Components.Add) do begin Component := cxGrid1; //specifying the Properties.Add('RootLevelStyles.Tab'); end; //adding a reference to cxTabStyle into the Components collection with TcxPropertiesStoreComponent(Components.Add) do begin Component := cxTabStyle; //specifying the Color property for storing/restoring Properties.Add('Color'); end; //setting the storage type to INI file StorageType := stIniFile; //specifying the name of the INI file StorageName := 'c:\store.ini'; //saving information StoreTo; end; //... //C++ Builder //... //setting the level tabs painting style to cxTabStyle cxGrid1->RootLevelStyles->Tab = cxTabStyle; TcxPropertiesStoreComponent * APSComponent; //adding a reference to the cxGrid1 control into the Components collection APSComponent = (TcxPropertiesStoreComponent *)cxPropertiesStore1->Components->Add(); APSComponent->Component = cxGrid1; //specifying the APSComponent->Properties->Add("RootLevelStyles.Tab"); //adding a reference to cxTabStyle into the Components collection APSComponent = (TcxPropertiesStoreComponent *)cxPropertiesStore1->Components->Add(); APSComponent->Component = cxTabStyle; //specifying the Color property for storing/restoring APSComponent->Properties->Add("Color"); //setting the storage type to INI file
Page 418 of 629
cxPropertiesStore1->StorageType = stIniFile; //specifying the name of the INI file cxPropertiesStore1->StorageName = "c:\\store.ini"; //saving information cxPropertiesStore1->StoreTo(); //... The result of this code execution is shown below: [cxGrid1: TcxPropertiesStoreComponent] = RootLevelStyles.Tab=cxTabStyle [cxTabStyle: TcxPropertiesStoreComponent] = Color=15451300 The resulting file contains all the required information the RootLevelStyles.Tab style object and the Color property value for that object.
Page 419 of 629
TcxPropertiesStoreComponent Object
Represents a reference to a component with properties stored by a TcxPropertiesStore object. Unit cxPropertiesStore TcxPropertiesStoreComponent = class(TcxInterfacedCollectionItem, IcxStoredObject, IcxStoredParent) Description The TcxPropertiesStore component is used to save/restore published properties of components present on a form. Components with properties being saved/restored by a TcxPropertiesStore instance are accessible via its Components collection. Each item in this collection is a TcxPropeprtiesStoreComponent object. The Component property identifies the component whose properties are being saved/restored. To select the components properties to store/restore, see the Properties object. If the selected property represents a TPersistent descendant (like the Font property of a component), you can specify its subproperties to store. A sub-property is delimited from the main property by a dot. For instance, you can insert the "Font.Style" string into the Properties list instead of "Font". This will save only the Style property of the TFont object associated with the Font property. If you specify the controls Font property to store, all its published sub-properties (Charset, Color, Height, Name, Pitch, Size and Style) will be automatically saved. The TcxPropertiesStoreComponent classs methods allow you to save/restore individual components from the Components collection to any type of supported storage (registry, INI file, stream).
Page 420 of 629
TcxPropertiesStoreComponents Object
Represents a collection of references to the components whose properties are saved/restored by the TcxPropertiesStore component. Unit cxPropertiesStore TcxPropertiesStoreComponents = class(TOwnedCollection) Description Each component with properties saved/restored by a TcxPropertiesStore component, is represented by a TcxPropertiesStoreComponent object. References to all stored components are contained within the Components collection. To add components in order to store/restore this collection at design time, do one of the following: 1. Use the PropertiesStore Editor. It allows the selecting of components and their properties by right-clicking elements within the list. In this case, the properties of the added item (Component and Properties) are initialized automatically. 2. In the Object Inspector, use the TcxCustomEditPropwertiesStore.Components property editor to manually initialize properties of the item being added.
Page 421 of 629
TcxCustomPropertiesStore.Active
TcxCustomPropertiesStore See Also
Determines whether the default save/restore functionality is enabled or disabled. property Active: Boolean; Description Use this property to determine whether the components default functionality is enabled or disabled. If Active is set to False, then saving selected properties on closing the form and restoring upon its creation, are disabled. However, saving/restoring can be implemented by calling the StoreTo/RestoreFrom methods at any time. The default value of the Active property is True.
Page 422 of 629
TcxCustomPropertiesStore.Components
Represents a collection of objects whose properties are stored to/restored from a storage. property Components: TcxPropertiesStoreComponents; Description The TcxCustomPropertiesStore object is used to save and restore component settings using the storage specified by the StorageType and StorageName properties. Each component to be saved/restored has a corresponding item in the Components collection. Each element in this collection represents a TcxPropertiesStoreComponent object. The TcxPropertiesStoreComponent.Component property specifies a TComponent descendant whose properties must be stored/restored. To specify the component settings to store/restore, see the TcxPropertiesStoreComponent.Properties member.
Page 423 of 629
TcxCustomPropertiesStore.RestoreFrom
Restores component settings from the currently specified storage. procedure RestoreFrom; Description Use the RestoreFrom method to restore components' settings from the storage specified by the StorageName and StorageType properties. After calling this method the cxPropertiesStore component restores settings of all components referenced within the Components collection. If the storage does not exist or if there are no components selected, this method does nothing. To save components' settings, use the StoreTo method.
Page 424 of 629
TcxCustomPropertiesStore.StorageName
Identifies the storage used to save/restore selected component settings. property StorageName: string; Description The TcxCustomPropertiesStore object is able to save component-specific information to three storage types: INI file, registry key and stream. All components available for saving/restoring can be accessed by the Components collection. Properties to save/restore are listed by the Properties property of each item within this collection. The StorageName property value interpretation varies depending on the storage type specified by the StorageType property.
Page 425 of 629
TcxCustomPropertiesStore.StorageStream
Specifies the stream used for storing/restoring components' properties when StorageType is set to stStream. property StorageStream: TStream; Description Use the StorageStream property to specify a stream (a descendant of the TStream class) used for storing/restoring components' properties. This property value is in effect only if the StorageType property value is stStream. If a TStream descendant instance is chosen as the storage, the StorageName property is not in effect.
Page 426 of 629
TcxCustomPropertiesStore.StorageType
Specifies the type of storage used for saving/restoring components' properties. type TcxStorageType = (stIniFile, stRegistry, stStream); property StorageType: TcxStorageType; Description Use the StorageType property to specify the type of storage for saving/restoring components' properties. All components, selected for saving/restoring, can be accessed by the Components collection. Properties to save/restore are listed by the Properties property for each item within this collection. This property value affects the StorageName property value interpretation. StorageType stIniFile stRegistry stStream The path and the name of the INI file. The registry key name. This name is relative to HKEY_CURRENT_USER. The StorageName property is not in effect. Use the StorageStream property instead to specify a stream for storing/restoring components' properties. StorageName Interpretation
The default value of the StorageType property is stIniFile.
Page 427 of 629
TcxCustomPropertiesStore.StoreTo
Saves component settings to the current storage. procedure StoreTo(const AReCreate: Boolean = True); Description Use the StoreTo method to save components' settings to the storage specified by the StorageName and StorageType properties. After calling this method, the cxPropertiesStore component saves settings of all components referenced within the Components collection. If there are no components selected, this method does nothing. To restore components' settings, use the RestoreFrom method. The AReCreate parameter determines whether the selected storage is deleted and then re-created by the StoreTo method. If this parameter value is False, information is appended to the end of the existing storage.
Page 428 of 629
TcxPropertiesStoreComponents.ComponentItems
TcxPropertiesStoreComponents See Also
Provides indexed access to the components to store/restore. property ComponentItems[Index: Integer]: TcxPropertiesStoreComponent; Description Use this property to access individual components within the Components collection of the PropertiesStore object. The Index parameter represents an item's position within the collection.
Page 429 of 629
TcxPropertiesStoreComponent.Component
TcxPropertiesStoreComponent See Also
Specifies a component whose properties are stored/restored by the PropertiesStore object. property Component: TComponent; Description Each component with properties being saved/restored by a TcxPropertiesStore object, has a corresponding item within its Components collection. Items in this collection represent TcxPropertiesStoreComponent objects. The Component property of the TcxPropertiesStoreComponent object identifies the component whose settings are stored/restored. To select the components settings to save/restore, see the Properties attribute.
Page 430 of 629
TcxPropertiesStoreComponent.Properties
Specifies the properties of a component to store/restore using a storage. property Properties: TStrings; Description Use the Properties property to specify which published properties of a component will be saved/restored. To specify the component itself, see the Component property. Note that only existing properties can be saved. If the component to store does not have a property with a name in the Properties list, this property is ignored. If a property relates to a TPersistent descendant, you can store its specific attributes. To specify the attributes to store, you need to add a string consisting of the property and attribute names delimited by a dot. For instance, if you wish to save only the Height sub-property of the Font property, you need to add the "Font.Height" string to the Properties string list. If you specify the controls Font property to store, all its published sub-properties (Charset, Color, Height, Name, Pitch, Size and Style) will be automatically saved. Note that if your property references a TComponent descendant, only the objects Name is saved in this case. See example for details.
Page 431 of 629
TcxPropertiesStoreComponent.RestoreFromIniFile
Restores the current components properties from an INI file. procedure RestoreFromIniFile(const AStorageName: string); Description Use this method to restore the properties of the component specified by the Component property from an INI file. The properties to restore are specified by the Properties list. You can call the RestoreFromIniFile method even if the StorageType of the current TcxPropertiesStore instance is not set to stIniFile. The AStorageName parameter specifies the path and the name of the INI file used as a storage. If such a file does not exist, the RestoreFromIniFile method does nothing.
Page 432 of 629
TcxPropertiesStoreComponent.RestoreFromRegistry
Restores the current components properties from the registry. procedure RestoreFromRegistry(const AStorageName: string); Description Use this method to restore the properties of the component specified by the Component property from the registry. The properties to restore are specified by the Properties list. You can call the RestoreFromRegistry method even if the StorageType of the current TcxPropertiesStore instance is not set to stRegistry. The AStorageName parameter specifies the suffix to the HKEY_CURRENT_USER registry key. So, the whole registry key, used as a storage, looks like HKEY_CURRENT_USER\ + the AStorageName parameter value.
Page 433 of 629
TcxPropertiesStoreComponent.RestoreFromStream
Restores the current components properties from a stream. procedure RestoreFromStream(const AStream: TStream); Description Use this method to restore the properties of the component specified by the Component property from a stream. The properties to restore are specified by the Properties list. You can call the RestoreFromStream method even if the StorageType of the current TcxPropertiesStore instance is not set to stStream. The AStream parameter specifies the stream used as a storage.
Page 434 of 629
TcxPropertiesStoreComponent.StoreToIniFile
Saves the current components properties to an INI file. procedure StoreToIniFile(const AStorageName: string; const AReCreate: Boolean); Description Use this method to save the properties of the component specified by the Component property to an INI file. The properties to store are specified by the Properties list. You can call the StoreToIniFile method even if the StorageType of the current TcxPropertiesStore instance is not set to stIniFile. The AStorageName parameter specifies the name and the path to the INI file used as the storage. The AReCreate parameter determines whether the INI file is deleted and created again with each call to this method. If this parameter value is False, information is appended to the end of the existing file.
Page 435 of 629
TcxPropertiesStoreComponent.StoreToRegistry
Saves the current components properties to the registry. procedure StoreToRegistry(const AStorageName: string; const AReCreate: Boolean); Description Use this method to save the properties of the component specified by the Component property to the registry. The properties to store are specified by the Properties list. You can call the StoreToRegistry method even if the StorageType of the current TcxPropertiesStore instance is not set to stRegistry. The AStorageName parameter specifies the suffix to the HKEY_CURRENT_USER registry key. So, the whole registry key, used as a storage, looks like HKEY_CURRENT_USER\ + the AStorageName parameter value. The AReCreate parameter determines whether the registry key is deleted and created again with each call to this method. If this parameter value is False, information is appended to the existing key.
Page 436 of 629
TcxPropertiesStoreComponent.StoreToStream
Saves the current components properties to a stream. procedure StoreToStream(const AStream: TStream; const AReCreate: Boolean); Description Use this method to save the properties of the component specified by the Component property to a stream (a TStream descendant). The properties to store are specified by the Properties list. You can call the StoreToStream method even if the StorageType of the current TcxPropertiesStore instance is not set to stStream. The AStream parameter identifies the TStream descendant used as the storage. The AReCreate parameter determines whether the storage stream is destroyed and created again with each call to this method. If this parameter value is False, information is appended to the end of the existing storage.
Page 437 of 629
TcxCustomPropertiesStore Methods
TcxCustomPropertiesStore Legend
In TcxCustomPropertiesStore RestoreFrom StoreTo
Page 438 of 629
TcxPropertiesStore Methods
TcxPropertiesStore Legend
Derived from TcxCustomPropertiesStore RestoreFrom StoreTo
Page 439 of 629
TcxPropertiesStoreComponent Methods
TcxPropertiesStoreComponent Legend
In TcxPropertiesStoreComponent RestoreFromIniFile RestoreFromRegistry RestoreFromStream StoreToIniFile StoreToRegistry StoreToStream
Page 440 of 629
TcxCustomPropertiesStore Properties
TcxCustomPropertiesStore Legend
In TcxCustomPropertiesStore Active Components StorageName StorageStream StorageType
Page 441 of 629
TcxPropertiesStore Properties
TcxPropertiesStore Legend
Derived from TcxCustomPropertiesStore Active Components StorageName StorageStream StorageType
Page 442 of 629
TcxPropertiesStoreComponent Properties
TcxPropertiesStoreComponent Legend
In TcxPropertiesStoreComponent Component Properties
Page 443 of 629
TcxPropertiesStoreComponents Properties
TcxPropertiesStoreComponents Legend
In TcxPropertiesStoreComponents ComponentItems
Page 444 of 629
Page 445 of 629
Hierarchy TOwnedCollection |
Page 446 of 629
Hierarchy TCollectionItem | TcxInterfacedCollectionItem |
Page 447 of 629
Hierarchy TComponent | TcxCustomPropertiesStore |
Page 448 of 629
TcxCustomStyleSheet.Caption
TcxCustomStyleSheet
Represents the caption of the style sheet. property Caption: string; Description The Caption property specifies the style sheet caption. Use the caption according to your needs. For instance, it can be used to give a unique name to a style sheet in order to easily recognize it among other style sheets.
Page 449 of 629
TcxCustomStyleSheet.Create
TcxCustomStyleSheet
Creates an instance of the TcxCustomStyleSheet object. constructor Create(AOwner: TComponent); override; Description Use the constructor to create a style sheet at runtime. The AOwner parameter is the owner of the TcxCustomStyleSheet object. TcxCustomStyleSheet is an abstract class. Use its descendants, such as TcxGridTableViewStyleSheet or TcxGridCardViewStyleSheet classes instead.
Page 450 of 629
TcxCustomStyleSheet.Destroy
TcxCustomStyleSheet
Removes the style sheet from memory. destructor Destroy; override; Description Do not call the Destroy method directly. Call the Free method instead.
Page 451 of 629
TcxCustomStyleSheet.GetStyles
TcxCustomStyleSheet
Returns the collection of styles contained in the style sheet. function GetStyles: TcxCustomStyles; Description The GetStyles method returns the collection of styles contained in the style sheet. The returned styles are specific for the control. To obtain the styles class, use the GetStylesClass method. To set the styles collection for the style sheet, use the SetStyles method. This allows you to set all style properties at once. For instance, if you want to create a style sheet specifying the same styles as a style collection, use the SetStyles method and pass the style collection to it as a parameter. Then you can save the style sheet to an INI file via the SaveStyleSheetsToIniFile procedure to save it for future use.
Page 452 of 629
TcxCustomStyleSheet.GetStylesClass
TcxCustomStyleSheet
Determines the class of styles within the style sheet. type TcxCustomStylesClass = class of TcxCustomStyles; function GetStylesClass: TcxCustomStylesClass; virtual; Description Use this method to determine the style class. This is important when working with a styles collection. The control styles collections may vary (have different styles) and it is necessary to determine what style collection the style sheet contains.
Page 453 of 629
TcxCustomStyleSheet.SetStyles
TcxCustomStyleSheet
Sets the styles collection for the style sheet. procedure SetStyles(const Value: TcxCustomStyles); Description The SetStyles method sets the style collection provided via the Value parameter. This allows you to set all style properties at once. For instance, if you want to create a style sheet specifying the same styles as a style collection, use the SetStyles method and pass the style collection to it as a parameter. Then you can save the style sheet to an INI file using the SaveStyleSheetsToIniFile procedure to save it for future use. To get the styles collection, use the GetStyles method.
Page 454 of 629
TcxCustomStyleSheet.StyleRepository
TcxCustomStyleSheet
Specifies the style repository containing the current style sheet. property StyleRepository: TcxStyleRepository; Description The StyleRepository property specifies the style repository that contains the style sheet. Style sheets should be stored in repositories for proper design time handling. When created via the repository editor, style sheet is automatically placed within it.
Page 455 of 629
TcxCustomStyles.Assign
TcxCustomStyles
Copies one set of styles to another. procedure Assign(Source: TPersistent); override; Description The Assign method copies the set of styles and style event handlers contained in the Source parameter to the current set of styles. Descendants of the TcxCustomStyles class override this method to copy styles specific to them. For instance, TcxGridBandStyles assigns its Background, Content, Header style properties and the OnGetHeaderStyle event handler. Use the Assign method when you need to copy styles provided by some style collection to the current one. This results in applying the same styles to different controls.
Page 456 of 629
TcxCustomStyles.Create
TcxCustomStyles
Creates a new instance of the TcxCustomStyles class. constructor Create(AOwner: TPersistent); override; Description Create calls the inherited constructor and initializes object properties to their default values.
Page 457 of 629
TcxCustomStyles.Destroy
TcxCustomStyles
Destroys the current TcxCustomStyles object. destructor Destroy; override; Description The destructor frees all resources allocated by the current object.
Page 458 of 629
TcxCustomStyles.StyleChanged
TcxCustomStyles
The method is called when any of attributes of the specified TcxCustomStyle object are changed. procedure StyleChanged(Sender: TcxCustomStyle); Description Use this method to implement operations in response to style attribute changes. The Sender parameter identifies the style object whose attributes are changed.
Page 459 of 629
TcxCustomStyles.StyleRemoved
TcxCustomStyles
This method is called when the specified style is about to be destroyed. procedure StyleRemoved(Sender: TcxCustomStyle); Description Implement the StyleRemoved method to react to style destroying. The Sender parameter defines the style object which is about to be destroyed.
Page 460 of 629
TcxCustomStyles.StyleSheet
TcxCustomStyles See Also
Specifies the style sheet for the current style collection. property StyleSheet: TcxCustomStyleSheet; Description The StyleSheet property specifies the style sheet for the style collection provided by the current TcxCustomStyles object. A style collection provides multiple attributes that control the appearance of different elements of a control. The TcxGridTableViewStyles collection, for instance, contains the Background, Content, Footer properties specifying styles for the views background, data cells and footer panel respectively. A corresponding style sheet (TcxGridTableViewStyleSheet) contains the same style attributes. If a style sheet, which is not set, is assigned to the style property within the style collection, the value of this property is determined by the corresponding property of the style sheet. Thus, a style sheet represents another collection of styles to be assigned to TcxCustomStyles. Once a style sheet is created and adjusted according to your preferences, it can be used in different applications over and over again. Style sheets can be saved to an INI file by the SaveStyleSheetsToIniFile procedure and can be loaded from this file via LoadStyleSheetsFromIniFile. Usually, you create a style sheet via a style repository of class TcxStyleRepository. At design time, you can create a style sheet via the style repository editor. It gives you the ability to create a style sheet of a specific type, adjust its properties, add predefined style sheets, load from and save style sheets to an INI file.
Page 461 of 629
TcxCustomStyle.AddListener
TcxCustomStyle See Also
Adds the specified listener to the notification list. procedure AddListener(AStyles: TcxCustomStyles); virtual; Description When the attributes provided by the current style object are changed or the style object is destroyed, all the listeners within the notification list receive the corresponding notification. Call the AddListener method to add the listener specified by the AStyles parameter to this list. The listener represents a collection of style links for various component elements. To remove a listener, use the RemoveListener method.
Page 462 of 629
TcxCustomStyle.Create
TcxCustomStyle
Creates a new instance of the TcxCustomStyle class. constructor Create(AOwner: TComponent); override; Description The constructor creates a new instance of the TcxCustomStyle class and initializes all properties to their default values. The AOwner specifies the component to own the created style. The owner disposes of the component when it is destroyed.
Page 463 of 629
TcxCustomStyle.Destroy
TcxCustomStyle
Destroys the current style object. destructor Destroy; override; Description The destructor frees all resources allocated by the current style object. Also, it removes itself from a repository if one is assigned and sends the destroy notification to all its listeners.
Page 464 of 629
TcxCustomStyle.RemoveListener
Removes the specified listener from the notification list. procedure RemoveListener(AStyles: TcxCustomStyles); virtual; Description The RemoveListener method removes the listener specified by the AStyles parameter from the notification list. The listener (a collection of style links for various component elements) will no longer receive notifications when style attribute are changed or when the style object is destroyed. To add a listener to the notification list, use the AddListener method.
Page 465 of 629
TcxCustomStyle.RestoreDefaults
TcxCustomStyle
Restores default values of style attributes provided by the current style object. procedure RestoreDefaults; virtual; Description RestoreDefaults is a virtual method overridden by TcxCustomStyle descendants in order to restore default style attribute values.
Page 466 of 629
TcxCustomStyle.StyleRepository
Specifies the repository storing the current style object. property StyleRepository: TcxStyleRepository; Description A repository is an object allowing you to manage a collection of individual styles. When a repository is destroyed, all styles it owns are also deleted. Assigning the StyleRepository property adds the current style to this repository.
Page 467 of 629
TcxStyleRepository.Clear
TcxStyleRepository See Also
Destroys all styles in the current repository. procedure Clear; Description The Clear method disposes all TcxCustomStyle objects contained in the current repository object.
Page 468 of 629
TcxStyleRepository.ClearStyleSheets
TcxStyleRepository
Removes all style sheets from the style repository. procedure ClearStyleSheets; Description The ClearStyleSheets method removes all style sheets from the style repository. Note that the TcxStyle objects created along with the style sheets are not removed. Styles are disposed of when the style repository is destroyed.
Page 469 of 629
TcxStyleRepository.Count
Gets the number of styles in the current repository. property Count: Integer; Description The Count property identifies the number of styles in the Items collection. Use either CreateItem or CreateItemEx methods to add styles to the repository. ReadOnly Property
Page 470 of 629
TcxStyleRepository.Create
TcxStyleRepository
Creates a new instance of the TcxStyleRepository class. constructor Create(AOwner: TComponent); override; Description The constructor creates and initializes a new instance of the TcxStyleRepository class. The AOwner parameter identifies the object to own the created repository. An owner is responsible for disposing objects it owns.
Page 471 of 629
TcxStyleRepository.CreateItem
Creates a new style in a repository. type TcxCustomStyleClass = class of TcxCustomStyle; function CreateItem(AStyleClass: TcxCustomStyleClass): TcxCustomStyle; virtual; Description Use the CreateItem method to create a new style in a repository. The class of the style to create is determined by the AStyleClass parameter. The current repository object becomes the owner of the new style and is used to initialize the TcxCustomStyle.StyleRepository property. The method returns the style object created.
Page 472 of 629
TcxStyleRepository.CreateItemEx
Creates a new style in the repository with a specified owner. type TcxCustomStyleClass = class of TcxCustomStyle; function CreateItemEx(AStyleClass: TcxCustomStyleClass; AOwner: TComponent): TcxCustomStyle; virtual; Description The CreateItemEx method allows you to create a style with a specified owner. The AStyleClass parameter identifies the class of the style to create. The StyleRepository property of the style created is initialized with the current TcxStyleRepository object.
Page 473 of 629
TcxStyleRepository.CreateStyleSheet
TcxStyleRepository
Creates and adds a style sheet to the style repository. type TcxCustomStyleSheetClass = class of TcxCustomStyleSheet; function CreateStyleSheet(AStyleSheetClass: TcxCustomStyleSheetClass): TcxCustomStyleSheet; virtual; Description The CreateStyleSheet method creates a style sheet of class specified by the AStyleSheetClass parameter and adds it to the style repository. If the operation is successful the method returns the newly added style sheet.
Page 474 of 629
TcxStyleRepository.CreateStyleSheetEx
TcxStyleRepository
Creates a style sheet and adds it to the style repository. type TcxCustomStyleSheetClass = class of TcxCustomStyleSheet; function CreateStyleSheetEx(AStyleSheetClass: TcxCustomStyleSheetClass; AOwner: TComponent): TcxCustomStyleSheet; virtual; Description The CreateStyleSheetEx method creates a style sheet of class specified by the AStyleSheetClass parameter and adds it to the style repository. The AOwner parameter specifies the owner component for the added style sheet. If the operation is successful, the method returns the newly added style sheet. You should not use this method directly. It is for internal use. Use the CreateStyleSheet method instead.
Page 475 of 629
TcxStyleRepository.Destroy
TcxStyleRepository
Destroys the current TcxStyleRepository object. destrutor Destroy; override; Description The destructor disposes all styles the repository owns and frees all resources allocated by the object.
Page 476 of 629
TcxStyleRepository.Items
Provides indexed access to a collection of styles in the current repository object. property Items[Index: Integer]: TcxCustomStyle; Description The Items property allows you to access a specific style by its index. The number of styles is determined by the Count property. ReadOnly Property
Page 477 of 629
TcxStyleRepository.Scalable
TcxStyleRepository
Specifies whether the font size of all styles stored within the current style repository is automatically adjusted, based on the system font size. property Scalable: Boolean; Description Set this property to True to automatically scale a styles font size in response to screen resolution and system font size changes. Otherwise, the font size is always equal to the styles Font.Size property value. Use the Scalable property in conjunction with a forms Scaled property. The default value of the Scalable property is False.
Page 478 of 629
TcxStyleRepository.StyleSheetCount
TcxStyleRepository
Determines the number of style sheets within the style repository. property StyleSheetCount: Integer; Description The StyleSheetCount property determines the style sheet count within the repository. All available style sheets are represented by the StyleSheets property. ReadOnly Property
Page 479 of 629
TcxStyleRepository.StyleSheets
TcxStyleRepository
Represents all available style sheets within the style repository. property StyleSheets[Index: Integer]: TcxCustomStyleSheet; Description The StyleSheets property represents all available style sheets within the style repository and enables accessing them by a zerobased index. The index cannot be greater than StyleSheetCount1. At design time, you can access the available styles via the style repository editor:
ReadOnly Property
Page 480 of 629
TcxStyle.AssignedValues
TcxStyle
Determines which style attributes are assigned. type TcxStyleValues = set of TcxStyleValue; property AssignedValues: TcxStyleValues; Description The AssignedValues property consists of a set of flags controlling which style attributes are used to render elements of a specific control. When the Color, Font or TextColor properties are assigned, the corresponding flags in AssignedValues are enabled, thus specifying that these attributes are used when drawing a control element. If any flag in AssignedValues is not enabled, the value of the corresponding attribute is not used when drawing.
Page 481 of 629
TcxStyle.Bitmap
TcxStyle See Also
Specifies the background bitmap for a control element. property Bitmap: TBitmap; Description Use the Bitmap property to specify the background bitmap for a control element. Setting this property overrides the Color property value. The following image shows a view with bitmaps assigned to the GroupByBox and Content styles:
When assigning the Bitmap property, the svBitmap flag is automatically activated in the AssignedValues property.
Page 482 of 629
TcxStyle.Color
TcxStyle
Defines the background color for a control element. property Color: TColor; Description The Color property determines the color of control background. When assigning the Color property the svColor flag is automatically set in AssignedValues.
Page 483 of 629
TcxStyle.Create
TcxStyle
Creates an instance of the TcxStyle class. constructor Create(AOwner: TComponent); override; Description The constructor creates an instance of the TcxStyle class and initializes its attributes to their default values.
Page 484 of 629
TcxStyle.Destroy
TcxStyle
Destroys an instance of the TcxStyle class. destructor Destroy; override; Description The destructor frees all resources allocated by the current TcxStyle object. The destructor deletes the object from a repository, if assigned, and sends notification when destroyed to all listeners.
Page 485 of 629
TcxStyle.Font
TcxStyle
Specifies the font of the output text in a control element. property Font: TFont; Description The Font property defines the font attributes such as height, font family and style (bold, italic, etc.). The TFont.Color attribute is ignored. Use the TextColor property instead to specify the font color. When changing Font attributes the svFont flag is set in AssignedValues.
Page 486 of 629
TcxStyle.RestoreDefaults
TcxStyle See Also
Clears all the flags in the AssignedValues property. procedure RestoreDefaults; override; Description The RestoreDefaults method clears all the flags in the AssignedValues property, thus preventing the corresponding style attributes (Color, Font, TextColor) from being used when rendering a control element. RestoreDefaults also sets the Color and TextColor properties to clDefault.
Page 487 of 629
TcxStyle.TextColor
TcxStyle
Specifies the text color. property TextColor: TColor; Description The TextColor defines the color of the text (in contrast to the background color determined by the Color property). When TextColor is assigned, the svTextColor flag is set in AssignedValues.
Page 488 of 629
TcxStyleValue type
Enumerates flags indicating which TcxStyle attributes are assigned. Unit cxStyles type TcxStyleValue = (svBitmap, svColor, svFont, svTextColor); Description The TcxStyleValue type enumerates the flags indicating which TcxStyle attributes are assigned. These flags are set via the TcxStyle.AssignedValues property. Value svBitmap svColor svFont svTextColor Indicates that a value is assigned to the TcxStyle.Bitmap property. Indicates that a value is assigned to the TcxStyle.Color property. Indicates that a value is assigned to the TcxStyle.Font property. Indicates that a value is assigned to the TcxStyle.TextColor property. Meaning
Page 489 of 629
TcxStyleValues type
Represents a set of flags indicating what style attributes of a TcxStyle object are assigned values. Unit cxStyles type TcxStyleValues = set of TcxStyleValue; Description The TcxStyleValues type represents a set of flags indicating what TcxStyle attributes are set. Use the TcxStyle.AssignedValues property to access these flags.
Page 490 of 629
TcxCustomStyle Methods
TcxCustomStyle Legend
In TcxCustomStyle AddListener Create Destroy RemoveListener RestoreDefaults
Page 491 of 629
TcxCustomStyles Methods
TcxCustomStyles Legend
In TcxCustomStyles Assign Create Destroy StyleChanged StyleRemoved
Page 492 of 629
TcxCustomStyleSheet Methods
TcxCustomStyleSheet Legend
In TcxCustomStyleSheet Create Destroy GetStyles GetStylesClass SetStyles
Page 493 of 629
TcxStyle Methods
TcxStyle Legend
In TcxStyle Create Destroy RestoreDefaults Derived from TcxCustomStyle AddListener Create Destroy RemoveListener RestoreDefaults
Page 494 of 629
TcxStyleRepository Methods
TcxStyleRepository Legend
In TcxStyleRepository Clear ClearStyleSheets Create CreateItem CreateItemEx CreateStyleSheet CreateStyleSheetEx Destroy
Page 495 of 629
TcxStyles Methods
TcxStyles Legend
Derived from TcxCustomStyles Assign Create Destroy
Page 496 of 629
TcxCustomStyle Properties
TcxCustomStyle Legend
In TcxCustomStyle StyleRepository
Page 497 of 629
TcxCustomStyles Properties
TcxCustomStyles Legend
In TcxCustomStyles StyleSheet
Page 498 of 629
TcxCustomStyleSheet Properties
TcxCustomStyleSheet Legend
In TcxCustomStyleSheet Caption StyleRepository
Page 499 of 629
TcxStyle Properties
TcxStyle Legend
In TcxStyle AssignedValues Bitmap Color Font TextColor Derived from TcxCustomStyle StyleRepository
Page 500 of 629
TcxStyleRepository Properties
TcxStyleRepository Legend
In TcxStyleRepository Count Items Scalable StyleSheetCount StyleSheets
Page 501 of 629
TcxStyles Properties
TcxStyles Legend
Derived from TcxCustomStyles StyleSheet
Page 502 of 629
Hierarchy TComponent | TcxComponent |
Page 503 of 629
Hierarchy TInterfacedPersistent | TcxInterfacedPersistent |
Page 504 of 629
Page 505 of 629
Page 506 of 629
Hierarchy TInterfacedPersistent | TcxInterfacedPersistent | TcxCustomStyles |
Page 507 of 629
Hierarchy TComponent | TcxCustomStyle |
Page 508 of 629
TcxCustomHintStyle Object
Hierarchy
The base class for the TcxHintStyle and TdxScreenTipStyle classes that contain style settings for hints controlled by the TcxHintStyleController component. Unit dxCustomHint TcxCustomHintStyle = class(TcxInterfacedPersistent) Description Do not use this class directly. Use its descendants instead.
Page 509 of 629
TcxCustomHintStyleController Object
Serves as the base for components controlling the appearance and behavior of hints within the application. Unit dxCustomHint TcxCustomHintStyleController = class(TComponent) Description The TcxCustomHintStyleController class implements the functionality required by its descendant the TcxHintStyleController component. This descendant is used to control the appearance and behavior of hints in the application or form (the Global property value specifies what it controls). Once the component is placed on a form, its properties affect all hints within the application or form. Please refer to the TcxHintStyleController class description for details. Do not create instances of TcxCustomHintStyleController class. If you need a hint style controller in your application, place the TcxHintStyleController component on a form. The TcxCustomHintStyleController can be used to derive other hint style controllers.
Page 510 of 629
TcxCustomHintStyleController.Global
TcxCustomHintStyleController
Specifies whether the current hint controllers style has a global effect within an application. property Global: Boolean; Description Whenever an active hint style controller with the Global property set to True is present within an application, each control that shows its hints uses this hint style controllers style unless another (which is called "local") hint style controller is defined within the form. When neither a global hint style controller (within the application) or a local hint style controller (within the form) is present, the standard hint style is used. Set the Global property to True to designate the current hint style controller as global. Doing so also renders the existing (if any) global hint style controller as local. There can be only one global hint style controller at a time. Note:The first hint style controller created automatically assumes the global role.
Page 511 of 629
TcxCustomHintStyleController.HideHint
Hides the hint that was previously invoked using the ShowHint method. procedure HideHint; Description Use the HideHint method to hide the hint invoked using the ShowHint method. If no hint invoked using this method is currently active, the HideHint method does nothing.
Page 512 of 629
TcxCustomHintStyleController.HintHidePause
TcxCustomHintStyleController See Also
Specifies the time interval during which the hint is displayed. property HintHidePause: Integer; Description The HintHidePause property specifies the interval in milliseconds between the time when the hint appears and before it is hidden. This assumes that the mouse pointer stays within the control displaying the hint. If the mouse pointer leaves the control area, the hint is hidden immediately. When you assign a value to the HintHidePause property, it is actually passed to the applications HintHidePause property. The default value of the HintHidePause property is 2500.
Page 513 of 629
TcxCustomHintStyleController.HintPause
Specifies the time interval before the hint is displayed. property HintPause: Integer; Description The HintPause property specifies the interval, in milliseconds, between the time when the mouse pointer enters the controls area and when the hint is displayed. If you need hints to be displayed immediately, set this property to 0. Note that if the mouse pointer leaves the controls area before this time has elapsed, the hint is not displayed at all. When you assign a value to the HintPause property, it is actually passed to the applications HintPause property. The default value of the HintPause property is 500.
Page 514 of 629
TcxCustomHintStyleController.HintShortPause
Specifies the time period passed before a hint is displayed if another hint has already been shown. property HintShortPause: Integer; Description Use the HintShortPause property to reduce the flicker when moving the mouse quickly over a set of buttons that all have help hints. If flicker appears, assign a greater value to this property. Values are set in milliseconds. When you assign a value to the HintShortPause property, it is actually assigned to the applications HintShortPause property. The default value of the HintShortPause property is 50.
Page 515 of 629
TcxCustomHintStyleController.HintStyle
Specifies the hint style. property HintStyle: TcxCustomHintStyle; Description Use the HintStyle property to specify one of two available hint styles TcxHintStyle and TdxScreenTipStyle. Please refer to the TcxHintStyle or TdxScreenTipStyle description, for a list of hint style settings.
Page 516 of 629
TcxCustomHintStyleController.HintWindow
Provides access to a hint window. property HintWindow: TcxCustomHintWindow; Description Use the HintWindow.Caption property to modify a hints caption in a currently displayed hint window. ReadOnly Property
Page 517 of 629
TcxCustomHintStyleController.LookAndFeel
Specifies the hint painting style. property LookAndFeel: TcxLookAndFeel; Description Styles include:
l l
Five predefined styles provided by the TcxLookAndFeel. Skins from the ExpressSkins Library.
Page 518 of 629
TcxCustomHintStyleController.LookAndFeelPainter
Provides access to the painter that corresponds to the currently used painting style. property LookAndFeelPainter: TcxCustomLookAndFeelPainter; Description Use the LookAndFeelPainter property to paint the hint manually, if required. ReadOnly Property
Page 519 of 629
TcxCustomHintStyleController.OnHintStyleChanged
Fires when hint style settings have been changed. type TcxHintStyleChangedEvent = procedure(Sender: TObject; AStyle: TcxCustomHintStyle) of object; property OnHintStyleChanged: TcxHintStyleChangedEvent; Description Write a handler for the OnHintStyleChanged event if you need to do something after the hint controllers style settings changed. This event fires if any of attributes of the HintStyle property are modified. Handling this event is useful if you allow end-users to alter hint styles and want to provide a common response to property changes. For instance, you may want to restrict some style attribute combinations. In this case, you can handle the OnHintStyleChanged event to check whether the combination is allowed and modify the style settings as required. The Sender parameter specifies the hint controller component that raised the event. The AStyle parameter contains style settings of the hint controller (its HintStyle property value).
Page 520 of 629
TcxCustomHintStyleController.OnShowHint
Fires before a hint is displayed. type TcxShowHintEvent = procedure(Sender: TObject; var HintStr: string; var CanShow: Boolean; var HintInfo: THintInfo) of object; property OnShowHint: TcxShowHintEvent; Description This event is obsolete and used for compatibility purposes. Use the OnShowHintEx event instead.
Page 521 of 629
TcxCustomHintStyleController.OnShowHintEx
Fires before a hint is displayed. type TcxShowHintExEvent = procedure(Sender: TObject; var Caption, HintStr: string; var CanShow: Boolean; var HintInfo: THintInfo) of object; property OnShowHintEx: TcxShowHintExEvent; Description Handle the OnShowHintEx event to control the general appearance and customize the behavior and various appearance aspects of a hint window. The Sender parameter specifies the hint controller component that raised the event. To prohibit a hint from appearing, pass False as the CanShow parameter. Otherwise, a hint will be displayed. Use the Caption and HintStr parameters to specify the hints caption and body. To customize the appearance and behavior of the hint window, use the HintInfo parameter. Refer to the description of the THintInfo type for details. Note:Calling the ShowHint method doesnt fire the OnShowHintEx and OnShowHint events.
Page 522 of 629
TcxCustomHintStyleController.ShowHint
Displays a hint window, already pre-configured, at a specified position on screen. procedure ShowHint(X, Y: Integer; ACaption, AHint: string; AMaxWidth: Integer = 0); Description The X and Y parameters specify the hints top-left corner position. They represent the horizontal and vertical screen coordinates respectively. The ACaption and AHint parameters specify strings that will be displayed as the hints caption and body. If you dont need to display a caption, pass an empty string as the ACaption parameter. To modify the caption of the displayed hint, use the HintWindow.Caption property. The AMaxWidth parameter specifies the maximum width of a hint window (in pixels). 0 indicates that its width is limited by the screen width. Calling the ShowHint method hides the hint that was invoked previously. If you need to hide the currently active hint, use the HideHint method. Note:The ShowHint method doesnt fire the OnShowHint and OnShowHintEx events.
Page 523 of 629
TcxCustomHintStyleController.UseHintControlLookAndFeel
Specifies whether to use the corresponding controls look and feel. property UseHintControlLookAndFeel: Boolean; Description Value True False The hint is painted with the look and feel specified by the corresponding controls LookAndFeel property. The hint is painted with the look and feel specified by the hint style controllers LookAndFeel property. Meaning
The default value of the UseHintControlLookAndFeel property is False.
Page 524 of 629
TcxCustomHintStyleController Events
TcxCustomHintStyleController Legend
In TcxCustomHintStyleController OnHintStyleChanged OnShowHint OnShowHintEx
Page 525 of 629
TcxCustomHintStyleController Methods
In TcxCustomHintStyleController HideHint ShowHint
Page 526 of 629
TcxCustomHintStyleController Properties
In TcxCustomHintStyleController Global HintHidePause HintPause HintShortPause HintStyle HintWindow LookAndFeel LookAndFeelPainter UseHintControlLookAndFeel
Page 527 of 629
Hierarchy TComponent | TcxCustomHintStyleController
Page 528 of 629
Hierarchy TInterfacedPersistent | TcxInterfacedPersistent | TcxCustomHintStyle
Page 529 of 629
TdxFader.MaxAnimationCount
TdxFader
Specifies the maximum number of animations that can be played at one time. property MaxAnimationCount: Integer; Description Decreasing this property value allows you to improve performance. Possible values are 0 through 20. The default value of the MaxAnimationCount property is 10.
Page 530 of 629
TdxFader Properties
TdxFader Legend
In TdxFader MaxAnimationCount State
Page 531 of 629
Hierarchy TObject | TdxFader
Page 532 of 629
TdxGPImage Object
The base class for classes that implement image formats. Unit dxGDIPlusClasses TdxGPImage = class(TGraphic) Description Do not use this class directly. Instead, use the TdxSmartImage as a generic type.
Page 533 of 629
TdxGPImage.Clear
TdxGPImage
Releases resources and a handle used by the image instance. procedure Clear; virtual;
Page 534 of 629
TdxGPImage.ClientRect
TdxGPImage
Determines the images bounding rectangle. property ClientRect: TRect; ReadOnly Property
Page 535 of 629
TdxGPImage.Clone
TdxGPImage
Creates a new image object and copies the contents of the image into the newly created object. function Clone: TdxGPImage; virtual;
Page 536 of 629
TdxGPImage.Compare
TdxGPImage
Compares the image and AImage. function Compare(AImage: TdxGPImage): Boolean; virtual; Description The comparison is performed by image size and image colors. The Compare method returns True if images are identical.
Page 537 of 629
TdxGPImage.CreateFromBitmap
TdxGPImage
Creates an image object using ABitmap. constructor CreateFromBitmap(ABitmap: TBitmap); virtual; Description ABitmap specifies the bitmap from which the image object will be created.
Page 538 of 629
TdxGPImage.CreateFromBits
TdxGPImage
Creates an image object using image bits. constructor CreateFromBits(AWidth, AHeight: Integer; const ABits: TRGBColors; AHasAlphaChannel: Boolean); virtual; Description AWidth and AHeight specify the image size. ABits specifies the image bits from which the image object will be created. AHasAlphaChannel specifies the image transparency. Set AHasAlphaChannel to True to support transparency.
Page 539 of 629
TdxGPImage.CreateFromStream
TdxGPImage
Creates an image object using AStream. constructor CreateFromStream(AStream: TStream); virtual; Description AStream specifies the stream from which the image will be loaded.
Page 540 of 629
TdxGPImage.GetAsBitmap
TdxGPImage
Creates a bitmap from the image. function GetAsBitmap: TBitmap; virtual;
Page 541 of 629
TdxGPImage.GetBitmapBits
TdxGPImage
Returns bitmap bits of the image. function GetBitmapBits: TRGBColors;
Page 542 of 629
TdxGPImage.Handle
TdxGPImage
An image instance handle. type GpImage = Pointer; property Handle: GpImage; ReadOnly Property
Page 543 of 629
TdxGPImage.ImageDataFormat
TdxGPImage
Determines the format of the image. type TdxImageDataFormat = (dxImageUnknown, dxImageBitmap, dxImageJpeg, dxImagePng, dxImageTiff, dxImageGif); property ImageDataFormat: TdxImageDataFormat; Description Refer to the TdxImageDataFormat description, for details. ReadOnly Property
Page 544 of 629
TdxGPImage.IsAlphaUsed
TdxGPImage
Determines the image transparency. property IsAlphaUsed: Boolean; Description The IsAlphaUsed property returns True if the image is translucent. ReadOnly Property
Page 545 of 629
TdxGPImage.LoadFromBits
TdxGPImage
Overrides the image using specified image bits. procedure LoadFromBits(AWidth, AHeight: Integer; const ABits: TRGBColors; AHasAlphaChannel: Boolean); Description AWidth and AHeight specify the image size. ABits specifies the image bits from which the image object will be created. AHasAlphaChannel specifies the image transparency. Set AHasAlphaChannel to True to support transparency.
Page 546 of 629
TdxGPImage.LoadFromResource
TdxGPImage
Overrides the image using the specified resource. procedure LoadFromResource(AInstance: THandle; const AResName: string; AResType: PChar); Description AInstance specifies the resource handle. AResName specifies the resource name. AResType specifies the resource type.
Page 547 of 629
TdxGPImage.MakeComposition
TdxGPImage
Paints AOverlay over the image. function MakeComposition(AOverlay: TdxGPImage; AAlpha: Byte): TdxGPImage; Description AOverlay specifies the image that will be drawn over the image. AAlpha specifies the transparency level.
Page 548 of 629
TdxGPImage.SaveToStreamByCodec
TdxGPImage
Persists the image with streams by an encoder. type TdxImageDataFormat = (dxImageUnknown, dxImageBitmap, dxImageJpeg, dxImagePng, dxImageTiff, dxImageGif); procedure SaveToStreamByCodec(AStream: TStream; AImageFormat: TdxImageDataFormat); Description AStream specifies the target stream. AImageFormat specifies the image format, whose associated encoder is used.
Page 549 of 629
TdxGPImage.SetBitmap
TdxGPImage
Overrides the image using the specified bitmap. procedure SetBitmap(ABitmap: TBitmap); virtual; Description ABitmap specifies the bitmap from which the image will be created.
Page 550 of 629
TdxGPImage.StretchDraw
TdxGPImage
Paints the image within a destination rectangle. procedure StretchDraw(DC: HDC; const ADest, ASource: TRect; AAlpha: Byte = 255); procedure StretchDraw(DC: HDC; const ADest: TRect; AAlpha: Byte = 255); Description The StretchDraw method resizes the image to completely fill the destination rectangle. Note that the image is properly resized if its initial dimensions (height and width) are two or more pixels. The overload copies the ASource image fragment into the ADest rectangle. DC specifies a handle to the device context. ADest and ASource specify a destination and source rectangles.
Page 551 of 629
TdxBMPImage Methods
TdxBMPImage Legend
Derived from TdxGPImage Clear Clone Compare CreateFromBitmap CreateFromBits CreateFromStream GetAsBitmap GetBitmapBits LoadFromBits LoadFromResource MakeComposition SaveToStreamByCodec SetBitmap StretchDraw
Page 552 of 629
TdxGIFImage Methods
TdxGIFImage Legend
Page 553 of 629
TdxGPImage Methods
TdxGPImage Legend
In TdxGPImage Clear Clone Compare CreateFromBitmap CreateFromBits CreateFromStream GetAsBitmap GetBitmapBits LoadFromBits LoadFromResource MakeComposition SaveToStreamByCodec SetBitmap StretchDraw
Page 554 of 629
TdxJPEGImage Methods
TdxJPEGImage Legend
Page 555 of 629
TdxPNGImage Methods
TdxPNGImage Legend
Page 556 of 629
TdxSmartImage Methods
TdxSmartImage Legend
Page 557 of 629
TdxTIFFImage Methods
TdxTIFFImage Legend
Page 558 of 629
TdxBMPImage Properties
TdxBMPImage Legend
Derived from TdxGPImage ClientRect Handle ImageDataFormat IsAlphaUsed
Page 559 of 629
TdxGIFImage Properties
TdxGIFImage Legend
Page 560 of 629
TdxGPImage Properties
TdxGPImage Legend
In TdxGPImage ClientRect Handle ImageDataFormat IsAlphaUsed
Page 561 of 629
TdxJPEGImage Properties
TdxJPEGImage Legend
Page 562 of 629
TdxPNGImage Properties
TdxPNGImage Legend
Page 563 of 629
TdxSmartImage Properties
TdxSmartImage Legend
Page 564 of 629
TdxTIFFImage Properties
TdxTIFFImage Legend
Page 565 of 629
Hierarchy TGraphic | TdxGPImage | TdxBMPImage
Page 566 of 629
Hierarchy TGraphic | TdxGPImage | TdxGIFImage
Page 567 of 629
Hierarchy TGraphic | TdxGPImage
Page 568 of 629
Hierarchy TGraphic | TdxGPImage | TdxJPEGImage
Page 569 of 629
Hierarchy TGraphic | TdxGPImage | TdxPNGImage
Page 570 of 629
Hierarchy TGraphic | TdxGPImage | TdxSmartImage
Page 571 of 629
Hierarchy TGraphic | TdxGPImage | TdxTIFFImage
Page 572 of 629
TdxScreenTipFooterBand Object
The TdxScreenTipFooterBand class implements the ScreenTips footer section that can be defined on a set of ScreenTips. Unit dxScreenTip TdxScreenTipFooterBand = class(TdxCustomScreenTipBand) Description A ScreenTip window can be split into three sections header (see the ScreenTips Header property), description (see the ScreenTips Description property) and footer (see the ScreenTips Footer property).
These sections are of type TdxScreenTipBand, and proprietary to each ScreenTip. If an application needs to display footer information common to a number of ScreenTips, use the ScreenTip repositorys StandardFooter property (instead of the ScreenTips Footer property), and toggle the UseStandardFooter property of specific ScreenTips to show this information.
Page 573 of 629
TdxCustomScreenTipBand.BandType
TdxCustomScreenTipBand
Specifies the ScreenTips section to which section settings will be applied. type TdxScreenTipBandType = (stbHeader, stbDescription, stbFooter); property BandType: TdxScreenTipBandType;
Page 574 of 629
TdxCustomScreenTipBand.Font
TdxCustomScreenTipBand See Also
Gets font settings for the descriptive string displayed in the currently processed ScreenTip. property Font: TFont; Description The Font property returns font settings that depend upon settings are currently applied to the string either TdxScreenTipRepositorys or system font options (see the ScreenTip repositorys AssignedFonts property). ReadOnly Property
Page 575 of 629
TdxCustomScreenTipBand.Glyph
Specifies the explanatory image for the currently processed ScreenTip. property Glyph: TBitmap; Description The specified image is displayed in the ScreenTip along with the descriptive text (see the Text property).
The image is displayed to the left of the descriptive text, if the latter is aligned to the right of the ScreenTip window. Its displayed to the right of the text, if the text is aligned to the left of the window (see the TextAlign property).
Page 576 of 629
TdxCustomScreenTipBand.Text
Specifies the descriptive text for the currently processed ScreenTip. property Text: string; Description The specified text is a description of the controls intended purpose. This text can be used along with the specified explanatory image (see the Glyph property).
The image is displayed to the left of the descriptive text, if the latter is aligned to the right of the ScreenTip window. Its displayed to the right of the text, if the text is aligned to the left of the window (see the TextAlign property).
Page 577 of 629
TdxCustomScreenTipBand.TextAlign
Specifies the descriptive texts position relative to an explanatory image in the currently processed ScreenTip. type TdxScreenTipBandTextAlign = (stbtaLeft, stbtaRight); property TextAlign: TdxScreenTipBandTextAlign; Description A ScreenTip provides a description for a corresponding control. This description contains an explanatory image (see the Glyph property), and a descriptive text (see the Text property). Use the TextAlign property to specify the position of the descriptive text it can be positioned to the left (the TextAlign property is stbtaLeft) or to the right (the TextAlign property is stbtaRight) of the explanatory image in the ScreenTip window. The default value of the TextAlign property is stbtaRight.
Page 578 of 629
TdxScreenTipBand.ScreenTip
TdxScreenTipBand
References a ScreenTip that contains the currently processed section. property ScreenTip: TdxScreenTip; Description The TdxScreenTip class implements an enhanced ScreenTip. A ScreenTip window can contain three sections header (see the Header property), description (see the Description property) and footer (see the Footer property).
Each section can display an explanatory image (see the sections Glyph property), a descriptive text (see the sections Text property) and a keyboard shortcut. To display a common footer in a number of ScreenTips, specify footer information via the ScreenTip repositorys StandardFooter property and toggle the UseStandardFooter property of specific ScreenTips. If there are no specific details to be shown in the ScreenTips header, toggle the ScreenTips UseHintAsHeader property to display a hint in this section specified by the controls Hint property. To customize the width of the ScreenTips window, use the ScreenTips Width property. From the ScreenTip instance, you can access other ScreenTips via the ScreenTips Collection property. Use the ScreenTip property to access the ScreenTip instance. ReadOnly Property
Page 579 of 629
TdxScreenTipCollection.Add
TdxScreenTipCollection
Adds a new ScreenTip at the end of the ScreenTip collection. function Add: TdxScreenTip; Description The Add method returns a reference to the newly created ScreenTip.
Page 580 of 629
TdxScreenTipCollection.Items
Provides indexed access to the ScreenTip at the position specified by the zero-based Index parameter. property Items[Index:Integer]: TdxScreenTip; Description The collection contains control ScreenTips created both at design and run-time.
Page 581 of 629
TdxScreenTipCollection.Repository
Represents the ScreenTip repository. property Repository: TdxScreenTipRepository; Description A ScreenTip repository is a component used for storing information on control ScreenTips. It wraps the ScreenTip collection (see the repositorys Items property) and provides the following ScreenTip-specific settings:
l
l l
l l
StandardFooter property provides settings for a ScreenTip windows footer section common to a number of ScreenTips. To apply settings specified by this property to a particular ScreenTip, set the ScreenTips UseStandardFooter property to True. ReadOnly Property
Page 582 of 629
TdxScreenTipFooterBand.Repository
TdxScreenTipFooterBand
References the ScreenTip repository. property Repository: TdxScreenTipRepository; Description A ScreenTip repository is a component used for storing information on control ScreenTips. It wraps the ScreenTip collection (see the repositorys Items property), and provides the following ScreenTip-specific settings:
l
l l
l l
StandardFooter property provides settings for a ScreenTip windows footer section common to a number of ScreenTips. To apply settings specified by this property to a particular ScreenTip, set the ScreenTips UseStandardFooter property to True. ReadOnly Property
Page 583 of 629
TdxScreenTipLinks.Add
TdxScreenTipLinks
Adds a new ScreenTip link at the end of the ScreenTip link collection. function Add: TdxScreenTipLink; Description The Add method returns a reference to the newly created ScreenTip link.
Page 584 of 629
TdxScreenTipLinks.FindScreenTipByControl
TdxScreenTipLinks
Finds a ScreenTip by the specified hinted control. function FindScreenTipByControl(AControl: TControl): TdxScreenTip; Description If a match was found, the FindScreenTipByControl method returns the TdxScreenTip instance. Otherwise, nil is returned.
Page 585 of 629
TdxScreenTipLinks.Items
TdxScreenTipLinks
Provides indexed access to the ScreenTip link at the position specified by the zero-based Index parameter. property Items[Index:Integer]: TdxScreenTipLink;
Page 586 of 629
TdxScreenTipLinks.ScreenTipStyle
TdxScreenTipLinks
Provides access to the ScreenTip style which owns links. property ScreenTipStyle: TdxScreenTipStyle; ReadOnly Property
Page 587 of 629
TdxScreenTipLink.Control
TdxScreenTipLink
Specifies the hinted control. property Control: TControl; Description An associated ScreenTip is specified via the ScreenTip property.
Page 588 of 629
TdxScreenTipLink.ScreenTip
TdxScreenTipLink
Specifies the ScreenTip that is associated with a hinted control. property ScreenTip: TdxScreenTip; Description A hinted control is specified via the Control property.
Page 589 of 629
TdxScreenTipRepository.AssignedFonts
TdxScreenTipRepository
Activates font settings to be applied to a descriptive text shown in the specified sections of the ScreenTip window. property AssignedFonts: TdxScreenTipRepositoryFonts; Description By activating the corresponding flags, specified font settings can be applied to the text contained in the following sections:
l l l
The header section contains header information. The description section contains a description of an associated control. The footer section contains footer information.
Note: if you modify font settings, the corresponding flags are automatically activated on the AssignedFonts property. The default value of the AssignedFonts property is [].
Page 590 of 629
TdxScreenTipRepository.DescriptionFont
TdxScreenTipRepository See Also
Represents font settings for a descriptive string displayed in the ScreenTip windows description section. property DescriptionFont: TFont; Description The ScreenTip window is split into three sections header, description and footer (see the ScreenTips Description, Footer and Header properties).
A descriptive string to be shown in the description section is specified via the ScreenTips Decscription.Text property. Specified font settings are only applied if the stbDescription flag on the AssignedFonts property is active. Otherwise, system settings are used instead.
Page 591 of 629
TdxScreenTipRepository.FooterFont
Represents font settings for a descriptive string displayed in the ScreenTip windows footer section. property FooterFont: TFont; Description The ScreenTip window is split into three sections header, description and footer (see the ScreenTips Description, Footer and Header properties).
A descriptive string to be shown in the footer section is specified via the ScreenTips Footer.Text property. Specified font settings are only applied if the stbFooter flag on the AssignedFonts property is active. Otherwise, system settings are used instead.
Page 592 of 629
TdxScreenTipRepository.HeaderFont
Represents font settings for a descriptive string displayed in the ScreenTip windows header section. property HeaderFont: TFont; Description The ScreenTip window is split into three sections header, description and footer (see the ScreenTips Description, Footer and Header properties).
A descriptive string to be shown in the header section is specified via the ScreenTips Header.Text property. Specified font settings are only applied if the stbHeader flag on the AssignedFonts property is active. Otherwise, system settings are used instead.
Page 593 of 629
TdxScreenTipRepository.Items
TdxScreenTipRepository
Represents a collection of ScreenTips. property Items: TdxScreenTipCollection; Description This collection stores ScreenTips created both at design and run-time. At design-time (within the Object Inspector) click the ellipsis button next to the Items property to invoke a design-time editor for adding or removing ScreenTips from the repository. At run-time, you can add a new ScreenTip to the collection using the collections Add method. Indexed access to an individual ScreenTip can be obtained via the collections Items property.
Page 594 of 629
TdxScreenTipRepository.ShowDescription
Specifies whether to show an enhanced or a standard ScreenTip. property ShowDescription: Boolean; Description An enhanced ScreenTip can contain three sections header (see the ScreenTips Header property), description (see the ScreenTips Description property) and footer (see the ScreenTips Footer property).
Each section can display an explanatory image (see the sections Glyph property), a descriptive text (see the sections Text property) and a keyboard shortcut. A standard ScreenTip only shows a header section containing a descriptive text and a keyboard shortcut. Note: if a descriptive text is not specified for a particular control or the ScreenTips UseHintAsHeader property is set to True, a hint message (see the controls Hint property) will be shown instead. If the ShowDescription propertys value is True, enhanced ScreenTips appear. Set the ShowDescription property to False, to show standard ScreenTips. The ShowDescription propertys value is applied to all ScreenTips defined with the repository. The default value of the ShowDescription property is True.
Page 595 of 629
TdxScreenTipRepository.StandardFooter
Represents ScreenTip footer settings common to a number of ScreenTips. property StandardFooter: TdxScreenTipFooterBand; Description Each ScreenTip contains footer information provided by the proprietary Footer property. Some ScreenTips can contain standard footer information. In order to avoid repetition, you can specify footer information via the StandardFooter property. To display this information in specific ScreenTips, set their UseStandardFooter property to True.
Page 596 of 629
TdxScreenTipStyle.ScreenTipLinks
TdxScreenTipStyle
Specifies the collection of ScreenTip links to the hinted controls. property ScreenTipLinks: TdxScreenTipLinks;
Page 597 of 629
TdxScreenTip.Collection
TdxScreenTip
Represents the ScreenTip collection. property Collection: TdxScreenTipCollection; Description The ScreenTip collection stores ScreenTips created both at design and run-time. At design-time, in the Object Inspector, click the ellipsis button next to the ScreenTip repositorys Items property to invoke a design-time editor for adding or removing ScreenTips from the repository (see TdxScreenTipRepository). At run-time, you can add a new ScreenTip to the collection, using the collections Add method. Indexed access to an individual ScreenTip can be obtained via the collections Items property. ReadOnly Property
Page 598 of 629
TdxScreenTip.Description
TdxScreenTip See Also
Represents settings for the ScreenTip windows description section. property Description: TdxScreenTipBand; Description The ScreenTip window is split into three sections header (see the Header property), description and footer (see the Footer property).
The description section contains a description of the associated control. With the Description property, you can assign an explanatory image (see the sections Glyph property), specify a descriptive text (see the sections Text property) and also specify the texts horizontal alignment (see the sections TextAlign property).
Page 599 of 629
TdxScreenTip.Footer
Represents settings for the ScreenTip windows footer section. property Footer: TdxScreenTipBand; Description The ScreenTip window is split into three sections header (see the Header property), description (see the Description property) and footer.
The footer section contains footer information on the associated control. With the Footer property, you can assign an explanatory image (see the sections Glyph property), specify a descriptive text (see the sections Text property) and also specify the texts horizontal alignment (see the sections TextAlign property).
Page 600 of 629
TdxScreenTip.Header
Represents settings for the ScreenTip windows header section. property Header: TdxScreenTipBand; Description The ScreenTip window is split into three sections header, description (see the Description property) and footer (see the Footer property).
The header section contains a short description of the associated control. For example, it can display the controls caption (specified via the sections Text property) and the corresponding keyboard shortcut, if specified. With the Header property, you can assign an explanatory image (see the sections Glyph property), specify a descriptive text (see the sections Text property) and also specify the texts horizontal alignment (see the sections TextAlign property).
Page 601 of 629
TdxScreenTip.UseHintAsHeader
Specifies whether header information is provided by the controls Hint property. property UseHintAsHeader: Boolean; Description Generally, information in the ScreenTips header section is specified via the ScreenTips Header property. To avoid repetition if there is no specific header information, you can show a hint message here (specified by the controls Hint property). To do this, set the UseHintAsHeader property to True. The default value of the UseHintAsHeader property is False.
Page 602 of 629
TdxScreenTip.UseStandardFooter
Specifies whether to display footer information provided by the ScreenTip repositorys StandardFooter property. property UseStandardFooter: Boolean; Description Some ScreenTips can contain standard footer information. In order to avoid repetition, you can specify footer information via the ScreenTip repositorys StandardFooter property for these ScreenTips. To apply footer details specified by the StandardFooter property to the currently processed ScreenTip, set the UseStandardFooter property to True. The default value of the UseStandardFooter property is False.
Page 603 of 629
TdxScreenTip.Width
TdxScreenTip
Specifies the width of the currently processed ScreenTip. property Width: Integer; Description If the Width property is set to 0, the ScreenTips width is calculated automatically. The calculated value depends upon whether an explanatory image in the ScreenTips description section is provided. If so, the ScreenTips window is 318 pixels wide. Otherwise, the windows width is 210 pixels. The default value of the Width property is 0.
Page 604 of 629
TdxScreenTipRepositoryFonts type
See Also
Enumerates ScreenTip sections to which font settings will be applied. Unit dxScreenTip type TdxScreenTipBandType = (stbHeader, stbDescription, stbFooter); TdxScreenTipRepositoryFonts = set of TdxScreenTipBandType; Description Values include: Value stbHeader stbDescription stbFooter The header section of the ScreenTip window The description section of the ScreenTip window The footer section of the ScreenTip window Meaning
Page 605 of 629
TdxScreenTip Methods
TdxScreenTip Legend
Derived from TcxComponentCollectionItem AddToCollection GetParentComponent RemoveFromCollection SetParentComponent
Page 606 of 629
TdxScreenTipCollection Methods
TdxScreenTipCollection Legend
In TdxScreenTipCollection Add Derived from TcxComponentCollection Add BeginUpdate Clear Delete EndUpdate FindItemByID Insert Update
Page 607 of 629
TdxScreenTipLinks Methods
TdxScreenTipLinks Legend
In TdxScreenTipLinks Add FindScreenTipByControl
Page 608 of 629
TdxCustomScreenTipBand Properties
TdxCustomScreenTipBand Legend
In TdxCustomScreenTipBand BandType Font Glyph Text TextAlign
Page 609 of 629
TdxScreenTip Properties
TdxScreenTip Legend
In TdxScreenTip Collection Description Footer Header UseHintAsHeader UseStandardFooter Width Derived from TcxComponentCollectionItem Collection ID Index
Page 610 of 629
TdxScreenTipBand Properties
TdxScreenTipBand Legend
In TdxScreenTipBand ScreenTip Derived from TdxCustomScreenTipBand BandType Font Glyph Text TextAlign
Page 611 of 629
TdxScreenTipCollection Properties
TdxScreenTipCollection Legend
In TdxScreenTipCollection Items Repository Derived from TcxComponentCollection Count Items
Page 612 of 629
TdxScreenTipFooterBand Properties
TdxScreenTipFooterBand Legend
In TdxScreenTipFooterBand Repository Derived from TdxCustomScreenTipBand BandType Font Glyph Text TextAlign
Page 613 of 629
TdxScreenTipLink Properties
TdxScreenTipLink Legend
In TdxScreenTipLink Control ScreenTip
Page 614 of 629
TdxScreenTipLinks Properties
TdxScreenTipLinks Legend
In TdxScreenTipLinks Items ScreenTipStyle
Page 615 of 629
TdxScreenTipRepository Properties
TdxScreenTipRepository Legend
In TdxScreenTipRepository AssignedFonts DescriptionFont FooterFont HeaderFont Items ShowDescription StandardFooter
Page 616 of 629
TdxScreenTipStyle Properties
TdxScreenTipStyle Legend
In TdxScreenTipStyle ScreenTipLinks
Page 617 of 629
Hierarchy TPersistent | TdxCustomScreenTipBand
Page 618 of 629
Hierarchy TPersistent | TdxCustomScreenTipBand | TdxScreenTipBand
Page 619 of 629
Hierarchy TPersistent | TcxComponentCollection | TdxScreenTipCollection
Page 620 of 629
Hierarchy TPersistent | TdxCustomScreenTipBand | TdxScreenTipFooterBand
Page 621 of 629
Hierarchy TCollection | TdxScreenTipLinks
Page 622 of 629
Hierarchy TCollectionItem | TdxScreenTipLink
Page 623 of 629
Hierarchy TComponent | TdxScreenTipRepository
Page 624 of 629
Hierarchy TInterfacedPersistent | TcxInterfacedPersistent | TcxCustomHintStyle | TdxScreenTipStyle
Page 625 of 629
Hierarchy TComponent | TcxComponentCollectionItem | TdxScreenTip
Page 626 of 629
Skin Skins give you total freedom in look and feel customization. A skin contains bitmaps showing all control elements in their various states (normal, hot-tracked, selected, pressed, etc.) Since each control is painted using the corresponding bitmaps, the appearance of the entire skinned application does not generally depend on the Operating System. By using skins you can introduce the Windows XP look and feel options in applications that are not running under the XP OS. With the ExpressSkins Library, you can add skin support to your applications built with Developer Express controls. Note that this library is not shipped as part of the Express Cross Platform Library and must be purchased separately.
Page 627 of 629
Legend Protected Published ReadOnly
Page 628 of 629
WYSIWYG "What You See Is What You Get" - Applicable to editor classes in that the author is aware at all times of the final appearance of the object being built.
Page 629 of 629

Express Cross Platform Library

Transféré par

Informations du document

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

Express Cross Platform Library

Transféré par

Droits d'auteur :

Formats disponibles

Known Issues and Important Changes List

IsWin95X IsWin2K IsWin2KorXP IsWinNT IsWinVista IsWinXP

IsWinXPOrLater IsWinXP IsWinNT IsWin9X (IsWinMe or IsWin2KorLater)

ReadBufferFromStream ReadBoolean ReadByte ReadInteger ReadWord WriteBoolean

WriteByte WriteInteger WriteWord WriteCharToStream WriteDoubleToStream WriteIntegerToStream WriteSmallIntToStream WriteStringToStream WriteBufferToStream

//Delphi // ... {$DEFINE cxImageListOldSaveFormat} unit cxGraphics; // ...

Using the cxPropertiesStore component

Using the Image List Editor

Image List Editor UI

Close closes a file. Exit closes the Localizer Editor.

Custom Resource Strings:

How To Create Localized Strings Using the Localizer Editor

6. Save localized resource strings in the storage.

How To Localize an Application Using the TcxLocalizer

This concept provides flexibility when implementing various styles.

Images can be added to the component in the following ways:

cxContainerMaxBorderWidth global constant

cxContainerShadowWidth global constant

cxDefaultAutoCompleteDelay global constant

cxDefaultLookAndFeelKind global constant

cxDefaultLookAndFeelNativeStyle global constant

cxDefaultLookAndFeelSkinName global constant

cxExportGraphicClass global constant

cxExportGraphicClass : TGraphicClass = TBitmap;

dxFadeInDefaultAnimationFrameCount global constant

dxFadeInDefaultAnimationFrameDelay global constant

dxFadeOutDefaultAnimationFrameCount global constant

dxFadeOutDefaultAnimationFrameDelay global constant

dxFader global function

The check box has a check mark in it, but it is grayed.

A 3D lowered border is painted around the control.

An ultra flat border is painted around the control.

Page 100 of 629

Page 101 of 629

Page 102 of 629

Page 103 of 629

Page 104 of 629

Page 105 of 629

Page 106 of 629

Page 107 of 629

Page 108 of 629

Represents a skin name. Unit cxClasses type TdxSkinName = type string;

Page 109 of 629

Page 110 of 629

Page 111 of 629

Page 112 of 629

Global Constants cxExportGraphicClass

Page 113 of 629

Page 114 of 629

Page 115 of 629

Page 116 of 629

Page 117 of 629

Page 118 of 629

Page 119 of 629

Page 120 of 629

Page 121 of 629

Page 122 of 629

Page 123 of 629

Hierarchy IUnknown | IcxDialogMetricsInfoData

Page 124 of 629

Page 125 of 629

Page 126 of 629

Page 127 of 629

Page 128 of 629