FormPopup

Methods Summarized

Type	Name	Summary
Object	component()	Get the component form popup will be shown relative to.
FormPopup	component(component)	Set component form popup will be shown relative to.
String	dataprovider()	Get the popup form dataprovider (which was set using setter).
FormPopup	dataprovider(dataprovider)	Set form popup dataprovider that will be set.
Number	height()	Get the popup form height (which was set using setter).
FormPopup	height(height)	Set form popup height.
Function	onClose()	Get/Set the onclose function that is called when the closeFormPopup is called.
FormPopup	onClose(function)	Get/Set the onclose function that is called when the closeFormPopup is called.
Object	scope()	Get the popup form scope (which was set using setter).
FormPopup	scope(scope)	Set form popup scope that will be modified.
void	show()	Show form popup using parameters that were set
Boolean	showBackdrop()	Get the popup form show backdrop (which was set using setter).
FormPopup	showBackdrop(showBackdrop)	Set whether backdrop will be shown.
Number	width()	Get the popup form width (which was set using setter).
FormPopup	width(width)	Set form popup width.
Number	x()	Get the popup form x location (which was set using setter).
FormPopup	x(x)	Set form popup x location.
Number	y()	Get the popup form y location (which was set using setter).
FormPopup	y(y)	Set form popup y location.

Methods Detailed

component()

Get the component form popup will be shown relative to.

Returns: Object IComponent

Sample

popupform.component();

component(component)

Set component form popup will be shown relative to. If null, will use coordinates or show at screen center.

Parameters

• Object component the form to show

Returns: FormPopup this The FormPopup itself

Sample

plugins.window.createFormPopup(forms.orderPicker).component(elements.myelement).show();

dataprovider()

Get the popup form dataprovider (which was set using setter).

Returns: String String

Sample

popupform.dataprovider();

dataprovider(dataprovider)

Set form popup dataprovider that will be set. If this is set, also scope needs to be specified.

Parameters

• String dataprovider form popup dataprovider

Returns: FormPopup this The FormPopup itself

Sample

plugins.window.createFormPopup(forms.orderPicker).dataprovider('myid').scope(foundset.getSelectedRecord()).show();

height()

Get the popup form height (which was set using setter).

Returns: Number int

Sample

popupform.height();

height(height)

Set form popup height. If not set, form design height will be used.

Parameters

• Number height form popup height

Returns: FormPopup

Sample

plugins.window.createFormPopup(forms.orderPicker).height(100).show();

onClose()

Get/Set the onclose function that is called when the closeFormPopup is called. This onClose will get a JSEvent as the first argument, and the return value that is given to the closeFormPopup(retvalue) call.

Returns: Function Function

Sample

popupform.onClose();

onClose(function)

Get/Set the onclose function that is called when the closeFormPopup is called. This onClose will get a JSEvent as the first argument, and the return value that is given to the closeFormPopup(retvalue) call.

Parameters

• Function function function that needs to be called when closed

Returns: FormPopup this The FormPopup itself

Sample

plugins.window.createFormPopup(forms.orderPicker).dataprovider('myid').onClose(closePopupFunction).show();

scope()

Get the popup form scope (which was set using setter).

Returns: Object Object

Sample

popupform.scope();

scope(scope)

Set form popup scope that will be modified. If this is set, also dataprovider needs to be specified.

Parameters

• Object scope form popup scope to modify

Returns: FormPopup this The FormPopup itself

Sample

plugins.window.createFormPopup(forms.orderPicker).dataprovider('myid').scope(foundset.getSelectedRecord()).show();

show()

Show form popup using parameters that were set

Returns: void

Sample

plugins.window.createFormPopup(forms.orderPicker).x(100).y(100).width(100).height(100).showBackdrop(true).show();

showBackdrop()

Get the popup form show backdrop (which was set using setter).

Returns: Boolean boolean

Sample

popupform.showBackdrop();

showBackdrop(showBackdrop)

Set whether backdrop will be shown. Default value is false.

Parameters

• Boolean showBackdrop form popup showBackdrop

Returns: FormPopup this The FormPopup itself

Sample

plugins.window.createFormPopup(forms.orderPicker).showBackdrop(true).show();

width()

Get the popup form width (which was set using setter).

Returns: Number int

Sample

popupform.width();

width(width)

Set form popup width. If not set, form design width will be used.

Parameters

• Number width form popup width

Returns: FormPopup this The FormPopup itself

Sample

plugins.window.createFormPopup(forms.orderPicker).width(100).show();

x()

Get the popup form x location (which was set using setter).

Returns: Number int

Sample

popupform.x();

x(x)

Set form popup x location. The priority sequence for location is: related element, set location, center of screen.

Parameters

• Number x form popup x location

Returns: FormPopup

Sample

plugins.window.createFormPopup(forms.orderPicker).x(100).show();

y()

Get the popup form y location (which was set using setter).

Returns: Number int

Sample

popupform.y();

y(y)

Set form popup y location. The priority sequence for location is: related element, set location, center of screen.

Parameters

• Number y form popup y location

Returns: FormPopup this The FormPopup itself

Sample

plugins.window.createFormPopup(forms.orderPicker).y(100).show();