Form (PRIM_FORM)
Form is a display area representing a window
Ancestors - Container (PRIM_CPST)Control (PRIM_CTRL)Object (PRIM_OBJT)
Details
A Form is a display area representing a window.
All LANSA desktop applications are started by executing a Form
Properties
Name |
Description |
System icons shown in the top right corner of the form |
|
BusyCancelResult sets the behavior of the component during update operations |
|
BusyUpdates specifies how the control updates itself Inherited from Control (PRIM_CTRL) |
|
BusyUpdatesOfParent specifies whether the parent controls updates Inherited from Control (PRIM_CTRL) |
|
CanFocus returns a value indicating whether the control can receive keyboard focus Inherited from Control (PRIM_CTRL) |
|
Text shown in the title bar of the window |
|
ClientHeight specifies the height of the area inside the form |
|
ClientWidth specifies the width of the area inside the form |
|
ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT) |
|
ComponentControls is a collection of all the controls contained in this component. Inherited from Container (PRIM_CPST) |
|
ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT) |
|
ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT) |
|
Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT) |
|
ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT) |
|
ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT) |
|
Variant of the control being used |
|
Cursor sets the cursor image Inherited from Control (PRIM_CTRL) |
|
DisplayPosition determines the order in which components are shown Inherited from Control (PRIM_CTRL) |
|
DragStyle determines how a component can be dragged Inherited from Control (PRIM_CTRL) |
|
EnableChildren specifies if the parent sets the Enabled property of child components Inherited from Container (PRIM_CPST) |
|
Enable activates/deactivates the component Inherited from Control (PRIM_CTRL) |
|
Ensure that a form is shown on a monitor that is active |
|
Fix the control position so that it does not move if the parent is scrolled Inherited from Control (PRIM_CTRL) |
|
Focus tells whether the component has focus Inherited from Control (PRIM_CTRL) |
|
Reference to a style to be applied when the control is focus Inherited from Control (PRIM_CTRL) |
|
Collection of styles to be applied when the control is focus Inherited from Control (PRIM_CTRL) |
|
The form to which this form belongs in a stack of modal forms |
|
FormPosition specifies the form's position when first shown |
|
Determines how the form behaves in a multiform application |
|
FrameStyle sets the style of a form's frame |
|
Allows a form to use a semi-opaque glass background |
|
Returns the Windows handle in desktop applications Inherited from Control (PRIM_CTRL) |
|
The height of the control in pixels Inherited from Control (PRIM_CTRL) |
|
Caption displayed when the mouse hovers over the control Inherited from Control (PRIM_CTRL) |
|
HintPopup allows a PopupPanel instance to be used instead of the default hint text box Inherited from Control (PRIM_CTRL) |
|
Enabled or disable the appearance of hints Inherited from Control (PRIM_CTRL) |
|
Delegate hints appearance to the parent control Inherited from Control (PRIM_CTRL) |
|
HintTitle defines the text shown at the top of the hint window in emphasized text Inherited from Control (PRIM_CTRL) |
|
Image displayed on the left side of the title bar |
|
Image displayed as the form background |
|
Position of the image within the form |
|
IsAnimating indicates that a control is currently being animated Inherited from Control (PRIM_CTRL) |
|
True if the control is currently realized Inherited from Control (PRIM_CTRL) |
|
Reference to a layout manager used to control the position of child controls |
|
Position of the control relative to the left boundary of its parent Inherited from Control (PRIM_CTRL) |
|
Reference to a menubar to be shown at the top of the form |
|
ModalResult tells how a modal form was closed |
|
Modified indicates that the contents of the component have changed Inherited from Control (PRIM_CTRL) |
|
MouseOver determines whether the mouse is directly over a control Inherited from Control (PRIM_CTRL) |
|
True if the cursor is within the bounds of a child component Inherited from Container (PRIM_CPST) |
|
MouseOverStyle defines the style to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL) |
|
MouseOverStyles is a collection of styles to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL) |
|
Name identifies the component Inherited from Object (PRIM_OBJT) |
|
NormalHeight returns information about the height property of the form in its restored size |
|
NormalLeft returns information about the left property of the form in its restored size |
|
NormalTop returns information about the top property of the form in its restored size |
|
NormalWidth returns information about the width property of the form in its restored size |
|
Opacity denotes the appearance of a control in terms of its interaction with its background Inherited from Control (PRIM_CTRL) |
|
Owner owns this component Inherited from Object (PRIM_OBJT) |
|
The starting form or owner of the application |
|
Popup allows a PopupPanel instance to be used instead of the typical right click popup menu Inherited from Control (PRIM_CTRL) |
|
Reference to a PopupMenu to be shown on a right click Inherited from Control (PRIM_CTRL) |
|
Style applied to the control but not inherited by child controls Inherited from Container (PRIM_CPST) |
|
Collection of styles applied to the control but not inherited by child controls Inherited from Container (PRIM_CPST) |
|
Defines the whether the form should render using DirectX, Win32 or defer to the application |
|
Rotation allows a control to rotate a number of degrees about a given origin Inherited from Control (PRIM_CTRL) |
|
RotationOriginLeft defines the left coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL) |
|
RotationOriginTop defines the top coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL) |
|
ScaleHeight is the percentage of the height to use in the visual appearance of a control Inherited from Control (PRIM_CTRL) |
|
ScaleOriginLeft defines the left coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL) |
|
ScaleOriginTop defines the top coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL) |
|
ScaleWidth is the percentage of the width to use in the visual appearance of a control Inherited from Control (PRIM_CTRL) |
|
Horizontal scaling factor |
|
Vertical scaling factor |
|
ScreenLeft sets the distance from the left of the screen Inherited from Control (PRIM_CTRL) |
|
ScreenTop sets the distance from the top of the screen Inherited from Control (PRIM_CTRL) |
|
Left position of a horizontally scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL) |
|
Top position of a vertically scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL) |
|
Defines whether a form is shown in the Windows desktop Taskbar |
|
SkewLeft defines the angle at which to skew the control horizontally Inherited from Control (PRIM_CTRL) |
|
SkewOriginLeft defines the left coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL) |
|
SkewOriginTop defines the top coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL) |
|
SkewTop defines the angle at which to skew the control vertically Inherited from Control (PRIM_CTRL) |
|
Style defines the style to be applied to a control Inherited from Control (PRIM_CTRL) |
|
Collection of styles to be applied to the control Inherited from Control (PRIM_CTRL) |
|
TabPosition sets the order of focus when the Tab key is used Inherited from Control (PRIM_CTRL) |
|
Set to false to stop focus being given to the control via the Tab key Inherited from Control (PRIM_CTRL) |
|
Reference to a form TaskBar instance allowing a form to interact with the Windows Task Bar |
|
Theme is the name of the repository defined Theme to be used for this form. |
|
Name of the Theme DrawStyle to be applied to the form |
|
Specifies how theme usage is determined |
|
TitleBarVisible hides/shows the title bar |
|
Position of the control relative to the top boundary of its parent Inherited from Control (PRIM_CTRL) |
|
Determines how the control will respond to touch move processing Inherited from Control (PRIM_CTRL) |
|
Determines how the control will respond to touch rotation Inherited from Control (PRIM_CTRL) |
|
Determines how the control will respond to touch scaling Inherited from Control (PRIM_CTRL) |
|
Determines whether a control can be resized Inherited from Control (PRIM_CTRL) |
|
Show or hide the control Inherited from Control (PRIM_CTRL) |
|
VisualStyle sets the appearance Inherited from Control (PRIM_CTRL) |
|
Adopt the Visual style from the parent control Inherited from Control (PRIM_CTRL) |
|
Width of the component in pixels Inherited from Control (PRIM_CTRL) |
|
WindowState controls how the window is displayed |
Events
Name |
Description |
Fired when the form becomes the active window |
|
Fired when an animation is ended [Inherited from Form (PRIM_FORM) Cancelled |
|
Fired when the mouse is clicked on the control Origin, Handled |
|
Fired when the form is about to close Continue |
|
Closing event happens when the user closes the form Action |
|
CreateInstance is signalled when an instance of a component is created [Inherited from Form (PRIM_FORM) |
|
Deactivate event happens when the form is deactivated |
|
DestroyInstance is signalled when an instance of a component is about to be destroyed [Inherited from Form (PRIM_FORM) |
|
Fired when the user double clicks Origin, Handled |
|
Fired on mouse up to signify the end of a drag process [Inherited from Form (PRIM_FORM) PosX, PosY, Source, Payload, AggregatedSource, Origin, Handled, DragResult |
|
Fired during the drag and drop process when the cursor moves over the control [Inherited from Form (PRIM_FORM) PosX, PosY, Source, Payload, DragState, AcceptDrop, DragCursor, ShowDropHilight, AggregatedSource, Origin, Handled |
|
Fired when the drag and drop process has completed [Inherited from Form (PRIM_FORM) Source, Payload, DragResult, AggregatedSource, Origin, Handled |
|
Fired when the control receives the focus |
|
Fired after a component has been realized for the first time [Inherited from Form (PRIM_FORM) |
|
LostFocus happens when a component is no longer active |
|
The mouse has entered the bounds of the control [Inherited from Form (PRIM_FORM) |
|
The mouse has hovered over the control [Inherited from Form (PRIM_FORM) Origin, Handled |
|
The mouse has left the bounds of the control [Inherited from Form (PRIM_FORM) |
|
The form has changed size |
|
Fired when the user starts a drag and drop process [Inherited from Form (PRIM_FORM) Source, Payload, Continue, DragList, AggregatedSource, Origin, Handled |
|
Fired repeatedly between the TouchStart and TouchEnd boundaries to provide details of the touch events [Inherited from Form (PRIM_FORM) MoveLeft, MoveTop, ScaleWidth, ScaleHeight, Rotation, Continue |
|
Fired when the user stops touching the screen [Inherited from Form (PRIM_FORM) |
|
Fired when the user first makes physical contact with the screen [Inherited from Form (PRIM_FORM) Origin, TouchMove, TouchRotate, TouchScale, TouchSize |
Methods
Name |
Description |
Forces the form to become the active window |
|
CloseForm closes the form |
|
Close the form and fire the CloseFormQuery event to allow for confirmation |
|
Animate from invisible to visible Inherited from Control (PRIM_CTRL) Duration, Delay |
|
Animate from visible to invisible Inherited from Control (PRIM_CTRL) Duration, Delay, Visible |
|
HideForm hides the form |
|
MaximizeForm maximizes the form so the it fills the screen |
|
MinimizeForm minimizes the form |
|
Move a control from the specified position to the current position Inherited from Control (PRIM_CTRL) Left, Top, Duration, Delay |
|
Animate a move from the specified number of pixels Inherited from Control (PRIM_CTRL) Left, Top, Duration, Delay |
|
Creates the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL) |
|
RestoreForm method restores the form's size |
|
Animate a change of scale Inherited from Control (PRIM_CTRL) ScaleWidth, ScaleHeight, Duration, Delay |
|
Sets the control to be the focus control Inherited from Control (PRIM_CTRL) |
|
ShowForm shows the form |
|
LANSA Internal Use Inherited from Control (PRIM_CTRL) |
|
ShowModalForm method shows the form and makes it modal |
|
Changes and animates control size changing Inherited from Control (PRIM_CTRL) Width, Height, Duration, Delay |
|
Animate the change from one control to another Inherited from Container (PRIM_CPST) From, To, TransitionType, Duration, Delay |
|
Destroys the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL) |
|
UpdateDisplay updates the display immediately Inherited from Control (PRIM_CTRL) |