TApplicationProperties class

In unit Forms

A component that provides access to the properties for the current application.

Declaration

pascal

TApplicationProperties = class(TLCLComponent)

Inheritance

TApplicationProperties
TLCLComponent
TComponent
TPersistent
TObject

Description

TApplicationProperties is a non-visual component used to provide design-time settings that are applied at run-time to an application, including:

CaptureExceptions
HelpFile
Hint
HintColor
HintHidePause
HintPause
HintShortCuts
HintShortPause
ShowButtonGlyphs
ShowMenuGlyphs
ShowHint
ShowMainForm
Title
OnException
OnGetMainFormHandle
OnIdle
OnIdleEnd
OnEndSession
OnQueryEndSession
OnMinimize
OnModalBegin
OnModalEnd
OnRestore
OnDropFiles
OnHelp
OnHint
OnShowHint
OnUserInput

Values for the properties are assigned in the constructor using the currently assigned values in the Application singleton. The assignments can be maintained at design-time.

At run-time, changes to the properties are also assigned to the Application singleton. For event handler properties, the previous routine is removed as a handler and the new handler is added to the Application singleton. When the component is freed, the event handlers are removed from the Application singleton. The changed properties are not assigned to the Application singleton at design-time.

TApplicationProperties is available on the Additional tab in the Lazarus IDE Component Palette. TApplicationProperties is similar to the TApplicationEvents class in Delphi.

Properties

`CaptureExceptions`	published	Enables exception handling in the Application.
`ExceptionDialog`	published	Indicates the dialog type displayed for an exception.
`GlyphDrawEffectsEnabled`	published
`HelpFile`	published	Contains the name for the help file in an application.
`Hint`	published	The current Hint text active for the application.
`HintColor`	published	The background color for a Hint window.
`HintHidePause`	published	Indicates how long a Hint remains visible after the mouse pointer is moved.
`HintPause`	published	The delay before a Hint is shown for a form or control.
`HintShortCuts`	published	Enables or disables display of keyboard shortcuts (e. g. on menu items).
`HintShortPause`	published	The pause before a different Hint is displayed.
`ShowButtonGlyphs`	published	Allows the platform defaults for glyphs on buttons to be overridden.
`ShowMenuGlyphs`	published	Sets the default policy for showing or hiding glyph images in menus.
`ShowHint`	published	Indicates if Hints are displayed for the application.
`ShowMainForm`	published	Allows the main form to be shown or hidden when an application is started.
`Title`	published	Contains the title for the application.

Methods

`SetCaptureExceptions`	protected	Sets the value for the CaptureExceptions property.
`SetGlyphDrawEffectsEnabled`	protected
`SetHelpFile`	protected	Sets the value for the HelpFile property.
`SetHint`	protected	Sets the value for the Hint property.
`SetHintColor`	protected	Sets the value for the HintColor property.
`SetHintHidePause`	protected	Sets the value for the HintHidePause property.
`SetHintPause`	protected	Sets the value for the HintPause property.
`SetHintShortCuts`	protected	Sets the value for the HintShortCuts property.
`SetHintShortPause`	protected	Sets the value for the HintShortPause property.
`SetShowButtonGlyphs`	protected	Sets the value for the ShowButtonGlyphs property.
`SetShowMenuGlyphs`	protected	Sets the value for the ShowMenuGlyphs property.
`SetShowHint`	protected	Sets the value for the ShowHint property.
`SetShowMainForm`	protected	Sets the value for the ShowMainForm property.
`SetTitle`	protected	Sets the value for the Title property.
`SetOnActivate`	protected	Sets the value for the OnActivate property.
`SetOnDeactivate`	protected	Sets the value for the OnDeactivate property.
`SetOnException`	protected	Sets the value for the OnException property.
`SetOnGetMainFormHandle`	protected	Sets the value for the OnGetMainFormHandle property.
`SetOnIdle`	protected	Sets the value for the OnIdle property.
`SetOnIdleEnd`	protected	Sets the value for the OnIdleEnd property.
`SetOnEndSession`	protected	Sets the value for the OnEndSession property.
`SetOnQueryEndSession`	protected	Sets the value for the OnQueryEndSession property.
`SetOnMinimize`	protected	Sets the value for the OnMinimize property.
`SetOnModalBegin`	protected	Sets the value for the OnModalBegin property.
`SetOnModalEnd`	protected	Sets the value for the OnModalEnd property.
`SetOnRestore`	protected	Sets the value for the OnRestore property.
`SetOnDropFiles`	protected	Sets the value for the OnDropFiles property.
`SetOnHelp`	protected	Sets the value for the OnHelp property.
`SetOnHint`	protected	Sets the value for the OnHint property.
`SetOnShowHint`	protected	Sets the value for the OnShowHint property.
`SetOnUserInput`	protected	Sets the value for the OnUserInput property.
`SetOnActionExecute`	protected	Sets the value for the OnActionExecute property.
`SetOnActionUpdate`	protected	Sets the value for the OnActionUpdate property.
`Create`	public	Constructor for the class instance.
`Destroy`	public	Destructor for the class instance.

Events

`OnActivate`	published	Event handler signalled when an Activate message is handled in the application.
`OnDeactivate`	published	Event handler signalled when a Deactivate message is handled in the application.
`OnException`	published	Event handler signalled to handle an exception in an application.
`OnGetMainFormHandle`	published	Event handler used to provide a value for the MainFormHandle property.
`OnIdle`	published	Event handler signalled when the application enters the idle state.
`OnIdleEnd`	published	Event handler signalled when the application leaves the Idle state.
`OnEndSession`	published	Event handler signalled when a session is ended in the application.
`OnQueryEndSession`	published	Event handler signalled to determine if the current session be be ended, and the application can be closed.
`OnMinimize`	published	Event handler signalled when the application is minimized.
`OnModalBegin`	published	Event handler signalled when a form in the application is displayed as a modal form.
`OnModalEnd`	published	Event handler signalled when the last modal form for the application has been exited.
`OnRestore`	published	Event handler signalled when the application is restored from a minimized / maximized state.
`OnDropFiles`	published	Event handler signalled when file(s) are dropped into the application.
`OnHelp`	published	Event handler signalled when help is requested in the application.
`OnHint`	published	Event handler signalled when a hint is requested in the application.
`OnShowHint`	published	Event handler signalled prior to displaying a hint window.
`OnUserInput`	published	Event handler signalled to handle user input messages.
`OnActionExecute`	published	Default handler for unhandled Actions.
`OnActionUpdate`	published	Event handler signalled to update actions used in the application.