The FormInterface object is used as a wrapper around the form class used to display a form in the application. It manages the addition and removal of all the elements placed on it, as well as all of the ribbon pages created through it. It also manages the layout loading process.

Properties

Form: This property returns the underlying form managed by the FormInterface. It can be used for fine-tuned control over the form's properties.

This property allows access to a complicated object. The underlying form should only be used by addon developers that are also experienced with .Net because incorrect use of the underlying form can result in unexpected behavior that cannot be supported.
Name: Returns the name of the form. This is the text that is displayed on the form's tab as well as the string that is used to retrieve the form using the ScriptInterfaceManager.GetForm method.

Methods

CreateBrowser(string name, string label, string ribbonPageName)

Creates a Browser object that can be used for interacting with web pages.

Parameter Direction	Parameter Name	Parameter Description
Input	name	The name of the new browser, which is also used as the text for the browser tab
Input	label	The text to use for the Browser control's label.
Input	ribbonPageName	The name to use for the page the browser's buttons will be placed on.
Output	Browser

CreateCheckEdit(string name, string label)

Creates a CheckEdit control which users can check or uncheck.

Parameter Direction	Parameter Name	Parameter Description
Input	name	The name of the control, which is used when attempting to retrieve it.
Input	label	The text to use for the control's label.
Output	CheckEdit

CreateComboBoxEdit(string name, string label)

Creates a ComboBoxEdit control which users can use to select an option from a drop down list.

Parameter Direction	Parameter Name	Parameter Description
Input	name	The name of the control, which is used when attempting to retrieve it.
Input	label	The text to use for the control's label.
Output	ComboBoxEdit

CreateGrid(string name, string label)

Creates a Grid control which can be used to display data.

Parameter Direction	Parameter Name	Parameter Description
Input	name	The name of the control, which is used when attempting to retrieve it.
Input	label	The text to use for the control's label.
Output	Grid

CreateListBox(string name, string label)

Creates a ListBox control which can be used to display a list of options, from which users can make one or more selections.

Parameter Direction	Parameter Name	Parameter Description
Input	name	The name of the control, which is used when attempting to retrieve it.
Input	label	The text to use for the control's label.
Output	ListBox

CreateMemoEdit(string name, string label)

Creates a MemoEdit control which can be used to allow users to enter large blocks of text.

Parameter Direction	Parameter Name	Parameter Description
Input	name	The name of the control, which is used when attempting to retrieve it.
Input	label	The text to use for the control's label.
Output	MemoEdit

CreateRadioGroup(string name, string label)

Creates a RadioGroup control which can be used to display a list of options with radio buttons.

Parameter Direction	Parameter Name	Parameter Description
Input	name	The name of the control, which is used when attempting to retrieve it.
Input	label	The text to use for the control's label.
Output	RadioGroup

CreateRibbonPage(string pageName)

Creates a ScriptRibbonPage that can be used to hold buttons used by the form.

Parameter Direction	Parameter Name	Parameter Description
Input	pageName	The name of the page that is displayed on the ribbon page's tab and that is used for retrieving the ScriptRibbonPage object later.
Output	ScriptRibbonPage

CreateTextEdit(string name, string label)

Creates a TextEdit control which can be used to allow users to enter text.

Parameter Direction	Parameter Name	Parameter Description
Input	name	The name of the control, which is used when attempting to retrieve it.
Input	label	The text to use for the control's label.
Output	TextEdit

GetControl(string name)

Retrieves a control owned by the form based on the name provided.

Parameter Direction	Parameter Name	Parameter Description
Input	name	The name of the control, which is used when attempting to retrieve it.
Input	label	The text to use for the control's label.
Output	AddonControlBase

The AddonControlBase class that is listed as the output for the GetControl method is the base class used for all of the available form controls. Because Lua uses dynamic typing, it is not necessary to cast the AddonControlBase to the desired control type.

GetRibbonPage(string pageName)

Retrieves the ScriptRibbonPage matching the page name provided.

Parameter Direction	Parameter Name	Parameter Description
Input	pageName	The name of the page to retrieve.
Output	ScriptRibbonPage

LoadLayout(string fileName)

Loads the form layout information contained in the file represented by the file name provided. The file name can either be rooted or it can be relative to the addon's directory.

Parameter Direction	Parameter Name	Parameter Description
Input	fileName	The file containing the layout information to load.

Show()

Shows the form and adds it as a tab on the form hosting the addon.

PrivateMode

Deletes the cached history in the default browser. This ability can only be used with installations of Aeon v5.1.

Parameter Direction	Parameter Name	Parameter Description
Input	fileName	The name of the new browser. This value will be used as the text for the browser tab.
Input	Label	The text to use for the Browser control's label.
Input	PageName	The name to use for the page the browser's buttons will be placed on.
Input	BrowserType	If blank, the browser will be IE. If "Chromium", the browser will be Chromium.
Input	PrivateMode	If true, the browser cache will be deleted every time the browser is closed. If false, the browser will store the cache across sessions. Default value: false.