About Dialog Box components

Class TOlfAboutDialog

Description
Hierarchy
Fields
Methods
Properties

Unit

Olf.VCL.AboutDialog

Declaration

type TOlfAboutDialog = class(TComponent)

Description

Delphi 10.3 Rio and after

Attributes
ComponentPlatformsAttribute(pfidWindows)

Hierarchy

Overview

Methods

Protected procedure Notification(AComponent: TComponent; Operation: TOperation); override;
Protected procedure DoReplaceMainFormCaption;
Public constructor Create(AOwner: TComponent); override;
Public destructor Destroy; override;
Public function Execute: boolean;
Public function GetMainFormCaption: string; virtual;
Public function GetVersionDate: string; virtual;

Properties

Public property onButtonLicenseClickProc: TNotifyEvent read FonButtonLicenseClickProc write SetonButtonLicenseClickProc;
Public property onButtonBuyClickProc: TNotifyEvent read FonButtonBuyClickProc write SetonButtonBuyClickProc;
Public property onButtonRegisterClickProc: TNotifyEvent read FonButtonRegisterClickProc write SetonButtonRegisterClickProc;
Public property onGetTextProc: TOlfAboutDialogGetTextProc read FonGetTextProc write SetonGetTextProc;
Public property onGetFooterTextProc: TOlfAboutDialogGetTextProc read FonGetFooterTextProc write SetonGetFooterTextProc;
Published property Titre: string read FTitre write SetTitre;
Published property VersionNumero: string read FVersionNumero write SetVersionNumero;
Published property VersionDate: string read FVersionDate write SetVersionDate;
Published property Image: TImage read FImage write SetImage;
Published property Picture: TPicture read FPicture write SetPicture;
Published property Images: TCustomImageList read FImageList write SetImageList;
Published property ImageIndex: system.UITypes.TImageIndex read FImageListIndex write SetImageListIndex default -1;
Published property ImageName: TImageName read FImageListName write SetImageListName;
Published property URL: string read FURL write SetURL;
Published property Description: tstrings read FDescription write SetDescription;
Published property Licence: tstrings read FLicence write SetLicence;
Published property onCloseDialog: TOlfAboutDialogCloseEvent read FonCloseDialog write SetonCloseDialog;
Published property onURLClick: TOlfAboutDialogURLClickEvent read FonURLClick write SetonURLClick;
Published property Langue: TOlfAboutDialogLang read FLangue write SetLangue default TOlfAboutDialogLang.Auto;
Published property Copyright: string read FCopyright write SetCopyright;
Published property onBeforeExecute: TNotifyEvent read FonBeforeExecute write SetonBeforeExecute;
Published property onAfterExecute: TNotifyEvent read FonAfterExecute write SetonAfterExecute;
Published property onFormCreate: TNotifyEvent read FonFormCreate write SetonFormCreate;
Published property onFormActivate: TNotifyEvent read FonFormActivate write SetonFormActivate;
Published property onFormShow: TNotifyEvent read FonFormShow write SetonFormShow;
Published property onFormClose: TNotifyEvent read FonFormClose write SetonFormClose;
Published property onButtonLicenseClick: TNotifyEvent read FonButtonLicenseClick write SetonButtonLicenseClick;
Published property onButtonBuyClick: TNotifyEvent read FonButtonBuyClick write SetonButtonBuyClick;
Published property onButtonRegisterClick: TNotifyEvent read FonButtonRegisterClick write SetonButtonRegisterClick;
Published property onGetText: TOlfAboutDialogGetTextEvent read FonGetText write SetonGetText;
Published property onGetFooterText: TOlfAboutDialogGetTextEvent read FonGetFooterText write SetonGetFooterText;
Published property MainFormCaptionPrefix: string read FMainFormCaptionPrefix write SetMainFormCaptionPrefix;
Published property MainFormCaptionSuffix: string read FMainFormCaptionSuffix write SetMainFormCaptionSuffix;
Published property ReplaceMainFormCaption: boolean read FReplaceMainFormCaption write SetReplaceMainFormCaption default false;

Description

Methods

Protected procedure Notification(AComponent: TComponent; Operation: TOperation); override;
 
Protected procedure DoReplaceMainFormCaption;
 
Public constructor Create(AOwner: TComponent); override;

Création d'une instance du composant

Public destructor Destroy; override;

Suppression des données de l'instance du composant

Public function Execute: boolean;

A appeler pour afficher la boite de dialogue

Public function GetMainFormCaption: string; virtual;

Return a standard main form caption from About Box properties

Public function GetVersionDate: string; virtual;

Return a string like 'v1.0-20240801' from VersionNumero and VersionDate properties

Properties

Public property onButtonLicenseClickProc: TNotifyEvent read FonButtonLicenseClickProc write SetonButtonLicenseClickProc;
 
Public property onButtonBuyClickProc: TNotifyEvent read FonButtonBuyClickProc write SetonButtonBuyClickProc;
 
Public property onButtonRegisterClickProc: TNotifyEvent read FonButtonRegisterClickProc write SetonButtonRegisterClickProc;
 
