Form Class
Allows you to display a custom form window or dialog as part of a TradeStation analysis technique, strategy, or trading app.
Namespace: elsystem.windows.forms
Properties
Additional properties, methods, and events are described in the classes listed under Inheritance Hierarchy (see below).
Name | Type | Description | |
AcceptButton | object | Gets or sets the button object on the form that is clicked when the user presses the Enter key, regardless of which other control on the form has the focus.Note that the AcceptButton might not be activated if the currently selected control on the form intercepts the Enter key and processes it. For example, a multiline text box control allows the Enter key to be pressed when it is selected to insert a new line character in the control. | |
AutoScaleFactor | object | Gets the value indicating the automatic scaling being performed on a windows form. This reflects the factoring that needs to be performed on the controls based upon the Windows text sizing being "smaller", "medium", or "larger". As long as a form can resize TradeStation automatically handles the refactoring of the form controls. | |
CancelButton | object | Gets or sets the button control that is clicked when the user presses the Esc key. | |
ClientSize | object | Gets or sets the size of the client area of the form. | |
ControlBox | bool | True when a control box is displayed in the caption bar of the form. | |
FormBorderStyle | enum | Gets or sets the border style of the form. See FormBorderStyle for a list of possible values. | |
Margin | object | Reserved for future use. | |
MaximizeBox | bool | True indicates that the Maximize button is enabled in the caption bar of the form. | |
MaximumSize | object | Gets or sets the maximum size to which the form can be resized. | |
MinimizeBox | bool | True indicates that the Minimize button is enabled in the caption bar of the form. | |
MinimumSize | object | Gets or sets the minimum size to which the form can be resized. | |
Position | object | Gets or sets a Point object identifying the location of the upper left corner of the form in screen coordinates. | |
RightToLeftLayout | bool | True when the form displays child controls from right-to-left. | |
TabIndex | int | Not applicable to a form. | |
TabStop | bool | Not applicable to a form. | |
ToolTip | object | Represents a ToolTip object which is a small rectangular pop-up window that displays a brief description of a control's purpose when the user rests the pointer on the control. Note that the ToolTip object is automatically created. | |
TopMost | bool | True when the form is to be displayed always-on-top of other windows. | |
Visible | bool | True to make the form visible. False to hide it. | |
WindowState | enum | Gets or sets the state of the window. See FormWindowState for a list of possible values. |
Methods
Name | Description | |
Activate() | Activates the form and gives it focus. | |
Close() | Closes the form. | |
Create() | Creates a new instance of a form. | |
Create(text,width,height) | Creates a new instance of a form. Parameters include the Text to appear on the title bar followed by the Width and Height of the control. | |
Location(x,y) | Sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. | |
RemoveGradient() | Removes the gradient. | |
ResumeLayout() | Resumes usual layout logic. | |
SetLinearGradient(mode, startColor, endColor) | Creates a linear gradient listview background. See LinearGradientMode and Color for lists of possible values. | |
SetRadialGradient(startColor, endColor) | Creates a radial gradient listview background. See Color for a list of possible values. | |
Show() | Displays the form. | |
SuspendLayout() | Temporarily suspends the layout logic for the control. |
Event
See EventArgs for the properties returned by the event handler's args parameter unless otherwise indicated..
Name | Description | |
Activated | Occurs when the form is activated. | |
DockChanged | Occurs when the dock property of the form has changed. | |
FormClosed | Reserved for future use. See FormClosedEventArgs for event-specific properties. | |
FormClosing | Occurs when an undocked form is in the process of closing. See FormClosingEventArgs for event-specific properties | |
Resize | Occurs when a form is resized. See EventArgs for the properties returned by the handler's args parameter. | |
ResizeBegin | Occurs when a form resizing operation starts. | |
ResizeEnd | Occurs when a form resizing operation finishes. | |
Shown | Occurs when a form is shown. |