Desktop Application Object (PRIM_APPL)

Desktop application component

Ancestors - Application Object (PRIM_APP)Object (PRIM_OBJT)

Details

Desktop application component defining features of Visual LANSA Application.
 
At runtime, use the #SYS_APPLN variable name to access the object that represents your running application.

Properties

Name Description
AllowWindowsDragDrop Allow the application to respond to a Windows drag and drop
Appearance Configure the default appearance of the application
ComponentClassName ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT)
ComponentForms Collection of all forms in the application
ComponentMembers ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT)
ComponentPatternName ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT)
ComponentTag Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT)
ComponentType ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT)
ComponentTypeName ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT)
Cursors Collection of system defined cursors
EnsureVisibleForms Ensure forms show on correct monitor
FocusControl Reference to the current focus control
GlassEnabled True if the application is using the Glass feature of forms
HelpHandler Use the Help Handler to override the default F1 behavior
HintDuration Number of milliseconds that a hint will stay visible
Images Collection of system defined images
Monitors Collection of monitors available
Name Name identifies the component Inherited from Object (PRIM_OBJT)
NumericEditStyle NumericEditStyle controls insert and overtype data entry styles for numbers
OperatingSystem The name of the current desktop operating system
Owner Owner owns this component Inherited from Object (PRIM_OBJT)
Parent The component instance to which this instance is attached. The visual container for a control or the collector of a set of child instances Inherited from Object (PRIM_OBJT)
PartitionShortCharLength Returns the partition Short Char setting Inherited from Application Object (PRIM_APP)
PartitionShortCharLevel Returns the partition Short Char setting Inherited from Application Object (PRIM_APP)
PrimaryMonitor Reference to the Primary Monitor
RenderStyle Render style determined from the runtime parameter and main form
ScalingFactorHor Horizontal scaling factor
ScalingFactorVer Vertical scaling factor
ScreenHeight Height of the screen in pixels
ScreenWidth Width of the screen in pixels
ServicesManager LANSA Internal Use Inherited from Application Object (PRIM_APP)
Style Style to be applied to the whole application
Styles Collection of styles to be applied to the whole application
Theme Theme property
Theme2003Color1 Theme2003Color property
Theme2003Color2 Theme2003Color property
Theme2003Colors Theme2003Color property
ThemedForms Apply theme colors to all forms
ThemedReadOnly Show a readonly background for readonly edits in a themed application
TraceHandler User defined trace handler Inherited from Application Object (PRIM_APP)
UxThemeEnabled Enabled/Disable LANSA use of Windows UxTheme.dll
VirtualScreenHeight Height of the available screen space across all monitors
VirtualScreenLeft Left position in pixels for all monitors
VirtualScreenTop Top position in pixels for all monitors
VirtualScreenWidth Width of the available screen space across all monitors
WheelOnMouseOver Scroll controls when the mouse is over the control without being focus

Events

Name Description
CreateInstance CreateInstance is signalled when an instance of a component is created Inherited from Desktop Application Object (PRIM_APPL)
DestroyInstance DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Desktop Application Object (PRIM_APPL)
FocusControlChanged Fired when the Focus Control changes
Control
Idle Fired every 5 seconds when there is no user input from the keyboard or mouse
Seconds
IdleEnd Fired if already in idle state and there is keyboard or mouse input

Methods

Name Description
CaptureDesktop Capture a bitmap screen print of the desktop as a file
Result, FileName
CaptureWindow Capture a bitmap screen print of a window as a file
Result, FileName, Control
CloseAllDialogs Closes all open dialogs
CloseAllForms Close all open forms
ColorToRGB Covert a LANSA color name to an RGB color
Result, Color, R, G, B
ControlAtPoint Returns the control at the specified location
Control, Left, Top, ControlPart
CreateBitmap Create an instance of a bitmap (Prim_bmp)
Result, FileName, Exists
CreateColorDialog Create an instance of the Color Picker
Result
CreateFileOpenDialog Create an instance of the File Open dialog
Result
CreateFileSaveDialog Create an instance of the File Save dialog
Result
CreateFolderBrowseDialog Create an instance of the Folder Browser dialog
Result
DisableProcessGhosting Prevent Windows from replacing a busy form
ShowHelp Equivalent to pressing F1
Handled, Context, Requestor, TagString
TraceMessageData Send a string to the user defined Trace Handler Inherited from Application Object (PRIM_APP)
Source, Value1, Value2, Value3, Value4, Value5, Value6, Value7, Value8, Value9
TraceMessageText Send multiple strings to the user defined Trace Handler Inherited from Application Object (PRIM_APP)
String1, String2, String3, String4

See also

All Component Classes

Technical Reference

LANSA Version 15, April 2020