Form

Assembly: Forms;

Namespace: Prognoz.Platform.Interop.Forms;

Description

The Form class is used to create custom forms.

Comments

It is used only in the desktop application.

Fore.NET Syntax

Class to get analog of the Form class:

Prognoz.Platform.Interop.Forms.FormClassClass

Class to get analog of the Form class object:

Prognoz.Platform.Interop.Forms.FormClass_2

Constructors

	Property name	Brief description
	CreateForm	The CreateForm constructor creates a new form.

Static properties of the class inherited from IFormClass

	Property name	Brief description
	Active	The Active property returns parameters of the form that is active at the moment.
	MakeShortcut	The MakeShortcut property returns the value that corresponds to the combination of hot keys that should be assigned for any action.

Class object properties inherited from IFormControl

	Property name	Brief description
	ActiveControl	The ActiveControl property determines the component that was the last focused component on the form.
	BorderStyle	The BorderStyle property determines a component border style.
	Constraints	The Constraints property sets constraints on the component sizes in pixels.
	Icon	The Icon property determines the custom icon that is displayed in the form header.
	MainMenu	The MainMenu property determines a main menu of the form.
	MaxTabLength	The MaxTabLength property determines the maximum allowed header length of the MDI child form. If this length is exceeded in the header of tab that corresponds to this form, the shortened header is displayed.
	MDIActive	The MDIActive property determines the MDI child form that is active at the moment.
	MDIChildCount	The MDIChildCount property returns the number of MDI child forms.
	MDIChildren	The MDIChildren property returns parameters of the MDI child form.
	MDITabLocation	The MDITabLocation property determines location of the tabs of the MDI child windows in the area of the main MDI form.
	MDITabMenu	The MDITabMenu property determines the context menu that is called in the area of tabs that correspond to the MDI child forms.
	ModalResult	The ModalResult property determines result of form execution.
	ParentWindow	The ParentWindow property returns parent window.
	Position	The Position property determines position of the form window on the screen.
	Resources	The Resources property determines the resources object, from which the text and graphic values are taken for form components.
	ShowOnTaskbar	The ShowOnTaskbar property determines whether the form icon is displayed in the taskbar when the form is executed.
	StartupObject	The StartupObject property returns the description of the object that is started directly from object.
	ToolbarPopupMenu	The ToolbarPopupMenu property determines the context menu that is displayed on clicking the additional mouse button in the main menu area or in the form toolbars area.
	TopMost	The TopMost property determines how the form is placed relative to other windows during its execution.
	WindowState	The WindowState property determines state of the form on the screen during startup.
	WindowStyle	The WindowStyle property determines a form style.

Class object properties inherited from IControl

	Property name	Brief description
	Align	The Align property determines component alignment within its parent component.
	AllowDrag	The AllowDrag property determines whether an object can be dragged from a component.
	AllowDrop	The AllowDrop property determines whether a component can accept a dragged object.
	Anchors	The Anchors property returns settings determining % of the resize for the current component when the parent component is resized.
	Brush	The Brush property determines the brush that is used to fill the component area.
	ClientHeight	The ClientHeight property determines the height of the client component area.
	ClientWidth	The ClientWidth property determines the width of the client component area.
	Color	The Color property determines a component background color.
	Cursor	The Cursor property determines how the cursor looks like when is it hovered over a component during form execution.
	Enabled	The Enabled property determines whether a component is available for the user.
	Focused	The Focused property returns True if the focus is set to the component.
	Font	The Font property determines parameters of the font that is used to display text in a component.
	Height	The Height property determines component height in pixels.
	HelpContext	The HelpContext property determines a unique index for a section of a context help for this component.
	Hint	The Hint property determines a tooltip text displayed on hovering over a component.
	HintTimeout	The HintTimeout property determines for how long a tooltip is displayed.
	Left	The Left property determines a coordinate of the component left edge in pixels.
	Parent	The Parent property determines a parent component.
	ParentColor	The ParentColor property determines whether a component inherits the color of the parent component.
	ParentFont	The ParentFont property determines whether a component uses the font of the parent component.
	ParentShowHint	The ParentShowHint property determines when a tooltip is displayed.
	PopupMenu	The PopupMenu property determines the context menu displayed when a component is clicked with the right mouse button.
	Scrolls	The Scrolls property returns parameters of component's scrollbars.
	ShowHint	The ShowHint property determines whether a tooltip is displayed when a component is hovered.
	TabOrder	The TabOrder property determines a component position in a tab order.
	TabStop	The TabStop property determines whether the component must be focused when the Tab button is pressed.
	Text	The Text property determines a row identifying a component for the user.
	Top	The Top property determines a coordinate of the component top edge in pixels.
	Visible	The Visible property determines whether the component is displayed when a form is executed.
	Width	The Width property determines horizontal size of a component in pixels.

Class object properties inherited from IComponent

	Property name	Brief description
	ComponentCount	The ComponentCount property returns the number of child components located on the parent component.
	Components	The Components property returns the child component, which index is passed by the input parameter.
	Data	The Data property is used to store any custom data.
	Name	The Name property determines a component name.
	Tag	The compiler does not use the Tag property. The user can change the value of the Tag property and use it as he wishes.

