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 |
|---|---|
| BorderIcons | System icons shown in the top right corner of the form |
| BusyCancelResult | BusyCancelResult sets the behavior of the component during update operations |
| BusyUpdates | BusyUpdates specifies how the control updates itself Inherited from Control (PRIM_CTRL) |
| BusyUpdatesOfParent | BusyUpdatesOfParent specifies whether the parent controls updates Inherited from Control (PRIM_CTRL) |
| CanFocus | CanFocus returns a value indicating whether the control can receive keyboard focus Inherited from Control (PRIM_CTRL) |
| Caption | Text shown in the title bar of the window |
| ClientHeight | ClientHeight specifies the height of the area inside the form |
| ClientWidth | ClientWidth specifies the width of the area inside the form |
| ComponentClassName | ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT) |
| ComponentControls | ComponentControls is a collection of all the controls contained in this component. Inherited from Container (PRIM_CPST) |
| 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) |
| ComponentVersion | Variant of the control being used |
| Cursor | Cursor sets the cursor image Inherited from Control (PRIM_CTRL) |
| DisplayPosition | DisplayPosition determines the order in which components are shown Inherited from Control (PRIM_CTRL) |
| DragStyle | DragStyle determines how a component can be dragged Inherited from Control (PRIM_CTRL) |
| EnableChildren | EnableChildren specifies if the parent sets the Enabled property of child components Inherited from Container (PRIM_CPST) |
| Enabled | Enable activates/deactivates the component Inherited from Control (PRIM_CTRL) |
| EnsureVisible | Ensure that a form is shown on a monitor that is active |
| FixedPosition | Fix the control position so that it does not move if the parent is scrolled Inherited from Control (PRIM_CTRL) |
| Focus | Focus tells whether the component has focus Inherited from Control (PRIM_CTRL) |
| FocusedStyle | Reference to a style to be applied when the control is focus Inherited from Control (PRIM_CTRL) |
| FocusedStyles | Collection of styles to be applied when the control is focus Inherited from Control (PRIM_CTRL) |
| FormOwner | The form to which this form belongs in a stack of modal forms |
| FormPosition | FormPosition specifies the form's position when first shown |
| FormStyle | Determines how the form behaves in a multiform application |
| FrameStyle | FrameStyle sets the style of a form's frame |
| Glass | Allows a form to use a semi-opaque glass background |
| Handle | Returns the Windows handle in desktop applications Inherited from Control (PRIM_CTRL) |
| Height | The height of the control in pixels Inherited from Control (PRIM_CTRL) |
| Hint | Caption displayed when the mouse hovers over the control Inherited from Control (PRIM_CTRL) |
| HintPopup | HintPopup allows a PopupPanel instance to be used instead of the default hint text box Inherited from Control (PRIM_CTRL) |
| HintShow | Enabled or disable the appearance of hints Inherited from Control (PRIM_CTRL) |
| HintShowOfParent | Delegate hints appearance to the parent control Inherited from Control (PRIM_CTRL) |
| HintTitle | HintTitle defines the text shown at the top of the hint window in emphasized text Inherited from Control (PRIM_CTRL) |
| Icon | Image displayed on the left side of the title bar |
| Image | Image displayed as the form background |
| ImageAlignment | Position of the image within the form |
| IsAnimating | IsAnimating indicates that a control is currently being animated Inherited from Control (PRIM_CTRL) |
| IsRealized | True if the control is currently realized Inherited from Control (PRIM_CTRL) |
| LayoutManager | Reference to a layout manager used to control the position of child controls |
| Left | Position of the control relative to the left boundary of its parent Inherited from Control (PRIM_CTRL) |
| MenuBar | Reference to a menubar to be shown at the top of the form |
| ModalResult | ModalResult tells how a modal form was closed |
| Modified | Modified indicates that the contents of the component have changed Inherited from Control (PRIM_CTRL) |
| MouseOver | MouseOver determines whether the mouse is directly over a control Inherited from Control (PRIM_CTRL) |
| MouseOverPart | True if the cursor is within the bounds of a child component Inherited from Container (PRIM_CPST) |
| MouseOverStyle | MouseOverStyle defines the style to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL) |
| MouseOverStyles | MouseOverStyles is a collection of styles to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL) |
| Name | Name identifies the component Inherited from Object (PRIM_OBJT) |
| NormalHeight | NormalHeight returns information about the height property of the form in its restored size |
| NormalLeft | NormalLeft returns information about the left property of the form in its restored size |
| NormalTop | NormalTop returns information about the top property of the form in its restored size |
| NormalWidth | NormalWidth returns information about the width property of the form in its restored size |
| Opacity | Opacity denotes the appearance of a control in terms of its interaction with its background Inherited from Control (PRIM_CTRL) |
| Owner | Owner owns this component Inherited from Object (PRIM_OBJT) |
| Parent | The starting form or owner of the application |
| Popup | Popup allows a PopupPanel instance to be used instead of the typical right click popup menu Inherited from Control (PRIM_CTRL) |
| PopupMenu | Reference to a PopupMenu to be shown on a right click Inherited from Control (PRIM_CTRL) |
| PrivateStyle | Style applied to the control but not inherited by child controls Inherited from Container (PRIM_CPST) |
| PrivateStyles | Collection of styles applied to the control but not inherited by child controls Inherited from Container (PRIM_CPST) |
| RenderStyle | Defines the whether the form should render using DirectX, Win32 or defer to the application |
| Rotation | Rotation allows a control to rotate a number of degrees about a given origin Inherited from Control (PRIM_CTRL) |
| RotationOriginLeft | RotationOriginLeft defines the left coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL) |
| RotationOriginTop | RotationOriginTop defines the top coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL) |
| ScaleHeight | ScaleHeight is the percentage of the height to use in the visual appearance of a control Inherited from Control (PRIM_CTRL) |
| ScaleOriginLeft | ScaleOriginLeft defines the left coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL) |
| ScaleOriginTop | ScaleOriginTop defines the top coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL) |
| ScaleWidth | ScaleWidth is the percentage of the width to use in the visual appearance of a control Inherited from Control (PRIM_CTRL) |
| ScalingFactorHor | Horizontal scaling factor |
| ScalingFactorVer | Vertical scaling factor |
| ScreenLeft | ScreenLeft sets the distance from the left of the screen Inherited from Control (PRIM_CTRL) |
| ScreenTop | ScreenTop sets the distance from the top of the screen Inherited from Control (PRIM_CTRL) |
| ScrollLeft | Left position of a horizontally scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL) |
| ScrollTop | Top position of a vertically scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL) |
| ShowInTaskbar | Defines whether a form is shown in the Windows desktop Taskbar |
| SkewLeft | SkewLeft defines the angle at which to skew the control horizontally Inherited from Control (PRIM_CTRL) |
| SkewOriginLeft | SkewOriginLeft defines the left coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL) |
| SkewOriginTop | SkewOriginTop defines the top coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL) |
| SkewTop | SkewTop defines the angle at which to skew the control vertically Inherited from Control (PRIM_CTRL) |
| Style | Style defines the style to be applied to a control Inherited from Control (PRIM_CTRL) |
| Styles | Collection of styles to be applied to the control Inherited from Control (PRIM_CTRL) |
| TabPosition | TabPosition sets the order of focus when the Tab key is used Inherited from Control (PRIM_CTRL) |
| TabStop | Set to false to stop focus being given to the control via the Tab key Inherited from Control (PRIM_CTRL) |
| Taskbar | Reference to a form TaskBar instance allowing a form to interact with the Windows Task Bar |
| Theme | Theme is the name of the repository defined Theme to be used for this form. |
| ThemeDrawStyle | Name of the Theme DrawStyle to be applied to the form |
| ThemeStyle | Specifies how theme usage is determined |
| TitleBarVisible | TitleBarVisible hides/shows the title bar |
| Top | Position of the control relative to the top boundary of its parent Inherited from Control (PRIM_CTRL) |
| TouchMove | Determines how the control will respond to touch move processing Inherited from Control (PRIM_CTRL) |
| TouchRotate | Determines how the control will respond to touch rotation Inherited from Control (PRIM_CTRL) |
| TouchScale | Determines how the control will respond to touch scaling Inherited from Control (PRIM_CTRL) |
| TouchSize | Determines whether a control can be resized Inherited from Control (PRIM_CTRL) |
| Visible | Show or hide the control Inherited from Control (PRIM_CTRL) |
| VisualStyle | VisualStyle sets the appearance Inherited from Control (PRIM_CTRL) |
| VisualStyleOfParent | Adopt the Visual style from the parent control Inherited from Control (PRIM_CTRL) |
| Width | Width of the component in pixels Inherited from Control (PRIM_CTRL) |
| WindowState | WindowState controls how the window is displayed |
Events
| Name | Description |
|---|---|
| Activate | Fired when the form becomes the active window |
| AnimationEnded | Fired when an animation is ended Inherited from Form (PRIM_FORM) Cancelled |
| Click | Fired when the mouse is clicked on the control
Origin, Handled |
| CloseQuery | Fired when the form is about to close
Continue |
| Closing | Closing event happens when the user closes the form
Action |
| CreateInstance | CreateInstance is signalled when an instance of a component is created Inherited from Form (PRIM_FORM) |
| Deactivate | Deactivate event happens when the form is deactivated |
| DestroyInstance | DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Form (PRIM_FORM) |
| DoubleClick | Fired when the user double clicks
Origin, Handled |
| DragDrop | 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 |
| DragOver | 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 |
| EndDrag | Fired when the drag and drop process has completed Inherited from Form (PRIM_FORM) Source, Payload, DragResult, AggregatedSource, Origin, Handled |
| GotFocus | Fired when the control receives the focus |
| Initialize | Fired after a component has been realized for the first time Inherited from Form (PRIM_FORM) |
| LostFocus | LostFocus happens when a component is no longer active |
| MouseEnter | The mouse has entered the bounds of the control Inherited from Form (PRIM_FORM) |
| MouseHover | The mouse has hovered over the control Inherited from Form (PRIM_FORM) Origin, Handled |
| MouseLeave | The mouse has left the bounds of the control Inherited from Form (PRIM_FORM) |
| SizeChanged | The form has changed size |
| StartDrag | Fired when the user starts a drag and drop process Inherited from Form (PRIM_FORM) Source, Payload, Continue, DragList, AggregatedSource, Origin, Handled |
| TouchChange | 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 |
| TouchEnd | Fired when the user stops touching the screen Inherited from Form (PRIM_FORM) |
| TouchStart | Fired when the user first makes physical contact with the screen Inherited from Form (PRIM_FORM) Origin, TouchMove, TouchRotate, TouchScale, TouchSize |
Methods
| Name | Description |
|---|---|
| ActivateForm | Forces the form to become the active window |
| CloseForm | CloseForm closes the form |
| CloseFormQuery | Close the form and fire the CloseFormQuery event to allow for confirmation |
| FadeIn | Animate from invisible to visible Inherited from Control (PRIM_CTRL) Duration, Delay |
| FadeOut | Animate from visible to invisible Inherited from Control (PRIM_CTRL) Duration, Delay, Visible |
| HideForm | HideForm hides the form |
| MaximizeForm | MaximizeForm maximizes the form so the it fills the screen |
| MinimizeForm | MinimizeForm minimizes the form |
| MoveFrom | Move a control from the specified position to the current position Inherited from Control (PRIM_CTRL) Left, Top, Duration, Delay |
| MoveTo | Animate a move from the specified number of pixels Inherited from Control (PRIM_CTRL) Left, Top, Duration, Delay |
| Realize | Creates the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL) |
| RestoreForm | RestoreForm method restores the form's size |
| Scale | Animate a change of scale Inherited from Control (PRIM_CTRL) ScaleWidth, ScaleHeight, Duration, Delay |
| SetFocus | Sets the control to be the focus control Inherited from Control (PRIM_CTRL) |
| ShowForm | ShowForm shows the form |
| ShowMessages | LANSA Internal Use Inherited from Control (PRIM_CTRL) |
| ShowModalForm | ShowModalForm method shows the form and makes it modal |
| SizeTo | Changes and animates control size changing Inherited from Control (PRIM_CTRL) Width, Height, Duration, Delay |
| Transition | Animate the change from one control to another Inherited from Container (PRIM_CPST) From, To, TransitionType, Duration, Delay |
| Unrealize | Destroys the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL) |
| UpdateDisplay | UpdateDisplay updates the display immediately Inherited from Control (PRIM_CTRL) |
See also
LANSA Version 15, April 2020