Skip to main content

# IForm

Methods to get information about the custom form

See FormEvents for supported events

## Extends​

- `IScriptingObject`

## Methods​

### _dispose()?​

    optional _dispose(): void;

#### Returns​

`void`

#### Inherited from​

`IScriptingObject`.`_dispose`

### _toJSON()​

    _toJSON(): RemotingScriptingObject;

#### Returns​

`RemotingScriptingObject`

#### Inherited from​

`IScriptingObject`.`_toJSON`

### getControl()​

    getControl(id: string): Promise<unknown>;

get reference to the form's input control

#### Parameters​

##### id​

`string`

form id

#### Returns​

`Promise`<`unknown`>

form input control object

### getDescriptor()​

    getDescriptor(): Promise<FormDescriptor>;

get metadata of the form

#### Returns​

`Promise`<`FormDescriptor`>

form metadata

## Properties​

### id​

    readonly id: string;

#### Inherited from​

`IScriptingObject`.`id`

### Load​

    readonly Load: IEvent;

event fired when the form is loaded

Use FormLoadListener to handle this event

### objectType​

    readonly objectType: string;

#### Inherited from​

`IScriptingObject`.`objectType`

### Unload​

    readonly Unload: IEvent;

event fired when the form is unloaded

Use FormUnloadListener to handle this event