Class object methods inherited from IFormControl

	Method name	Brief description
	BeginOperation	The BeginOperation method activates the status bar, which displays text, timer and animated progress bar.
	BeginUpdate	The BeginUpdate method deactivates form rerendering.
	Close	The Close method closes a form.
	EndOperation	The EndOperation method deactivates process indicator.
	EndUpdate	The EndUpdate method resumes form rerendering.
	EnterContextHelpMode	The EnterContextHelpMode method turns a form in the help display mode.
	FreeComponent	The FreeComponent method enables the user to visually remove a component.
	LoadState	The LoadState method loads parameters of the form controls from the registry.
	MDICascade	The MDICascade method places all child windows in the cascade mode.
	MDIIconArrange	The MDIIconArrange method arranges all minimized MDI child forms.
	MDIMaximize	The MDIMaximize method maximizes the specified MDI child form within the parent form.
	MDIMinimize	The MDIMinimize method minimizes the specified MDI child form within the parent form.
	MDINext	The MDINext method activates a window of the next MDI child form.
	MDIPrev	The MDIPrev method activates a window of the previous MDI child form.
	MDIRestore	The MDIRestore method restores the initial sizes of the window of the specified MDI child form.
	MDITile	The MDITile method forms all child windows in the specified order.
	PostCommand	The PostCommand method enables sending a command to a form.
	SaveState	The SaveState method saves parameters of the form controls in the registry.
	SendCommand	The SendCommand methods enables sending the command to a form and get result of its execution.
	SetOperationText	The SetOperationText method changes the text that is displayed in the status bar.
	ShowModal	The ShowModal method enables the user to open modally the form, for which this method is called.

Class object methods inherited from IControl

	Method name	Brief description
	BringToFront	Outdated.The BringToFront method brings the component to front.
	ClientToScreen	The ClientToScreen method converts point coordinates specified relative to the component's coordinate system into screen coordinates.
	DoDragDrop	The DoDragDrop method enables the user to start dragging operation.
	GetImage	The GetImage method returns a graphic presentation of a component together with all child components.
	ScreenToClient	The ScreenToClient method converts point's screen coordinates into coordinates specified relative to the component's coordinate system.
	SendToBack	Outdated. The SendToBack method sends the component to back.
	SetFocus	The SetFocus method sets focus to this component.

Events

	Event name	Brief description
	OnActivate	The OnActivate event occurs when the form or one of its child components receives focus.
	OnClose	The OnClose event occurs right before a form is closed.
	OnCloseQuery	The OnCloseQuery event occurs when the form receives a command for closing.
	OnCommand	The OnCommand event occurs when a command is sent to this form from another one.
	OnCreate	The OnCreate event occurs at the moment a form is created.
	OnDeactivate	The OnDeactivate event occurs when the form or one of its child components loses focus.
	OnHelp	The OnHelp event occurs when the component is pressed if the mode of help displaying is active or on pressing the F1 button for the active component.
	OnHide	The OnHide event occurs right before form becomes invisible.
	OnMDIActivate	The OnMDIActivate event occurs when an active child MDI form is changed.
	OnMDIClose	The OnMDIClose event occurs before the MDI child form is closed.
	OnResize	The OnResize event occurs after the form size has been changed.
	OnShow	The OnShow event occurs right before a form is displayed.

Events inherited from IControl

	Event name	Brief description
	OnBeginDrag	The OnBeginDrag event occurs for a component, when the user starts to drag an object from the component.
	OnClick	The OnClick event occurs if the user clicks a component area with the main mouse button.
	OnControlMove	The OnControlMove event occurs when the component is moved.
	OnControlResize	The OnControlResize event occurs when the component is resized.
	OnDblClick	The OnDblClick event occurs if the user double-clicks the component area with the mouse button.
	OnDragDrop	The OnDragDrop event occurs for the component if the user drops a dragged object over it.
	OnDragEnter	The OnDragEnter event occurs when a dragged object enters the component area.
	OnDragLeave	The OnDragLeave event occurs when a dragged object leaves component borders.
	OnDragOver	The OnDragOver event occurs for the component when the user drags an object over it.
	OnEnter	The OnEnter event occurs when the component receives focus.
	OnExit	The OnExit event occurs when the component loses focus.
	OnHScroll	The OnHScroll event occurs when horizontal scrollbar slider changes its position.
	OnKeyDown	The OnKeyDown event occurs if the component is focused and a keyboard key is pressed.
	OnKeyPress	The OnKeyPress event occurs if the component is focused when the user presses a character key.
	OnKeyPreview	The OnKeyPreview event occurs prior to each event related to key pressing.
	OnKeyUp	The OnKeyUp event occurs if the component is focused and the user releases any button previously pressed.
	OnMouseDown	The OnMouseDown event occurs if the pointer is in the component area and a mouse key is pressed.
	OnMouseEnter	The OnMouseEnter event occurs when the mouse cursor enters the component area.
	OnMouseHover	The OnMouseHover event occurs when the mouse cursor is held in the component area.
	OnMouseLeave	The OnMouseLeave event occurs when the mouse cursor leaves the component area.
	OnMouseMove	The OnMouseMove event occurs when the mouse cursor moves over a component.
	OnMouseUp	The OnMouseUp event occurs when the mouse button is released and the cursor is in the component area.
	OnMouseWheel	The OnMouseWheel event occurs if the component is focused when the user rotates a mouse wheel.
	OnVScroll	The OnVScroll event occurs when vertical scrollbar slider changes its position.

See also:

Forms Assembly Classes