Sign in Join
FPDoc Onlineexperiment

TCustomTaskDialog.CustomMainIcon property

Member of TCustomTaskDialogpublicIn unit Dialogs

Contains a custom icon displayed in the main content area on the dialog.

Declaration

pascal
property CustomMainIcon: TIcon read FCustomMainIcon write SetCustomMainIcon stored IsCustomMainIconStored;

Description

CustomMainIcon is a TIcon property which contains the custom icon used in the main content area on the task dialog. It allows an icon other than one of the built-in resources in MainIcon to be used in the content area. The image content can be loaded at design-time using the property editor in the Object Inspector, or assigned at run-time prior to calling Execute for the task dialog.

The property value is stored during component streaming when an icon has been assigned to the property and its image data is not empty. Otherwise, it is omitted from the LFM resource.

The handle for the custom icon image is used when the Execute method in the widgetset class instance is called. Include the value tfUseHIconMain in the Flags property to enable use of the handle in the widget instance instead of a handle for one of the built-in icon resources.

Use MainIcon to select one the standard built-in icons for use in the main content area.

Use FooterIcon or CustomFooterIcon to specify the icon displayed in the footer content area on the task dialog.

Added in LCL version 4.0.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.