Public property onGetTextProc: TOlfAboutDialogGetTextProc read FonGetTextProc write SetonGetTextProc;
 
Public property onGetFooterTextProc: TOlfAboutDialogGetTextProc read FonGetFooterTextProc write SetonGetFooterTextProc;
 
Published property Titre: string read FTitre write SetTitre;

Titre affiché dans la barre de titre de la fenêtre "à propos" et en premier sur la boite de dialogue

Published property VersionNumero: string read FVersionNumero write SetVersionNumero;

Affiché sous le titre sur la forme "version XXX" ou "Version XXX du JJ/MM/AAAA"

Published property VersionDate: string read FVersionDate write SetVersionDate;

Affiché sous le titre sur la forme "Version du JJ/MM/AAAA" ou "Version XXX du JJ/MM/AAAA"

Published property Image: TImage read FImage write SetImage;

Image utilisée comme logo dans la boite de dialogue (pris en compte si pas d'ImageList)

Published property Picture: TPicture read FPicture write SetPicture;

Bitmap utilisé par l'image servant de logo dans la boite de dialogue (pris en compte si pas d'ImageList ni d'Image)

Published property Images: TCustomImageList read FImageList write SetImageList;

Liste d'images contenant le logo à utiliser dans la boite de dialogue

Published property ImageIndex: system.UITypes.TImageIndex read FImageListIndex write SetImageListIndex default -1;

Index de l'image provenant de la liste d'images correspondant au logo à utiliser dans la boite de dialogue

Published property ImageName: TImageName read FImageListName write SetImageListName;

Nom de l'image provenant de la liste d'images correspondant au logo à utiliser dans la boite de dialogue (le nom est prioritaire sur l'index s'il est renseigné et géré par la liste d'images)

Published property URL: string read FURL write SetURL;

Adresse du site pour lequel on affiche un lien sous le numéro de version/date

Published property Description: tstrings read FDescription write SetDescription;

Texte de description à afficher dans la boite de dialogue S'il est vide, son pavé n'est pas affiché. S'il est indiqué et qu'une licence est aussi présente, ils se partagent l'espace disponible.

Published property Licence: tstrings read FLicence write SetLicence;

Texte de la licence à afficher dans la boite de dialogue S'il est vide, son pavé n'est pas affiché. S'il est indiqué et qu'une description est aussi présente, ils se partagent l'espace disponible.

Published property onCloseDialog: TOlfAboutDialogCloseEvent read FonCloseDialog write SetonCloseDialog;

Evenement appelé lorsdu click sur le bouton de fermeture de la boite de dialogue

Published property onURLClick: TOlfAboutDialogURLClickEvent read FonURLClick write SetonURLClick;

Evenement appelé lorsqu'on clique sur l'URL (si URL affichée).

Published property Langue: TOlfAboutDialogLang read FLangue write SetLangue default TOlfAboutDialogLang.Auto;

Langue des textes affichés par la boite de dialogue

Published property Copyright: string read FCopyright write SetCopyright;

Copyright du projet, affiché sous le numéro de version

Published property onBeforeExecute: TNotifyEvent read FonBeforeExecute write SetonBeforeExecute;
 
Published property onAfterExecute: TNotifyEvent read FonAfterExecute write SetonAfterExecute;
 
Published property onFormCreate: TNotifyEvent read FonFormCreate write SetonFormCreate;
 
Published property onFormActivate: TNotifyEvent read FonFormActivate write SetonFormActivate;
 
Published property onFormShow: TNotifyEvent read FonFormShow write SetonFormShow;
 
Published property onFormClose: TNotifyEvent read FonFormClose write SetonFormClose;
 
Published property onButtonLicenseClick: TNotifyEvent read FonButtonLicenseClick write SetonButtonLicenseClick;
 
Published property onButtonBuyClick: TNotifyEvent read FonButtonBuyClick write SetonButtonBuyClick;
 
Published property onButtonRegisterClick: TNotifyEvent read FonButtonRegisterClick write SetonButtonRegisterClick;
 
Published property onGetText: TOlfAboutDialogGetTextEvent read FonGetText write SetonGetText;
 
Published property onGetFooterText: TOlfAboutDialogGetTextEvent read FonGetFooterText write SetonGetFooterText;
 
Published property MainFormCaptionPrefix: string read FMainFormCaptionPrefix write SetMainFormCaptionPrefix;

Used in the main form caption string between "[DEBUG]" (if any) and the program title

Published property MainFormCaptionSuffix: string read FMainFormCaptionSuffix write SetMainFormCaptionSuffix;

Used in the main form caption after the title and program version

Published property ReplaceMainFormCaption: boolean read FReplaceMainFormCaption write SetReplaceMainFormCaption default false;

Allow replacing the main form caption by the Aboutbox component. If "True", changes in MainFormCaptionPrefix, MainFormCaptionSuffix, Titre, VersionNumero erase current main form caption of the project.

About Dialog Box components (c) 2022-2025 Patrick PREMARTIN - Powered by PasDoc
Generated by PasDoc 0.16.0.