F Classes - FormTabControl to FormWindowControl

API reference for classes from FormTabControl to FormWindowControl.

Class FormTabControl

class FormTabControl extends FormControl

Remarks

Examples

Methods

Method Description
public FormControl addControl(FormControlType controlType, str controlName, [FormControl insertAfter])
public FormControl addControlEx(str controlClass, str controlName, [FormControl insertAfter])
public FormControl addDataField(int dataSourceId, FieldId fieldId, [FormControl insertAfter], [int arrayIndex])
public boolean alignChild([boolean value])
public boolean alignChildren([boolean value])
public boolean alignControl([boolean value]) Determines whether to align the control.
public boolean allowEdit([boolean value]) Determines whether the user can change the contents of the control.
public boolean allowSysSetup() Retrieves a value that indicates whether the control is shown in the SysSetup form.
public int allowUserSetup([int value])
public int arrangeGuide([int value])
public int arrangeMethod([int value])
public int arrangeWhen([int value])
public boolean autoDeclaration([boolean value]) Determines whether the system can declare a member variable that has the same name as the control.
public int backgroundColor([int value]) Gets or sets the background color of the control.
public int backStyle([int value]) Determines whether the control background can be transparent.
public int beginDrag(int x, int y) Is called when the user starts to drag a form control.
public int bottomMargin([int value], [AutoMode mode])
public AutoMode bottomMarginMode([AutoMode mode])
public int bottomMarginValue([int value])
public container calcControlSize(int chars, int lines) Retrieves the size of the control.
public boolean canAddDataField(int dataSourceId, FieldId fieldId, [int arrayIndex])
public boolean canContain(FormControl control)
public int colorScheme([int value]) Gets or sets the color scheme of the control.
public int columns([int value], [ColumnsMode mode])
public ColumnsMode columnsMode([ColumnsMode mode])
public int columnspace([int value], [AutoMode mode])
public AutoMode columnspaceMode([AutoMode mode])
public int columnspaceValue([int value])
public int columnsValue([int value])
public ConfigurationKeyId configurationKey([ConfigurationKeyId value]) Gets or sets the configuration key that is assigned to the control.
public List configurationKeyEx() Retrieves a list that contains the IDs of configuration keys that are in effect for the control.
public int containerScrollHorizontalOffset([int value])
public int containerScrollVerticalOffset([int value])
public boolean contains(FormControl control)
public int controlCount()
public FormControl controlNum(int controlNo)
public str countryRegionCodes([str value]) Gets or sets the comma-separated list of country/region codes for the control.
public FieldId countryRegionContextField([FieldId value])
public str dataRelationPath([str value]) Gets or sets the period-delimited list of relations that links the field binding of the DataField object to a relative table.
public int dataSource([AnyType value]) Gets or sets a data source that is used by the control or the form.
public int displayTarget([int value]) Gets or sets the value that indicates whether the control is displayed in the Finance and Operations client, in Enterprise Portal for Finance and Operations, or in both.
public int dragDrop([int value]) Determines whether to enable or disable drag-and-drop operations for the control.
public FormDrag dragOver(FormControl dragSource, FormDrag dragMode, int x, int y) Raises the dragOver event to indicate that a mouse drag operation is over the current control.
public FormDrag dragOverEx(Array dragSource, FormDrag dragMode, int x, int y) Raises the dragOverEx event to indicate that a mouse drag operation is over the current control.
public str dragText() Retrieves the text that is displayed when the form control is dragged.
public boolean enabled([boolean value]) Determines whether to enable or disable the object.
public FormControl getActivePage()
public boolean hasChanged([boolean val]) Sets or returns a value that indicates whether the contents of the control have changed.
public boolean hasControlPositionOverride()
public boolean hasUserSetting() Indicates whether the control has custom user settings.
public int height(int value, [int mode]) Gets or sets the height of the control.
public int heightMode([int value]) Gets or sets a calculation mode for the height of the control.
public int heightValue([int value]) Gets or sets the height of the control.
public str helpField() Retrieves the Help text for the control.
public str helpText([str value]) Gets or sets the Help text to display at the bottom of the screen when a field or control is pointed to.
public boolean hideIfEmpty([boolean value])
public str hierarchyParent([str value]) Gets or sets the HierarchyParent property value of the control.
public boolean horizontalScrollBarVisible([boolean value])
public int hWnd() Retrieves the Windows handle for the control.
public boolean isContainer()
public boolean isDisplayed() Retrieves a value that indicates whether the control is displayed.
public boolean isRestricted() Retrieves a value that indicates whether the control is restricted.
public boolean isUserSetupEnabled(int neededSetupRights) Retrieves a value that indicates whether the control allows for the specified level of customization.
public int left(int value, [int mode]) Gets or sets the horizontal position of the control in the form.
public int leftMargin([int value], [AutoMode mode])
public AutoMode leftMarginMode([AutoMode mode])
public int leftMarginValue([int value])
public int leftMode([int value]) Sets the horizontal arrange mode for the control in the form.
public int leftValue([int value]) Gets or sets the horizontal position of the control in the form.
public boolean markAsUserAdd([boolean value]) Marks or unmarks the control as a user-added control.
public int mouseDblClick(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the control is double-clicked by the user.
public int mouseDown(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user clicks the mouse button over the control.
public int mouseMove(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user moves the mouse pointer over the control.
public int mouseUp(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user releases the mouse button over the control area.
public int moveControl(int controlId, [int insertAfterId])
public str name([str value]) Gets or sets the name that is used in code to identify a form, report, table, query, or another Finance and Operations application object.
public int neededPermission([int value])
public container SysObsoleteAttribute()
public FormControl parentControl() Retrieves the parent control for the control.
public int rightMargin([int value], [AutoMode mode])
public AutoMode rightMarginMode([AutoMode mode])
public int rightMarginValue([int value])
public int scrollbars([int value])
public SecurityKeyId securityKey([SecurityKeyId value]) Sets or returns the ID of the security key for the control.
public boolean selectControl([boolean value])
public int showContextMenu(int menuHandle) Shows the shortcut menu for the control.
public boolean showTabs([boolean value])
public boolean skip([boolean value]) Sets or returns a value that indicates whether the control is skipped when the user presses the TAB key to move to the control.
public int sort([SortOrder sortDirection])
public int style([int value])
public TabStyle styleValue()
public int tab([int value], [AutoMode mode])
public int tabAppearance([int value])
public boolean tabAutoChange([boolean value])
public boolean tabChange(int FromTab)
public int tabLayout([int value])
public AutoMode tabMode([AutoMode mode])
public int tabPlacement([int value])
public int tabs([int value])
public int tabValue([int value])
public str toolTip() Retrieves the tooltip text for the control.
public int top(int value, [int mode]) Gets or sets the vertical position of the control in the form.
public int topMargin([int value], [AutoMode mode])
public AutoMode topMarginMode([AutoMode mode])
public int topMarginValue([int value])
public int topMode([int value]) Sets the vertical arrange mode for the control in the form.
public int topValue([int value]) Gets or sets the vertical position of the control in the form.
public int type([int value])
public boolean SysObsoleteAttribute(container data)
public int userData([int value]) Gets or sets the user data for the control.
public int userDataItem([int value]) Gets or sets the user data item for the control.
public int userDataItems([int value]) Gets or sets the number of user data items for the control.
public int userDisable([int value]) Gets or sets the value that indicates whether the control is disabled for the user.
public int userHeight([int value]) Gets or sets the custom user height for the control.
public int userHide([int value]) Gets or sets the value that indicates whether the control is hidden from the user.
public int userOrgContainer([int value]) Gets or sets the organization container for the control.
public int userOrgSibling([int value]) Gets or sets the organization sibling for the control.
public str userPromptText([str value]) Gets or sets the user label text for the control.
public int userSecurityLevel([int value]) Gets or sets the user security level for the control.
public int userSkip([int value]) Sets or returns the value that indicates whether the form control is skipped when the user presses the TAB key to navigate the controls in the form.
public int userWidth([int value]) Sets or returns the width of the control in pixels, as specified by the user.
public boolean useUserLayout([boolean value])
public boolean verticalScrollBarVisible([boolean value])
public int verticalSpacing([int value], [AutoMode mode]) Gets or sets the vertical spacing of the control in the form.
public AutoMode verticalSpacingMode([AutoMode mode]) Sets the vertical spacing mode for the control in the form.
public int verticalSpacingValue([int value]) Gets or sets the vertical spacing of the control in the form.
public int viewEditMode([int value])
public boolean visible([boolean value]) Sets or returns a value that indicates whether the control is visible.
public int width(int value, [int mode]) Gets or sets the width of the control.
public int widthMode([int value]) Gets or sets the calculation mode of the width of the control.
public int widthValue([int value]) Gets or sets the width of the control.
public void setFocus() Sets the focus on the control.
public void lostFocus() Indicates that the control has lost focus.
private void OnLostFocus([FormControl sender], [FormControlEventArgs e])
public void drop(FormControl dragSource, FormDrag dragMode, int x, int y) Raises the drop event to indicate that a drop operation is being performed on the current control.
public void endDrag() Is called when the user has finished dragging a form control.
public void registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])
public void gotFocus() Indicates that the control has received focus.
public void mouseEnter(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user moves the mouse pointer into the control area.
public void jumpRef()
public void paste() Pastes the contents of the clipboard into the control.
public void dropEx(Array dragSource, FormDrag dragMode, int x, int y) Raises the dropEx event to indicate that a drop operation is being performed on the current control.
public void arrange()
private void OnGotFocus([FormControl sender], [FormControlEventArgs e])
public void context() Shows the shortcut menu for the control.
public void copy() Copies the contents of the control to the clipboard.
public void filter([str filterStr])
public void resetUserSetting() Resets the user settings for the control.
public void cut() Cuts the contents of the control.
public void mouseLeave() Indicates that the mouse pointer has left the control.
public void displayControl() Displays the control.
private void OnTabChanged([FormControl sender], [FormControlEventArgs e])
public void inputSearch(str searchStr) Performs data filtering for the control, based on the specified string.
public void dragLeave() Raises the dragLeave event to indicate that a mouse drag operation has left the current control.
public void tabChanged(int FromTab, int ToTab)
public void prefColumnSize(int width, int height) Specifies the preferred column width and height for the form control.

Method addControl

public FormControl addControl(FormControlType controlType, str controlName, [FormControl insertAfter])

Parameters

controlType

controlName

insertAfter

Return Value

Method addControlEx

public FormControl addControlEx(str controlClass, str controlName, [FormControl insertAfter])

Parameters

controlClass

controlName

insertAfter

Return Value

Method addDataField

public FormControl addDataField(int dataSourceId, FieldId fieldId, [FormControl insertAfter], [int arrayIndex])

Parameters

dataSourceId

fieldId

insertAfter

arrayIndex

Return Value

Method alignChild

public boolean alignChild([boolean value])

Parameters

value

Return Value

Method alignChildren

public boolean alignChildren([boolean value])

Parameters

value

Return Value

Method alignControl

Determines whether to align the control.

public boolean alignControl([boolean value])

Parameters

value

Return Value

true if the control should be aligned; otherwise, false.

Remarks

The upper-left corner of the control is aligned according to the longest label.

Method allowEdit

Determines whether the user can change the contents of the control.

public boolean allowEdit([boolean value])

Parameters

value

Return Value

true if the control can be edited; otherwise, false.

Remarks

When this property is set on a container control, modifications are disabled or enabled for all controls in the container.

Method allowSysSetup

Retrieves a value that indicates whether the control is shown in the SysSetup form.

public boolean allowSysSetup()

Return Value

true if the control is shown in the SysSetup form; otherwise, false.

Method allowUserSetup

public int allowUserSetup([int value])

Parameters

value

Return Value

Method arrangeGuide

public int arrangeGuide([int value])

Parameters

value

Return Value

Method arrangeMethod

public int arrangeMethod([int value])

Parameters

value

Return Value

Method arrangeWhen

public int arrangeWhen([int value])

Parameters

value

Return Value

Method autoDeclaration

Determines whether the system can declare a member variable that has the same name as the control.

public boolean autoDeclaration([boolean value])

Parameters

value

Return Value

true if the member variable can be declared for this control; otherwise, false.

Remarks

Controls cannot have identical names.

Method backgroundColor

Gets or sets the background color of the control.

public int backgroundColor([int value])

Parameters

value

Return Value

An integer that contains a packed RGB color.

Remarks

The integer that is returned contains a packed RGB color as follows:

  • The low-order byte contains a value for the relative intensity of red.
  • The second byte contains a value for green.
  • The third byte contains a value for blue.
  • The high-order byte must be zero.
  • The maximum value for a single byte is 255.

Method backStyle

Determines whether the control background can be transparent.

public int backStyle([int value])

Parameters

value

Return Value

1 if the control background can be transparent; otherwise, 0.

Method beginDrag

Is called when the user starts to drag a form control.

public int beginDrag(int x, int y)

Parameters

x
An integer value that indicates the y-coordinate of the mouse pointer. The coordinate is relative to the upper-left corner of the control.

y
An integer value that indicates the y-coordinate of the mouse pointer. The coordinate is relative to the upper-left corner of the control.

Return Value

0 (zero) if the event has been handled.

Remarks

This event is not raised unless the DragDrop property is enabled for the control. To drag a control, a user presses the mouse button in the control area and then moves the mouse pointer.

Method bottomMargin

public int bottomMargin([int value], [AutoMode mode])

Parameters

value

mode

Return Value

Method bottomMarginMode

public AutoMode bottomMarginMode([AutoMode mode])

Parameters

mode

Return Value

Method bottomMarginValue

public int bottomMarginValue([int value])

Parameters

value

Return Value

Method calcControlSize

Retrieves the size of the control.

public container calcControlSize(int chars, int lines)

Parameters

chars
The number of lines to use to determine the height.

lines
The number of lines to use to determine the height.

Return Value

The container that holds the width and height.

Method canAddDataField

public boolean canAddDataField(int dataSourceId, FieldId fieldId, [int arrayIndex])

Parameters

dataSourceId

fieldId

arrayIndex

Return Value

Method canContain

public boolean canContain(FormControl control)

Parameters

control

Return Value

Method colorScheme

Gets or sets the color scheme of the control.

public int colorScheme([int value])

Parameters

value

Return Value

An integer between zero and two, inclusive.

Remarks

The color scheme is defined according to the following table.

Value Style
0 Default
1 The MicrosoftWindows palette
2 The true-color scheme

Method columns

public int columns([int value], [ColumnsMode mode])

Parameters

value

mode

Return Value

Method columnsMode

public ColumnsMode columnsMode([ColumnsMode mode])

Parameters

mode

Return Value

Method columnspace

public int columnspace([int value], [AutoMode mode])

Parameters

value

mode

Return Value

Method columnspaceMode

public AutoMode columnspaceMode([AutoMode mode])

Parameters

mode

Return Value

Method columnspaceValue

public int columnspaceValue([int value])

Parameters

value

Return Value

Method columnsValue

public int columnsValue([int value])

Parameters

value

Return Value

Method configurationKey

Gets or sets the configuration key that is assigned to the control.

public ConfigurationKeyId configurationKey([ConfigurationKeyId value])

Parameters

value

Return Value

The identifier of the configuration key that is assigned to the control.

Remarks

The configuration key is used to determine whether this control can be displayed. If the configuration key is disabled in the system, the control is not displayed in the form.

Method configurationKeyEx

Retrieves a list that contains the IDs of configuration keys that are in effect for the control.

public List configurationKeyEx()

Return Value

A list that contains the IDs of configuration keys that are in effect for the control.

Remarks

The returned list does not contain duplicate IDs. If the control is bound to a data source, the returned list of configuration key IDs also includes the configuration key ID for the table and field. The returned list also contains any configuration key IDs that are applied to the properties, extended data type, or enumType methods.

Method containerScrollHorizontalOffset

public int containerScrollHorizontalOffset([int value])

Parameters

value

Return Value

Method containerScrollVerticalOffset

public int containerScrollVerticalOffset([int value])

Parameters

value

Return Value

Method contains

public boolean contains(FormControl control)

Parameters

control

Return Value

Method controlCount

public int controlCount()

Return Value

Method controlNum

public FormControl controlNum(int controlNo)

Parameters

controlNo

Return Value

Method countryRegionCodes

Gets or sets the comma-separated list of country/region codes for the control.

public str countryRegionCodes([str value])

Parameters

value
The string that contains the country/region codes to set; optional.

Return Value

The comma-separated list of country/region codes for the control.

Method countryRegionContextField

public FieldId countryRegionContextField([FieldId value])

Parameters

value

Return Value

Method dataRelationPath

Gets or sets the period-delimited list of relations that links the field binding of the DataField object to a relative table.

public str dataRelationPath([str value])

Parameters

value
The string that contains the period-delimited list of relations; optional.

Return Value

The period-delimited list of relations that links the field binding of the DataField object to a relative table.

Remarks

This method is used by the reference group control to track exactly which relations produce the replacement field that is used. It enables the reference group control to bind consistently to the controls that it contains.

Method dataSource

Gets or sets a data source that is used by the control or the form.

public int dataSource([AnyType value])

Parameters

value

Return Value

The ID of the data source to use.

Method displayTarget

Gets or sets the value that indicates whether the control is displayed in the Finance and Operations client, in Enterprise Portal for Finance and Operations, or in both.

public int displayTarget([int value])

Parameters

value
The integer value that indicates where the control is displayed; optional.

Return Value

The value that indicates whether the control is displayed in the Finance and Operations client, in Enterprise Portal, or in both.

Method dragDrop

Determines whether to enable or disable drag-and-drop operations for the control.

public int dragDrop([int value])

Parameters

value

Return Value

1 if drag-and-drop operations are enabled; otherwise, false.

Method dragOver

Raises the dragOver event to indicate that a mouse drag operation is over the current control.

public FormDrag dragOver(FormControl dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.

Return Value

A FormDrag enumeration value that indicates the mode of dragging.

Method dragOverEx

Raises the dragOverEx event to indicate that a mouse drag operation is over the current control.

public FormDrag dragOverEx(Array dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.

Return Value

A FormDrag enumeration value that indicates the mode of dragging.

Method dragText

Retrieves the text that is displayed when the form control is dragged.

public str dragText()

Return Value

The text that is displayed when the control is dragged; an empty string if there is no text to display when the control is dragged.

Method enabled

Determines whether to enable or disable the object.

public boolean enabled([boolean value])

Parameters

value

Return Value

true if the object is enabled; otherwise, false.

Remarks

The enabled property allows for controls to be enabled or disabled at run time. For example, you can disable objects that do not apply to the current state of the application. You can also disable a control that is used only for display purposes, such as an error message, which provides read-only information.

Method getActivePage

public FormControl getActivePage()

Return Value

Method hasChanged

Sets or returns a value that indicates whether the contents of the control have changed.

public boolean hasChanged([boolean val])

Parameters

val
The value to assign as the hasChanged value for the control; optional.

Return Value

true if the contents of the control have changed; otherwise, false.

Method hasControlPositionOverride

public boolean hasControlPositionOverride()

Return Value

Method hasUserSetting

Indicates whether the control has custom user settings.

public boolean hasUserSetting()

Return Value

true if the control has custom user settings; otherwise, false.

Method height

Gets or sets the height of the control.

public int height(int value, [int mode])

Parameters

value

mode

Return Value

The height of the control in pixels.

Remarks

Exact mode is used if the value parameter is omitted. Calculate the height according to the following table.

Mode Height calculation
-1 Exact The exact height in pixels of the controls is used.
0 Auto The height of the control is calculated automatically and the value parameter is ignored.
1 Column height The layout of the form determines the height of the control.

The height and height calculation mode can be set separately.

Method heightMode

Gets or sets a calculation mode for the height of the control.

public int heightMode([int value])

Parameters

value

Return Value

The calculation mode.

Remarks

Calculate the height according to the following table.

Mode Height calculation
Exact The exact height in pixels of the controls is used.
Auto The height of the control is calculated automatically and the value parameter is ignored.
Column height The layout of the form determines the height of the control.

The height of the control might change when the mode is set to auto or column height.

Method heightValue

Gets or sets the height of the control.

public int heightValue([int value])

Parameters

value

Return Value

The height in pixels.

Remarks

The height of the control is not changed unless the exact height calculation mode is used.

Method helpField

Retrieves the Help text for the control.

public str helpField()

Return Value

The Help text for the control; an empty string if there is no Help text for the control.

Remarks

The helpField method cannot be used to set the value of the Help text. Use the helpText method to set the value of the Help text.

Method helpText

Gets or sets the Help text to display at the bottom of the screen when a field or control is pointed to.

public str helpText([str value])

Parameters

value

Return Value

The string to be displayed at the bottom of the screen.

Remarks

Set the HelpText property for an object by using the property dialog box. The Help text must not exceed 250 characters.

Method hideIfEmpty

public boolean hideIfEmpty([boolean value])

Parameters

value

Return Value

Method hierarchyParent

Gets or sets the HierarchyParent property value of the control.

public str hierarchyParent([str value])

Parameters

value
The value to assign to the HierarchyParent property of the control.

Return Value

The HierarchyParent property value of the control.

Method horizontalScrollBarVisible

public boolean horizontalScrollBarVisible([boolean value])

Parameters

value

Return Value

Method hWnd

Retrieves the Windows handle for the control.

public int hWnd()

Return Value

The handle for the control.

Remarks

The handle can be used with the Windows API.

Method isContainer

public boolean isContainer()

Return Value

Method isDisplayed

Retrieves a value that indicates whether the control is displayed.

public boolean isDisplayed()

Return Value

true if the control is displayed; otherwise, false.

Remarks

To modify the visible state of the control, call the visible method.

Method isRestricted

Retrieves a value that indicates whether the control is restricted.

public boolean isRestricted()

Return Value

true if the control is restricted; otherwise, false.

Method isUserSetupEnabled

Retrieves a value that indicates whether the control allows for the specified level of customization.

public boolean isUserSetupEnabled(int neededSetupRights)

Parameters

neededSetupRights
A value from the FormAllowUserSetup enumeration that specifies the level of customization that is being queried for the control.

Return Value

true if the control, design, and parent containers allow for the level of customization that is specified by the neededSetupRights parameter; otherwise, false.

Remarks

The following table describes the values for the neededSetupRights parameter.

FormAllowUserSetup::No 0 No changes can be made to the control. If this value is set for the neededSetupRights parameter, the method always returns true.
FormAllowUserSetup::Restricted 1 The user can change the editable, visible, skip, label, and width properties of the control. The user cannot move the control.
FormAllowUserSetup::Yes 2 The user can change the editable, visible, skip, label, and width properties of the control. The user can also move the control.

For this method to return true, the AllowUserSetup property for the design and all parent containers must allow for the level of access that is specified by the neededSetupRights parameter.

Method left

Gets or sets the horizontal position of the control in the form.

public int left(int value, [int mode])

Parameters

value
An integer value that indicates the horizontal arrange mode for the control; optional.

mode
An integer value that indicates the horizontal arrange mode for the control; optional.

Return Value

The horizontal position of the control in the form.

Method leftMargin

public int leftMargin([int value], [AutoMode mode])

Parameters

value

mode

Return Value

Method leftMarginMode

public AutoMode leftMarginMode([AutoMode mode])

Parameters

mode

Return Value

Method leftMarginValue

public int leftMarginValue([int value])

Parameters

value

Return Value

Method leftMode

Sets the horizontal arrange mode for the control in the form.

public int leftMode([int value])

Parameters

value
An integer value that indicates the horizontal arrange mode for the control; optional.

Return Value

The horizontal arrange mode for the control in the form.

Method leftValue

Gets or sets the horizontal position of the control in the form.

public int leftValue([int value])

Parameters

value
An integer value that indicates the horizontal position of the control; optional.

Return Value

The horizontal position of the control in the form.

Method markAsUserAdd

Marks or unmarks the control as a user-added control.

public boolean markAsUserAdd([boolean value])

Parameters

value
The Boolean value that indicates whether the control should be marked as a user-added control.

Return Value

true if the control was marked as a user-added control; otherwise, false.

Method mouseDblClick

Is called when the control is double-clicked by the user.

public int mouseDblClick(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned.

Method mouseDown

Is called when the user clicks the mouse button over the control.

public int mouseDown(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned. This event is called only if a value is specified for the label of the control and the ShowLabel property of the control is set to Yes.

Method mouseMove

Is called when the user moves the mouse pointer over the control.

public int mouseMove(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned.

Method mouseUp

Is called when the user releases the mouse button over the control area.

public int mouseUp(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned. This event is called only if a value is specified for the label of the control and the ShowLabel property of the control is set to Yes.

Method moveControl

public int moveControl(int controlId, [int insertAfterId])

Parameters

controlId

insertAfterId

Return Value

Method name

Gets or sets the name that is used in code to identify a form, report, table, query, or another Finance and Operations application object.

public str name([str value])

Parameters

value

Return Value

The name that is used in code to identify an application object.

Remarks

The name property value of an object must meet the following criteria to avoid code conflicts:

  • Begins with a letter.
  • Doesn't exceed 250 characters.
  • Can include numbers and underscore characters.
  • Cannot include punctuation or spaces.
  • Tables cannot have the same name as other public objects, such as extended data types, base enumeration types, classes, and so on.

Method neededPermission

public int neededPermission([int value])

Parameters

value

Return Value

Method SysObsoleteAttribute

public container SysObsoleteAttribute()

Return Value

Method parentControl

Retrieves the parent control for the control.

public FormControl parentControl()

Return Value

The parent control for the control.

Method rightMargin

public int rightMargin([int value], [AutoMode mode])

Parameters

value

mode

Return Value

Method rightMarginMode

public AutoMode rightMarginMode([AutoMode mode])

Parameters

mode

Return Value

Method rightMarginValue

public int rightMarginValue([int value])

Parameters

value

Return Value

Method scrollbars

public int scrollbars([int value])

Parameters

value

Return Value

Method securityKey

Sets or returns the ID of the security key for the control.

public SecurityKeyId securityKey([SecurityKeyId value])

Parameters

value
The ID of the security key to assign to the control; optional.

Return Value

The ID of the security key for the control; 0 (zero) if no security key is assigned to the control.

Method selectControl

public boolean selectControl([boolean value])

Parameters

value

Return Value

Method showContextMenu

Shows the shortcut menu for the control.

public int showContextMenu(int menuHandle)

Parameters

menuHandle
The ID of the menu to show.

Return Value

An integer value that indicates whether the call succeeded.

Method showTabs

public boolean showTabs([boolean value])

Parameters

value

Return Value

Method skip

Sets or returns a value that indicates whether the control is skipped when the user presses the TAB key to move to the control.

public boolean skip([boolean value])

Parameters

value
The value to assign to the skip property of the control; optional.

Return Value

true if the control is skipped when the user presses the TAB key to move to the control; otherwise, false.

Remarks

If the enabled property is true, the allowEdit property is false, and the skip property is true, the user cannot change the contents of the control but can still copy the contents of the control.

Method sort

public int sort([SortOrder sortDirection])

Parameters

sortDirection

Return Value

Method style

public int style([int value])

Parameters

value

Return Value

Method styleValue

public TabStyle styleValue()

Return Value

Method tab

public int tab([int value], [AutoMode mode])

Parameters

value

mode

Return Value

Method tabAppearance

public int tabAppearance([int value])

Parameters

value

Return Value

Method tabAutoChange

public boolean tabAutoChange([boolean value])

Parameters

value

Return Value

Method tabChange

public boolean tabChange(int FromTab)

Parameters

FromTab

Return Value

Method tabLayout

public int tabLayout([int value])

Parameters

value

Return Value

Method tabMode

public AutoMode tabMode([AutoMode mode])

Parameters

mode

Return Value

Method tabPlacement

public int tabPlacement([int value])

Parameters

value

Return Value

Method tabs

public int tabs([int value])

Parameters

value

Return Value

Method tabValue

public int tabValue([int value])

Parameters

value

Return Value

Method toolTip

Retrieves the tooltip text for the control.

public str toolTip()

Return Value

The tooltip text for the control; an empty string if no tooltip text has been defined for the control.

Remarks

The method might be overridden to provide a value to the toolTip method.

Method top

Gets or sets the vertical position of the control in the form.

public int top(int value, [int mode])

Parameters

value
An integer value that indicates the vertical arrange mode for the control; optional.

mode
An integer value that indicates the vertical arrange mode for the control; optional.

Return Value

The vertical position of the control in the form.

Method topMargin

public int topMargin([int value], [AutoMode mode])

Parameters

value

mode

Return Value

Method topMarginMode

public AutoMode topMarginMode([AutoMode mode])

Parameters

mode

Return Value

Method topMarginValue

public int topMarginValue([int value])

Parameters

value

Return Value

Method topMode

Sets the vertical arrange mode for the control in the form.

public int topMode([int value])

Parameters

value
An integer value that indicates the vertical arrange mode for the control; optional.

Return Value

The vertical arrange mode for the control in the form.

Method topValue

Gets or sets the vertical position of the control in the form.

public int topValue([int value])

Parameters

value
An integer value that indicates the vertical position of the control; optional.

Return Value

The vertical position of the control in the form.

Method type

public int type([int value])

Parameters

value

Return Value

Method SysObsoleteAttribute

public boolean SysObsoleteAttribute(container data)

Parameters

data

Return Value

Method userData

Gets or sets the user data for the control.

public int userData([int value])

Parameters

value
An integer value that indicates the user data for the control; optional.

Return Value

The user data for the control.

Method userDataItem

Gets or sets the user data item for the control.

public int userDataItem([int value])

Parameters

value
An integer value that indicates the user data item for the control; optional.

Return Value

The user data item for the control.

Method userDataItems

Gets or sets the number of user data items for the control.

public int userDataItems([int value])

Parameters

value
An integer value that indicates the number of user data items for the control; optional.

Return Value

The number of user data items for the control.

Method userDisable

Gets or sets the value that indicates whether the control is disabled for the user.

public int userDisable([int value])

Parameters

value
The value that indicates whether the control is disabled for the user; optional.

Return Value

1 if the control is disabled for the user; otherwise, 0.

Method userHeight

Gets or sets the custom user height for the control.

public int userHeight([int value])

Parameters

value
The user height for the control; optional.

Return Value

The custom user height for the control.

Method userHide

Gets or sets the value that indicates whether the control is hidden from the user.

public int userHide([int value])

Parameters

value
The value that indicates whether the control is hidden from the user; optional.

Return Value

1 if the control is hidden from the user; otherwise, 0.

Remarks

The user specifies whether a control is hidden by right-clicking the control when it is viewable or by right-clicking another control when the original control is hidden. A right-click opens a menu that can be used to hide or display the control. This method lets you programmatically determine and set the value.

Method userOrgContainer

Gets or sets the organization container for the control.

public int userOrgContainer([int value])

Parameters

value
The organization container to set for the control; optional.

Return Value

The organization container for the control.

Method userOrgSibling

Gets or sets the organization sibling for the control.

public int userOrgSibling([int value])

Parameters

value
The organization sibling to set for the control; optional.

Return Value

The organization sibling for the control.

Method userPromptText

Gets or sets the user label text for the control.

public str userPromptText([str value])

Parameters

value
The user label text to set for the control; optional.

Return Value

The user label text for the control.

Method userSecurityLevel

Gets or sets the user security level for the control.

public int userSecurityLevel([int value])

Parameters

value
The user security level to set for the control; optional.

Return Value

The user security level for the control.

Method userSkip

Sets or returns the value that indicates whether the form control is skipped when the user presses the TAB key to navigate the controls in the form.

public int userSkip([int value])

Parameters

value
The value to assign to the userSkip property; optional. The value is 1 if the user setting to skip the control is in effect; otherwise, the value is 0.

Return Value

1 if the user setting to skip the control is in effect; otherwise, 0.

Method userWidth

Sets or returns the width of the control in pixels, as specified by the user.

public int userWidth([int value])

Parameters

value
The number of pixels to use as the width of the control; optional.

Return Value

The number of pixels that the user specified as the width of the control; 0 (zero) if the user did not specify a character width.

Remarks

The userWidth method returns the width in pixels, based on six times the number of characters. For example, if the user has specified 30 characters as the width of the control, the return value is 6 * 30 = 180. To specify the width of the control in characters, users can right-click the control to open the setup form where the character specification is made.

Method useUserLayout

public boolean useUserLayout([boolean value])

Parameters

value

Return Value

Method verticalScrollBarVisible

public boolean verticalScrollBarVisible([boolean value])

Parameters

value

Return Value

Method verticalSpacing

Gets or sets the vertical spacing of the control in the form.

public int verticalSpacing([int value], [AutoMode mode])

Parameters

value
An integer value that indicates the AutoMode value for the control; optional.

mode
An integer value that indicates the AutoMode value for the control; optional.

Return Value

The vertical spacing of the control in the form.

Method verticalSpacingMode

Sets the vertical spacing mode for the control in the form.

public AutoMode verticalSpacingMode([AutoMode mode])

Parameters

mode

Return Value

The vertical spacing mode for the control in the form.

Method verticalSpacingValue

Gets or sets the vertical spacing of the control in the form.

public int verticalSpacingValue([int value])

Parameters

value
An integer value that indicates the vertical spacing of the control; optional.

Return Value

The vertical spacing of the control in the form.

Method viewEditMode

public int viewEditMode([int value])

Parameters

value

Return Value

Method visible

Sets or returns a value that indicates whether the control is visible.

public boolean visible([boolean value])

Parameters

value
The value to assign to the visibility setting for the control; optional.

Return Value

true if the control is visible; otherwise, false.

Method width

Gets or sets the width of the control.

public int width(int value, [int mode])

Parameters

value

mode

Return Value

The width of the control in pixels.

Remarks

Exact mode is used if the value parameter is omitted. Calculate the width according to the following table.

Mode Width calculation
-1 Exact The exact width in pixels of the controls is used.
0 Auto The width of the control is calculated automatically and the value parameter is ignored.
1 Column width The layout of the form determines the width of the control.

The width and width calculation mode can be set separately.

Method widthMode

Gets or sets the calculation mode of the width of the control.

public int widthMode([int value])

Parameters

value

Return Value

An integer value that indicates the current calculation mode.

Remarks

Calculate the width according to the following table.

Mode Width calculation
Exact The exact width in pixels of the controls is used.
Auto The width of the control is calculated automatically and the value parameter is ignored.
Column width The layout of the form determines the width of the control.

The width of the control might change when the mode is set to auto or column width.

Method widthValue

Gets or sets the width of the control.

public int widthValue([int value])

Parameters

value

Return Value

The width in pixels of the control.

Remarks

To change the width of the control, use the exact width calculation mode.

Method setFocus

Sets the focus on the control.

public void setFocus()

Method lostFocus

Indicates that the control has lost focus.

public void lostFocus()

Method OnLostFocus

private void OnLostFocus([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method drop

Raises the drop event to indicate that a drop operation is being performed on the current control.

public void drop(FormControl dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.

Method endDrag

Is called when the user has finished dragging a form control.

public void endDrag()

Remarks

This event is not raised unless the DragDrop property is enabled for the control and a beginDrag event has already been started. To drag a control, a user presses the mouse button in the control area and then moves the mouse pointer.

Method registerOverrideMethod

public void registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])

Parameters

methodToOverride

objectMethodToCall

overrideObject

Method gotFocus

Indicates that the control has received focus.

public void gotFocus()

Method mouseEnter

Is called when the user moves the mouse pointer into the control area.

public void mouseEnter(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Method jumpRef

public void jumpRef()

Method paste

Pastes the contents of the clipboard into the control.

public void paste()

Method dropEx

Raises the dropEx event to indicate that a drop operation is being performed on the current control.

public void dropEx(Array dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.

Method arrange

public void arrange()

Method OnGotFocus

private void OnGotFocus([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method context

Shows the shortcut menu for the control.

public void context()

Method copy

Copies the contents of the control to the clipboard.

public void copy()

Method filter

public void filter([str filterStr])

Parameters

filterStr

Method resetUserSetting

Resets the user settings for the control.

public void resetUserSetting()

Method cut

Cuts the contents of the control.

public void cut()

Method mouseLeave

Indicates that the mouse pointer has left the control.

public void mouseLeave()

Method displayControl

Displays the control.

public void displayControl()

Method OnTabChanged

private void OnTabChanged([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method inputSearch

Performs data filtering for the control, based on the specified string.

public void inputSearch(str searchStr)

Parameters

searchStr
The string value to use to filter data; optional.

Method dragLeave

Raises the dragLeave event to indicate that a mouse drag operation has left the current control.

public void dragLeave()

Method tabChanged

public void tabChanged(int FromTab, int ToTab)

Parameters

FromTab

ToTab

Method prefColumnSize

Specifies the preferred column width and height for the form control.

public void prefColumnSize(int width, int height)

Parameters

width
The preferred height of the control.

height
The preferred height of the control.

Class FormTableCell

class FormTableCell extends Object

Remarks

Examples

Methods

Method Description
public int colSpan([int value])
public AnyType data([AnyType value])
public FormControl editControl([FormControl value])
public Object object([Object value])
public int rowSpan([int value])

Method colSpan

public int colSpan([int value])

Parameters

value

Return Value

Method data

public AnyType data([AnyType value])

Parameters

value

Return Value

Method editControl

public FormControl editControl([FormControl value])

Parameters

value

Return Value

Method object

public Object object([Object value])

Parameters

value

Return Value

Method rowSpan

public int rowSpan([int value])

Parameters

value

Return Value

Class FormTableControl

class FormTableControl extends FormControl

Remarks

Examples

Methods

Method Description
public FormControl addControl(FormControlType controlType, str controlName, [FormControl insertAfter])
public FormControl addControlEx(str controlClass, str controlName, [FormControl insertAfter])
public FormControl addDataField(int dataSourceId, FieldId fieldId, [FormControl insertAfter], [int arrayIndex])
public boolean alignControl([boolean value]) Determines whether to align the control.
public boolean allowEdit([boolean value]) Determines whether the user can change the contents of the control.
public boolean allowSysSetup() Retrieves a value that indicates whether the control is shown in the SysSetup form.
public boolean autoDeclaration([boolean value]) Determines whether the system can declare a member variable that has the same name as the control.
public int backgroundColor([int value]) Gets or sets the background color of the control.
public int beginDrag(int x, int y) Is called when the user starts to drag a form control.
public int bottomMargin([int value])
public container calcControlSize(int chars, int lines) Retrieves the size of the control.
public boolean canAddDataField(int dataSourceId, FieldId fieldId, [int arrayIndex])
public boolean canContain(FormControl control)
public FormTableCell cell([int column], [int row])
public str colLabel(int column)
public int colorScheme([int value]) Gets or sets the color scheme of the control.
public int column([int value])
public int columns([int value])
public ConfigurationKeyId configurationKey([ConfigurationKeyId value]) Gets or sets the configuration key that is assigned to the control.
public List configurationKeyEx() Retrieves a list that contains the IDs of configuration keys that are in effect for the control.
public boolean contains(FormControl control)
public int controlCount()
public FormControl controlNum(int controlNo)
public str countryRegionCodes([str value]) Gets or sets the comma-separated list of country/region codes for the control.
public AnyType data(int column, int row)
public str dataRelationPath([str value]) Gets or sets the period-delimited list of relations that links the field binding of the DataField object to a relative table.
public int displayTarget([int value]) Gets or sets the value that indicates whether the control is displayed in the Finance and Operations client, in Enterprise Portal for Finance and Operations, or in both.
public int dragDrop([int value]) Determines whether to enable or disable drag-and-drop operations for the control.
public FormDrag dragOver(FormControl dragSource, FormDrag dragMode, int x, int y) Raises the dragOver event to indicate that a mouse drag operation is over the current control.
public FormDrag dragOverEx(Array dragSource, FormDrag dragMode, int x, int y) Raises the dragOverEx event to indicate that a mouse drag operation is over the current control.
public str dragText() Retrieves the text that is displayed when the form control is dragged.
public FormControl editControl(int Column, int Row)
public boolean enabled([boolean value]) Determines whether to enable or disable the object.
public boolean gridLines([boolean value])
public boolean hasChanged([boolean val]) Sets or returns a value that indicates whether the contents of the control have changed.
public boolean hasUserSetting() Indicates whether the control has custom user settings.
public int height(int value, [int mode]) Gets or sets the height of the control.
public int heightMode([int value]) Gets or sets a calculation mode for the height of the control.
public int heightValue([int value]) Gets or sets the height of the control.
public str helpField() Retrieves the Help text for the control.
public str helpText([str value]) Gets or sets the Help text to display at the bottom of the screen when a field or control is pointed to.
public str hierarchyParent([str value]) Gets or sets the HierarchyParent property value of the control.
public boolean highlightActive([boolean value])
public int hWnd() Retrieves the Windows handle for the control.
public boolean isContainer()
public boolean isDisplayed() Retrieves a value that indicates whether the control is displayed.
public boolean isRestricted() Retrieves a value that indicates whether the control is restricted.
public boolean isUserSetupEnabled(int neededSetupRights) Retrieves a value that indicates whether the control allows for the specified level of customization.
public boolean leave()
public int left(int value, [int mode]) Gets or sets the horizontal position of the control in the form.
public int leftMargin([int value])
public int leftMode([int value]) Sets the horizontal arrange mode for the control in the form.
public int leftValue([int value]) Gets or sets the horizontal position of the control in the form.
public boolean markAsUserAdd([boolean value]) Marks or unmarks the control as a user-added control.
public int mouseDblClick(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the control is double-clicked by the user.
public int mouseDown(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user clicks the mouse button over the control.
public int mouseMove(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user moves the mouse pointer over the control.
public int mouseUp(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user releases the mouse button over the control area.
public int moveControl(int controlId, [int insertAfterId])
public str name([str value]) Gets or sets the name that is used in code to identify a form, report, table, query, or another Finance and Operations application object.
public int neededPermission([int value])
public container SysObsoleteAttribute()
public FormControl parentControl() Retrieves the parent control for the control.
public int rightMargin([int value])
public int row([int value])
public str rowLabel(int row)
public int rows([int value])
public SecurityKeyId securityKey([SecurityKeyId value]) Sets or returns the ID of the security key for the control.
public boolean showColLabels([boolean value])
public int showContextMenu(int menuHandle) Shows the shortcut menu for the control.
public boolean showRowLabels([boolean value])
public boolean skip([boolean value]) Sets or returns a value that indicates whether the control is skipped when the user presses the TAB key to move to the control.
public str toolTip() Retrieves the tooltip text for the control.
public int top(int value, [int mode]) Gets or sets the vertical position of the control in the form.
public int topMargin([int value])
public int topMode([int value]) Sets the vertical arrange mode for the control in the form.
public int topValue([int value]) Gets or sets the vertical position of the control in the form.
public int type([int value])
public boolean SysObsoleteAttribute(container data)
public int userData([int value]) Gets or sets the user data for the control.
public int userDataItem([int value]) Gets or sets the user data item for the control.
public int userDataItems([int value]) Gets or sets the number of user data items for the control.
public int userDisable([int value]) Gets or sets the value that indicates whether the control is disabled for the user.
public int userHeight([int value]) Gets or sets the custom user height for the control.
public int userHide([int value]) Gets or sets the value that indicates whether the control is hidden from the user.
public int userOrgContainer([int value]) Gets or sets the organization container for the control.
public int userOrgSibling([int value]) Gets or sets the organization sibling for the control.
public str userPromptText([str value]) Gets or sets the user label text for the control.
public int userSecurityLevel([int value]) Gets or sets the user security level for the control.
public int userSkip([int value]) Sets or returns the value that indicates whether the form control is skipped when the user presses the TAB key to navigate the controls in the form.
public int userWidth([int value]) Sets or returns the width of the control in pixels, as specified by the user.
public boolean useUserLayout([boolean value])
public int verticalSpacing([int value], [AutoMode mode]) Gets or sets the vertical spacing of the control in the form.
public AutoMode verticalSpacingMode([AutoMode mode]) Sets the vertical spacing mode for the control in the form.
public int verticalSpacingValue([int value]) Gets or sets the vertical spacing of the control in the form.
public boolean visible([boolean value]) Sets or returns a value that indicates whether the control is visible.
public int width(int value, [int mode]) Gets or sets the width of the control.
public int widthMode([int value]) Gets or sets the calculation mode of the width of the control.
public int widthValue([int value]) Gets or sets the width of the control.
public void prefColumnSize(int width, int height) Specifies the preferred column width and height for the form control.
public void drop(FormControl dragSource, FormDrag dragMode, int x, int y) Raises the drop event to indicate that a drop operation is being performed on the current control.
public void setColLabel(int column, str text)
public void mouseEnter(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user moves the mouse pointer into the control area.
public void resetUserSetting() Resets the user settings for the control.
public void lostFocus() Indicates that the control has lost focus.
public void inputSearch(str searchStr) Performs data filtering for the control, based on the specified string.
public void dragLeave() Raises the dragLeave event to indicate that a mouse drag operation has left the current control.
private void OnGotFocus([FormControl sender], [FormControlEventArgs e])
public void registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])
public void arrange()
private void OnLeaving([FormControl sender], [FormControlEventArgs e])
public void deleteRows(int deleteAfterRow, int rows) ;
public void endDrag() Is called when the user has finished dragging a form control.
public void deleteCols(int deleteAfterColumn, int columns)
public void clear()
public void insertRows(int insertAfterRow, int rows)
public void gotFocus() Indicates that the control has received focus.
public void displayControl() Displays the control.
private void OnEnter([FormControl sender], [FormControlEventArgs e])
public void copy() Copies the contents of the control to the clipboard.
public void setRowLabel(int row, str text)
public void mouseLeave() Indicates that the mouse pointer has left the control.
public void paste() Pastes the contents of the clipboard into the control.
public void enter()
public void cut() Cuts the contents of the control.
public void dropEx(Array dragSource, FormDrag dragMode, int x, int y) Raises the dropEx event to indicate that a drop operation is being performed on the current control.
private void OnLostFocus([FormControl sender], [FormControlEventArgs e])
public void updateCell(int column, int row)
public void insertCols(int insertAferColumn, int columns)
public void activeCellChanged()
public void context() Shows the shortcut menu for the control.
public void setFocus() Sets the focus on the control.

Method addControl

public FormControl addControl(FormControlType controlType, str controlName, [FormControl insertAfter])

Parameters

controlType

controlName

insertAfter

Return Value

Method addControlEx

public FormControl addControlEx(str controlClass, str controlName, [FormControl insertAfter])

Parameters

controlClass

controlName

insertAfter

Return Value

Method addDataField

public FormControl addDataField(int dataSourceId, FieldId fieldId, [FormControl insertAfter], [int arrayIndex])

Parameters

dataSourceId

fieldId

insertAfter

arrayIndex

Return Value

Method alignControl

Determines whether to align the control.

public boolean alignControl([boolean value])

Parameters

value
The new value for the property; optional.

Return Value

true if the control should be aligned; otherwise, false.

Remarks

The upper-left corner of the control is aligned according to the longest label.

Method allowEdit

Determines whether the user can change the contents of the control.

public boolean allowEdit([boolean value])

Parameters

value
The value to assign to the allowEdit property.

Return Value

true if the control can be edited; otherwise, false.

Remarks

When this property is set on a container control, modifications are disabled or enabled for all controls in the container.

Method allowSysSetup

Retrieves a value that indicates whether the control is shown in the SysSetup form.

public boolean allowSysSetup()

Return Value

true if the control is shown in the SysSetup form; otherwise, false.

Method autoDeclaration

Determines whether the system can declare a member variable that has the same name as the control.

public boolean autoDeclaration([boolean value])

Parameters

value
If supplied, the property is set to this value.

Return Value

true if the member variable can be declared for this control; otherwise, false.

Remarks

Controls cannot have identical names.

Method backgroundColor

Gets or sets the background color of the control.

public int backgroundColor([int value])

Parameters

value

Return Value

An integer that contains a packed RGB color.

Remarks

The integer that is returned contains a packed RGB color as follows:

  • The low-order byte contains a value for the relative intensity of red.
  • The second byte contains a value for green.
  • The third byte contains a value for blue.
  • The high-order byte must be zero.
  • The maximum value for a single byte is 255.

Method beginDrag

Is called when the user starts to drag a form control.

public int beginDrag(int x, int y)

Parameters

x
An integer value that indicates the y-coordinate of the mouse pointer. The coordinate is relative to the upper-left corner of the control.

y
An integer value that indicates the y-coordinate of the mouse pointer. The coordinate is relative to the upper-left corner of the control.

Return Value

0 (zero) if the event has been handled.

Remarks

This event is not raised unless the DragDrop property is enabled for the control. To drag a control, a user presses the mouse button in the control area and then moves the mouse pointer.

Method bottomMargin

public int bottomMargin([int value])

Parameters

value

Return Value

Method calcControlSize

Retrieves the size of the control.

public container calcControlSize(int chars, int lines)

Parameters

chars
The number of lines to use to determine the height.

lines
The number of lines to use to determine the height.

Return Value

The container that holds the width and height.

Method canAddDataField

public boolean canAddDataField(int dataSourceId, FieldId fieldId, [int arrayIndex])

Parameters

dataSourceId

fieldId

arrayIndex

Return Value

Method canContain

public boolean canContain(FormControl control)

Parameters

control

Return Value

Method cell

public FormTableCell cell([int column], [int row])

Parameters

column

row

Return Value

Method colLabel

public str colLabel(int column)

Parameters

column

Return Value

Method colorScheme

Gets or sets the color scheme of the control.

public int colorScheme([int value])

Parameters

value

Return Value

An integer between zero and two, inclusive.

Remarks

The color scheme is defined according to the following table.

Value Style
0 Default
1 The MicrosoftWindows palette
2 The true-color scheme

Method column

public int column([int value])

Parameters

value

Return Value

Method columns

public int columns([int value])

Parameters

value

Return Value

Method configurationKey

Gets or sets the configuration key that is assigned to the control.

public ConfigurationKeyId configurationKey([ConfigurationKeyId value])

Parameters

value
The ID of the configuration key to assign to the control; optional.

Return Value

The identifier of the configuration key that is assigned to the control.

Remarks

The configuration key is used to determine whether this control can be displayed. If the configuration key is disabled in the system, the control is not displayed in the form.

Method configurationKeyEx

Retrieves a list that contains the IDs of configuration keys that are in effect for the control.

public List configurationKeyEx()

Return Value

A list that contains the IDs of configuration keys that are in effect for the control.

Remarks

The returned list does not contain duplicate IDs. If the control is bound to a data source, the returned list of configuration key IDs also includes the configuration key ID for the table and field. The returned list also contains any configuration key IDs that are applied to the properties, extended data type, or enumType methods.

Method contains

public boolean contains(FormControl control)

Parameters

control

Return Value

Method controlCount

public int controlCount()

Return Value

Method controlNum

public FormControl controlNum(int controlNo)

Parameters

controlNo

Return Value

Method countryRegionCodes

Gets or sets the comma-separated list of country/region codes for the control.

public str countryRegionCodes([str value])

Parameters

value
The string that contains the country/region codes to set; optional.

Return Value

The comma-separated list of country/region codes for the control.

Method data

public AnyType data(int column, int row)

Parameters

column

row

Return Value

Method dataRelationPath

Gets or sets the period-delimited list of relations that links the field binding of the DataField object to a relative table.

public str dataRelationPath([str value])

Parameters

value
The string that contains the period-delimited list of relations; optional.

Return Value

The period-delimited list of relations that links the field binding of the DataField object to a relative table.

Remarks

This method is used by the reference group control to track exactly which relations produce the replacement field that is used. It enables the reference group control to bind consistently to the controls that it contains.

Method displayTarget

Gets or sets the value that indicates whether the control is displayed in the Finance and Operations client, in Enterprise Portal for Finance and Operations, or in both.

public int displayTarget([int value])

Parameters

value
The integer value that indicates where the control is displayed; optional.

Return Value

The value that indicates whether the control is displayed in the Finance and Operations client, in Enterprise Portal, or in both.

Method dragDrop

Determines whether to enable or disable drag-and-drop operations for the control.

public int dragDrop([int value])

Parameters

value
An integer that indicates whether drag-and-drop behavior is enabled; optional.

Return Value

1 if drag-and-drop operations are enabled; otherwise, false.

Remarks

Use the dragLeave Method, the dragOver Method, and the dragOverEx Method to specify the behavior.

Method dragOver

Raises the dragOver event to indicate that a mouse drag operation is over the current control.

public FormDrag dragOver(FormControl dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.

Return Value

A FormDrag enumeration value that indicates the mode of dragging.

Method dragOverEx

Raises the dragOverEx event to indicate that a mouse drag operation is over the current control.

public FormDrag dragOverEx(Array dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.

Return Value

A FormDrag enumeration value that indicates the mode of dragging.

Method dragText

Retrieves the text that is displayed when the form control is dragged.

public str dragText()

Return Value

The text that is displayed when the control is dragged; an empty string if there is no text to display when the control is dragged.

Method editControl

public FormControl editControl(int Column, int Row)

Parameters

Column

Row

Return Value

Method enabled

Determines whether to enable or disable the object.

public boolean enabled([boolean value])

Parameters

value
A Boolean value that specifies whether the control is enabled; optional.

Return Value

true if the object is enabled; otherwise, false.

Remarks

The enabled property allows controls to be enabled or disabled at run time. For example, you can disable objects that do not apply to the current state of the application. You can also disable a control that is used only for display purposes, such as an error message, which provides read-only information.

Method gridLines

public boolean gridLines([boolean value])

Parameters

value

Return Value

Method hasChanged

Sets or returns a value that indicates whether the contents of the control have changed.

public boolean hasChanged([boolean val])

Parameters

val
The value to assign as the hasChanged value for the control; optional.

Return Value

true if the contents of the control have changed; otherwise, false.

Method hasUserSetting

Indicates whether the control has custom user settings.

public boolean hasUserSetting()

Return Value

true if the control has custom user settings; otherwise, false.

Method height

Gets or sets the height of the control.

public int height(int value, [int mode])

Parameters

value
An integer that indicates how the height is calculated; optional.

mode
An integer that indicates how the height is calculated; optional.

Return Value

The height of the control in pixels.

Remarks

Exact mode is used if the value parameter is omitted. Calculate the height according to the following table.

Mode Height calculation
-1 Exact The exact height in pixels of the controls is used.
0 Auto The height of the control is calculated automatically and the value parameter is ignored.
1 Column height The layout of the form determines the height of the control.

The height and height calculation mode can be set separately.

Method heightMode

Gets or sets a calculation mode for the height of the control.

public int heightMode([int value])

Parameters

value
An integer value that indicates how control height is calculated; optional.

Return Value

The calculation mode.

Remarks

Calculate the height according to the following table.

Mode Height calculation
Exact The exact height in pixels of the controls is used.
Auto The height of the control is calculated automatically and the value parameter is ignored.
Column height The layout of the form determines the height of the control.

The height of the control might change when the mode is set to auto or column height.

Method heightValue

Gets or sets the height of the control.

public int heightValue([int value])

Parameters

value
An integer that specifies the height in pixels; optional.

Return Value

The height in pixels.

Remarks

The height of the control is not changed unless the exact height calculation mode is used.

Method helpField

Retrieves the Help text for the control.

public str helpField()

Return Value

The Help text for the control; an empty string if there is no Help text for the control.

Remarks

The helpField method cannot be used to set the value of the Help text. Use the helpText method to set the value of the Help text.

Method helpText

Gets or sets the Help text to display at the bottom of the screen when a field or control is pointed to.

public str helpText([str value])

Parameters

value
The value to assign as the Help text for the control.

Return Value

The string to be displayed at the bottom of the screen.

Remarks

Set the HelpText property for an object by using the property sheet. The Help text must not exceed 250 characters.

Method hierarchyParent

Gets or sets the HierarchyParent property value of the control.

public str hierarchyParent([str value])

Parameters

value
The value to assign to the HierarchyParent property of the control.

Return Value

The HierarchyParent property value of the control.

Method highlightActive

public boolean highlightActive([boolean value])

Parameters

value

Return Value

Method hWnd

Retrieves the Windows handle for the control.

public int hWnd()

Return Value

The handle for the control.

Remarks

The handle can be used with the Windows API.

Method isContainer

public boolean isContainer()

Return Value

Method isDisplayed

Retrieves a value that indicates whether the control is displayed.

public boolean isDisplayed()

Return Value

true if the control is displayed; otherwise, false.

Remarks

To modify the visible state of the control, call the visible method.

Method isRestricted

Retrieves a value that indicates whether the control is restricted.

public boolean isRestricted()

Return Value

true if the control is restricted; otherwise, false.

Method isUserSetupEnabled

Retrieves a value that indicates whether the control allows for the specified level of customization.

public boolean isUserSetupEnabled(int neededSetupRights)

Parameters

neededSetupRights
A value from the FormAllowUserSetup enumeration that specifies the level of customization that is being queried for the control.

Return Value

true if the control, design, and parent containers allow for the level of customization that is specified by the neededSetupRights parameter; otherwise, false.

Remarks

The following table describes the values for the neededSetupRights parameter.

FormAllowUserSetup::No 0 No changes can be made to the control. If this value is set for the neededSetupRights parameter, the method always returns true.
FormAllowUserSetup::Restricted 1 The user can change the editable, visible, skip, label, and width properties of the control. The user cannot move the control.
FormAllowUserSetup::Yes 2 The user can change the editable, visible, skip, label, and width properties of the control. The user can also move the control.

For this method to return true, the AllowUserSetup property for the design and all parent containers must allow for the level of access that is specified by the neededSetupRights parameter.

Method leave

public boolean leave()

Return Value

Method left

Gets or sets the horizontal position of the control in the form.

public int left(int value, [int mode])

Parameters

value
An integer value that indicates the horizontal arrange mode for the control; optional.

mode
An integer value that indicates the horizontal arrange mode for the control; optional.

Return Value

The horizontal position of the control in the form.

Method leftMargin

public int leftMargin([int value])

Parameters

value

Return Value

Method leftMode

Sets the horizontal arrange mode for the control in the form.

public int leftMode([int value])

Parameters

value
An integer value that indicates the horizontal arrange mode for the control; optional.

Return Value

The horizontal arrange mode for the control in the form.

Method leftValue

Gets or sets the horizontal position of the control in the form.

public int leftValue([int value])

Parameters

value
An integer value that indicates the horizontal position of the control; optional.

Return Value

The horizontal position of the control in the form.

Method markAsUserAdd

Marks or unmarks the control as a user-added control.

public boolean markAsUserAdd([boolean value])

Parameters

value
The Boolean value that indicates whether the control should be marked as a user-added control.

Return Value

true if the control was marked as a user-added control; otherwise, false.

Method mouseDblClick

Is called when the control is double-clicked by the user.

public int mouseDblClick(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned.

Method mouseDown

Is called when the user clicks the mouse button over the control.

public int mouseDown(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned. This event is called only if a value is specified for the label of the control and the ShowLabel property of the control is set to Yes.

Method mouseMove

Is called when the user moves the mouse pointer over the control.

public int mouseMove(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned.

Method mouseUp

Is called when the user releases the mouse button over the control area.

public int mouseUp(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned. This event is called only if a value is specified for the label of the control and the ShowLabel property of the control is set to Yes.

Method moveControl

public int moveControl(int controlId, [int insertAfterId])

Parameters

controlId

insertAfterId

Return Value

Method name

Gets or sets the name that is used in code to identify a form, report, table, query, or another Finance and Operations application object.

public str name([str value])

Parameters

value
The name to assign to the control.

Return Value

The name that is used in code to identify an application object.

Remarks

The name property value of an object must meet the following criteria to avoid code conflicts:

  • Begins with a letter.
  • Doesn't exceed 250 characters.
  • Can include numbers and underscore characters.
  • Cannot include punctuation or spaces.
  • Tables cannot have the same name as other public objects, such as extended data types, base enumeration types, classes, and so on.

Method neededPermission

public int neededPermission([int value])

Parameters

value

Return Value

Method SysObsoleteAttribute

public container SysObsoleteAttribute()

Return Value

Method parentControl

Retrieves the parent control for the control.

public FormControl parentControl()

Return Value

The parent control for the control.

Method rightMargin

public int rightMargin([int value])

Parameters

value

Return Value

Method row

public int row([int value])

Parameters

value

Return Value

Method rowLabel

public str rowLabel(int row)

Parameters

row

Return Value

Method rows

public int rows([int value])

Parameters

value

Return Value

Method securityKey

Sets or returns the ID of the security key for the control.

public SecurityKeyId securityKey([SecurityKeyId value])

Parameters

value
The ID of the security key to assign to the control; optional.

Return Value

The ID of the security key for the control; 0 (zero) if no security key is assigned to the control.

Method showColLabels

public boolean showColLabels([boolean value])

Parameters

value

Return Value

Method showContextMenu

Shows the shortcut menu for the control.

public int showContextMenu(int menuHandle)

Parameters

menuHandle
The ID of the menu to show.

Return Value

An integer value that indicates whether the call succeeded.

Method showRowLabels

public boolean showRowLabels([boolean value])

Parameters

value

Return Value

Method skip

Sets or returns a value that indicates whether the control is skipped when the user presses the TAB key to move to the control.

public boolean skip([boolean value])

Parameters

value
The value to assign to the skip property of the control; optional.

Return Value

true if the control is skipped when the user presses the TAB key to move to the control; otherwise, false.

Remarks

If the enabled property is true, the allowEdit property is false, and the skip property is true, the user cannot change the contents of the control but can still copy the contents of the control.

Method toolTip

Retrieves the tooltip text for the control.

public str toolTip()

Return Value

The tooltip text for the control; an empty string if no tooltip text has been defined for the control.

Remarks

The method might be overridden to provide a value to the toolTip method.

Method top

Gets or sets the vertical position of the control in the form.

public int top(int value, [int mode])

Parameters

value
An integer value that indicates the vertical arrange mode for the control; optional.

mode
An integer value that indicates the vertical arrange mode for the control; optional.

Return Value

The vertical position of the control in the form.

Method topMargin

public int topMargin([int value])

Parameters

value

Return Value

Method topMode

Sets the vertical arrange mode for the control in the form.

public int topMode([int value])

Parameters

value
An integer value that indicates the vertical arrange mode for the control; optional.

Return Value

The vertical arrange mode for the control in the form.

Method topValue

Gets or sets the vertical position of the control in the form.

public int topValue([int value])

Parameters

value
An integer value that indicates the vertical position of the control; optional.

Return Value

The vertical position of the control in the form.

Method type

public int type([int value])

Parameters

value

Return Value

Method SysObsoleteAttribute

public boolean SysObsoleteAttribute(container data)

Parameters

data

Return Value

Method userData

Gets or sets the user data for the control.

public int userData([int value])

Parameters

value
An integer value that indicates the user data for the control; optional.

Return Value

The user data for the control.

Method userDataItem

Gets or sets the user data item for the control.

public int userDataItem([int value])

Parameters

value
An integer value that indicates the user data item for the control; optional.

Return Value

The user data item for the control.

Method userDataItems

Gets or sets the number of user data items for the control.

public int userDataItems([int value])

Parameters

value
An integer value that indicates the number of user data items for the control; optional.

Return Value

The number of user data items for the control.

Method userDisable

Gets or sets the value that indicates whether the control is disabled for the user.

public int userDisable([int value])

Parameters

value
The value that indicates whether the control is disabled for the user; optional.

Return Value

1 if the control is disabled for the user; otherwise, 0.

Method userHeight

Gets or sets the custom user height for the control.

public int userHeight([int value])

Parameters

value
The user height for the control; optional.

Return Value

The custom user height for the control.

Method userHide

Gets or sets the value that indicates whether the control is hidden from the user.

public int userHide([int value])

Parameters

value
The value that indicates whether the control is hidden from the user; optional.

Return Value

1 if the control is hidden from the user; otherwise, 0.

Remarks

The user specifies whether a control is hidden by right-clicking the control when it is viewable or by right-clicking another control when the original control is hidden. A right-click opens a menu that can be used to hide or display the control. This method lets you programmatically determine and set the value.

Method userOrgContainer

Gets or sets the organization container for the control.

public int userOrgContainer([int value])

Parameters

value
The organization container to set for the control; optional.

Return Value

The organization container for the control.

Method userOrgSibling

Gets or sets the organization sibling for the control.

public int userOrgSibling([int value])

Parameters

value
The organization sibling to set for the control; optional.

Return Value

The organization sibling for the control.

Method userPromptText

Gets or sets the user label text for the control.

public str userPromptText([str value])

Parameters

value
The user label text to set for the control; optional.

Return Value

The user label text for the control.

Method userSecurityLevel

Gets or sets the user security level for the control.

public int userSecurityLevel([int value])

Parameters

value
The user security level to set for the control; optional.

Return Value

The user security level for the control.

Method userSkip

Sets or returns the value that indicates whether the form control is skipped when the user presses the TAB key to navigate the controls in the form.

public int userSkip([int value])

Parameters

value
The value to assign to the userSkip property; optional. The value is 1 if the user setting to skip the control is in effect; otherwise, the value is 0.

Return Value

1 if the user setting to skip the control is in effect; otherwise, 0.

Method userWidth

Sets or returns the width of the control in pixels, as specified by the user.

public int userWidth([int value])

Parameters

value
The number of pixels to use as the width of the control; optional.

Return Value

The number of pixels that the user specified as the width of the control; 0 (zero) if the user did not specify a character width.

Remarks

The userWidth method returns the width in pixels, based on six times the number of characters. For example, if the user has specified 30 characters as the width of the control, the return value is 6 * 30 = 180. To specify the width of the control in characters, users can right-click the control to open the setup form where the character specification is made.

Method useUserLayout

public boolean useUserLayout([boolean value])

Parameters

value

Return Value

Method verticalSpacing

Gets or sets the vertical spacing of the control in the form.

public int verticalSpacing([int value], [AutoMode mode])

Parameters

value
An integer value that indicates the AutoMode value for the control; optional.

mode
An integer value that indicates the AutoMode value for the control; optional.

Return Value

The vertical spacing of the control in the form.

Method verticalSpacingMode

Sets the vertical spacing mode for the control in the form.

public AutoMode verticalSpacingMode([AutoMode mode])

Parameters

mode

Return Value

The vertical spacing mode for the control in the form.

Method verticalSpacingValue

Gets or sets the vertical spacing of the control in the form.

public int verticalSpacingValue([int value])

Parameters

value
An integer value that indicates the vertical spacing of the control; optional.

Return Value

The vertical spacing of the control in the form.

Method visible

Sets or returns a value that indicates whether the control is visible.

public boolean visible([boolean value])

Parameters

value
The value to assign to the visibility setting for the control; optional.

Return Value

true if the control is visible; otherwise, false.

Method width

Gets or sets the width of the control.

public int width(int value, [int mode])

Parameters

value
An integer that indicates how the width is calculated; optional.

mode
An integer that indicates how the width is calculated; optional.

Return Value

The width of the control in pixels.

Remarks

Exact mode is used if the value parameter is omitted. Calculate the width according to the following table.

Mode Width calculation
-1 Exact The exact width in pixels of the controls is used.
0 Auto The width of the control is calculated automatically and the value parameter is ignored.
1 Column width The layout of the form determines the width of the control.

The width and width calculation mode can be set separately.

Method widthMode

Gets or sets the calculation mode of the width of the control.

public int widthMode([int value])

Parameters

value
An integer value that indicates how control width is calculated; optional.

Return Value

An integer value that indicates the current calculation mode.

Remarks

Calculate the width according to the following table.

Mode Width calculation
Exact The exact width in pixels of the controls is used.
Auto The width of the control is calculated automatically and the value parameter is ignored.
Column width The layout of the form determines the width of the control.

The width of the control might change when the mode is set to auto or column width.

Method widthValue

Gets or sets the width of the control.

public int widthValue([int value])

Parameters

value
An integer that specifies the width in pixels; optional.

Return Value

The width in pixels of the control.

Remarks

To change the width of the control, use the exact width calculation mode.

Method prefColumnSize

Specifies the preferred column width and height for the form control.

public void prefColumnSize(int width, int height)

Parameters

width
The preferred height of the control.

height
The preferred height of the control.

Method drop

Raises the drop event to indicate that a drop operation is being performed on the current control.

public void drop(FormControl dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.

Method setColLabel

public void setColLabel(int column, str text)

Parameters

column

text

Method mouseEnter

Is called when the user moves the mouse pointer into the control area.

public void mouseEnter(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Method resetUserSetting

Resets the user settings for the control.

public void resetUserSetting()

Method lostFocus

Indicates that the control has lost focus.

public void lostFocus()

Method inputSearch

Performs data filtering for the control, based on the specified string.

public void inputSearch(str searchStr)

Parameters

searchStr
The string value to use to filter data; optional.

Method dragLeave

Raises the dragLeave event to indicate that a mouse drag operation has left the current control.

public void dragLeave()

Method OnGotFocus

private void OnGotFocus([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method registerOverrideMethod

public void registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])

Parameters

methodToOverride

objectMethodToCall

overrideObject

Method arrange

public void arrange()

Method OnLeaving

private void OnLeaving([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method deleteRows

;

public void deleteRows(int deleteAfterRow, int rows)

Parameters

deleteAfterRow

rows

Method endDrag

Is called when the user has finished dragging a form control.

public void endDrag()

Remarks

This event is not raised unless the DragDrop property is enabled for the control and a beginDrag event has already been started. To drag a control, a user presses the mouse button in the control area and then moves the mouse pointer.

Method deleteCols

public void deleteCols(int deleteAfterColumn, int columns)

Parameters

deleteAfterColumn

columns

Method clear

public void clear()

Method insertRows

public void insertRows(int insertAfterRow, int rows)

Parameters

insertAfterRow

rows

Method gotFocus

Indicates that the control has received focus.

public void gotFocus()

Method displayControl

Displays the control.

public void displayControl()

Method OnEnter

private void OnEnter([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method copy

Copies the contents of the control to the clipboard.

public void copy()

Method setRowLabel

public void setRowLabel(int row, str text)

Parameters

row

text

Method mouseLeave

Indicates that the mouse pointer has left the control.

public void mouseLeave()

Method paste

Pastes the contents of the clipboard into the control.

public void paste()

Method enter

public void enter()

Method cut

Cuts the contents of the control.

public void cut()

Method dropEx

Raises the dropEx event to indicate that a drop operation is being performed on the current control.

public void dropEx(Array dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.

Method OnLostFocus

private void OnLostFocus([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method updateCell

public void updateCell(int column, int row)

Parameters

column

row

Method insertCols

public void insertCols(int insertAferColumn, int columns)

Parameters

insertAferColumn

columns

Method activeCellChanged

public void activeCellChanged()

Method context

Shows the shortcut menu for the control.

public void context()

Method setFocus

Sets the focus on the control.

public void setFocus()

Class FormTabPageControl

class FormTabPageControl extends FormControl

Remarks

Examples

Methods

Method Description
public FormControl addControl(FormControlType controlType, str controlName, [FormControl insertAfter])
public FormControl addControlEx(str controlClass, str controlName, [FormControl insertAfter])
public FormControl addDataField(int dataSourceId, FieldId fieldId, [FormControl insertAfter], [int arrayIndex])
public boolean alignChild([boolean value])
public boolean alignChildren([boolean value])
public boolean alignControl([boolean value]) Determines whether to align the control.
public boolean allowEdit([boolean value]) Determines whether the user can change the contents of the control.
public boolean allowPageDeactivate()
public boolean allowSysSetup() Retrieves a value that indicates whether the control is shown in the SysSetup form.
public int allowUserSetup([int value])
public int arrangeGuide([int value])
public int arrangeMethod([int value])
public int arrangeWhen([int value])
public boolean autoDeclaration([boolean value]) Determines whether the system can declare a member variable that has the same name as the control.
public int backgroundColor([int value]) Gets or sets the background color of the control.
public Image backgroundImage([Image image], [int drawMode])
public int backStyle([int value]) Determines whether the control background can be transparent.
public int beginDrag(int x, int y) Is called when the user starts to drag a form control.
public int bottomMargin([int value], [AutoMode mode])
public AutoMode bottomMarginMode([AutoMode mode])
public int bottomMarginValue([int value])
public container calcControlSize(int chars, int lines) Retrieves the size of the control.
public boolean canAddDataField(int dataSourceId, FieldId fieldId, [int arrayIndex])
public boolean canContain(FormControl control)
public str caption([str value]) Gets or set the caption of the control.
public int colorScheme([int value]) Gets or sets the color scheme of the control.
public int columns([int value], [ColumnsMode mode])
public ColumnsMode columnsMode([ColumnsMode mode])
public int columnspace([int value], [AutoMode mode])
public AutoMode columnspaceMode([AutoMode mode])
public int columnspaceValue([int value])
public int columnsValue([int value])
public ConfigurationKeyId configurationKey([ConfigurationKeyId value]) Gets or sets the configuration key that is assigned to the control.
public List configurationKeyEx() Retrieves a list that contains the IDs of configuration keys that are in effect for the control.
public int containerScrollHorizontalOffset([int value])
public int containerScrollVerticalOffset([int value])
public boolean contains(FormControl control)
public int controlCount()
public FormControl controlNum(int controlNo)
public str countryRegionCodes([str value]) Gets or sets the comma-separated list of country/region codes for the control.
public FieldId countryRegionContextField([FieldId value])
public str dataRelationPath([str value]) Gets or sets the period-delimited list of relations that links the field binding of the DataField object to a relative table.
public int dataSource([AnyType value]) Gets or sets a data source that will be used by the control or the form.
public int displayTarget([int value]) Gets or sets the value that indicates whether the control is displayed in the Finance and Operations client, in Enterprise Portal for Finance and Operations, or in both.
public int dragDrop([int value]) Determines whether to enable or disable drag-and-drop operations for the control.
public FormDrag dragOver(FormControl dragSource, FormDrag dragMode, int x, int y) Raises the dragOver event to indicate that a mouse drag operation is over the current control.
public FormDrag dragOverEx(Array dragSource, FormDrag dragMode, int x, int y) Raises the dragOverEx event to indicate that a mouse drag operation is over the current control.
public str dragText() Retrieves the text that is displayed when the form control is dragged.
public boolean enabled([boolean value]) Determines whether to enable or disable the object.
public int fastTabExpanded([int value])
public boolean hasChanged([boolean val]) Sets or returns a value that indicates whether the contents of the control have changed.
public boolean hasUserSetting() Indicates whether the control has custom user settings.
public int height(int value, [int mode]) Gets or sets the height of the control.
public int heightMode([int value]) Gets or sets a calculation mode for the height of the control.
public int heightValue([int value]) Gets or sets the height of the control.
public str helpField() Retrieves the Help text for the control.
public str helpText([str value]) Gets or sets the Help text to display at the bottom of the screen when a field or control is pointed to.
public boolean hideIfEmpty([boolean value])
public str hierarchyParent([str value]) Gets or sets the HierarchyParent property value of the control.
public boolean horizontalScrollBarVisible([boolean value])
public int hWnd() Retrieves the Windows handle for the control.
public boolean isActivePage()
public boolean isContainer()
public boolean isDisplayed() Retrieves a value that indicates whether the control is displayed.
public boolean isExpanded()
public boolean isRestricted() Retrieves a value that indicates whether the control is restricted.
public boolean isUserSetupEnabled(int neededSetupRights) Retrieves a value that indicates whether the control allows for the specified level of customization.
public int left(int value, [int mode]) Gets or sets the horizontal position of the control in the form.
public int leftMargin([int value], [AutoMode mode])
public AutoMode leftMarginMode([AutoMode mode])
public int leftMarginValue([int value])
public int leftMode([int value]) Sets the horizontal arrange mode for the control in the form.
public int leftValue([int value]) Gets or sets the horizontal position of the control in the form.
public boolean markAsUserAdd([boolean value]) Marks or unmarks the control as a user-added control.
public int mouseDblClick(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the control is double-clicked by the user.
public int mouseDown(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user clicks the mouse button over the control.
public int mouseMove(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user moves the mouse pointer over the control.
public int mouseUp(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user releases the mouse button over the control area.
public int moveControl(int controlId, [int insertAfterId])
public str name([str value]) Gets or sets the name that is used in code to identify a form, report, table, query, or another Finance and Operations application object.
public int neededPermission([int value])
public container SysObsoleteAttribute()
public int panelStyle([int value])
public FormControl parentControl() Retrieves the parent control for the control.
public str parentPage([str value])
public int rightMargin([int value], [AutoMode mode])
public AutoMode rightMarginMode([AutoMode mode])
public int rightMarginValue([int value])
public int scrollbars([int value])
public SecurityKeyId securityKey([SecurityKeyId value]) Sets or returns the ID of the security key for the control.
public int showContextMenu(int menuHandle) Shows the shortcut menu for the control.
public boolean skip([boolean value]) Sets or returns a value that indicates whether the control is skipped when the user presses the TAB key to move to the control.
public int sort([SortOrder sortDirection])
public int style([int value])
public int tabAppearance([int value])
public boolean tabAutoChange([boolean value])
public str toolTip() Retrieves the tooltip text for the control.
public int top(int value, [int mode]) Gets or sets the vertical position of the control in the form.
public int topMargin([int value], [AutoMode mode])
public AutoMode topMarginMode([AutoMode mode])
public int topMarginValue([int value])
public int topMode([int value]) Sets the vertical arrange mode for the control in the form.
public int topValue([int value]) Gets or sets the vertical position of the control in the form.
public int type([int value])
public boolean SysObsoleteAttribute(container data)
public int userData([int value]) Gets or sets the user data for the control.
public int userDataItem([int value]) Gets or sets the user data item for the control.
public int userDataItems([int value]) Gets or sets the number of user data items for the control.
public int userDisable([int value]) Gets or sets the value that indicates whether the control is disabled for the user.
public int userHeight([int value]) Gets or sets the custom user height for the control.
public int userHide([int value]) Gets or sets the value that indicates whether the control is hidden from the user.
public int userOrgContainer([int value]) Gets or sets the organization container for the control.
public int userOrgSibling([int value]) Gets or sets the organization sibling for the control.
public str userPromptText([str value]) Gets or sets the user label text for the control.
public int userSecurityLevel([int value]) Gets or sets the user security level for the control.
public int userSkip([int value]) Sets or returns the value that indicates whether the form control is skipped when the user presses the TAB key to navigate the controls in the form.
public int userWidth([int value]) Sets or returns the width of the control in pixels, as specified by the user.
public boolean useUserLayout([boolean value])
public boolean verticalScrollBarVisible([boolean value])
public int verticalSpacing([int value], [AutoMode mode]) Gets or sets the vertical spacing of the control in the form.
public AutoMode verticalSpacingMode([AutoMode mode]) Sets the vertical spacing mode for the control in the form.
public int verticalSpacingValue([int value]) Gets or sets the vertical spacing of the control in the form.
public int viewEditMode([int value])
public boolean visible([boolean value]) Sets or returns a value that indicates whether the control is visible.
public int width(int value, [int mode]) Gets or sets the width of the control.
public int widthMode([int value]) Gets or sets the calculation mode of the width of the control.
public int widthValue([int value]) Gets or sets the width of the control.
public void pageActivated()
private void OnLostFocus([FormControl sender], [FormControlEventArgs e])
public void collapse()
public void registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])
private void OnExpanding([FormControl sender], [FormControlEventArgs e])
public void drop(FormControl dragSource, FormDrag dragMode, int x, int y) Raises the drop event to indicate that a drop operation is being performed on the current control.
public void mouseEnter(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user moves the mouse pointer into the control area.
public void jumpRef()
public void endDrag() Is called when the user has finished dragging a form control.
public void filter([str filterStr])
public void paste() Pastes the contents of the clipboard into the control.
public void setFocus() Sets the focus on the control.
public void resetUserSetting() Resets the user settings for the control.
private void OnExpanded([FormControl sender], [FormControlEventArgs e])
public void mouseLeave() Indicates that the mouse pointer has left the control.
public void arrange()
private void OnPageActivated([FormControl sender], [FormControlEventArgs e])
public void dropEx(Array dragSource, FormDrag dragMode, int x, int y) Raises the dropEx event to indicate that a drop operation is being performed on the current control.
public void expand()
public void gotFocus() Indicates that the control has received focus.
public void prefColumnSize(int width, int height) Specifies the preferred column width and height for the form control.
public void copy() Copies the contents of the control to the clipboard.
public void activatePage()
public void context() Shows the shortcut menu for the control.
public void cut() Cuts the contents of the control.
public void lostFocus() Indicates that the control has lost focus.
public void displayControl() Displays the control.
private void OnAllowPageDeactivate([FormControl sender], [FormControlEventArgs e])
public void inputSearch(str searchStr) Performs data filtering for the control, based on the specified string.
public void dragLeave() Raises the dragLeave event to indicate that a mouse drag operation has left the current control.
private void OnGotFocus([FormControl sender], [FormControlEventArgs e])

Method addControl

public FormControl addControl(FormControlType controlType, str controlName, [FormControl insertAfter])

Parameters

controlType

controlName

insertAfter

Return Value

Method addControlEx

public FormControl addControlEx(str controlClass, str controlName, [FormControl insertAfter])

Parameters

controlClass

controlName

insertAfter

Return Value

Method addDataField

public FormControl addDataField(int dataSourceId, FieldId fieldId, [FormControl insertAfter], [int arrayIndex])

Parameters

dataSourceId

fieldId

insertAfter

arrayIndex

Return Value

Method alignChild

public boolean alignChild([boolean value])

Parameters

value

Return Value

Method alignChildren

public boolean alignChildren([boolean value])

Parameters

value

Return Value

Method alignControl

Determines whether to align the control.

public boolean alignControl([boolean value])

Parameters

value
The new value for the property; optional.

Return Value

true if the control should be aligned; otherwise, false.

Remarks

The upper-left corner of the control is aligned according to the longest label.

Method allowEdit

Determines whether the user can change the contents of the control.

public boolean allowEdit([boolean value])

Parameters

value
The value to assign to the allowEdit property.

Return Value

true if the control can be edited; otherwise, false.

Remarks

When this property is set on a container control, modifications are disabled or enabled for all controls in the container.

Method allowPageDeactivate

public boolean allowPageDeactivate()

Return Value

Method allowSysSetup

Retrieves a value that indicates whether the control is shown in the SysSetup form.

public boolean allowSysSetup()

Return Value

true if the control is shown in the SysSetup form; otherwise, false.

Method allowUserSetup

public int allowUserSetup([int value])

Parameters

value

Return Value

Method arrangeGuide

public int arrangeGuide([int value])

Parameters

value

Return Value

Method arrangeMethod

public int arrangeMethod([int value])

Parameters

value

Return Value

Method arrangeWhen

public int arrangeWhen([int value])

Parameters

value

Return Value

Method autoDeclaration

Determines whether the system can declare a member variable that has the same name as the control.

public boolean autoDeclaration([boolean value])

Parameters

value
The new value of the property; optional

Return Value

true if the member variable can be declared for this control; otherwise, false.

Remarks

Controls cannot have identical names.

Method backgroundColor

Gets or sets the background color of the control.

public int backgroundColor([int value])

Parameters

value

Return Value

An integer that contains a packed RGB color.

Remarks

The integer that is returned contains a packed RGB color as follows:

  • The low-order byte contains a value for the relative intensity of red.
  • The second byte contains a value for green.
  • The third byte contains a value for blue.
  • The high-order byte must be zero.
  • The maximum value for a single byte is 255.

Method backgroundImage

public Image backgroundImage([Image image], [int drawMode])

Parameters

image

drawMode

Return Value

Method backStyle

Determines whether the control background can be transparent.

public int backStyle([int value])

Parameters

value

Return Value

1 if the control background can be transparent; otherwise, 0.

Method beginDrag

Is called when the user starts to drag a form control.

public int beginDrag(int x, int y)

Parameters

x
An integer value that indicates the y-coordinate of the mouse pointer. The coordinate is relative to the upper-left corner of the control.

y
An integer value that indicates the y-coordinate of the mouse pointer. The coordinate is relative to the upper-left corner of the control.

Return Value

0 (zero) if the event has been handled.

Remarks

This event is not raised unless the DragDrop property is enabled for the control. To drag a control, a user presses the mouse button in the control area and then moves the mouse pointer.

Method bottomMargin

public int bottomMargin([int value], [AutoMode mode])

Parameters

value

mode

Return Value

Method bottomMarginMode

public AutoMode bottomMarginMode([AutoMode mode])

Parameters

mode

Return Value

Method bottomMarginValue

public int bottomMarginValue([int value])

Parameters

value

Return Value

Method calcControlSize

Retrieves the size of the control.

public container calcControlSize(int chars, int lines)

Parameters

chars
The number of lines to use to determine the height.

lines
The number of lines to use to determine the height.

Return Value

The container that holds the width and height.

Method canAddDataField

public boolean canAddDataField(int dataSourceId, FieldId fieldId, [int arrayIndex])

Parameters

dataSourceId

fieldId

arrayIndex

Return Value

Method canContain

public boolean canContain(FormControl control)

Parameters

control

Return Value

Method caption

Gets or set the caption of the control.

public str caption([str value])

Parameters

value

Return Value

The string that is used as the caption of the control.

Method colorScheme

Gets or sets the color scheme of the control.

public int colorScheme([int value])

Parameters

value

Return Value

An integer between zero and two, inclusive.

Remarks

The color scheme is defined according to the following table.

Value Style
0 Default
1 The MicrosoftWindows palette
2 The true-color scheme

Method columns

public int columns([int value], [ColumnsMode mode])

Parameters

value

mode

Return Value

Method columnsMode

public ColumnsMode columnsMode([ColumnsMode mode])

Parameters

mode

Return Value

Method columnspace

public int columnspace([int value], [AutoMode mode])

Parameters

value

mode

Return Value

Method columnspaceMode

public AutoMode columnspaceMode([AutoMode mode])

Parameters

mode

Return Value

Method columnspaceValue

public int columnspaceValue([int value])

Parameters

value

Return Value

Method columnsValue

public int columnsValue([int value])

Parameters

value

Return Value

Method configurationKey

Gets or sets the configuration key that is assigned to the control.

public ConfigurationKeyId configurationKey([ConfigurationKeyId value])

Parameters

value
The ID of the configuration key to assign to the control; optional.

Return Value

The identifier of the configuration key that is assigned to the control.

Remarks

The configuration key is used to determine whether this control can be displayed. If the configuration key is disabled in the system, the control is not displayed in the form.

Method configurationKeyEx

Retrieves a list that contains the IDs of configuration keys that are in effect for the control.

public List configurationKeyEx()

Return Value

A list that contains the IDs of configuration keys that are in effect for the control.

Remarks

The returned list does not contain duplicate IDs. If the control is bound to a data source, the returned list of configuration key IDs also includes the configuration key ID for the table and field. The returned list also contains any configuration key IDs that are applied to the properties, extended data type, or enumType methods.

Method containerScrollHorizontalOffset

public int containerScrollHorizontalOffset([int value])

Parameters

value

Return Value

Method containerScrollVerticalOffset

public int containerScrollVerticalOffset([int value])

Parameters

value

Return Value

Method contains

public boolean contains(FormControl control)

Parameters

control

Return Value

Method controlCount

public int controlCount()

Return Value

Method controlNum

public FormControl controlNum(int controlNo)

Parameters

controlNo

Return Value

Method countryRegionCodes

Gets or sets the comma-separated list of country/region codes for the control.

public str countryRegionCodes([str value])

Parameters

value
The string that contains the country/region codes to set; optional.

Return Value

The comma-separated list of country/region codes for the control.

Method countryRegionContextField

public FieldId countryRegionContextField([FieldId value])

Parameters

value

Return Value

Method dataRelationPath

Gets or sets the period-delimited list of relations that links the field binding of the DataField object to a relative table.

public str dataRelationPath([str value])

Parameters

value
The string that contains the period-delimited list of relations; optional.

Return Value

The period-delimited list of relations that links the field binding of the DataField object to a relative table.

Remarks

This method is used by the reference group control to track exactly which relations produce the replacement field that is used. It enables the reference group control to bind consistently to the controls that it contains.

Method dataSource

Gets or sets a data source that will be used by the control or the form.

public int dataSource([AnyType value])

Parameters

value

Return Value

The identifier of the data source that will be used.

Method displayTarget

Gets or sets the value that indicates whether the control is displayed in the Finance and Operations client, in Enterprise Portal for Finance and Operations, or in both.

public int displayTarget([int value])

Parameters

value
The integer value that indicates where the control is displayed; optional.

Return Value

The value that indicates whether the control is displayed in the Finance and Operations client, in Enterprise Portal, or in both.

Method dragDrop

Determines whether to enable or disable drag-and-drop operations for the control.

public int dragDrop([int value])

Parameters

value
An integer that indicates whether drag-and-drop behavior is enabled; optional.

Return Value

1 if drag-and-drop operations are enabled; otherwise, false.

Remarks

Use the dragLeave Method, the dragOver Method, and the dragOverEx Method to specify the behavior.

Method dragOver

Raises the dragOver event to indicate that a mouse drag operation is over the current control.

public FormDrag dragOver(FormControl dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.

Return Value

A FormDrag enumeration value that indicates the mode of dragging.

Method dragOverEx

Raises the dragOverEx event to indicate that a mouse drag operation is over the current control.

public FormDrag dragOverEx(Array dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.

Return Value

A FormDrag enumeration value that indicates the mode of dragging.

Method dragText

Retrieves the text that is displayed when the form control is dragged.

public str dragText()

Return Value

The text that is displayed when the control is dragged; an empty string if there is no text to display when the control is dragged.

Method enabled

Determines whether to enable or disable the object.

public boolean enabled([boolean value])

Parameters

value
A Boolean value that specifies whether the control is enabled; optional.

Return Value

true if the object is enabled; otherwise, false.

Remarks

The enabled property allows controls to be enabled or disabled at run time. For example, you can disable objects that do not apply to the current state of the application. You can also disable a control that is used only for display purposes, such as an error message, which provides read-only information.

Method fastTabExpanded

public int fastTabExpanded([int value])

Parameters

value

Return Value

Method hasChanged

Sets or returns a value that indicates whether the contents of the control have changed.

public boolean hasChanged([boolean val])

Parameters

val
The value to assign as the hasChanged value for the control; optional.

Return Value

true if the contents of the control have changed; otherwise, false.

Method hasUserSetting

Indicates whether the control has custom user settings.

public boolean hasUserSetting()

Return Value

true if the control has custom user settings; otherwise, false.

Method height

Gets or sets the height of the control.

public int height(int value, [int mode])

Parameters

value
An integer that indicates how the height is calculated; optional.

mode
An integer that indicates how the height is calculated; optional.

Return Value

The height of the control in pixels.

Remarks

Exact mode is used if the value parameter is omitted. Calculate the height according to the following table.

Mode Height calculation
-1 Exact The exact height in pixels of the controls is used.
0 Auto The height of the control is calculated automatically and the value parameter is ignored.
1 Column height The layout of the form determines the height of the control.

The height and height calculation mode can be set separately.

Method heightMode

Gets or sets a calculation mode for the height of the control.

public int heightMode([int value])

Parameters

value
An integer value that indicates how control height is calculated; optional.

Return Value

The calculation mode.

Remarks

Calculate the height according to the following table.

Mode Height calculation
Exact The exact height in pixels of the controls is used.
Auto The height of the control is calculated automatically and the value parameter is ignored.
Column height The layout of the form determines the height of the control.

The height of the control might change when the mode is set to auto or column height.

Method heightValue

Gets or sets the height of the control.

public int heightValue([int value])

Parameters

value
An integer that specifies the height in pixels; optional.

Return Value

The height in pixels.

Remarks

The height of the control is not changed unless the exact height calculation mode is used.

Method helpField

Retrieves the Help text for the control.

public str helpField()

Return Value

The Help text for the control; an empty string if there is no Help text for the control.

Remarks

The helpField method cannot be used to set the value of the Help text. Use the helpText method to set the value of the Help text.

Method helpText

Gets or sets the Help text to display at the bottom of the screen when a field or control is pointed to.

public str helpText([str value])

Parameters

value
The value that is assigned as the Help text for the control.

Return Value

The string to be displayed at the bottom of the screen.

Remarks

Set the HelpText property for an object by using the property sheet. The Help text must not exceed 250 characters.

Method hideIfEmpty

public boolean hideIfEmpty([boolean value])

Parameters

value

Return Value

Method hierarchyParent

Gets or sets the HierarchyParent property value of the control.

public str hierarchyParent([str value])

Parameters

value
The value to assign to the HierarchyParent property of the control.

Return Value

The HierarchyParent property value of the control.

Method horizontalScrollBarVisible

public boolean horizontalScrollBarVisible([boolean value])

Parameters

value

Return Value

Method hWnd

Retrieves the Windows handle for the control.

public int hWnd()

Return Value

The handle for the control.

Remarks

The handle can be used with the Windows API.

Method isActivePage

public boolean isActivePage()

Return Value

Method isContainer

public boolean isContainer()

Return Value

Method isDisplayed

Retrieves a value that indicates whether the control is displayed.

public boolean isDisplayed()

Return Value

true if the control is displayed; otherwise, false.

Remarks

To modify the visible state of the control, call the visible method.

Method isExpanded

public boolean isExpanded()

Return Value

Method isRestricted

Retrieves a value that indicates whether the control is restricted.

public boolean isRestricted()

Return Value

true if the control is restricted; otherwise, false.

Method isUserSetupEnabled

Retrieves a value that indicates whether the control allows for the specified level of customization.

public boolean isUserSetupEnabled(int neededSetupRights)

Parameters

neededSetupRights
A value from the FormAllowUserSetup enumeration that specifies the level of customization that is being queried for the control.

Return Value

true if the control, design, and parent containers allow for the level of customization that is specified by the neededSetupRights parameter; otherwise, false.

Remarks

The following table describes the values for the neededSetupRights parameter.

FormAllowUserSetup::No 0 No changes can be made to the control. If this value is set for the neededSetupRights parameter, the method always returns true.
FormAllowUserSetup::Restricted 1 The user can change the editable, visible, skip, label, and width properties of the control. The user cannot move the control.
FormAllowUserSetup::Yes 2 The user can change the editable, visible, skip, label, and width properties of the control. The user can also move the control.

For this method to return true, the AllowUserSetup property for the design and all parent containers must allow for the level of access that is specified by the neededSetupRights parameter.

Method left

Gets or sets the horizontal position of the control in the form.

public int left(int value, [int mode])

Parameters

value
An integer value that indicates the horizontal arrange mode for the control; optional.

mode
An integer value that indicates the horizontal arrange mode for the control; optional.

Return Value

The horizontal position of the control in the form.

Method leftMargin

public int leftMargin([int value], [AutoMode mode])

Parameters

value

mode

Return Value

Method leftMarginMode

public AutoMode leftMarginMode([AutoMode mode])

Parameters

mode

Return Value

Method leftMarginValue

public int leftMarginValue([int value])

Parameters

value

Return Value

Method leftMode

Sets the horizontal arrange mode for the control in the form.

public int leftMode([int value])

Parameters

value
An integer value that indicates the horizontal arrange mode for the control; optional.

Return Value

The horizontal arrange mode for the control in the form.

Method leftValue

Gets or sets the horizontal position of the control in the form.

public int leftValue([int value])

Parameters

value
An integer value that indicates the horizontal position of the control; optional.

Return Value

The horizontal position of the control in the form.

Method markAsUserAdd

Marks or unmarks the control as a user-added control.

public boolean markAsUserAdd([boolean value])

Parameters

value
The Boolean value that indicates whether the control should be marked as a user-added control.

Return Value

true if the control was marked as a user-added control; otherwise, false.

Method mouseDblClick

Is called when the control is double-clicked by the user.

public int mouseDblClick(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned.

Method mouseDown

Is called when the user clicks the mouse button over the control.

public int mouseDown(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned. This event is called only if a value is specified for the label of the control and the ShowLabel property of the control is set to Yes.

Method mouseMove

Is called when the user moves the mouse pointer over the control.

public int mouseMove(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned.

Method mouseUp

Is called when the user releases the mouse button over the control area.

public int mouseUp(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned. This event is called only if a value is specified for the label of the control and the ShowLabel property of the control is set to Yes.

Method moveControl

public int moveControl(int controlId, [int insertAfterId])

Parameters

controlId

insertAfterId

Return Value

Method name

Gets or sets the name that is used in code to identify a form, report, table, query, or another Finance and Operations application object.

public str name([str value])

Parameters

value
The name assigned to the control.

Return Value

The name that is used in code to identify an application object.

Remarks

The name property value of an object must meet the following criteria to avoid code conflicts:

  • Begins with a letter.
  • Doesn't exceed 250 characters.
  • Can include numbers and underscore characters.
  • Cannot include punctuation or spaces.
  • Tables cannot have the same name as other public objects, such as extended data types, base enumeration types, classes, and so on.

Method neededPermission

public int neededPermission([int value])

Parameters

value

Return Value

Method SysObsoleteAttribute

public container SysObsoleteAttribute()

Return Value

Method panelStyle

public int panelStyle([int value])

Parameters

value

Return Value

Method parentControl

Retrieves the parent control for the control.

public FormControl parentControl()

Return Value

The parent control for the control.

Method parentPage

public str parentPage([str value])

Parameters

value

Return Value

Method rightMargin

public int rightMargin([int value], [AutoMode mode])

Parameters

value

mode

Return Value

Method rightMarginMode

public AutoMode rightMarginMode([AutoMode mode])

Parameters

mode

Return Value

Method rightMarginValue

public int rightMarginValue([int value])

Parameters

value

Return Value

Method scrollbars

public int scrollbars([int value])

Parameters

value

Return Value

Method securityKey

Sets or returns the ID of the security key for the control.

public SecurityKeyId securityKey([SecurityKeyId value])

Parameters

value
The ID of the security key to assign to the control; optional.

Return Value

The ID of the security key for the control; 0 (zero) if no security key is assigned to the control.

Method showContextMenu

Shows the shortcut menu for the control.

public int showContextMenu(int menuHandle)

Parameters

menuHandle
The ID of the menu to show.

Return Value

An integer value that indicates whether the call succeeded.

Method skip

Sets or returns a value that indicates whether the control is skipped when the user presses the TAB key to move to the control.

public boolean skip([boolean value])

Parameters

value
The value to assign to the skip property of the control; optional.

Return Value

true if the control is skipped when the user presses the TAB key to move to the control; otherwise, false.

Remarks

If the enabled property is true, the allowEdit property is false, and the skip property is true, the user cannot change the contents of the control but can still copy the contents of the control.

Method sort

public int sort([SortOrder sortDirection])

Parameters

sortDirection

Return Value

Method style

public int style([int value])

Parameters

value

Return Value

Method tabAppearance

public int tabAppearance([int value])

Parameters

value

Return Value

Method tabAutoChange

public boolean tabAutoChange([boolean value])

Parameters

value

Return Value

Method toolTip

Retrieves the tooltip text for the control.

public str toolTip()

Return Value

The tooltip text for the control; an empty string if no tooltip text has been defined for the control.

Remarks

The method might be overridden to provide a value to the toolTip method.

Method top

Gets or sets the vertical position of the control in the form.

public int top(int value, [int mode])

Parameters

value
An integer value that indicates the vertical arrange mode for the control; optional.

mode
An integer value that indicates the vertical arrange mode for the control; optional.

Return Value

The vertical position of the control in the form.

Method topMargin

public int topMargin([int value], [AutoMode mode])

Parameters

value

mode

Return Value

Method topMarginMode

public AutoMode topMarginMode([AutoMode mode])

Parameters

mode

Return Value

Method topMarginValue

public int topMarginValue([int value])

Parameters

value

Return Value

Method topMode

Sets the vertical arrange mode for the control in the form.

public int topMode([int value])

Parameters

value
An integer value that indicates the vertical arrange mode for the control; optional.

Return Value

The vertical arrange mode for the control in the form.

Method topValue

Gets or sets the vertical position of the control in the form.

public int topValue([int value])

Parameters

value
An integer value that indicates the vertical position of the control; optional.

Return Value

The vertical position of the control in the form.

Method type

public int type([int value])

Parameters

value

Return Value

Method SysObsoleteAttribute

public boolean SysObsoleteAttribute(container data)

Parameters

data

Return Value

Method userData

Gets or sets the user data for the control.

public int userData([int value])

Parameters

value
An integer value that indicates the user data for the control; optional.

Return Value

The user data for the control.

Method userDataItem

Gets or sets the user data item for the control.

public int userDataItem([int value])

Parameters

value
An integer value that indicates the user data item for the control; optional.

Return Value

The user data item for the control.

Method userDataItems

Gets or sets the number of user data items for the control.

public int userDataItems([int value])

Parameters

value
An integer value that indicates the number of user data items for the control; optional.

Return Value

The number of user data items for the control.

Method userDisable

Gets or sets the value that indicates whether the control is disabled for the user.

public int userDisable([int value])

Parameters

value
The value that indicates whether the control is disabled for the user; optional.

Return Value

1 if the control is disabled for the user; otherwise, 0.

Method userHeight

Gets or sets the custom user height for the control.

public int userHeight([int value])

Parameters

value
The user height for the control; optional.

Return Value

The custom user height for the control.

Method userHide

Gets or sets the value that indicates whether the control is hidden from the user.

public int userHide([int value])

Parameters

value
The value that indicates whether the control is hidden from the user; optional.

Return Value

1 if the control is hidden from the user; otherwise, 0.

Remarks

The user specifies whether a control is hidden by right-clicking the control when it is viewable or by right-clicking another control when the original control is hidden. A right-click opens a menu that can be used to hide or display the control. This method lets you programmatically determine and set the value.

Method userOrgContainer

Gets or sets the organization container for the control.

public int userOrgContainer([int value])

Parameters

value
The organization container to set for the control; optional.

Return Value

The organization container for the control.

Method userOrgSibling

Gets or sets the organization sibling for the control.

public int userOrgSibling([int value])

Parameters

value
The organization sibling to set for the control; optional.

Return Value

The organization sibling for the control.

Method userPromptText

Gets or sets the user label text for the control.

public str userPromptText([str value])

Parameters

value
The user label text to set for the control; optional.

Return Value

The user label text for the control.

Method userSecurityLevel

Gets or sets the user security level for the control.

public int userSecurityLevel([int value])

Parameters

value
The user security level to set for the control; optional.

Return Value

The user security level for the control.

Method userSkip

Sets or returns the value that indicates whether the form control is skipped when the user presses the TAB key to navigate the controls in the form.

public int userSkip([int value])

Parameters

value
The value to assign to the userSkip property; optional. The value is 1 if the user setting to skip the control is in effect; otherwise, the value is 0.

Return Value

1 if the user setting to skip the control is in effect; otherwise, 0.

Method userWidth

Sets or returns the width of the control in pixels, as specified by the user.

public int userWidth([int value])

Parameters

value
The number of pixels to use as the width of the control; optional.

Return Value

The number of pixels that the user specified as the width of the control; 0 (zero) if the user did not specify a character width.

Remarks

The userWidth method returns the width in pixels, based on six times the number of characters. For example, if the user has specified 30 characters as the width of the control, the return value is 6 * 30 = 180. To specify the width of the control in characters, users can right-click the control to open the setup form where the character specification is made.

Method useUserLayout

public boolean useUserLayout([boolean value])

Parameters

value

Return Value

Method verticalScrollBarVisible

public boolean verticalScrollBarVisible([boolean value])

Parameters

value

Return Value

Method verticalSpacing

Gets or sets the vertical spacing of the control in the form.

public int verticalSpacing([int value], [AutoMode mode])

Parameters

value
An integer value that indicates the AutoMode value for the control; optional.

mode
An integer value that indicates the AutoMode value for the control; optional.

Return Value

The vertical spacing of the control in the form.

Method verticalSpacingMode

Sets the vertical spacing mode for the control in the form.

public AutoMode verticalSpacingMode([AutoMode mode])

Parameters

mode

Return Value

The vertical spacing mode for the control in the form.

Method verticalSpacingValue

Gets or sets the vertical spacing of the control in the form.

public int verticalSpacingValue([int value])

Parameters

value
An integer value that indicates the vertical spacing of the control; optional.

Return Value

The vertical spacing of the control in the form.

Method viewEditMode

public int viewEditMode([int value])

Parameters

value

Return Value

Method visible

Sets or returns a value that indicates whether the control is visible.

public boolean visible([boolean value])

Parameters

value
The value to assign to the visibility setting for the control; optional.

Return Value

true if the control is visible; otherwise, false.

Method width

Gets or sets the width of the control.

public int width(int value, [int mode])

Parameters

value
An integer that indicates how the width is calculated; optional.

mode
An integer that indicates how the width is calculated; optional.

Return Value

The width of the control in pixels.

Remarks

Exact mode is used if the value parameter is omitted. Calculate the width according to the following table.

Mode Width calculation
-1 Exact The exact width in pixels of the controls is used.
0 Auto The width of the control is calculated automatically and the value parameter is ignored.
1 Column width The layout of the form determines the width of the control.

The width and width calculation mode can be set separately.

Method widthMode

Gets or sets the calculation mode of the width of the control.

public int widthMode([int value])

Parameters

value
An integer value that indicates how control width is calculated; optional.

Return Value

An integer value that indicates the current calculation mode.

Remarks

Calculate the width according to the following table.

Mode Width calculation
Exact The exact width in pixels of the controls is used.
Auto The width of the control is calculated automatically and the value parameter is ignored.
Column width The layout of the form determines the width of the control.

The width of the control might change when the mode is set to auto or column width.

Method widthValue

Gets or sets the width of the control.

public int widthValue([int value])

Parameters

value
An integer that specifies the width in pixels; optional.

Return Value

The width in pixels of the control.

Remarks

To change the width of the control, use the exact width calculation mode.

Method pageActivated

public void pageActivated()

Method OnLostFocus

private void OnLostFocus([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method collapse

public void collapse()

Method registerOverrideMethod

public void registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])

Parameters

methodToOverride

objectMethodToCall

overrideObject

Method OnExpanding

private void OnExpanding([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method drop

Raises the drop event to indicate that a drop operation is being performed on the current control.

public void drop(FormControl dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.

Method mouseEnter

Is called when the user moves the mouse pointer into the control area.

public void mouseEnter(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Method jumpRef

public void jumpRef()

Method endDrag

Is called when the user has finished dragging a form control.

public void endDrag()

Remarks

This event is not raised unless the DragDrop property is enabled for the control and a beginDrag event has already been started. To drag a control, a user presses the mouse button in the control area and then moves the mouse pointer.

Method filter

public void filter([str filterStr])

Parameters

filterStr

Method paste

Pastes the contents of the clipboard into the control.

public void paste()

Method setFocus

Sets the focus on the control.

public void setFocus()

Method resetUserSetting

Resets the user settings for the control.

public void resetUserSetting()

Method OnExpanded

private void OnExpanded([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method mouseLeave

Indicates that the mouse pointer has left the control.

public void mouseLeave()

Method arrange

public void arrange()

Method OnPageActivated

private void OnPageActivated([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method dropEx

Raises the dropEx event to indicate that a drop operation is being performed on the current control.

public void dropEx(Array dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.

Method expand

public void expand()

Method gotFocus

Indicates that the control has received focus.

public void gotFocus()

Method prefColumnSize

Specifies the preferred column width and height for the form control.

public void prefColumnSize(int width, int height)

Parameters

width
The preferred height of the control.

height
The preferred height of the control.

Method copy

Copies the contents of the control to the clipboard.

public void copy()

Method activatePage

public void activatePage()

Method context

Shows the shortcut menu for the control.

public void context()

Method cut

Cuts the contents of the control.

public void cut()

Method lostFocus

Indicates that the control has lost focus.

public void lostFocus()

Method displayControl

Displays the control.

public void displayControl()

Method OnAllowPageDeactivate

private void OnAllowPageDeactivate([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method inputSearch

Performs data filtering for the control, based on the specified string.

public void inputSearch(str searchStr)

Parameters

searchStr
The string value to use to filter data; optional.

Method dragLeave

Raises the dragLeave event to indicate that a mouse drag operation has left the current control.

public void dragLeave()

Method OnGotFocus

private void OnGotFocus([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Class FormTimeControl

class FormTimeControl extends FormControl

Remarks

Examples

Methods

Method Description
public boolean alignControl([boolean value]) Determines whether to align the control.
public int alignment([int value])
public boolean allowEdit([boolean value]) Determines whether the user can change the contents of the control.
public boolean allowSysSetup() Retrieves a value that indicates whether the control is shown in the SysSetup form.
public int arrayIndex([int value])
public boolean autoDeclaration([boolean value]) Determines whether the system can declare a member variable that has the same name as the control.
public int backgroundColor([int value]) Gets or sets the background color of the control.
public int backStyle([int value]) Determiness whether the control background can be transparent.
public int beginDrag(int x, int y) Is called when the user begins dragging a form control.
public int bold([int value]) Gets or sets the weight of font that was used to output text in the control.
public int border([int value]) Gets or sets the style of the borderline of the control.
public int cacheDataMethod([int value])
public container calcControlSize(int chars, int lines) Retrieves the size of the control.
public int characterSet([int value]) Gets or sets the character set of the font.
public int charFromPos(int x, int y)
public int colorScheme([int value]) Gets or sets the color scheme of the control.
public ConfigurationKeyId configurationKey([ConfigurationKeyId value]) Gets or sets the configuration key that is assigned to the control.
public List configurationKeyEx() Retrieves a list that contains the IDs of configuration keys that are in effect for the control.
public str countryRegionCodes([str value]) Gets or sets the comma-separated list of country/region codes for the control.
public FieldId countryRegionContextField([FieldId value])
public FieldId dataField([FieldId value])
public int dataFieldArrayIndex()
public FieldName dataFieldName()
public str dataMethod([str value])
public str dataRelationPath([str value]) Gets or sets the period-delimited list of relations that links the field binding of the DataField object to a relative table.
public int dataSource([AnyType value]) Gets or sets a data source that will be used by the control or the form.
public int direction([int value])
public int displayHeight([int value], [AutoMode mode])
public AutoMode displayHeightMode([AutoMode mode])
public int displayHeightValue([int value])
public int displayLength([int value], [AutoMode mode])
public AutoMode displayLengthMode([AutoMode mode])
public int displayLengthValue([int value])
public int displayTarget([int value]) Gets or sets the value that indicates whether the control is displayed in the Finance and Operations client, in Enterprise Portal for Finance and Operations, or in both.
public int dragDrop([int value]) Indicates whether to enable or disable drag-and-drop operations for the control.
public FormDrag dragOver(FormControl dragSource, FormDrag dragMode, int x, int y) Raises the dragOver event to indicate that a mouse drag operation is over the current control.
public FormDrag dragOverEx(Array dragSource, FormDrag dragMode, int x, int y) Raises the dragOverEx event to indicate that a mouse drag operation is over the current control.
public str dragText() Retrieves the text that is displayed when the form control is dragged.
public boolean enabled([boolean value]) Determines whether to enable or disable the object.
public ExtendedTypeId extendedDataType([ExtendedTypeId value])
public int fastTabSummary([int value])
public str font([str value]) Gets or sets the name of the font for the control to use.
public int fontSize([int value]) Gets or sets the size of the font for the control to use.
public int foregroundColor([int value]) Gets or sets the text color for the control to use.
public container getCursorPos()
public int getFirstVisibleLine()
public str getLine(int lineNo)
public int getLineCount()
public container getSelection()
public boolean hasChanged([boolean val]) Sets or returns a value that indicates whether the contents of the control have changed.
public boolean hasUserSetting() Indicates whether the control has custom user settings.
public int height(int value, [int mode]) Gets or sets the height of the control.
public int heightMode([int value]) Gets or sets a calculation mode for the height of the control.
public int heightValue([int value]) Gets or sets the height of the control.
public str helpField() Retrieves the Help text for the control.
public str helpText([str value]) Gets or sets the Help text to display at the bottom of the screen when a field or control is pointed to.
public str hierarchyParent([str value]) Gets or sets the HierarchyParent property value of the control.
public int hWnd() Retrieves the Windows handle for the control.
public int iMEMode([int value])
public boolean isContainer()
public boolean isDisplayed() Retrieves a value that indicates whether the control is displayed.
public boolean isRestricted() Retrieves a value that indicates whether the control is restricted.
public boolean isUserSetupEnabled(int neededSetupRights) Retrieves a value that indicates whether the control allows for the specified level of customization.
public boolean isValid()
public boolean italic([boolean value])
public str label([str value]) Gets or sets the label for a control.
public int labelAlignment([int value])
public int labelBold([int value])
public int labelCharacterSet([int value])
public str labelFont([str value])
public int labelFontSize([int value])
public int labelForegroundColor([int value])
public int labelGuide([int value])
public int labelHeight(int value, [int mode])
public int labelHeightMode([int value])
public int labelHeightValue([int value])
public boolean labelItalic([boolean value])
public int labelMouseDblClick(int x, int y, int button, boolean Ctrl, boolean Shift)
public int labelMouseDown(int x, int y, int button, boolean Ctrl, boolean Shift)
public int labelMouseUp(int x, int y, int button, boolean Ctrl, boolean Shift)
public int labelPosition([int value])
public boolean labelUnderline([boolean value])
public int labelWidth(int value, [int mode])
public int labelWidthMode([int value])
public int labelWidthValue([int value])
public boolean leave()
public int left(int value, [int mode]) Gets or sets the horizontal position of the control in the form.
public int leftMode([int value]) Sets the horizontal arrange mode for the control in the form.
public int leftValue([int value]) Gets or sets the horizontal position of the control in the form.
public int limitText([int value], [AutoMode mode])
public AutoMode limitTextMode([AutoMode mode])
public int limitTextValue([int value])
public int lineFromChar(int charIndex)
public int lineIndex(int lineNo)
public int lineLength(int lineNo)
public int lookupButton([int value])
public boolean mandatory([boolean value])
public boolean markAsUserAdd([boolean value]) Marks or unmarks the control as a user-added control.
public boolean modified()
public int mouseDblClick(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the control is double-clicked by the user.
public int mouseDown(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user clicks the mouse button over the control.
public int mouseMove(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user moves the mouse pointer over the control.
public int mouseUp(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user releases the mouse button over the control area.
public str name([str value]) Gets or sets the name that is used in code to identify a form, report, table, query, or another Finance and Operations application object.
public int neededPermission([int value])
public container SysObsoleteAttribute()
public FormControl parentControl() Retrieves the parent control for the control.
public container posFromChar(int charIndex)
public str previewPartRef([str value])
public int promptrect([int value])
public boolean replaceOnLookup([boolean value])
public int searchAfterInput([int value])
public int searchMode([int value])
public SecurityKeyId securityKey([SecurityKeyId value]) Sets or returns the ID of the security key for the control.
public int showContextMenu(int menuHandle) Shows the shortcut menu for the control.
public boolean showLabel([boolean value])
public boolean skip([boolean value]) Sets or returns a value that indicates whether the control is skipped when the user presses the TAB key to move to the control.
public int sort([SortOrder sortDirection])
public int style([int value])
public int timeFormat([int value])
public int timeHours([int value])
public int timeMinute([int value])
public int timeSeconds([int value])
public int timeSeparator([int value])
public str toolTip() Retrieves the tooltip text for the control.
public int top(int value, [int mode]) Gets or sets the vertical position of the control in the form.
public int topMode([int value]) Sets the vertical arrange mode for the control in the form.
public int topValue([int value]) Gets or sets the vertical position of the control in the form.
public int type([int value])
public boolean underline([boolean value])
public boolean SysObsoleteAttribute(container data)
public int userData([int value]) Gets or sets the user data for the control.
public int userDataItem([int value]) Gets or sets the user data item for the control.
public int userDataItems([int value]) Gets or sets the number of user data items for the control.
public int userDisable([int value]) Gets or sets the value that indicates whether the control is disabled for the user.
public int userFastTabSummary([int value])
public int userHeight([int value]) Gets or sets the custom user height for the control.
public int userHide([int value]) Gets or sets the value that indicates whether the control is hidden from the user.
public int userOrgContainer([int value]) Gets or sets the organization container for the control.
public int userOrgSibling([int value]) Gets or sets the organization sibling for the control.
public str userPromptText([str value]) Gets or sets the user label text for the control.
public int userSecurityLevel([int value]) Gets or sets the user security level for the control.
public int userSkip([int value]) Sets or returns the value that indicates whether the form control is skipped when the user presses the TAB key to navigate the controls in the form.
public int userWidth([int value]) Sets or returns the width of the control in pixels, as specified by the user.
public boolean validate()
public int value([int value])
public int verticalSpacing([int value], [AutoMode mode]) Gets or sets the vertical spacing of the control in the form.
public AutoMode verticalSpacingMode([AutoMode mode]) Sets the vertical spacing mode for the control in the form.
public int verticalSpacingValue([int value]) Gets or sets the vertical spacing of the control in the form.
public int viewEditMode([int value])
public boolean visible([boolean value]) Sets or returns a value that indicates whether the control is visible.
public int width(int value, [int mode]) Gets or sets the width of the control.
public int widthMode([int value]) Gets or sets the calculation mode of the width of the control.
public int widthValue([int value]) Gets or sets the width of the control.
public void performTypeLookup([int userType], [int arrayIndex], [SelectableDataArea company])
private void OnLostFocus([FormControl sender], [FormControlEventArgs e])
public void endDrag() Is called when the user has finished dragging a form control.
public void textChange()
public void lookup()
private void OnEnter([FormControl sender], [FormControlEventArgs e])
public void mouseLeave() Indicates that the mouse pointer has left the control.
public void undo()
public void setCursorPos(int x, int y)
public void performDBLookup([FieldId fieldId], [TableId tableId], [SelectableDataArea company])
private void OnValidated([FormControl sender], [FormControlEventArgs e])
public void context() Shows the shortcut menu for the control.
public void dropEx(Array dragSource, FormDrag dragMode, int x, int y) Raises the dropEx event to indicate that a drop operation is being performed on the current control.
private void OnLeaving([FormControl sender], [FormControlEventArgs e])
public void filter([str filterStr])
private void OnLookup([FormControl sender], [FormControlEventArgs e])
public void resetUserSetting() Resets the user settings for the control.
public void displayControl() Displays the control.
public void enter()
public void inputSearch(str searchStr) Performs data filtering for the control, based on the specified string.
public void setFocus() Sets the focus on the control.
public void gotFocus() Indicates that the control has received focus.
public void copy() Copies the contents of the control to the clipboard.
public void dragLeave() Raises the dragLeave event to indicate that a mouse drag operation has left the current control.
public void lineScroll(int dx, int dy)
public void cut() Cuts the contents of the control.
private void OnGotFocus([FormControl sender], [FormControlEventArgs e])
public void performFormLookup(xFormRun form)
private void OnModified([FormControl sender], [FormControlEventArgs e])
public void paste() Pastes the contents of the clipboard into the control.
public void prefColumnSize(int width, int height) Specifies the preferred column width and height for the form control.
public void registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])
public void jumpRef()
public void lostFocus() Indicates that the control has lost focus.
public void mouseEnter(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user moves the mouse pointer into the control area.
public void scrollCursor()
public void pasteText(str pasteStr, [boolean InsertSel])
private void OnValidating([FormControl sender], [FormControlEventArgs e])
public void drop(FormControl dragSource, FormDrag dragMode, int x, int y) Raises the drop event to indicate that a drop operation is being performed on the current control.
public void setSelection(int charIndexFrom, int charIndexTo)

Method alignControl

Determines whether to align the control.

public boolean alignControl([boolean value])

Parameters

value
The new value for the property; optional.

Return Value

true if the control should be aligned; otherwise, false.

Remarks

The upper-left corner of the control is aligned according to the longest label.

Method alignment

public int alignment([int value])

Parameters

value

Return Value

Method allowEdit

Determines whether the user can change the contents of the control.

public boolean allowEdit([boolean value])

Parameters

value
The value to assign to the allowEdit property.

Return Value

true if the control can be edited; otherwise, false.

Remarks

When this property is set on a container control, modifications are disabled or enabled for all controls in the container.

Method allowSysSetup

Retrieves a value that indicates whether the control is shown in the SysSetup form.

public boolean allowSysSetup()

Return Value

true if the control is shown in the SysSetup form; otherwise, false.

Method arrayIndex

public int arrayIndex([int value])

Parameters

value

Return Value

Method autoDeclaration

Determines whether the system can declare a member variable that has the same name as the control.

public boolean autoDeclaration([boolean value])

Parameters

value
The new value for the property; optional.

Return Value

true if the member variable can be declared for this control; otherwise, false.

Remarks

Controls cannot have identical names.

Method backgroundColor

Gets or sets the background color of the control.

public int backgroundColor([int value])

Parameters

value

Return Value

An integer that contains a packed RGB color.

Remarks

The integer that is returned contains a packed RGB color as follows:

  • The low-order byte contains a value for the relative intensity of red.
  • The second byte contains a value for green.
  • The third byte contains a value for blue.
  • The high-order byte must be zero.
  • The maximum value for a single byte is 255.

Method backStyle

Determiness whether the control background can be transparent.

public int backStyle([int value])

Parameters

value

Return Value

1 if the control background can be transparent; otherwise, 0.

Method beginDrag

Is called when the user begins dragging a form control.

public int beginDrag(int x, int y)

Parameters

x
An integer value that indicates the y-coordinate of the mouse pointer. The coordinate is relative to the upper-left corner of the control.

y
An integer value that indicates the y-coordinate of the mouse pointer. The coordinate is relative to the upper-left corner of the control.

Return Value

0 (zero) if the event has been handled.

Remarks

This event is not raised unless the DragDrop property is enabled for the control. To drag a control, a user presses the mouse button in the control area and then moves the mouse pointer.

Method bold

Gets or sets the weight of font that was used to output text in the control.

public int bold([int value])

Parameters

value

Return Value

An integer value between zero and nine, inclusive.

Remarks

The integer that is returned contains the weight of the font as follows:

  • 0 Use the default font weight.
  • 1 Thin.
  • 2 Extra-light.
  • 3 Light.
  • 4 Normal.
  • 5 Medium.
  • 6 Semibold.
  • 7 Bold.
  • 8 Extra-bold.
  • 9 Heavy.

Method border

Gets or sets the style of the borderline of the control.

public int border([int value])

Parameters

value

Return Value

An integer between zero and four, inclusive.

Remarks

The integer that is returned contains the style of the borderline of the control as follows.

Value Description
0 Auto
1 3D
2 Single line
3 Flat
4 None

Method cacheDataMethod

public int cacheDataMethod([int value])

Parameters

value

Return Value

Method calcControlSize

Retrieves the size of the control.

public container calcControlSize(int chars, int lines)

Parameters

chars
The number of lines to use to determine the height.

lines
The number of lines to use to determine the height.

Return Value

The container that holds the width and height.

Method characterSet

Gets or sets the character set of the font.

public int characterSet([int value])

Parameters

value

Return Value

An integer value that indicates the character set of the font.

Remarks

The values for the integer that is returned indicate the character set according to the following table.

Value Description
0 ANSI_CHARSET
1 DEFAULT_CHARSET
2 SYMBOL_CHARSET
77 MAC_CHARSET
128 SHIFTJIS_CHARSET
129 HANGUL_CHARSET
134 GB2312_CHARSET
136 CHINESEBIG5_CHARSET
161 GREEK_CHARSET
162 TURKISH_CHARSET
163 VIETNAMESE_CHARSET
186 BALTIC_CHARSET
204 RUSSIAN_CHARSET
238 EASTEUROPE_CHARSET
255 OEM_CHARSET

The value in the following table is for the Korean language edition of MicrosoftWindows.

Value Description
130 JOHAB_CHARSET

The values in the following table are for the Middle East language edition of Windows.

Value Description
177 HEBREW_CHARSET
178 ARABIC_CHARSET

The value in the following table is for the Thai language edition of Windows.

Value Description
222 THAI_CHARSET

The default character set is set to a value, depending on the current system locale. For example, when the system locale is English (United States), it is set as ANSI_CHARSET. For more information, see the LOGFONT structure on the MSDN website, http://go.microsoft.com/fwlink/?LinkID=85972.

Method charFromPos

public int charFromPos(int x, int y)

Parameters

x

y

Return Value

Method colorScheme

Gets or sets the color scheme of the control.

public int colorScheme([int value])

Parameters

value

Return Value

An integer between zero and two, inclusive.

Remarks

The color scheme is defined according to the following table.

Value Style
0 Default
1 The Windows palette
2 The true-color scheme

Method configurationKey

Gets or sets the configuration key that is assigned to the control.

public ConfigurationKeyId configurationKey([ConfigurationKeyId value])

Parameters

value
The ID of the configuration key being assigned to the control; optional.

Return Value

The identifier of the configuration key that is assigned to the control.

Remarks

The configuration key is used to determine whether this control can be displayed. If the configuration key is disabled in the system, the control is not displayed in the form.

Method configurationKeyEx

Retrieves a list that contains the IDs of configuration keys that are in effect for the control.

public List configurationKeyEx()

Return Value

A list that contains the IDs of configuration keys that are in effect for the control.

Remarks

The returned list does not contain duplicate IDs. If the control is bound to a data source, the returned list of configuration key IDs also includes the configuration key ID for the table and field. The returned list also contains any configuration key IDs that are applied to the properties, extended data type, or enumType methods.

Method countryRegionCodes

Gets or sets the comma-separated list of country/region codes for the control.

public str countryRegionCodes([str value])

Parameters

value
The string that contains the country/region codes to set; optional.

Return Value

The comma-separated list of country/region codes for the control.

Method countryRegionContextField

public FieldId countryRegionContextField([FieldId value])

Parameters

value

Return Value

Method dataField

public FieldId dataField([FieldId value])

Parameters

value

Return Value

Method dataFieldArrayIndex

public int dataFieldArrayIndex()

Return Value

Method dataFieldName

public FieldName dataFieldName()

Return Value

Method dataMethod

public str dataMethod([str value])

Parameters

value

Return Value

Method dataRelationPath

Gets or sets the period-delimited list of relations that links the field binding of the DataField object to a relative table.

public str dataRelationPath([str value])

Parameters

value
The string that contains the period-delimited list of relations; optional.

Return Value

The period-delimited list of relations that links the field binding of the DataField object to a relative table.

Remarks

This method is used by the reference group control to track exactly which relations produce the replacement field that is used. It enables the reference group control to bind consistently to the controls that it contains.

Method dataSource

Gets or sets a data source that will be used by the control or the form.

public int dataSource([AnyType value])

Parameters

value

Return Value

The identifier of the data source that will be used.

Method direction

public int direction([int value])

Parameters

value

Return Value

Method displayHeight

public int displayHeight([int value], [AutoMode mode])

Parameters

value

mode

Return Value

Method displayHeightMode

public AutoMode displayHeightMode([AutoMode mode])

Parameters

mode

Return Value

Method displayHeightValue

public int displayHeightValue([int value])

Parameters

value

Return Value

Method displayLength

public int displayLength([int value], [AutoMode mode])

Parameters

value

mode

Return Value

Method displayLengthMode

public AutoMode displayLengthMode([AutoMode mode])

Parameters

mode

Return Value

Method displayLengthValue

public int displayLengthValue([int value])

Parameters

value

Return Value

Method displayTarget

Gets or sets the value that indicates whether the control is displayed in the Finance and Operations client, in Enterprise Portal for Finance and Operations, or in both.

public int displayTarget([int value])

Parameters

value
The integer value that indicates where the control is displayed; optional.

Return Value

The value that indicates whether the control is displayed in the Finance and Operations client, in Enterprise Portal, or in both.

Method dragDrop

Indicates whether to enable or disable drag-and-drop operations for the control.

public int dragDrop([int value])

Parameters

value
An integer that indicates whether drag-and-drop behavior is enabled; optional.

Return Value

1 if drag-and-drop operations are enabled; otherwise, 0.

Remarks

Use the dragLeave Method, the dragOver Method, and the dragOverEx Method to specify the behavior.

Method dragOver

Raises the dragOver event to indicate that a mouse drag operation is over the current control.

public FormDrag dragOver(FormControl dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.

Return Value

A FormDrag enumeration value that indicates the mode of dragging.

Method dragOverEx

Raises the dragOverEx event to indicate that a mouse drag operation is over the current control.

public FormDrag dragOverEx(Array dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.

Return Value

A FormDrag enumeration value that indicates the mode of dragging.

Method dragText

Retrieves the text that is displayed when the form control is dragged.

public str dragText()

Return Value

The text that is displayed when the control is dragged; an empty string if there is no text to display when the control is dragged.

Method enabled

Determines whether to enable or disable the object.

public boolean enabled([boolean value])

Parameters

value
A Boolean value that specifies whether the control is enabled; optional.

Return Value

true if the object is enabled; otherwise, false.

Remarks

The enabled property allows controls to be enabled or disabled at run time. For example, you can disable objects that do not apply to the current state of the application. You can also disable a control that is used only for display purposes, such as an error message, which provides read-only information.

Method extendedDataType

public ExtendedTypeId extendedDataType([ExtendedTypeId value])

Parameters

value

Return Value

Method fastTabSummary

public int fastTabSummary([int value])

Parameters

value

Return Value

Method font

Gets or sets the name of the font for the control to use.

public str font([str value])

Parameters

value

Return Value

The name of the font to use, such as Tahoma or Verdana.

Method fontSize

Gets or sets the size of the font for the control to use.

public int fontSize([int value])

Parameters

value

Return Value

The height of the font in points.

Method foregroundColor

Gets or sets the text color for the control to use.

public int foregroundColor([int value])

Parameters

value

Return Value

An integer that contains a packed RGB color.

Remarks

The integer that is returned contains a packed RGB color as follows:

  • The low-order byte contains a value for the relative intensity of red.
  • The second byte contains a value for green.
  • The third byte contains a value for blue.
  • The high-order byte must be zero.
  • The maximum value for a single byte is 255.

Method getCursorPos

public container getCursorPos()

Return Value

Method getFirstVisibleLine

public int getFirstVisibleLine()

Return Value

Method getLine

public str getLine(int lineNo)

Parameters

lineNo

Return Value

Method getLineCount

public int getLineCount()

Return Value

Method getSelection

public container getSelection()

Return Value

Method hasChanged

Sets or returns a value that indicates whether the contents of the control have changed.

public boolean hasChanged([boolean val])

Parameters

val
The value to assign as the hasChanged value for the control; optional.

Return Value

true if the contents of the control have changed; otherwise, false.

Method hasUserSetting

Indicates whether the control has custom user settings.

public boolean hasUserSetting()

Return Value

true if the control has custom user settings; otherwise, false.

Method height

Gets or sets the height of the control.

public int height(int value, [int mode])

Parameters

value
An integer that indicates how the height is calculated; optional.

mode
An integer that indicates how the height is calculated; optional.

Return Value

The height of the control in pixels.

Remarks

Exact mode is used if the value parameter is omitted. Calculate the height according to the following table.

Mode Height calculation
-1 Exact The exact height in pixels of the controls is used.
0 Auto The height of the control is calculated automatically and the value parameter is ignored.
1 Column height The layout of the form determines the height of the control.

The height and height calculation mode can be set separately.

Method heightMode

Gets or sets a calculation mode for the height of the control.

public int heightMode([int value])

Parameters

value
An integer value that indicates how control height is calculated; optional.

Return Value

The calculation mode.

Remarks

Calculate the height according to the following table.

Mode Height calculation
Exact The exact height in pixels of the controls is used.
Auto The height of the control is calculated automatically and the value parameter is ignored.
Column height The layout of the form determines the height of the control.

The height of the control might change when the mode is set to auto or column height.

Method heightValue

Gets or sets the height of the control.

public int heightValue([int value])

Parameters

value
An integer that specifies the height in pixels; optional.

Return Value

The height in pixels.

Remarks

The height of the control is not changed unless the exact height calculation mode is used.

Method helpField

Retrieves the Help text for the control.

public str helpField()

Return Value

The Help text for the control; an empty string if there is no Help text for the control.

Remarks

The helpField method cannot be used to set the value of the Help text. Use the helpText method to set the value of the Help text.

Method helpText

Gets or sets the Help text to display at the bottom of the screen when a field or control is pointed to.

public str helpText([str value])

Parameters

value
The value to assign as the Help text for the control.

Return Value

The string to be displayed at the bottom of the screen.

Remarks

Set the HelpText property for an object by using the property sheet. The Help text must not exceed 250 characters.

Method hierarchyParent

Gets or sets the HierarchyParent property value of the control.

public str hierarchyParent([str value])

Parameters

value
The value to assign to the HierarchyParent property of the control.

Return Value

The HierarchyParent property value of the control.

Method hWnd

Retrieves the Windows handle for the control.

public int hWnd()

Return Value

The handle for the control.

Remarks

The handle can be used with the Windows API.

Method iMEMode

public int iMEMode([int value])

Parameters

value

Return Value

Method isContainer

public boolean isContainer()

Return Value

Method isDisplayed

Retrieves a value that indicates whether the control is displayed.

public boolean isDisplayed()

Return Value

true if the control is displayed; otherwise, false.

Remarks

To modify the visible state of the control, call the visible method.

Method isRestricted

Retrieves a value that indicates whether the control is restricted.

public boolean isRestricted()

Return Value

true if the control is restricted; otherwise, false.

Method isUserSetupEnabled

Retrieves a value that indicates whether the control allows for the specified level of customization.

public boolean isUserSetupEnabled(int neededSetupRights)

Parameters

neededSetupRights
A value from the FormAllowUserSetup enumeration that specifies the level of customization that is being queried for the control.

Return Value

true if the control, design, and parent containers allow for the level of customization that is specified by the neededSetupRights parameter; otherwise, false.

Remarks

The following table describes the values for the neededSetupRights parameter.

FormAllowUserSetup::No 0 No changes can be made to the control. If this value is set for the neededSetupRights parameter, the method always returns true.
FormAllowUserSetup::Restricted 1 The user can change the editable, visible, skip, label, and width properties of the control. The user cannot move the control.
FormAllowUserSetup::Yes 2 The user can change the editable, visible, skip, label, and width properties of the control. The user can also move the control.

For this method to return true, the AllowUserSetup property for the design and all parent containers must allow for the level of access that is specified by the neededSetupRights parameter.

Method isValid

public boolean isValid()

Return Value

Method italic

public boolean italic([boolean value])

Parameters

value

Return Value

Method label

Gets or sets the label for a control.

public str label([str value])

Parameters

value

Return Value

The current value of the label string.

Remarks

The label determines which text is displayed in the control or adjacent to it. The label property value cannot exceed 250 characters.

Method labelAlignment

public int labelAlignment([int value])

Parameters

value

Return Value

Method labelBold

public int labelBold([int value])

Parameters

value

Return Value

Method labelCharacterSet

public int labelCharacterSet([int value])

Parameters

value

Return Value

Method labelFont

public str labelFont([str value])

Parameters

value

Return Value

Method labelFontSize

public int labelFontSize([int value])

Parameters

value

Return Value

Method labelForegroundColor

public int labelForegroundColor([int value])

Parameters

value

Return Value

Method labelGuide

public int labelGuide([int value])

Parameters

value

Return Value

Method labelHeight

public int labelHeight(int value, [int mode])

Parameters

value

mode

Return Value

Method labelHeightMode

public int labelHeightMode([int value])

Parameters

value

Return Value

Method labelHeightValue

public int labelHeightValue([int value])

Parameters

value

Return Value

Method labelItalic

public boolean labelItalic([boolean value])

Parameters

value

Return Value

Method labelMouseDblClick

public int labelMouseDblClick(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x

y

button

Ctrl

Shift

Return Value

Method labelMouseDown

public int labelMouseDown(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x

y

button

Ctrl

Shift

Return Value

Method labelMouseUp

public int labelMouseUp(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x

y

button

Ctrl

Shift

Return Value

Method labelPosition

public int labelPosition([int value])

Parameters

value

Return Value

Method labelUnderline

public boolean labelUnderline([boolean value])

Parameters

value

Return Value

Method labelWidth

public int labelWidth(int value, [int mode])

Parameters

value

mode

Return Value

Method labelWidthMode

public int labelWidthMode([int value])

Parameters

value

Return Value

Method labelWidthValue

public int labelWidthValue([int value])

Parameters

value

Return Value

Method leave

public boolean leave()

Return Value

Method left

Gets or sets the horizontal position of the control in the form.

public int left(int value, [int mode])

Parameters

value
An integer value that indicates the horizontal arrange mode for the control; optional.

mode
An integer value that indicates the horizontal arrange mode for the control; optional.

Return Value

The horizontal position of the control in the form.

Method leftMode

Sets the horizontal arrange mode for the control in the form.

public int leftMode([int value])

Parameters

value
An integer value that indicates the horizontal arrange mode for the control; optional.

Return Value

The horizontal arrange mode for the control in the form.

Method leftValue

Gets or sets the horizontal position of the control in the form.

public int leftValue([int value])

Parameters

value
An integer value that indicates the horizontal position of the control; optional.

Return Value

The horizontal position of the control in the form.

Method limitText

public int limitText([int value], [AutoMode mode])

Parameters

value

mode

Return Value

Method limitTextMode

public AutoMode limitTextMode([AutoMode mode])

Parameters

mode

Return Value

Method limitTextValue

public int limitTextValue([int value])

Parameters

value

Return Value

Method lineFromChar

public int lineFromChar(int charIndex)

Parameters

charIndex

Return Value

Method lineIndex

public int lineIndex(int lineNo)

Parameters

lineNo

Return Value

Method lineLength

public int lineLength(int lineNo)

Parameters

lineNo

Return Value

Method lookupButton

public int lookupButton([int value])

Parameters

value

Return Value

Method mandatory

public boolean mandatory([boolean value])

Parameters

value

Return Value

Method markAsUserAdd

Marks or unmarks the control as a user-added control.

public boolean markAsUserAdd([boolean value])

Parameters

value
The Boolean value that indicates whether the control should be marked as a user-added control.

Return Value

true if the control was marked as a user-added control; otherwise, false.

Method modified

public boolean modified()

Return Value

Method mouseDblClick

Is called when the control is double-clicked by the user.

public int mouseDblClick(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned.

Method mouseDown

Is called when the user clicks the mouse button over the control.

public int mouseDown(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned. This event is called only if a value is specified for the label of the control and the ShowLabel property of the control is set to Yes.

Method mouseMove

Is called when the user moves the mouse pointer over the control.

public int mouseMove(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned.

Method mouseUp

Is called when the user releases the mouse button over the control area.

public int mouseUp(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned. This event is called only if a value is specified for the label of the control and the ShowLabel property of the control is set to Yes.

Method name

Gets or sets the name that is used in code to identify a form, report, table, query, or another Finance and Operations application object.

public str name([str value])

Parameters

value
The name to assign to the control.

Return Value

The name that is used in code to identify an application object.

Remarks

The name property value of an object must meet the following criteria to avoid code conflicts:

  • Begins with a letter.
  • Doesn't exceed 250 characters.
  • Can include numbers and underscore characters.
  • Cannot include punctuation or spaces.
  • Tables cannot have the same name as other public objects, such as extended data types, base enumeration types, classes, and so on.

Method neededPermission

public int neededPermission([int value])

Parameters

value

Return Value

Method SysObsoleteAttribute

public container SysObsoleteAttribute()

Return Value

Method parentControl

Retrieves the parent control for the control.

public FormControl parentControl()

Return Value

The parent control for the control.

Method posFromChar

public container posFromChar(int charIndex)

Parameters

charIndex

Return Value

Method previewPartRef

public str previewPartRef([str value])

Parameters

value

Return Value

Method promptrect

public int promptrect([int value])

Parameters

value

Return Value

Method replaceOnLookup

public boolean replaceOnLookup([boolean value])

Parameters

value

Return Value

Method searchAfterInput

public int searchAfterInput([int value])

Parameters

value

Return Value

Method searchMode

public int searchMode([int value])

Parameters

value

Return Value

Method securityKey

Sets or returns the ID of the security key for the control.

public SecurityKeyId securityKey([SecurityKeyId value])

Parameters

value
The ID of the security key to assign to the control; optional.

Return Value

The ID of the security key for the control; 0 (zero) if no security key is assigned to the control.

Method showContextMenu

Shows the shortcut menu for the control.

public int showContextMenu(int menuHandle)

Parameters

menuHandle
The ID of the menu to show.

Return Value

An integer value that indicates whether the call succeeded.

Method showLabel

public boolean showLabel([boolean value])

Parameters

value

Return Value

Method skip

Sets or returns a value that indicates whether the control is skipped when the user presses the TAB key to move to the control.

public boolean skip([boolean value])

Parameters

value
The value to assign to the skip property of the control; optional.

Return Value

true if the control is skipped when the user presses the TAB key to move to the control; otherwise, false.

Remarks

If the enabled property is true, the allowEdit property is false, and the skip property is true, the user cannot change the contents of the control but can still copy the contents of the control.

Method sort

public int sort([SortOrder sortDirection])

Parameters

sortDirection

Return Value

Method style

public int style([int value])

Parameters

value

Return Value

Method timeFormat

public int timeFormat([int value])

Parameters

value

Return Value

Method timeHours

public int timeHours([int value])

Parameters

value

Return Value

Method timeMinute

public int timeMinute([int value])

Parameters

value

Return Value

Method timeSeconds

public int timeSeconds([int value])

Parameters

value

Return Value

Method timeSeparator

public int timeSeparator([int value])

Parameters

value

Return Value

Method toolTip

Retrieves the tooltip text for the control.

public str toolTip()

Return Value

The tooltip text for the control; an empty string if no tooltip text has been defined for the control.

Remarks

The method might be overridden to provide a value to the toolTip method.

Method top

Gets or sets the vertical position of the control in the form.

public int top(int value, [int mode])

Parameters

value
An integer value that indicates the vertical arrange mode for the control; optional.

mode
An integer value that indicates the vertical arrange mode for the control; optional.

Return Value

The vertical position of the control in the form.

Method topMode

Sets the vertical arrange mode for the control in the form.

public int topMode([int value])

Parameters

value
An integer value that indicates the vertical arrange mode for the control; optional.

Return Value

The vertical arrange mode for the control in the form.

Method topValue

Gets or sets the vertical position of the control in the form.

public int topValue([int value])

Parameters

value
An integer value that indicates the vertical position of the control; optional.

Return Value

The vertical position of the control in the form.

Method type

public int type([int value])

Parameters

value

Return Value

Method underline

public boolean underline([boolean value])

Parameters

value

Return Value

Method SysObsoleteAttribute

public boolean SysObsoleteAttribute(container data)

Parameters

data

Return Value

Method userData

Gets or sets the user data for the control.

public int userData([int value])

Parameters

value
An integer value that indicates the user data for the control; optional.

Return Value

The user data for the control.

Method userDataItem

Gets or sets the user data item for the control.

public int userDataItem([int value])

Parameters

value
An integer value that indicates the user data item for the control; optional.

Return Value

The user data item for the control.

Method userDataItems

Gets or sets the number of user data items for the control.

public int userDataItems([int value])

Parameters

value
An integer value that indicates the number of user data items for the control; optional.

Return Value

The number of user data items for the control.

Method userDisable

Gets or sets the value that indicates whether the control is disabled for the user.

public int userDisable([int value])

Parameters

value
The value that indicates whether the control is disabled for the user; optional.

Return Value

1 if the control is disabled for the user; otherwise, 0.

Method userFastTabSummary

public int userFastTabSummary([int value])

Parameters

value

Return Value

Method userHeight

Gets or sets the custom user height for the control.

public int userHeight([int value])

Parameters

value
The user height for the control; optional.

Return Value

The custom user height for the control.

Method userHide

Gets or sets the value that indicates whether the control is hidden from the user.

public int userHide([int value])

Parameters

value
The value that indicates whether the control is hidden from the user; optional.

Return Value

1 if the control is hidden from the user; otherwise, 0.

Remarks

The user specifies whether a control is hidden by right-clicking the control when it is viewable or by right-clicking another control when the original control is hidden. A right-click opens a menu that can be used to hide or display the control. This method lets you programmatically determine and set the value.

Method userOrgContainer

Gets or sets the organization container for the control.

public int userOrgContainer([int value])

Parameters

value
The organization container to set for the control; optional.

Return Value

The organization container for the control.

Method userOrgSibling

Gets or sets the organization sibling for the control.

public int userOrgSibling([int value])

Parameters

value
The organization sibling to set for the control; optional.

Return Value

The organization sibling for the control.

Method userPromptText

Gets or sets the user label text for the control.

public str userPromptText([str value])

Parameters

value
The user label text to set for the control; optional.

Return Value

The user label text for the control.

Method userSecurityLevel

Gets or sets the user security level for the control.

public int userSecurityLevel([int value])

Parameters

value
The user security level to set for the control; optional.

Return Value

The user security level for the control.

Method userSkip

Sets or returns the value that indicates whether the form control is skipped when the user presses the TAB key to navigate the controls in the form.

public int userSkip([int value])

Parameters

value
The value to assign to the userSkip property; optional. The value is 1 if the user setting to skip the control is in effect; otherwise, the value is 0.

Return Value

1 if the user setting to skip the control is in effect; otherwise, 0.

Method userWidth

Sets or returns the width of the control in pixels, as specified by the user.

public int userWidth([int value])

Parameters

value
The number of pixels to use as the width of the control; optional.

Return Value

The number of pixels that the user specified as the width of the control; 0 (zero) if the user did not specify a character width.

Remarks

The userWidth method returns the width in pixels, based on six times the number of characters. For example, if the user has specified 30 characters as the width of the control, the return value is 6 * 30 = 180. To specify the width of the control in characters, users can right-click the control to open the setup form where the character specification is made.

Method validate

public boolean validate()

Return Value

Method value

public int value([int value])

Parameters

value

Return Value

Method verticalSpacing

Gets or sets the vertical spacing of the control in the form.

public int verticalSpacing([int value], [AutoMode mode])

Parameters

value
An integer value that indicates the AutoMode value for the control; optional.

mode
An integer value that indicates the AutoMode value for the control; optional.

Return Value

The vertical spacing of the control in the form.

Method verticalSpacingMode

Sets the vertical spacing mode for the control in the form.

public AutoMode verticalSpacingMode([AutoMode mode])

Parameters

mode

Return Value

The vertical spacing mode for the control in the form.

Method verticalSpacingValue

Gets or sets the vertical spacing of the control in the form.

public int verticalSpacingValue([int value])

Parameters

value
An integer value that indicates the vertical spacing of the control; optional.

Return Value

The vertical spacing of the control in the form.

Method viewEditMode

public int viewEditMode([int value])

Parameters

value

Return Value

Method visible

Sets or returns a value that indicates whether the control is visible.

public boolean visible([boolean value])

Parameters

value
The value to assign to the visibility setting for the control; optional.

Return Value

true if the control is visible; otherwise, false.

Method width

Gets or sets the width of the control.

public int width(int value, [int mode])

Parameters

value
An integer that indicates how the width is calculated; optional.

mode
An integer that indicates how the width is calculated; optional.

Return Value

The width of the control in pixels.

Remarks

Exact mode is used if the value parameter is omitted. Calculate the width according to the following table.

Mode Width calculation
-1 Exact The exact width in pixels of the controls is used.
0 Auto The width of the control is calculated automatically and the value parameter is ignored.
1 Column width The layout of the form determines the width of the control.

The width and width calculation mode can be set separately.

Method widthMode

Gets or sets the calculation mode of the width of the control.

public int widthMode([int value])

Parameters

value
An integer value that indicates how control width is calculated; optional.

Return Value

An integer value that indicates the current calculation mode.

Remarks

Calculate the width according to the following table.

Mode Width calculation
Exact The exact width in pixels of the controls is used.
Auto The width of the control is calculated automatically and the value parameter is ignored.
Column width The layout of the form determines the width of the control.

The width of the control might change when the mode is set to auto or column width.

Method widthValue

Gets or sets the width of the control.

public int widthValue([int value])

Parameters

value
An integer that specifies the width in pixels; optional.

Return Value

The width in pixels of the control.

Remarks

To change the width of the control, use the exact width calculation mode.

Method performTypeLookup

public void performTypeLookup([int userType], [int arrayIndex], [SelectableDataArea company])

Parameters

userType

arrayIndex

company

Method OnLostFocus

private void OnLostFocus([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method endDrag

Is called when the user has finished dragging a form control.

public void endDrag()

Remarks

This event is not raised unless the DragDrop property is enabled for the control and a beginDrag event has already been started. To drag a control, a user presses the mouse button in the control area and then moves the mouse pointer.

Method textChange

public void textChange()

Method lookup

public void lookup()

Method OnEnter

private void OnEnter([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method mouseLeave

Indicates that the mouse pointer has left the control.

public void mouseLeave()

Method undo

public void undo()

Method setCursorPos

public void setCursorPos(int x, int y)

Parameters

x

y

Method performDBLookup

public void performDBLookup([FieldId fieldId], [TableId tableId], [SelectableDataArea company])

Parameters

fieldId

tableId

company

Method OnValidated

private void OnValidated([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method context

Shows the shortcut menu for the control.

public void context()

Method dropEx

Raises the dropEx event to indicate that a drop operation is being performed on the current control.

public void dropEx(Array dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.

Method OnLeaving

private void OnLeaving([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method filter

public void filter([str filterStr])

Parameters

filterStr

Method OnLookup

private void OnLookup([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method resetUserSetting

Resets the user settings for the control.

public void resetUserSetting()

Method displayControl

Displays the control.

public void displayControl()

Method enter

public void enter()

Method inputSearch

Performs data filtering for the control, based on the specified string.

public void inputSearch(str searchStr)

Parameters

searchStr
The string value to use to filter data; optional.

Method setFocus

Sets the focus on the control.

public void setFocus()

Method gotFocus

Indicates that the control has received focus.

public void gotFocus()

Method copy

Copies the contents of the control to the clipboard.

public void copy()

Method dragLeave

Raises the dragLeave event to indicate that a mouse drag operation has left the current control.

public void dragLeave()

Method lineScroll

public void lineScroll(int dx, int dy)

Parameters

dx

dy

Method cut

Cuts the contents of the control.

public void cut()

Method OnGotFocus

private void OnGotFocus([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method performFormLookup

public void performFormLookup(xFormRun form)

Parameters

form

Method OnModified

private void OnModified([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method paste

Pastes the contents of the clipboard into the control.

public void paste()

Method prefColumnSize

Specifies the preferred column width and height for the form control.

public void prefColumnSize(int width, int height)

Parameters

width
The preferred height of the control.

height
The preferred height of the control.

Method registerOverrideMethod

public void registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])

Parameters

methodToOverride

objectMethodToCall

overrideObject

Method jumpRef

public void jumpRef()

Method lostFocus

Indicates that the control has lost focus.

public void lostFocus()

Method mouseEnter

Is called when the user moves the mouse pointer into the control area.

public void mouseEnter(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Method scrollCursor

public void scrollCursor()

Method pasteText

public void pasteText(str pasteStr, [boolean InsertSel])

Parameters

pasteStr

InsertSel

Method OnValidating

private void OnValidating([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method drop

Raises the drop event to indicate that a drop operation is being performed on the current control.

public void drop(FormControl dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.

Method setSelection

public void setSelection(int charIndexFrom, int charIndexTo)

Parameters

charIndexFrom

charIndexTo

Class FormTreeControl

class FormTreeControl extends FormControl

Remarks

Examples

Methods

Method Description
public int add(int parent, int insertAfter, str Text, [int image], [int children])
public int addItem(int parent, int insertAfter, FormTreeItem item)
public boolean alignControl([boolean value]) Determines whether to align the control.
public boolean allowEdit([boolean value]) Determines whether the user can modify the contents of the control.
public boolean allowSysSetup() Retrieves a value that indicates whether the control is shown in the SysSetup form.
public boolean autoDeclaration([boolean value]) Determines whether the system can declare a member variable that has the same name as the control.
public int backgroundColor([int value]) Gets or sets the background color of the control.
public int backStyle([int value]) Determiness whether the control background can be transparent.
public int beginDrag(int x, int y) Is called when the user starts to drag a form tree control.
public boolean beginLabelEdit(int Idx, str text, AnyType data)
public int bold([int value]) Gets or sets the font weight that is used to display text in the control.
public int border([int value]) Gets or sets the style of the border for the control.
public container calcControlSize(int chars, int lines) Retrieves the size of the control.
public boolean canScroll([boolean value])
public boolean cascadeSelect([boolean value])
public int characterSet([int value]) Gets or sets the character set of the font.
public boolean checkBox([boolean value])
public int colorScheme([int value]) Gets or sets the color scheme of the control.
public ConfigurationKeyId configurationKey([ConfigurationKeyId value]) Gets or sets the configuration key that is assigned to the control.
public List configurationKeyEx() Returns a list that contains the IDs of configuration keys that are in effect for the control.
public int copyItem(int Idx, int newParent, [int insertAfter])
public str countryRegionCodes([str value]) Gets or sets the comma-separated list of country/region codes for the control.
public Imagelist createDragImagelist()
public str dataRelationPath([str value]) Gets or sets the period-delimited list of relations that links the field binding of the DataField object to a relative table.
public boolean delete(int Idx) Deletes the specified item from the form tree control.
public boolean deleteAll() Deletes all items from the form tree control.
public int displayTarget([int value]) Gets or sets the value that indicates whether the control is displayed in the Finance and Operations client, in Enterprise Portal for Finance and Operations, or in both.
public int dragDrop([int value]) Determines whether drag-and-drop operations are enabled or disabled for the control.
public FormDrag dragOver(FormControl dragSource, FormDrag dragMode, int x, int y) Raises the dragOver event to indicate that a mouse drag operation is over the current control.
public FormDrag dragOverEx(Array dragSource, FormDrag dragMode, int x, int y) Raises the dragOverEx event to indicate that a mouse drag operation is over the current control.
public str dragText() Returns the text that is displayed when the form tree control is dragged.
public boolean editLabels([boolean value])
public boolean enabled([boolean value]) Determines whether the object is enabled or disabled.
public int expand(int Idx, [FormTreeExpand action])
public boolean expanding(int Idx, FormTreeExpand action, AnyType data)
public str font([str value]) Gets or sets the name of the font that is used for the text in the control.
public int fontSize([int value]) Gets or sets the font size that is used for the text in the control.
public int foregroundColor([int value]) Gets or sets the color that is used for the text in the control.
public int getChild(int Idx)
public int getFirstSelected()
public int getFirstVisible()
public Imagelist getImagelist()
public FormTreeItem getItem(int Idx)
public int getNextSelected(int idx)
public int getNextSibling(int Idx)
public int getNextVisible(int Idx)
public int getParent(int Idx)
public int getPrevSelected(int idx)
public int getPrevSibling(int Idx)
public int getPrevVisible(int Idx)
public int getRoot()
public int getSelectedCount()
public int getSelection()
public Imagelist getStateImagelist()
public int getVisibleCount() Returns the number of visible items in the tree control.
public boolean hasButtons([boolean value]) Returns a value that indicates whether the tree control uses expand/collapse buttons.
public boolean hasChanged([boolean val]) Sets or returns a value that indicates whether the contents of the tree control have changed.
public boolean hasLines([boolean value]) Returns a value that indicates whether the tree control displays tree connector lines.
public boolean hasUserSetting() Indicates whether the control has custom user settings.
public int height(int value, [int mode]) Gets or sets the height of the control.
public int heightMode([int value]) Gets or sets a calculation mode for the height of the control.
public int heightValue([int value]) Gets or sets the height of the control.
public str helpField() Returns the Help text for the control.
public str helpText([str value]) Gets or sets the Help text that is displayed at the bottom of the screen when a field or control is pointed to.
public str hierarchyParent([str value]) Gets or sets the HierarchyParent property value of the control.
public container hitTest(int x, int y)
public int hWnd() Returns the Windows handle for the control.
public boolean isContainer() Returns a value that indicates whether the control is a container.
public boolean isDisplayed() Returns a value that indicates whether the control is displayed.
public boolean isRestricted() Retrieves a value that indicates whether the control is restricted.
public boolean isUserSetupEnabled(int neededSetupRights) Retrieves a value that indicates whether the control allows for the specified level of customization.
public boolean italic([boolean value]) Sets or returns a value that indicates whether the text in the control is italic.
public boolean keyDown(int vKey, boolean Ctrl, boolean Shift)
public boolean leave()
public int left(int value, [int mode]) Gets or sets the horizontal position of the control in the form.
public int leftMode([int value]) Sets the horizontal arrange mode for the control in the form.
public int leftValue([int value]) Gets or sets the horizontal position of the control in the form.
public boolean linesAtRoot([boolean value])
public boolean markAsUserAdd([boolean value]) Marks or unmarks the control as a user-added control.
public int mouseDblClick(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the control is double-clicked by the user.
public int mouseDown(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user clicks while the mouse pointer is over the control.
public int mouseMove(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user moves the mouse pointer over the control.
public int mouseUp(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user releases the mouse button while the mouse pointer is over the control.
public int moveItem(int Idx, int newParent, [int insertAfter])
public str name([str value]) Gets or sets the name that is used in code to identify a form, report, table, query, or another Finance and Operations application object.
public int neededPermission([int value])
public container SysObsoleteAttribute()
public FormControl parentControl() Retrieves the parent control for the control.
public boolean rowSelect([boolean value])
public SecurityKeyId securityKey([SecurityKeyId value]) Sets or returns the ID of the security key for the control.
public int select(int Idx)
public int selectEx(int Idx, boolean setSelection)
public boolean selectionChanging(FormTreeItem OldItem, FormTreeItem NewItem, FormTreeSelect how)
public int selectItems(int fromIdx, int toIdx)
public int selectSetFirstVisible(int Idx)
public boolean setInsertMark(int Idx, boolean After)
public boolean setItem(FormTreeItem item)
public int showContextMenu(int menuHandle) Shows the shortcut menu for the control.
public boolean showSelAlways([boolean value])
public boolean singleSelection([boolean value])
public boolean skip([boolean value]) Sets or returns a value that indicates whether the control is skipped when the user presses the TAB key to move to the control.
public str toolTip() Returns the tooltip text for the control.
public int top(int value, [int mode]) Gets or sets the vertical position of the control in the form.
public int topMode([int value]) Sets the vertical arrange mode for the control in the form.
public int topValue([int value]) Gets or sets the vertical position of the control in the form.
public boolean trackSelect([boolean value])
public int type([int value])
public boolean underline([boolean value])
public boolean SysObsoleteAttribute(container data)
public int userData([int value]) Gets or sets the user data for the control.
public int userDataItem([int value]) Gets or sets the user data item for the control.
public int userDataItems([int value]) Gets or sets the number of user data items for the control.
public int userDisable([int value]) Gets or sets the value that indicates whether the control is disabled for the user.
public int userHeight([int value]) Gets or sets the custom user height for the control.
public int userHide([int value]) Returns or sets the value that indicates whether the form tree control is hidden from the user.
public int userOrgContainer([int value]) Gets or sets the organization container for the control.
public int userOrgSibling([int value]) Gets or sets the organization sibling for the control.
public str userPromptText([str value]) Sets or retrieves the user prompt text for the control.
public int userSecurityLevel([int value]) Gets or sets the user security level for the control.
public int userSkip([int value]) Sets or returns the value that indicates whether the form control is skipped when the user presses the TAB key to navigate the controls in the form.
public int userWidth([int value]) Sets or returns the width of the control in pixels, as specified by the user.
public int verticalSpacing([int value], [AutoMode mode]) Gets or sets the vertical spacing of the control in the form.
public AutoMode verticalSpacingMode([AutoMode mode]) Sets the vertical spacing mode for the control in the form.
public int verticalSpacingValue([int value]) Gets or sets the vertical spacing of the control in the form.
public boolean visible([boolean value]) Sets or returns a value that indicates whether the control is visible.
public int width(int value, [int mode]) Gets or sets the width of the control.
public int widthMode([int value]) Gets or sets the calculation mode for the width of the control.
public int widthValue([int value]) Gets or sets the width of the control.
public void checkedStateChanged(int Idx, FormTreeCheckedState newState)
public void endLabelEdit(int Idx, str text, AnyType data)
public void drop(FormControl dragSource, FormDrag dragMode, int x, int y) Raises the drop event to indicate that a drop operation is being performed on the current control.
public void mouseEnter(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user moves the mouse pointer into the control.
private void OnExpanding([FormControl sender], [FormControlEventArgs e])
public void cut() Cuts the contents of the control.
public void paste() Pastes the form tree control in the form.
public void resetUserSetting() Resets the user settings for the control.
public void itemMoved(int OldIdx, int NewIdx)
public void expanded(int Idx, FormTreeExpand action, AnyType data)
public void setFocus() Sets the focus on the control.
private void OnSelectionChanged([FormControl sender], [FormControlEventArgs e])
private void OnLostFocus([FormControl sender], [FormControlEventArgs e])
public void dropEx(Array dragSource, FormDrag dragMode, int x, int y) Raises the dropEx event to indicate that a drop operation is being performed on the current control.
public void mouseLeave() Is called when the user moves the mouse pointer out of the control.
public void endDrag() Is called when the user has finished dragging a form tree control.
public void context() Shows the shortcut menu for the control.
public void itemCopy(int OldIdx, int NewIdx)
public void enter()
public void inputSearch(str searchStr) Performs data filtering for the control, based on the specified string.
public void displayControl() Displays the control.
public void prefColumnSize(int width, int height) Specifies the preferred column width and height for the form tree control.
public void setImagelist(Imagelist imageList)
private void OnExpanded([FormControl sender], [FormControlEventArgs e])
public void dragLeave() Raises the dragLeave event to indicate that a mouse drag operation has left the current control.
public void lostFocus() Indicates that the control has lost focus.
private void OnEnter([FormControl sender], [FormControlEventArgs e])
public void itemDeleted(int Idx, AnyType data)
public void gotFocus() Indicates that the control has received focus.
public void setStateImagelist(Imagelist imageList)
public void endEditLabel(boolean cancel)
public void copy() Copies the form tree control.
private void OnGotFocus([FormControl sender], [FormControlEventArgs e])
public void registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])
private void OnLeaving([FormControl sender], [FormControlEventArgs e])
public void selectionChanged(FormTreeItem OldItem, FormTreeItem NewItem, FormTreeSelect how) Indicates that the user has changed the selected item in the form tree control.
public void beginEditLabel(int Idx)

Method add

public int add(int parent, int insertAfter, str Text, [int image], [int children])

Parameters

parent

insertAfter

Text

image

children

Return Value

Method addItem

public int addItem(int parent, int insertAfter, FormTreeItem item)

Parameters

parent

insertAfter

item

Return Value

Method alignControl

Determines whether to align the control.

public boolean alignControl([boolean value])

Parameters

value
The new value for the property; optional.

Return Value

true if the control should be aligned; otherwise, false.

Remarks

The upper-left corner of the control is aligned according to the longest label.

Method allowEdit

Determines whether the user can modify the contents of the control.

public boolean allowEdit([boolean value])

Parameters

value
The value to assign to the allowEdit property.

Return Value

true if the control can be modified; otherwise, false.

Remarks

When this property is set on a container control, modifications are disabled or enabled for all controls in the container.

Examples

The following example shows how to return and set the value of the allowEdit property.

// Return the value. 
info (strfmt("allowEdit: %1", this.allowEdit())); 
// Set the value. 
this.allowEdit(false);

Method allowSysSetup

Retrieves a value that indicates whether the control is shown in the SysSetup form.

public boolean allowSysSetup()

Return Value

true if the control is shown in the SysSetup form; otherwise, false.

Method autoDeclaration

Determines whether the system can declare a member variable that has the same name as the control.

public boolean autoDeclaration([boolean value])

Parameters

value
The value to assign to the autoDeclaration property.

Return Value

true if the member variable can be declared for this control; otherwise, false.

Remarks

Controls cannot have identical names.

Method backgroundColor

Gets or sets the background color of the control.

public int backgroundColor([int value])

Parameters

value
The value to assign as the background color of the control.

Return Value

An integer that contains a packed RGB color.

Remarks

The integer that is returned contains a packed RGB color as follows:

  • The low-order byte contains a value for the relative intensity of red.
  • The second byte contains a value for green.
  • The third byte contains a value for blue.
  • The high-order byte must be 0 (zero).
  • The maximum value for a single byte is 255.

Examples

The following example shows how to return and set the background color for a control.

// Retrieve the existing background color. 
info (strfmt("Background color: %1", this.backgroundColor())); 
// Set the background color. 
this.backgroundColor(WindowsPalette::DarkShadow3D);

Method backStyle

Determiness whether the control background can be transparent.

public int backStyle([int value])

Parameters

value
The value to assign as the background style of the control.

Return Value

1 if the control background can be transparent; otherwise, 0.

Examples

The following example shows how to return and set the background style.

// Return the background style. 
info (strfmt("Background style: %1", this.backStyle())); 
// Set the background style. 
this.backStyle(FormBackStyle::Transparent);

Method beginDrag

Is called when the user starts to drag a form tree control.

public int beginDrag(int x, int y)

Parameters

x
An Integer data type that indicates the y-coordinate of the mouse pointer. The coordinate is relative to the upper-left corner of the control.

y
An Integer data type that indicates the y-coordinate of the mouse pointer. The coordinate is relative to the upper-left corner of the control.

Return Value

0 (zero) if the event has been handled.

Remarks

This event is not raised unless the DragDrop property is enabled for the control. To drag a control, the user presses the mouse button in the control area and then moves the mouse pointer.

Examples

The following example displays the x-coordinates and y-coordinates in the Infolog when the user starts to drag the form tree control.

public int beginDrag(int _x, int _y) 
{ 
    int ret; 
    info(strfmt("beginDrag (x, y) : (%1, %2)", _x, _y)); 
    ret = super(_x, _y); 
    return ret; 
}

Method beginLabelEdit

public boolean beginLabelEdit(int Idx, str text, AnyType data)

Parameters

Idx

text

data

Return Value

Method bold

Gets or sets the font weight that is used to display text in the control.

public int bold([int value])

Parameters

value
The value to assign to the bold setting for the control.

Return Value

An integer value between 0 (zero) and 9, inclusive.

Remarks

The integer that is returned contains the weight of the font as follows:

  • 0 – Use the default font weight.
  • 1 – Thin.
  • 2 – Extra-light.
  • 3 – Light.
  • 4 – Normal.
  • 5 – Medium.
  • 6 – Semibold.
  • 7 – Bold.
  • 8 – Extra-bold.
  • 9 – Heavy.

Method border

Gets or sets the style of the border for the control.

public int border([int value])

Parameters

value
The value to assign as the border style for the control; optional.

Return Value

An integer between 0 (zero) and 4, inclusive.

Remarks

The integer that is returned contains the style of the border for the control as follows.

Value Description
0 Auto
1 3D
2 Single line
3 Flat
4 None

Examples

The following example shows how to retrieve and set the border style for a control.

// Retrieve the border style. 
info (strfmt("border: %1", this.border())); 
// Set the border style. 
this.border(2);

Method calcControlSize

Retrieves the size of the control.

public container calcControlSize(int chars, int lines)

Parameters

chars
The number of lines to use to determine the height.

lines
The number of lines to use to determine the height.

Return Value

The container that holds the width and height.

Method canScroll

public boolean canScroll([boolean value])

Parameters

value

Return Value

Method cascadeSelect

public boolean cascadeSelect([boolean value])

Parameters

value

Return Value

Method characterSet

Gets or sets the character set of the font.

public int characterSet([int value])

Parameters

value

Return Value

An integer value that indicates the character set of the font.

Remarks

The values for the integer that is returned indicate the character set according to the following table.

Value Description
0 ANSI_CHARSET
1 DEFAULT_CHARSET
2 SYMBOL_CHARSET
77 MAC_CHARSET
128 SHIFTJIS_CHARSET
129 HANGUL_CHARSET
134 GB2312_CHARSET
136 CHINESEBIG5_CHARSET
161 GREEK_CHARSET
162 TURKISH_CHARSET
163 VIETNAMESE_CHARSET
186 BALTIC_CHARSET
204 RUSSIAN_CHARSET
238 EASTEUROPE_CHARSET
255 OEM_CHARSET

The value in the following table is for the Korean language edition of MicrosoftWindows.

Value Description
130 JOHAB_CHARSET

The values in the following table are for the Middle East language edition of Windows.

Value Description
177 HEBREW_CHARSET
178 ARABIC_CHARSET

The value in the following table is for the Thai language edition of Windows.

Value Description
222 THAI_CHARSET

The default character set is set to a value, depending on the current system locale. For example, when the system locale is English (United States), it is set as ANSI_CHARSET. For more information, see the LOGFONT structure on the MSDN website, http://go.microsoft.com/fwlink/?LinkID=85972.

Method checkBox

public boolean checkBox([boolean value])

Parameters

value

Return Value

Method colorScheme

Gets or sets the color scheme of the control.

public int colorScheme([int value])

Parameters

value

Return Value

An integer between zero and two, inclusive.

Remarks

The color scheme is defined according to the following table.

Value Style
0 Default
1 The Windows palette
2 The true-color scheme

Method configurationKey

Gets or sets the configuration key that is assigned to the control.

public ConfigurationKeyId configurationKey([ConfigurationKeyId value])

Parameters

value
The ID of the configuration key to assign to the control.

Return Value

The ID of the configuration key that is assigned to the control.

Remarks

The configuration key is used to determine whether this control can be displayed. If the configuration key is disabled in the system, the control is not displayed in the form.

Examples

The following example shows how to set and retrieve the configuration key for a control.

DictConfigurationKey dck; 
configurationKeyId cki; 
// objCtrl previously assigned. 
// Assign a configuration key to the control. 
objCtrl.configurationKey(configurationkeynum(BankDeposit)); 
// Retrieve the configuration key ID from the control. 
cki = objCtrl.configurationKey(); 
if (cki != 0) 
{ 
    dck = new DictConfigurationKey(cki); 
    if (dck) 
    { 
    print strfmt("Configuration Key ID: %1 Configuration Key Name: %2", 
                  cki, 
                  dck.name()); 
    } 
}

Method configurationKeyEx

Returns a list that contains the IDs of configuration keys that are in effect for the control.

public List configurationKeyEx()

Return Value

A list that contains the IDs of configuration keys that are in effect for the control.

Remarks

If the control is bound to a data source, the returned list of configuration key IDs also includes the configuration key ID for the table and field. The returned list also contains any configuration key IDs that are applied to the properties, extended data type, or enumType methods. The list does not contain duplicate IDs.

Examples

The following example shows how to retrieve the configuration key IDs for a control.

DictConfigurationKey dck; 
configurationKeyId cki; 
List list; 
ListEnumerator enum;
// objCtrl previously assigned. 
list = objCtrl.configurationKeyEx(); 
if (0 != list.elements()) 
{ 
    enum = list.getEnumerator(); 
    while (enum.moveNext()) 
    { 
       dck = new DictConfigurationKey(enum.current()); 
       if (dck) 
       { 
        print strfmt("Configuration Key ID: %1 Configuration Key Name: %2", 
                     enum.current(), 
                     dck.name() ); 
       } 
    } 
}

Method copyItem

public int copyItem(int Idx, int newParent, [int insertAfter])

Parameters

Idx

newParent

insertAfter

Return Value

Method countryRegionCodes

Gets or sets the comma-separated list of country/region codes for the control.

public str countryRegionCodes([str value])

Parameters

value
The string that contains the country/region codes to set; optional.

Return Value

The comma-separated list of country/region codes for the control.

Method createDragImagelist

public Imagelist createDragImagelist()

Return Value

Method dataRelationPath

Gets or sets the period-delimited list of relations that links the field binding of the DataField object to a relative table.

public str dataRelationPath([str value])

Parameters

value
The string that contains the period-delimited list of relations; optional.

Return Value

The period-delimited list of relations that links the field binding of the DataField object to a relative table.

Remarks

This method is used by the reference group control to track exactly which relations produce the replacement field that is used. It enables the reference group control to bind consistently to the controls that it contains.

Method delete

Deletes the specified item from the form tree control.

public boolean delete(int Idx)

Parameters

Idx
An integer that specifies the zero-based index of the item to delete.

Return Value

true if the item was successfully deleted; otherwise, false.

Examples

The following example shows how to delete the first item in the form tree control.

// The ftc variable was a previously allocated  
// FormTreeControl variable. 
boolean bDelete; 
bDelete = ftc.delete(0);

Method deleteAll

Deletes all items from the form tree control.

public boolean deleteAll()

Return Value

true if all items were successfully deleted; otherwise, false.

Examples

The following example shows how to delete all items from a form tree control.

// The ftc variable was a previously allocated 
// FormTreeControl variable. 
boolean bDelete; 
bDelete = ftc.deleteAll();

Method displayTarget

Gets or sets the value that indicates whether the control is displayed in the Finance and Operations client, in Enterprise Portal for Finance and Operations, or in both.

public int displayTarget([int value])

Parameters

value
The integer value that indicates where the control is displayed; optional.

Return Value

The value that indicates whether the control is displayed in the Finance and Operations client, in Enterprise Portal, or in both.

Method dragDrop

Determines whether drag-and-drop operations are enabled or disabled for the control.

public int dragDrop([int value])

Parameters

value
An Integer data type that indicates whether drag-and-drop behavior is enabled.

Return Value

1 if drag-and-drop operations are enabled; otherwise, false.

Examples

The following example shows how to return or set the value that indicates whether drag-and-drop behavior is enabled.

boolean dDragDrop; 
// The ctrl variable was previously assigned  
// as a FormTreeControl value. 
// Retrieve the drag–and–drop-enabled value. 
dDragDrop = ctrl.dragDrop(); 
// Set the drag–and–drop-enabled value. 
ctrl.dragDrop(true);

Method dragOver

Raises the dragOver event to indicate that a mouse drag operation is over the current control.

public FormDrag dragOver(FormControl dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.

Return Value

A FormDrag enumeration value that indicates the mode of dragging.

Method dragOverEx

Raises the dragOverEx event to indicate that a mouse drag operation is over the current control.

public FormDrag dragOverEx(Array dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.

Return Value

A FormDrag enumeration value that indicates the mode of dragging.

Method dragText

Returns the text that is displayed when the form tree control is dragged.

public str dragText()

Return Value

The text that is displayed when the tree control is dragged; an empty string if there is no text to display when the tree control is dragged.

Method editLabels

public boolean editLabels([boolean value])

Parameters

value

Return Value

Method enabled

Determines whether the object is enabled or disabled.

public boolean enabled([boolean value])

Parameters

value
A Boolean value that specifies whether the control is enabled.

Return Value

true if the object is enabled; otherwise, false.

Remarks

The enabled property lets you enable or disable controls at run time. For example, you can disable objects that do not apply to the current state of the application. You can also disable a control that is used only for display purposes, such as an error message that provides read-only information.

Examples

The following example shows how to return and set the enabled property for a control.

// Return the value of the enabled property. 
info(strfmt("enabled: %1",this.enabled())); 
// Set the enabled property. 
this.enabled(false);

Method expand

public int expand(int Idx, [FormTreeExpand action])

Parameters

Idx

action

Return Value

Method expanding

public boolean expanding(int Idx, FormTreeExpand action, AnyType data)

Parameters

Idx

action

data

Return Value

Method font

Gets or sets the name of the font that is used for the text in the control.

public str font([str value])

Parameters

value
A string value that indicates the font to use for the text in a form tree control.

Return Value

The name of the font to use, such as Tahoma or Verdana.

Examples

The following example shows how to return and set the font for a form tree control.

str strFont; 
// The ctrl variable was previously assigned  
// as a form tree control variable. 
// Retrieve the font. 
strFont = ctrl.font(); 
// Set the font. 
ctrl.font("Times New Roman");

Method fontSize

Gets or sets the font size that is used for the text in the control.

public int fontSize([int value])

Parameters

value
An Integer data type that indicates the font size, in points, for the text in a form tree control.

Return Value

The height of the font in points.

Examples

The following example shows how to return and set the font size for a control.

int nSize; 
// The ctrl variable was previously assigned  
// as a form tree control. 
// Retrieve the font size. 
nSize = ctrl.fontSize(); 
// Set the font size. 
ctrl.fontSize(16);

Method foregroundColor

Gets or sets the color that is used for the text in the control.

public int foregroundColor([int value])

Parameters

value

Return Value

An integer that contains a packed RGB color.

Remarks

The integer that is returned contains a packed RGB color as follows:

  • The low-order byte contains a value for the relative intensity of red.
  • The second byte contains a value for green.
  • The third byte contains a value for blue.
  • The high-order byte must be 0 (zero).
  • The maximum value for a single byte is 255.

Method getChild

public int getChild(int Idx)

Parameters

Idx

Return Value

Method getFirstSelected

public int getFirstSelected()

Return Value

Method getFirstVisible

public int getFirstVisible()

Return Value

Method getImagelist

public Imagelist getImagelist()

Return Value

Method getItem

public FormTreeItem getItem(int Idx)

Parameters

Idx

Return Value

Method getNextSelected

public int getNextSelected(int idx)

Parameters

idx

Return Value

Method getNextSibling

public int getNextSibling(int Idx)

Parameters

Idx

Return Value

Method getNextVisible

public int getNextVisible(int Idx)

Parameters

Idx

Return Value

Method getParent

public int getParent(int Idx)

Parameters

Idx

Return Value

Method getPrevSelected

public int getPrevSelected(int idx)

Parameters

idx

Return Value

Method getPrevSibling

public int getPrevSibling(int Idx)

Parameters

Idx

Return Value

Method getPrevVisible

public int getPrevVisible(int Idx)

Parameters

Idx

Return Value

Method getRoot

public int getRoot()

Return Value

Method getSelectedCount

public int getSelectedCount()

Return Value

Method getSelection

public int getSelection()

Return Value

Method getStateImagelist

public Imagelist getStateImagelist()

Return Value

Method getVisibleCount

Returns the number of visible items in the tree control.

public int getVisibleCount()

Return Value

The number of visibile items in the tree control.

Examples

The following example shows how to retrieve the number of visible items in the tree control.

int nCount; 
nCount = this.getVisibleCount(); 
info (strfmt("getVisibleCount: %1", int2str(nCount)));

Method hasButtons

Returns a value that indicates whether the tree control uses expand/collapse buttons.

public boolean hasButtons([boolean value])

Parameters

value

Return Value

true if the tree control uses expand/collapse buttons; otherwise, false.

Examples

The following example shows how to retrieve the value that indicates whether the tree control uses expand/collapse buttons.

boolean bHasButtons; 
// Retrieve the value. 
bHasButtons = this.hasButtons(); 
info (strfmt("hasButtons: %1",bHasButtons)); 
// Set the value. 
this.hasButtons(false);

Method hasChanged

Sets or returns a value that indicates whether the contents of the tree control have changed.

public boolean hasChanged([boolean val])

Parameters

val
The value to assign as the hasChanged value for the tree control.

Return Value

true if the contents of the tree control have changed; otherwise, false.

Examples

The following example shows how to return and set the value that indicates whether the contents of the tree control have changed.

boolean bHasChanged; 
// The ctrl variable was previously assigned 
// as a FormTreeControl variable. 
// Retrieve the hasChanged value. 
bHasChanged = ctrl.hasChanged(); 
// Modify the hasChanged value. 
ctrl.hasChanged(true);

Method hasLines

Returns a value that indicates whether the tree control displays tree connector lines.

public boolean hasLines([boolean value])

Parameters

value

Return Value

true if the tree control displays tree connector lines; otherwise, false.

Examples

The following example shows how to retrieve the value that indicates whether the tree control displays tree connector lines.

boolean bHasLines; 
// Retrieve the value. 
bHasLines = this.hasLines(); 
info (strfmt("hasLines: %1", bHasLines)); 
// Set the value. 
this.hasLines(false);

Method hasUserSetting

Indicates whether the control has custom user settings.

public boolean hasUserSetting()

Return Value

true if the control has custom user settings; otherwise, false.

Method height

Gets or sets the height of the control.

public int height(int value, [int mode])

Parameters

value
An Integer data type that indicates how the height is calculated; optional. This can be one of the following values:

mode
An Integer data type that indicates how the height is calculated; optional. This can be one of the following values:

Return Value

The height of the control in pixels.

Remarks

Exact mode is used if the value parameter is omitted. Calculate the height according to the following table.

Mode Height calculation
-1 – Exact The exact height of the control in pixels is used.
0 – Auto The height of the control is calculated automatically, and the value parameter is ignored.
1 – Column height The layout of the form determines the height of the control.

The height and the height calculation mode can be set separately.

Method heightMode

Gets or sets a calculation mode for the height of the control.

public int heightMode([int value])

Parameters

value
An Integer data type value that indicates how the height of the control is calculated. This value can be -1 for Exact mode, 0 for Auto mode, or 1 for Column height mode.

Return Value

The height calculation mode.

Remarks

Calculate the height according to the following table.

Mode Height calculation
Exact The exact height of the control in pixels is used.
Auto The height of the control is calculated automatically, and the value parameter is ignored.
Column height The layout of the form determines the height of the control.

The height of the control might change when the calculation mode is set to Auto or Column height.

Examples

The following example shows how to return and set the height calculation mode for a form tree control.

int nHeightMode; 
; 
// The ctrl variable was previously assigned 
// as a form tree control variable. 
// Retrieve the height mode. 
nHeightMode = ctrl.HeightMode(); 
// Set the height mode. 
ctrl.heightMode(-1); 
// Set the height. 
ctrl.heightValue(160);

Method heightValue

Gets or sets the height of the control.

public int heightValue([int value])

Parameters

value
An Integer data type that specifies the height in pixels.

Return Value

The height in pixels.

Remarks

The height of the control is not changed unless the Exact height calculation mode is used.

Examples

The following example shows how to return and set the height value of a form tree control.

int nHeightValue; 
// The ctrl variable was previously assigned 
// as a form tree control variable. 
// Retrieve the height value. 
nHeightValue = ctrl.heightValue(); 
// Set the height value. 
ctrl.heightMode(-1); 
ctrl.heightValue(160);

Method helpField

Returns the Help text for the control.

public str helpField()

Return Value

The Help text for the control; an empty string if there is no Help text for the control.

Remarks

The helpField method cannot be used to set the value of the Help text. Use the helpText method to set the value of the Help text.

Examples

The following example shows how to use the helpField method.

str strHelp; 
strHelp = this.helpField();

Method helpText

Gets or sets the Help text that is displayed at the bottom of the screen when a field or control is pointed to.

public str helpText([str value])

Parameters

value
The value to assign as the Help text for the control.

Return Value

The string that is displayed at the bottom of the screen.

Remarks

Set the HelpText property for an object by using the property sheet. The Help text must not exceed 250 characters.

Examples

The following example shows how to set and return the Help text for a control.

// objCtrl previously assigned to a control 
// Retrieve existing Help text. 
print objCtrl.helpText(); 
// Specify new Help text. 
objCtrl.helpText("My new Help text");

Method hierarchyParent

Gets or sets the HierarchyParent property value of the control.

public str hierarchyParent([str value])

Parameters

value
The value to assign to the HierarchyParent property of the control.

Return Value

The HierarchyParent property value of the control.

Method hitTest

public container hitTest(int x, int y)

Parameters

x

y

Return Value

Method hWnd

Returns the Windows handle for the control.

public int hWnd()

Return Value

The handle for the control.

Remarks

The handle can be used with the Windows API.

Examples

The following example shows how to retrieve the Windows handle for a control.

int h; 
h = this.hWnd(); 
info (strfmt("hWnd: %1", h));

Method isContainer

Returns a value that indicates whether the control is a container.

public boolean isContainer()

Return Value

true if the control is a container; otherwise false.

Examples

The following example shows how to determine whether a control is a container.

info(strfmt("IsContainer: %1", this.isContainer()));

Method isDisplayed

Returns a value that indicates whether the control is displayed.

public boolean isDisplayed()

Return Value

true if the control is displayed; otherwise, false.

Remarks

To modify the visible state of the control, call the visible method.

Examples

The following example shows how to determine whether a control is visible.

info(strfmt("isDisplayed: %1", this.isDisplayed()));

Method isRestricted

Retrieves a value that indicates whether the control is restricted.

public boolean isRestricted()

Return Value

true if the control is restricted; otherwise, false.

Method isUserSetupEnabled

Retrieves a value that indicates whether the control allows for the specified level of customization.

public boolean isUserSetupEnabled(int neededSetupRights)

Parameters

neededSetupRights
A value from the FormAllowUserSetup enumeration that specifies the level of customization that is being queried for the control.

Return Value

true if the control, design, and parent containers allow for the level of customization that is specified by the neededSetupRights parameter; otherwise, false. For this method to return true, the AllowUserSetup property for the design and all parent containers must allow for the level of access that is specified by the neededSetupRights parameter.

Remarks

The following table describes the values for the neededSetupRights parameter.

FormAllowUserSetup::No 0 No changes can be made to the control. If this value is set for the neededSetupRights parameter, the method always returns true.
FormAllowUserSetup::Restricted 1 The user can change the editable, visible, skip, label, and width properties of the control. The user cannot move the control.
FormAllowUserSetup::Yes 2 The user can change the editable, visible, skip, label, and width properties of the control. The user can also move the control.

Examples

The following example shows how to determine the user setup rights for a control.

FormAllowUserSetup formAllowUserSetup = FormAllowUserSetup::No; 
switch (true) 
{ 
    case this.isUserSetupEnabled(FormAllowUserSetup::Yes): 
        formAllowUserSetup = FormAllowUserSetup::Yes; 
        break; 
    case this.isUserSetupEnabled(FormAllowUserSetup::Restricted): 
        formAllowUserSetup = FormAllowUserSetup::Restricted; 
        break; 
    case this.isUserSetupEnabled(FormAllowUserSetup::No): 
       formAllowUserSetup = FormAllowUserSetup::No; 
        break; 
} 
info (strfmt("formAllowUserSetup: %1", formAllowUserSetup));

Method italic

Sets or returns a value that indicates whether the text in the control is italic.

public boolean italic([boolean value])

Parameters

value
The value to assign to the italic setting for the control.

Return Value

true if the text in the control is italic; otherwise, false.

Method keyDown

public boolean keyDown(int vKey, boolean Ctrl, boolean Shift)

Parameters

vKey

Ctrl

Shift

Return Value

Method leave

public boolean leave()

Return Value

Method left

Gets or sets the horizontal position of the control in the form.

public int left(int value, [int mode])

Parameters

value
An integer value that indicates the horizontal arrange mode for the control; optional.

mode
An integer value that indicates the horizontal arrange mode for the control; optional.

Return Value

The horizontal position of the control in the form.

Method leftMode

Sets the horizontal arrange mode for the control in the form.

public int leftMode([int value])

Parameters

value
An integer value that indicates the horizontal arrange mode for the control; optional.

Return Value

The horizontal arrange mode for the control in the form.

Method leftValue

Gets or sets the horizontal position of the control in the form.

public int leftValue([int value])

Parameters

value
An integer value that indicates the horizontal position of the control; optional.

Return Value

The horizontal position of the control in the form.

Method linesAtRoot

public boolean linesAtRoot([boolean value])

Parameters

value

Return Value

Method markAsUserAdd

Marks or unmarks the control as a user-added control.

public boolean markAsUserAdd([boolean value])

Parameters

value
The Boolean value that indicates whether the control should be marked as a user-added control.

Return Value

true if the control was marked as a user-added control; otherwise, false.

Method mouseDblClick

Is called when the control is double-clicked by the user.

public int mouseDblClick(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned.

Examples

The following example shows how to display the parameters of a mouseDblClick event in the Infolog.

public int mouseDblClick(int x,  
                         int y,  
                         int button, 
                         boolean Ctrl, 
                         boolean Shift) 
{ 
    int ret; 
    if (Shift) 
    { 
        info( "Shift set" ); 
    } 
    if (Ctrl) 
    { 
        info( "Ctrl set"); 
    } 
    info (strfmt("x, y: %1 %2 button: %3", x, y, button)); 
    ret = super(x, y, button, Ctrl, Shift); 
    info (strfmt("ret: %1", ret)); 
    return ret; 
}

Method mouseDown

Is called when the user clicks while the mouse pointer is over the control.

public int mouseDown(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned. This event is called only if a value is specified for the label of the control and the ShowLabel property of the control is set to Yes.

Examples

The following example shows how to display the parameters of a mouseDown event in the Infolog.

public int mouseDown(int x,  
                              int y,  
                              int button, 
                              boolean Ctrl, 
                              boolean Shift) 
{ 
    int ret; 
    if (Shift) 
    { 
        info( "Shift set" ); 
    } 
    if (Ctrl) 
    { 
        info( "Ctrl set"); 
    } 
    info (strfmt("x, y: %1 %2 button: %3", x, y, button)); 
    ret = super(x, y, button, Ctrl, Shift); 
    info (strfmt("ret: %1", ret)); 
    return ret; 
}

Method mouseMove

Is called when the user moves the mouse pointer over the control.

public int mouseMove(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned.

Examples

The following example shows how to display the parameters of a mouseMove event in the Infolog.

public int mouseMove(int x,  
                     int y,  
                     int button, 
                     boolean Ctrl, 
                     boolean Shift) 
{ 
    int ret; 
    if (Shift) 
    { 
        info( "Shift set" ); 
    } 
    if (Ctrl) 
    { 
        info( "Ctrl set"); 
    } 
    info (strfmt("x, y: %1 %2 button: %3", x, y, button)); 
    ret = super(x, y, button, Ctrl, Shift); 
    info (strfmt("ret: %1", ret)); 
    return ret; 
}

Method mouseUp

Is called when the user releases the mouse button while the mouse pointer is over the control.

public int mouseUp(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned. This event is called only if a value is specified for the label of the control and the ShowLabel property of the control is set to Yes.

Examples

The following example shows how to display the parameters of a mouseUp event in the Infolog.

public int mouseUp(int x,  
                   int y,  
                   int button, 
                   boolean Ctrl, 
                   boolean Shift) 
{ 
    int ret; 
    if (Shift) 
    { 
        info( "Shift set" ); 
    } 
    if (Ctrl) 
    { 
        info( "Ctrl set"); 
    } 
    info (strfmt("x, y: %1 %2 button: %3", x, y, button)); 
    ret = super(x, y, button, Ctrl, Shift); 
    info (strfmt("ret: %1", ret)); 
    return ret; 
}

Method moveItem

public int moveItem(int Idx, int newParent, [int insertAfter])

Parameters

Idx

newParent

insertAfter

Return Value

Method name

Gets or sets the name that is used in code to identify a form, report, table, query, or another Finance and Operations application object.

public str name([str value])

Parameters

value
The name to assign to the control.

Return Value

The name that is used in code to identify an application object.

Remarks

The name property value of an object must meet the following criteria to avoid code conflicts:

  • Begins with a letter.
  • Doesn't exceed 250 characters.
  • Can include numbers and underscore characters.
  • Cannot include punctuation or spaces.
  • Tables cannot have the same name as other public objects, such as extended data types, base enumeration types, classes, and so on.

Method neededPermission

public int neededPermission([int value])

Parameters

value

Return Value

Method SysObsoleteAttribute

public container SysObsoleteAttribute()

Return Value

Method parentControl

Retrieves the parent control for the control.

public FormControl parentControl()

Return Value

The parent control for the control.

Method rowSelect

public boolean rowSelect([boolean value])

Parameters

value

Return Value

Method securityKey

Sets or returns the ID of the security key for the control.

public SecurityKeyId securityKey([SecurityKeyId value])

Parameters

value
The ID of the security key to assign to the control.

Return Value

The ID of the security key for the control; 0 (zero) if no security key is assigned to the control.

Examples

The following example shows how to retrieve and assign a security key ID for a control.

DictSecurityKey dsk; 
securityKeyId ski; 
// objCtrl previously assigned. 
// Assign a security key ID to the control. 
objCtrl.securityKey(securitykeynum(AdminDaily)); 
// Retrieve the security key ID from the control. 
ski = objCtrl.securityKey(); 
if (ski != 0) 
{ 
    dsk = new DictSecurityKey(ski); 
    if (dsk) 
    { 
        print strfmt("Security Key ID: %1 Security Key Name: %2", 
                     ski, 
                     dsk.name()); 
    } 
}

Method select

public int select(int Idx)

Parameters

Idx

Return Value

Method selectEx

public int selectEx(int Idx, boolean setSelection)

Parameters

Idx

setSelection

Return Value

Method selectionChanging

public boolean selectionChanging(FormTreeItem OldItem, FormTreeItem NewItem, FormTreeSelect how)

Parameters

OldItem

NewItem

how

Return Value

Method selectItems

public int selectItems(int fromIdx, int toIdx)

Parameters

fromIdx

toIdx

Return Value

Method selectSetFirstVisible

public int selectSetFirstVisible(int Idx)

Parameters

Idx

Return Value

Method setInsertMark

public boolean setInsertMark(int Idx, boolean After)

Parameters

Idx

After

Return Value

Method setItem

public boolean setItem(FormTreeItem item)

Parameters

item

Return Value

Method showContextMenu

Shows the shortcut menu for the control.

public int showContextMenu(int menuHandle)

Parameters

menuHandle
The ID of the menu to show.

Return Value

An integer value that indicates whether the call succeeded.

Method showSelAlways

public boolean showSelAlways([boolean value])

Parameters

value

Return Value

Method singleSelection

public boolean singleSelection([boolean value])

Parameters

value

Return Value

Method skip

Sets or returns a value that indicates whether the control is skipped when the user presses the TAB key to move to the control.

public boolean skip([boolean value])

Parameters

value
The value to assign to the skip property of the control.

Return Value

true if the control is skipped when the user presses the TAB key to move to the control; otherwise, false.

Remarks

If the enabled property is true, the allowEdit property is false, and the skip property is true, the user cannot change the contents of the control but can still copy the contents of the control.

Examples

The following shows how to return and set the skip property of a control.

// Return the value of the skip property. 
info(strfmt("skip: %1", this.skip())); 
// Set the value of the skip property. 
this.skip(true);

Method toolTip

Returns the tooltip text for the control.

public str toolTip()

Return Value

The tooltip text for the control; an empty string if no tooltip text has been defined for the control.

Remarks

The method can be overridden to provide a value to the toolTip method.

Examples

The following example shows how to override the toolTip method.

str toolTip() 
{ 
    return "Account numbers of customers eligible for discount"; 
}

Method top

Gets or sets the vertical position of the control in the form.

public int top(int value, [int mode])

Parameters

value
An integer value that indicates the vertical arrange mode for the control; optional.

mode
An integer value that indicates the vertical arrange mode for the control; optional.

Return Value

The vertical position of the control in the form.

Method topMode

Sets the vertical arrange mode for the control in the form.

public int topMode([int value])

Parameters

value
An integer value that indicates the vertical arrange mode for the control; optional.

Return Value

The vertical arrange mode for the control in the form.

Method topValue

Gets or sets the vertical position of the control in the form.

public int topValue([int value])

Parameters

value
An integer value that indicates the vertical position of the control; optional.

Return Value

The vertical position of the control in the form.

Method trackSelect

public boolean trackSelect([boolean value])

Parameters

value

Return Value

Method type

public int type([int value])

Parameters

value

Return Value

Method underline

public boolean underline([boolean value])

Parameters

value

Return Value

Method SysObsoleteAttribute

public boolean SysObsoleteAttribute(container data)

Parameters

data

Return Value

Method userData

Gets or sets the user data for the control.

public int userData([int value])

Parameters

value
An integer value that indicates the user data for the control; optional.

Return Value

The user data for the control.

Method userDataItem

Gets or sets the user data item for the control.

public int userDataItem([int value])

Parameters

value
An integer value that indicates the user data item for the control; optional.

Return Value

The user data item for the control.

Method userDataItems

Gets or sets the number of user data items for the control.

public int userDataItems([int value])

Parameters

value
An integer value that indicates the number of user data items for the control; optional.

Return Value

The number of user data items for the control.

Method userDisable

Gets or sets the value that indicates whether the control is disabled for the user.

public int userDisable([int value])

Parameters

value
The value that indicates whether the control is disabled for the user; optional.

Return Value

1 if the control is disabled for the user; otherwise, 0.

Method userHeight

Gets or sets the custom user height for the control.

public int userHeight([int value])

Parameters

value
The user height for the control; optional.

Return Value

The custom user height for the control.

Method userHide

Returns or sets the value that indicates whether the form tree control is hidden from the user.

public int userHide([int value])

Parameters

value
The value that indicates whether the form tree control is hidden from the user.

Return Value

1 if the tree control is hidden from the user; otherwise, 0.

Remarks

The user specifies whether a control is hidden by right-clicking the control when it is viewable or by right-clicking another control when the original control is hidden. A right-click opens a menu that can be used to hide or display the control. This method lets you programmatically determine and set the value.

Examples

The following example shows how to return and set the value that specifies whether the form tree control is hidden from the user.

int nUserHide; 
// The ctrl variable was previously assigned  
// as a form tree control variable. 
// Retrieve the userHide value. 
nUserHide = ctrl.userHide(); 
// Set the userHide value. 
ctrl.userHide(1);

Method userOrgContainer

Gets or sets the organization container for the control.

public int userOrgContainer([int value])

Parameters

value
The organization container to set for the control; optional.

Return Value

The organization container for the control.

Method userOrgSibling

Gets or sets the organization sibling for the control.

public int userOrgSibling([int value])

Parameters

value
The organization sibling to set for the control; optional.

Return Value

The organization sibling for the control.

Method userPromptText

Sets or retrieves the user prompt text for the control.

public str userPromptText([str value])

Parameters

value
The value to assign as the user prompt text for the control.

Return Value

The user prompt text for the control; an empty string if no user prompt text is assigned to the control.

Method userSecurityLevel

Gets or sets the user security level for the control.

public int userSecurityLevel([int value])

Parameters

value
The user security level to set for the control; optional.

Return Value

The user security level for the control.

Method userSkip

Sets or returns the value that indicates whether the form control is skipped when the user presses the TAB key to navigate the controls in the form.

public int userSkip([int value])

Parameters

value
The value to assign to the userSkip property. The value is 1 if the user setting to skip the control is in effect; otherwise, the value is 0.

Return Value

1 if the user setting to skip the control is in effect; otherwise, 0.

Examples

The following example shows how to return and set the userSkip property.

int nUserSkip 
// The ctrl variable was previously assigned 
// as a FormTreeControl value. 
// Return the userSkip property. 
nUserSkip = ctrl.userSkip(); 
// Set the userSkip property. 
ctrl.userSkip(1);

Method userWidth

Sets or returns the width of the control in pixels, as specified by the user.

public int userWidth([int value])

Parameters

value
The number of pixels to use as the width of the control; optional.

Return Value

The number of pixels that the user specified as the width of the control; 0 (zero) if the user did not specify a character width.

Remarks

The userWidth method returns the width in pixels, based on six times the number of characters. For example, if the user has specified 30 characters as the width of the control, the return value is 6 * 30 = 180. To specify the width of the control in characters, users can right-click the control to open the setup form where the character specification is made.

Examples

The following example shows how to return and set the user width of a form tree control.

int nWidth; 
// The ctrl variable was previously defined 
// as a FormTreeControl value. 
// Return the width. 
nWidth = ctrl.userWidth(); 
// Specify the width. 
ctrl.userWidth(90);  // 15 characters * 6 pixels == 90

Method verticalSpacing

Gets or sets the vertical spacing of the control in the form.

public int verticalSpacing([int value], [AutoMode mode])

Parameters

value
An integer value that indicates the AutoMode value for the control; optional.

mode
An integer value that indicates the AutoMode value for the control; optional.

Return Value

The vertical spacing of the control in the form.

Method verticalSpacingMode

Sets the vertical spacing mode for the control in the form.

public AutoMode verticalSpacingMode([AutoMode mode])

Parameters

mode

Return Value

The vertical spacing mode for the control in the form.

Method verticalSpacingValue

Gets or sets the vertical spacing of the control in the form.

public int verticalSpacingValue([int value])

Parameters

value
An integer value that indicates the vertical spacing of the control; optional.

Return Value

The vertical spacing of the control in the form.

Method visible

Sets or returns a value that indicates whether the control is visible.

public boolean visible([boolean value])

Parameters

value
The value to assign to the visibility setting for the control.

Return Value

true if the control is visible; otherwise, false.

Method width

Gets or sets the width of the control.

public int width(int value, [int mode])

Parameters

value
An integer that indicates how the width is calculated; optional.

mode
An integer that indicates how the width is calculated; optional.

Return Value

The width of the control in pixels.

Remarks

Exact mode is used if the value parameter is omitted. Calculate the width according to the following table.

Mode Width calculation
-1 – Exact The exact width of the control in pixels is used.
0 – Auto The width of the control is calculated automatically, and the value parameter is ignored.
1 – Column width The layout of the form determines the width of the control.

The width and the width calculation mode can be set separately.

Method widthMode

Gets or sets the calculation mode for the width of the control.

public int widthMode([int value])

Parameters

value
An Integer data type value that indicates how control width is calculated. This value can be -1 for Exact mode, 0 for Auto mode, or 1 for Column width mode.

Return Value

An integer value that indicates the current width calculation mode.

Remarks

Calculate the width according to the following table.

Mode Width calculation
Exact The exact width of the control in pixels is used.
Auto The width of the control is calculated automatically, and the value parameter is ignored.
Column width The layout of the form determines the width of the control.

The width of the control might change when the calculation mode is set to Auto or Column width.

Examples

The following example shows how to return and set the width calculation mode for a form tree control.

int nWidthMode; 
// The ctrl variable was previously assigned 
// as a form tree control value. 
// Retrieve the width mode. 
nWidthMode = ctrl.widthMode (); 
// Set the width mode. 
ctrl.widthMode(-1); 
// Set the width. 
ctrl.widthValue(180);

Method widthValue

Gets or sets the width of the control.

public int widthValue([int value])

Parameters

value
An Integer data type that specifies the width in pixels.

Return Value

The width of the control in pixels.

Remarks

To change the width of the control, use the Exact width calculation mode.

Examples

The following example shows how to return and set the width value of a form tree control.

int nWidthValue; 
// The ctrl variable was previously assigned 
// as a form tree control value. 
// Retrieve the width value. 
nWidthValue = ctrl.widthValue(); 
// Set the width value. 
ctrl.widthMode(-1); 
ctrl.widthValue(160);

Method checkedStateChanged

public void checkedStateChanged(int Idx, FormTreeCheckedState newState)

Parameters

Idx

newState

Method endLabelEdit

public void endLabelEdit(int Idx, str text, AnyType data)

Parameters

Idx

text

data

Method drop

Raises the drop event to indicate that a drop operation is being performed on the current control.

public void drop(FormControl dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.

Method mouseEnter

Is called when the user moves the mouse pointer into the control.

public void mouseEnter(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned.

Method OnExpanding

private void OnExpanding([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method cut

Cuts the contents of the control.

public void cut()

Method paste

Pastes the form tree control in the form.

public void paste()

Method resetUserSetting

Resets the user settings for the control.

public void resetUserSetting()

Method itemMoved

public void itemMoved(int OldIdx, int NewIdx)

Parameters

OldIdx

NewIdx

Method expanded

public void expanded(int Idx, FormTreeExpand action, AnyType data)

Parameters

Idx

action

data

Method setFocus

Sets the focus on the control.

public void setFocus()

Method OnSelectionChanged

private void OnSelectionChanged([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method OnLostFocus

private void OnLostFocus([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method dropEx

Raises the dropEx event to indicate that a drop operation is being performed on the current control.

public void dropEx(Array dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.

Method mouseLeave

Is called when the user moves the mouse pointer out of the control.

public void mouseLeave()

Examples

The following example writes to the Infolog when the mouse pointer leaves the control area.

public void mouseLeave() 
{ 
    info (strfmt("The mouse has left the %1 control.", this.name()) ); 
    super(); 
}

Method endDrag

Is called when the user has finished dragging a form tree control.

public void endDrag()

Remarks

This event is not raised unless the DragDrop property is enabled for the control and a beginDrag event has already been started. To drag a control, the user presses the mouse button in the control area and then moves the mouse pointer.

Examples

The following example displays a message in the Infolog when the user has finished dragging the form tree control.

public void endDrag() 
{ 
    info("EndDrag completed"); 
    super(); 
}

Method context

Shows the shortcut menu for the control.

public void context()

Method itemCopy

public void itemCopy(int OldIdx, int NewIdx)

Parameters

OldIdx

NewIdx

Method enter

public void enter()

Method inputSearch

Performs data filtering for the control, based on the specified string.

public void inputSearch(str searchStr)

Parameters

searchStr
The string value to use to filter data; optional.

Method displayControl

Displays the control.

public void displayControl()

Method prefColumnSize

Specifies the preferred column width and height for the form tree control.

public void prefColumnSize(int width, int height)

Parameters

width
The preferred height of the control measures in pixels.

height
The preferred height of the control measures in pixels.

Examples

The following example shows how to set the preferred width and height of a form tree control.

// The nWidth and nHeight variables were previously assigned 
// as int variables. 
// The ctrl variable was previously assigned 
// as a FormTreeControl value. 
ctrl.prefColumnSize( nWidth, nHeight);

Method setImagelist

public void setImagelist(Imagelist imageList)

Parameters

imageList

Method OnExpanded

private void OnExpanded([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method dragLeave

Raises the dragLeave event to indicate that a mouse drag operation has left the current control.

public void dragLeave()

Method lostFocus

Indicates that the control has lost focus.

public void lostFocus()

Method OnEnter

private void OnEnter([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method itemDeleted

public void itemDeleted(int Idx, AnyType data)

Parameters

Idx

data

Method gotFocus

Indicates that the control has received focus.

public void gotFocus()

Method setStateImagelist

public void setStateImagelist(Imagelist imageList)

Parameters

imageList

Method endEditLabel

public void endEditLabel(boolean cancel)

Parameters

cancel

Method copy

Copies the form tree control.

public void copy()

Method OnGotFocus

private void OnGotFocus([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method registerOverrideMethod

public void registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])

Parameters

methodToOverride

objectMethodToCall

overrideObject

Method OnLeaving

private void OnLeaving([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method selectionChanged

Indicates that the user has changed the selected item in the form tree control.

public void selectionChanged(FormTreeItem OldItem, FormTreeItem NewItem, FormTreeSelect how)

Parameters

OldItem
The value that indicates how the item that is specified by the _NewItem parameter was selected.

NewItem
The value that indicates how the item that is specified by the _NewItem parameter was selected.

how
The value that indicates how the item that is specified by the _NewItem parameter was selected.

Method beginEditLabel

public void beginEditLabel(int Idx)

Parameters

Idx

Class FormTreeItem

class FormTreeItem extends Object

Remarks

Examples

Methods

Method Description
public int children([int value])
public AnyType data([AnyType value])
public int idx()
public int image([int value])
public int overlayImage([int value])
public int selectedImage([int value])
public boolean stateBold([boolean value])
public FormTreeCheckedState stateChecked([FormTreeCheckedState value])
public boolean stateCut([boolean value])
public boolean stateDropHilited([boolean value])
public boolean stateExpanded([boolean value])
public boolean stateExpandedOnce([boolean value])
public int stateImage([int value])
public boolean stateSelected([boolean value])
public str text([str value]) Sets or returns the text for the control.
public str toString() Returns a string representation of the instance of the FormTreeItem class.
public void new([str Text], [int Image], [int children], [AnyType Data]) Initializes a new instance of the Object class.
public void finalize()

Method children

public int children([int value])

Parameters

value

Return Value

Method data

public AnyType data([AnyType value])

Parameters

value

Return Value

Method idx

public int idx()

Return Value

Method image

public int image([int value])

Parameters

value

Return Value

Method overlayImage

public int overlayImage([int value])

Parameters

value

Return Value

Method selectedImage

public int selectedImage([int value])

Parameters

value

Return Value

Method stateBold

public boolean stateBold([boolean value])

Parameters

value

Return Value

Method stateChecked

public FormTreeCheckedState stateChecked([FormTreeCheckedState value])

Parameters

value

Return Value

Method stateCut

public boolean stateCut([boolean value])

Parameters

value

Return Value

Method stateDropHilited

public boolean stateDropHilited([boolean value])

Parameters

value

Return Value

Method stateExpanded

public boolean stateExpanded([boolean value])

Parameters

value

Return Value

Method stateExpandedOnce

public boolean stateExpandedOnce([boolean value])

Parameters

value

Return Value

Method stateImage

public int stateImage([int value])

Parameters

value

Return Value

Method stateSelected

public boolean stateSelected([boolean value])

Parameters

value

Return Value

Method text

Sets or returns the text for the control.

public str text([str value])

Parameters

value
The value to assign as the text for the control; optional.

Return Value

The text for the control; an empty string if no text has been assigned to the control.

Method toString

Returns a string representation of the instance of the FormTreeItem class.

public str toString()

Return Value

A string that contains a description of the instance of the FormTreeItem class.

Remarks

The default implementation returns the class name of the object. The method can be overridden in a derived class to return values that are meaningful for that type.

Examples

The following example shows how to use the toString method.

print objFormTreeItem.toString();

Method new

Initializes a new instance of the Object class.

public void new([str Text], [int Image], [int children], [AnyType Data])

Parameters

Text

Image

children

Data

Method finalize

public void finalize()

Class FormWindowControl

class FormWindowControl extends FormControl

Remarks

Examples

Methods

Method Description
public boolean alignControl([boolean value]) Determines whether to align the control.
public boolean allowEdit([boolean value]) Determines whether the user can change the contents of the control.
public boolean allowSysSetup() Retrieves a value that indicates whether the control is shown in the SysSetup form.
public boolean autoDeclaration([boolean value]) Determines whether the system can declare a member variable that has the same name as the control.
public int backgroundColor([int value]) Gets or sets the background color of the control.
public int backStyle([int value]) Determines whether the control background can be transparent.
public int beginDrag(int x, int y) Is called when the user starts to drag a form control.
public int cacheDataMethod([int value])
public container calcControlSize(int chars, int lines) Retrieves the size of the control.
public int colorScheme([int value]) Gets or sets the color scheme of the control.
public int command(int wParam, int lParam)
public ConfigurationKeyId configurationKey([ConfigurationKeyId value]) Gets or sets the configuration key that is assigned to the control.
public List configurationKeyEx() Retrieves a list that contains the IDs of configuration keys that are in effect for the control.
public str countryRegionCodes([str value]) Gets or sets the comma-separated list of country/region codes for the control.
public FieldId countryRegionContextField([FieldId value])
public FieldId dataField([FieldId value])
public str dataMethod([str value])
public str dataRelationPath([str value]) Gets or sets the period-delimited list of relations that links the field binding of the DataField object to a relative table.
public int dataSource([AnyType value]) Gets or sets a data source that will be used by the control or the form.
public int displayTarget([int value]) Gets or sets the value that indicates whether the control is displayed in the Finance and Operations client, in Enterprise Portal for Finance and Operations, or in both.
public int dragDrop([int value]) Determines whether to enable or disable drag-and-drop operations for the control.
public FormDrag dragOver(FormControl dragSource, FormDrag dragMode, int x, int y) Raises the dragOver event to indicate that a mouse drag operation is over the current control.
public FormDrag dragOverEx(Array dragSource, FormDrag dragMode, int x, int y) Raises the dragOverEx event to indicate that a mouse drag operation is over the current control.
public str dragText() Retrieves the text that is displayed when the form control is dragged.
public boolean enabled([boolean value]) Determines whether to enable or disable the object.
public int foregroundColor([int value]) Gets or sets the text color for the control to use.
public boolean hasChanged([boolean val]) Sets or returns a value that indicates whether the contents of the control have changed.
public boolean hasUserSetting() Indicates whether the control has custom user settings.
public int hDC()
public int height(int value, [int mode]) Gets or sets the height of the control.
public int heightMode([int value]) Gets or sets a calculation mode for the height of the control.
public int heightValue([int value]) Gets or sets the height of the control.
public str helpField() Retrieves the Help text for the control.
public str helpText([str value]) Gets or sets the Help text to display at the bottom of the screen when a field or control is pointed to.
public str hierarchyParent([str value]) Gets or sets the HierarchyParent property value of the control.
public int hWnd() Retrieves the Windows handle for the control.
public Image image([Image value])
public int imageLocation([int value])
public Imagelist imageList([Imagelist value])
public int imagemode([int value])
public str imageName([str value])
public int imageResource([int value])
public boolean isContainer()
public boolean isDisplayed() Retrieves a value that indicates whether the control is displayed.
public boolean isRestricted() Retrieves a value that indicates whether the control is restricted.
public boolean isUserSetupEnabled(int neededSetupRights) Retrieves a value that indicates whether the control allows for the specified level of customization.
public str label([str value]) Gets or sets the label for a control.
public int labelAlignment([int value])
public int labelBold([int value])
public int labelCharacterSet([int value])
public str labelFont([str value])
public int labelFontSize([int value])
public int labelForegroundColor([int value])
public int labelGuide([int value])
public int labelHeight(int value, [int mode])
public int labelHeightMode([int value])
public int labelHeightValue([int value])
public boolean labelItalic([boolean value])
public int labelMouseDblClick(int x, int y, int button, boolean Ctrl, boolean Shift)
public int labelMouseDown(int x, int y, int button, boolean Ctrl, boolean Shift)
public int labelMouseUp(int x, int y, int button, boolean Ctrl, boolean Shift)
public int labelPosition([int value])
public boolean labelUnderline([boolean value])
public int labelWidth(int value, [int mode])
public int labelWidthMode([int value])
public int labelWidthValue([int value])
public boolean leave()
public int left(int value, [int mode]) Gets or sets the horizontal position of the control in the form.
public int leftMode([int value]) Sets the horizontal arrange mode for the control in the form.
public int leftValue([int value]) Gets or sets the horizontal position of the control in the form.
public str location([str value])
public boolean markAsUserAdd([boolean value]) Marks or unmarks the control as a user-added control.
public boolean modified()
public int mouseDblClick(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the control is double-clicked by the user.
public int mouseDown(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user clicks the mouse button over the control.
public int mouseMove(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user moves the mouse pointer over the control.
public int mouseUp(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user releases the mouse button over the control area.
public str name([str value]) Gets or sets the name that is used in code to identify a form, report, table, query, or another Finance and Operations application object.
public int neededPermission([int value])
public str normalImage([str value])
public int onHScroll(int pos)
public int onVScroll(int pos)
public container SysObsoleteAttribute()
public int paint()
public FormControl parentControl() Retrieves the parent control for the control.
public str previewPartRef([str value])
public int promptrect([int value])
public int scrollInfo(int VertScroller, [int Pos], [int PageDelta], [int MoveDelta], [int MinLimit], [int MaxLimit])
public SecurityKeyId securityKey([SecurityKeyId value]) Sets or returns the ID of the security key for the control.
public int showContextMenu(int menuHandle) Shows the shortcut menu for the control.
public boolean showLabel([boolean value])
public boolean skip([boolean value]) Sets or returns a value that indicates whether the control is skipped when the user presses the TAB key to move to the control.
public int sort([SortOrder sortDirection])
public str toolTip() Retrieves the tooltip text for the control.
public int top(int value, [int mode]) Gets or sets the vertical position of the control in the form.
public int topMode([int value]) Sets the vertical arrange mode for the control in the form.
public int topValue([int value]) Gets or sets the vertical position of the control in the form.
public int type([int value])
public boolean SysObsoleteAttribute(container data)
public int userData([int value]) Gets or sets the user data for the control.
public int userDataItem([int value]) Gets or sets the user data item for the control.
public int userDataItems([int value]) Gets or sets the number of user data items for the control.
public int userDisable([int value]) Gets or sets the value that indicates whether the control is disabled for the user.
public int userHeight([int value]) Gets or sets the custom user height for the control.
public int userHide([int value]) Gets or sets the value that indicates whether the control is hidden from the user.
public int userOrgContainer([int value]) Gets or sets the organization container for the control.
public int userOrgSibling([int value]) Gets or sets the organization sibling for the control.
public str userPromptText([str value]) Gets or sets the user label text for the control.
public int userSecurityLevel([int value]) Gets or sets the user security level for the control.
public int userSkip([int value]) Sets or returns the value that indicates whether the form control is skipped when the user presses the TAB key to navigate the controls in the form.
public int userWidth([int value]) Sets or returns the width of the control in pixels, as specified by the user.
public boolean validate()
public int verticalSpacing([int value], [AutoMode mode]) Gets or sets the vertical spacing of the control in the form.
public AutoMode verticalSpacingMode([AutoMode mode]) Sets the vertical spacing mode for the control in the form.
public int verticalSpacingValue([int value]) Gets or sets the vertical spacing of the control in the form.
public boolean visible([boolean value]) Sets or returns a value that indicates whether the control is visible.
public int width(int value, [int mode]) Gets or sets the width of the control.
public int widthMode([int value]) Gets or sets the calculation mode of the width of the control.
public int widthValue([int value]) Gets or sets the width of the control.
public void lostFocus() Indicates that the control has lost focus.
public void registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])
public void mouseEnter(int x, int y, int button, boolean Ctrl, boolean Shift) Is called when the user moves the mouse pointer into the control area.
public void dragLeave() Raises the dragLeave event to indicate that a mouse drag operation has left the current control.
public void gotFocus() Indicates that the control has received focus.
public void context() Shows the shortcut menu for the control.
public void lockDC()
public void enter()
public void endDrag() Is called when the user has finished dragging a form control.
private void OnValidating([FormControl sender], [FormControlEventArgs e])
private void OnEnter([FormControl sender], [FormControlEventArgs e])
public void setDirty([int x], [int y], [int width], [int height])
public void resetUserSetting() Resets the user settings for the control.
private void OnClicked([FormControl sender], [FormControlEventArgs e])
private void OnLookup([FormControl sender], [FormControlEventArgs e])
public void filter([str filterStr])
private void OnModified([FormControl sender], [FormControlEventArgs e])
private void OnValidated([FormControl sender], [FormControlEventArgs e])
public void size(int width, int height)
public void dropFile(str FileName)
public void cut() Cuts the contents of the control.
public void lookup()
public void setFocus() Sets the focus on the control.
public void undo()
private void OnLeaving([FormControl sender], [FormControlEventArgs e])
public void jumpRef()
public void setScrollInfo()
public void paste() Pastes the contents of the clipboard into the control.
private void OnGotFocus([FormControl sender], [FormControlEventArgs e])
public void clicked()
public void inputSearch(str searchStr) Performs data filtering for the control, based on the specified string.
private void OnLostFocus([FormControl sender], [FormControlEventArgs e])
public void mouseLeave() Indicates that the mouse pointer has left the control.
public void copy() Copies the contents of the control to the clipboard.
public void drop(FormControl dragSource, FormDrag dragMode, int x, int y) Raises the drop event to indicate that a drop operation is being performed on the current control.
public void displayControl() Displays the control.
public void unlockDC()
public void prefColumnSize(int width, int height) Specifies the preferred column width and height for the form control.
public void dropEx(Array dragSource, FormDrag dragMode, int x, int y) Raises the dropEx event to indicate that a drop operation is being performed on the current control.

Method alignControl

Determines whether to align the control.

public boolean alignControl([boolean value])

Parameters

value

Return Value

true if the control should be aligned; otherwise, false.

Remarks

The upper-left corner of the control is aligned according to the longest label.

Method allowEdit

Determines whether the user can change the contents of the control.

public boolean allowEdit([boolean value])

Parameters

value

Return Value

true if the control can be edited; otherwise, false.

Remarks

When this property is set on a container control, modifications are disabled or enabled for all controls in the container.

Method allowSysSetup

Retrieves a value that indicates whether the control is shown in the SysSetup form.

public boolean allowSysSetup()

Return Value

true if the control is shown in the SysSetup form; otherwise, false.

Method autoDeclaration

Determines whether the system can declare a member variable that has the same name as the control.

public boolean autoDeclaration([boolean value])

Parameters

value

Return Value

true if the member variable can be declared for this control; otherwise, false.

Remarks

Controls cannot have identical names.

Method backgroundColor

Gets or sets the background color of the control.

public int backgroundColor([int value])

Parameters

value

Return Value

An integer that contains a packed RGB color.

Remarks

The integer that is returned contains a packed RGB color as follows:

  • The low-order byte contains a value for the relative intensity of red.
  • The second byte contains a value for green.
  • The third byte contains a value for blue.
  • The high-order byte must be zero.
  • The maximum value for a single byte is 255.

Method backStyle

Determines whether the control background can be transparent.

public int backStyle([int value])

Parameters

value

Return Value

1 if the control background can be transparent; otherwise, 0.

Method beginDrag

Is called when the user starts to drag a form control.

public int beginDrag(int x, int y)

Parameters

x
An integer value that indicates the y-coordinate of the mouse pointer. The coordinate is relative to the upper-left corner of the control.

y
An integer value that indicates the y-coordinate of the mouse pointer. The coordinate is relative to the upper-left corner of the control.

Return Value

0 (zero) if the event has been handled.

Remarks

This event is not raised unless the DragDrop property is enabled for the control. To drag a control, a user presses the mouse button in the control area and then moves the mouse pointer.

Method cacheDataMethod

public int cacheDataMethod([int value])

Parameters

value

Return Value

Method calcControlSize

Retrieves the size of the control.

public container calcControlSize(int chars, int lines)

Parameters

chars
The number of lines to use to determine the height.

lines
The number of lines to use to determine the height.

Return Value

The container that holds the width and height.

Method colorScheme

Gets or sets the color scheme of the control.

public int colorScheme([int value])

Parameters

value

Return Value

An integer between zero and two, inclusive.

Remarks

The color scheme is defined according to the following table.

Value Style
0 Default
1 The MicrosoftWindows palette
2 The true-color scheme

Method command

public int command(int wParam, int lParam)

Parameters

wParam

lParam

Return Value

Method configurationKey

Gets or sets the configuration key that is assigned to the control.

public ConfigurationKeyId configurationKey([ConfigurationKeyId value])

Parameters

value

Return Value

The identifier of the configuration key that is assigned to the control.

Remarks

The configuration key is used to determine whether this control can be displayed. If the configuration key is disabled in the system, the control is not displayed in the form.

Method configurationKeyEx

Retrieves a list that contains the IDs of configuration keys that are in effect for the control.

public List configurationKeyEx()

Return Value

A list that contains the IDs of configuration keys that are in effect for the control.

Remarks

The returned list does not contain duplicate IDs. If the control is bound to a data source, the returned list of configuration key IDs also includes the configuration key ID for the table and field. The returned list also contains any configuration key IDs that are applied to the properties, extended data type, or enumType methods.

Method countryRegionCodes

Gets or sets the comma-separated list of country/region codes for the control.

public str countryRegionCodes([str value])

Parameters

value
The string that contains the country/region codes to set; optional.

Return Value

The comma-separated list of country/region codes for the control.

Method countryRegionContextField

public FieldId countryRegionContextField([FieldId value])

Parameters

value

Return Value

Method dataField

public FieldId dataField([FieldId value])

Parameters

value

Return Value

Method dataMethod

public str dataMethod([str value])

Parameters

value

Return Value

Method dataRelationPath

Gets or sets the period-delimited list of relations that links the field binding of the DataField object to a relative table.

public str dataRelationPath([str value])

Parameters

value
The string that contains the period-delimited list of relations; optional.

Return Value

The period-delimited list of relations that links the field binding of the DataField object to a relative table.

Remarks

This method is used by the reference group control to track exactly which relations produce the replacement field that is used. It enables the reference group control to bind consistently to the controls that it contains.

Method dataSource

Gets or sets a data source that will be used by the control or the form.

public int dataSource([AnyType value])

Parameters

value

Return Value

The identifier of the data source that will be used.

Method displayTarget

Gets or sets the value that indicates whether the control is displayed in the Finance and Operations client, in Enterprise Portal for Finance and Operations, or in both.

public int displayTarget([int value])

Parameters

value
The integer value that indicates where the control is displayed; optional.

Return Value

The value that indicates whether the control is displayed in the Finance and Operations client, in Enterprise Portal, or in both.

Method dragDrop

Determines whether to enable or disable drag-and-drop operations for the control.

public int dragDrop([int value])

Parameters

value

Return Value

1 if drag-and-drop operations are enabled; otherwise, false.

Method dragOver

Raises the dragOver event to indicate that a mouse drag operation is over the current control.

public FormDrag dragOver(FormControl dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.

Return Value

A FormDrag enumeration value that indicates the mode of dragging.

Method dragOverEx

Raises the dragOverEx event to indicate that a mouse drag operation is over the current control.

public FormDrag dragOverEx(Array dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.

Return Value

A FormDrag enumeration value that indicates the mode of dragging.

Method dragText

Retrieves the text that is displayed when the form control is dragged.

public str dragText()

Return Value

The text that is displayed when the control is dragged; an empty string if there is no text to display when the control is dragged.

Method enabled

Determines whether to enable or disable the object.

public boolean enabled([boolean value])

Parameters

value

Return Value

true if the object is enabled; otherwise, false.

Remarks

The enabled property gives for controls to be enabled or disabled at run time. For example, you can disable objects that do not apply to the current state of the application. You can also disable a control that is used only for display purposes, such as an error message, which provides read-only information.

Method foregroundColor

Gets or sets the text color for the control to use.

public int foregroundColor([int value])

Parameters

value

Return Value

An integer that contains a packed RGB color.

Remarks

The integer that is returned contains a packed RGB color as follows:

  • The low-order byte contains a value for the relative intensity of red.
  • The second byte contains a value for green.
  • The third byte contains a value for blue.
  • The high-order byte must be zero.
  • The maximum value for a single byte is 255.

Method hasChanged

Sets or returns a value that indicates whether the contents of the control have changed.

public boolean hasChanged([boolean val])

Parameters

val
The value to assign as the hasChanged value for the control; optional.

Return Value

true if the contents of the control have changed; otherwise, false.

Method hasUserSetting

Indicates whether the control has custom user settings.

public boolean hasUserSetting()

Return Value

true if the control has custom user settings; otherwise, false.

Method hDC

public int hDC()

Return Value

Method height

Gets or sets the height of the control.

public int height(int value, [int mode])

Parameters

value

mode

Return Value

The height of the control in pixels.

Remarks

Exact mode is used if the value parameter is omitted. Calculate the height according to the following table.

Mode Height calculation
-1 Exact The exact height in pixels of the controls is used.
0 Auto The height of the control is calculated automatically and the value parameter is ignored.
1 Column height The layout of the form determines the height of the control.

The height and height calculation mode can be set separately.

Method heightMode

Gets or sets a calculation mode for the height of the control.

public int heightMode([int value])

Parameters

value

Return Value

The calculation mode.

Remarks

Calculate the height according to the following table.

Mode Height calculation
Exact The exact height in pixels of the controls is used.
Auto The height of the control is calculated automatically and the value parameter is ignored.
Column height The layout of the form determines the height of the control.

The height of the control might change when the mode is set to auto or column height.

Method heightValue

Gets or sets the height of the control.

public int heightValue([int value])

Parameters

value

Return Value

The height in pixels.

Remarks

The height of the control is not changed unless the exact height calculation mode is used.

Method helpField

Retrieves the Help text for the control.

public str helpField()

Return Value

The Help text for the control; an empty string if there is no Help text for the control.

Remarks

The helpField method cannot be used to set the value of the Help text. Use the helpText method to set the value of the Help text.

Method helpText

Gets or sets the Help text to display at the bottom of the screen when a field or control is pointed to.

public str helpText([str value])

Parameters

value

Return Value

The string to be displayed at the bottom of the screen.

Remarks

Set the HelpText property for an object by using the property sheet. The Help text must not exceed 250 characters.

Method hierarchyParent

Gets or sets the HierarchyParent property value of the control.

public str hierarchyParent([str value])

Parameters

value
The value to assign to the HierarchyParent property of the control.

Return Value

The HierarchyParent property value of the control.

Method hWnd

Retrieves the Windows handle for the control.

public int hWnd()

Return Value

The handle for the control.

Remarks

The handle can be used with the Windows API.

Method image

public Image image([Image value])

Parameters

value

Return Value

Method imageLocation

public int imageLocation([int value])

Parameters

value

Return Value

Method imageList

public Imagelist imageList([Imagelist value])

Parameters

value

Return Value

Method imagemode

public int imagemode([int value])

Parameters

value

Return Value

Method imageName

public str imageName([str value])

Parameters

value

Return Value

Method imageResource

public int imageResource([int value])

Parameters

value

Return Value

Method isContainer

public boolean isContainer()

Return Value

Method isDisplayed

Retrieves a value that indicates whether the control is displayed.

public boolean isDisplayed()

Return Value

true if the control is displayed; otherwise, false.

Remarks

To modify the visible state of the control, call the visible method.

Method isRestricted

Retrieves a value that indicates whether the control is restricted.

public boolean isRestricted()

Return Value

true if the control is restricted; otherwise, false.

Method isUserSetupEnabled

Retrieves a value that indicates whether the control allows for the specified level of customization.

public boolean isUserSetupEnabled(int neededSetupRights)

Parameters

neededSetupRights
A value from the FormAllowUserSetup enumeration that specifies the level of customization that is being queried for the control.

Return Value

true if the control, design, and parent containers allow for the level of customization that is specified by the neededSetupRights parameter; otherwise, false.

Remarks

The following table describes the values for the neededSetupRights parameter.

FormAllowUserSetup::No 0 No changes can be made to the control. If this value is set for the neededSetupRights parameter, the method always returns true.
FormAllowUserSetup::Restricted 1 The user can change the editable, visible, skip, label, and width properties of the control. The user cannot move the control.
FormAllowUserSetup::Yes 2 The user can change the editable, visible, skip, label, and width properties of the control. The user can also move the control.

For this method to return true, the AllowUserSetup property for the design and all parent containers must allow for the level of access that is specified by the neededSetupRights parameter.

Method label

Gets or sets the label for a control.

public str label([str value])

Parameters

value

Return Value

The current value of the label string.

Remarks

The label determines which text is displayed in the control or adjacent to it. The label property value cannot exceed 250 characters.

Method labelAlignment

public int labelAlignment([int value])

Parameters

value

Return Value

Method labelBold

public int labelBold([int value])

Parameters

value

Return Value

Method labelCharacterSet

public int labelCharacterSet([int value])

Parameters

value

Return Value

Method labelFont

public str labelFont([str value])

Parameters

value

Return Value

Method labelFontSize

public int labelFontSize([int value])

Parameters

value

Return Value

Method labelForegroundColor

public int labelForegroundColor([int value])

Parameters

value

Return Value

Method labelGuide

public int labelGuide([int value])

Parameters

value

Return Value

Method labelHeight

public int labelHeight(int value, [int mode])

Parameters

value

mode

Return Value

Method labelHeightMode

public int labelHeightMode([int value])

Parameters

value

Return Value

Method labelHeightValue

public int labelHeightValue([int value])

Parameters

value

Return Value

Method labelItalic

public boolean labelItalic([boolean value])

Parameters

value

Return Value

Method labelMouseDblClick

public int labelMouseDblClick(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x

y

button

Ctrl

Shift

Return Value

Method labelMouseDown

public int labelMouseDown(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x

y

button

Ctrl

Shift

Return Value

Method labelMouseUp

public int labelMouseUp(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x

y

button

Ctrl

Shift

Return Value

Method labelPosition

public int labelPosition([int value])

Parameters

value

Return Value

Method labelUnderline

public boolean labelUnderline([boolean value])

Parameters

value

Return Value

Method labelWidth

public int labelWidth(int value, [int mode])

Parameters

value

mode

Return Value

Method labelWidthMode

public int labelWidthMode([int value])

Parameters

value

Return Value

Method labelWidthValue

public int labelWidthValue([int value])

Parameters

value

Return Value

Method leave

public boolean leave()

Return Value

Method left

Gets or sets the horizontal position of the control in the form.

public int left(int value, [int mode])

Parameters

value
An integer value that indicates the horizontal arrange mode for the control; optional.

mode
An integer value that indicates the horizontal arrange mode for the control; optional.

Return Value

The horizontal position of the control in the form.

Method leftMode

Sets the horizontal arrange mode for the control in the form.

public int leftMode([int value])

Parameters

value
An integer value that indicates the horizontal arrange mode for the control; optional.

Return Value

The horizontal arrange mode for the control in the form.

Method leftValue

Gets or sets the horizontal position of the control in the form.

public int leftValue([int value])

Parameters

value
An integer value that indicates the horizontal position of the control; optional.

Return Value

The horizontal position of the control in the form.

Method location

public str location([str value])

Parameters

value

Return Value

Method markAsUserAdd

Marks or unmarks the control as a user-added control.

public boolean markAsUserAdd([boolean value])

Parameters

value
The Boolean value that indicates whether the control should be marked as a user-added control.

Return Value

true if the control was marked as a user-added control; otherwise, false.

Method modified

public boolean modified()

Return Value

Method mouseDblClick

Is called when the control is double-clicked by the user.

public int mouseDblClick(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned.

Method mouseDown

Is called when the user clicks the mouse button over the control.

public int mouseDown(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned. This event is called only if a value is specified for the label of the control and the ShowLabel property of the control is set to Yes.

Method mouseMove

Is called when the user moves the mouse pointer over the control.

public int mouseMove(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned.

Method mouseUp

Is called when the user releases the mouse button over the control area.

public int mouseUp(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Return Value

0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned. This event is called only if a value is specified for the label of the control and the ShowLabel property of the control is set to Yes.

Method name

Gets or sets the name that is used in code to identify a form, report, table, query, or another Finance and Operations application object.

public str name([str value])

Parameters

value

Return Value

The name that is used in code to identify an application object.

Remarks

The name property value of an object must meet the following criteria to avoid code conflicts:

  • Begins with a letter.
  • Doesn't exceed 250 characters.
  • Can include numbers and underscore characters.
  • Cannot include punctuation or spaces.
  • Tables cannot have the same name as other public objects, such as extended data types, base enumeration types, classes, and so on.

Method neededPermission

public int neededPermission([int value])

Parameters

value

Return Value

Method normalImage

public str normalImage([str value])

Parameters

value

Return Value

Method onHScroll

public int onHScroll(int pos)

Parameters

pos

Return Value

Method onVScroll

public int onVScroll(int pos)

Parameters

pos

Return Value

Method SysObsoleteAttribute

public container SysObsoleteAttribute()

Return Value

Method paint

public int paint()

Return Value

Method parentControl

Retrieves the parent control for the control.

public FormControl parentControl()

Return Value

The parent control for the control.

Method previewPartRef

public str previewPartRef([str value])

Parameters

value

Return Value

Method promptrect

public int promptrect([int value])

Parameters

value

Return Value

Method scrollInfo

public int scrollInfo(int VertScroller, [int Pos], [int PageDelta], [int MoveDelta], [int MinLimit], [int MaxLimit])

Parameters

VertScroller

Pos

PageDelta

MoveDelta

MinLimit

MaxLimit

Return Value

Method securityKey

Sets or returns the ID of the security key for the control.

public SecurityKeyId securityKey([SecurityKeyId value])

Parameters

value
The ID of the security key to assign to the control; optional.

Return Value

The ID of the security key for the control; 0 (zero) if no security key is assigned to the control.

Method showContextMenu

Shows the shortcut menu for the control.

public int showContextMenu(int menuHandle)

Parameters

menuHandle
The ID of the menu to show.

Return Value

An integer value that indicates whether the call succeeded.

Method showLabel

public boolean showLabel([boolean value])

Parameters

value

Return Value

Method skip

Sets or returns a value that indicates whether the control is skipped when the user presses the TAB key to move to the control.

public boolean skip([boolean value])

Parameters

value
The value to assign to the skip property of the control; optional.

Return Value

true if the control is skipped when the user presses the TAB key to move to the control; otherwise, false.

Remarks

If the enabled property is true, the allowEdit property is false, and the skip property is true, the user cannot change the contents of the control but can still copy the contents of the control.

Method sort

public int sort([SortOrder sortDirection])

Parameters

sortDirection

Return Value

Method toolTip

Retrieves the tooltip text for the control.

public str toolTip()

Return Value

The tooltip text for the control; an empty string if no tooltip text has been defined for the control.

Remarks

The method might be overridden to provide a value to the toolTip method.

Method top

Gets or sets the vertical position of the control in the form.

public int top(int value, [int mode])

Parameters

value
An integer value that indicates the vertical arrange mode for the control; optional.

mode
An integer value that indicates the vertical arrange mode for the control; optional.

Return Value

The vertical position of the control in the form.

Method topMode

Sets the vertical arrange mode for the control in the form.

public int topMode([int value])

Parameters

value
An integer value that indicates the vertical arrange mode for the control; optional.

Return Value

The vertical arrange mode for the control in the form.

Method topValue

Gets or sets the vertical position of the control in the form.

public int topValue([int value])

Parameters

value
An integer value that indicates the vertical position of the control; optional.

Return Value

The vertical position of the control in the form.

Method type

public int type([int value])

Parameters

value

Return Value

Method SysObsoleteAttribute

public boolean SysObsoleteAttribute(container data)

Parameters

data

Return Value

Method userData

Gets or sets the user data for the control.

public int userData([int value])

Parameters

value
An integer value that indicates the user data for the control; optional.

Return Value

The user data for the control.

Method userDataItem

Gets or sets the user data item for the control.

public int userDataItem([int value])

Parameters

value
An integer value that indicates the user data item for the control; optional.

Return Value

The user data item for the control.

Method userDataItems

Gets or sets the number of user data items for the control.

public int userDataItems([int value])

Parameters

value
An integer value that indicates the number of user data items for the control; optional.

Return Value

The number of user data items for the control.

Method userDisable

Gets or sets the value that indicates whether the control is disabled for the user.

public int userDisable([int value])

Parameters

value
The value that indicates whether the control is disabled for the user; optional.

Return Value

1 if the control is disabled for the user; otherwise, 0.

Method userHeight

Gets or sets the custom user height for the control.

public int userHeight([int value])

Parameters

value
The user height for the control; optional.

Return Value

The custom user height for the control.

Method userHide

Gets or sets the value that indicates whether the control is hidden from the user.

public int userHide([int value])

Parameters

value
The value that indicates whether the control is hidden from the user; optional.

Return Value

1 if the control is hidden from the user; otherwise, 0.

Remarks

The user specifies whether a control is hidden by right-clicking the control when it is viewable or by right-clicking another control when the original control is hidden. A right-click opens a menu that can be used to hide or display the control. This method lets you programmatically determine and set the value.

Method userOrgContainer

Gets or sets the organization container for the control.

public int userOrgContainer([int value])

Parameters

value
The organization container to set for the control; optional.

Return Value

The organization container for the control.

Method userOrgSibling

Gets or sets the organization sibling for the control.

public int userOrgSibling([int value])

Parameters

value
The organization sibling to set for the control; optional.

Return Value

The organization sibling for the control.

Method userPromptText

Gets or sets the user label text for the control.

public str userPromptText([str value])

Parameters

value
The user label text to set for the control; optional.

Return Value

The user label text for the control.

Method userSecurityLevel

Gets or sets the user security level for the control.

public int userSecurityLevel([int value])

Parameters

value
The user security level to set for the control; optional.

Return Value

The user security level for the control.

Method userSkip

Sets or returns the value that indicates whether the form control is skipped when the user presses the TAB key to navigate the controls in the form.

public int userSkip([int value])

Parameters

value
The value to assign to the userSkip property; optional. The value is 1 if the user setting to skip the control is in effect; otherwise, the value is 0.

Return Value

1 if the user setting to skip the control is in effect; otherwise, 0.

Method userWidth

Sets or returns the width of the control in pixels, as specified by the user.

public int userWidth([int value])

Parameters

value
The number of pixels to use as the width of the control; optional.

Return Value

The number of pixels that the user specified as the width of the control; 0 (zero) if the user did not specify a character width.

Remarks

The userWidth method returns the width in pixels, based on six times the number of characters. For example, if the user has specified 30 characters as the width of the control, the return value is 6 * 30 = 180. To specify the width of the control in characters, users can right-click the control to open the setup form where the character specification is made.

Method validate

public boolean validate()

Return Value

Method verticalSpacing

Gets or sets the vertical spacing of the control in the form.

public int verticalSpacing([int value], [AutoMode mode])

Parameters

value
An integer value that indicates the AutoMode value for the control; optional.

mode
An integer value that indicates the AutoMode value for the control; optional.

Return Value

The vertical spacing of the control in the form.

Method verticalSpacingMode

Sets the vertical spacing mode for the control in the form.

public AutoMode verticalSpacingMode([AutoMode mode])

Parameters

mode

Return Value

The vertical spacing mode for the control in the form.

Method verticalSpacingValue

Gets or sets the vertical spacing of the control in the form.

public int verticalSpacingValue([int value])

Parameters

value
An integer value that indicates the vertical spacing of the control; optional.

Return Value

The vertical spacing of the control in the form.

Method visible

Sets or returns a value that indicates whether the control is visible.

public boolean visible([boolean value])

Parameters

value
The value to assign to the visibility setting for the control; optional.

Return Value

true if the control is visible; otherwise, false.

Method width

Gets or sets the width of the control.

public int width(int value, [int mode])

Parameters

value

mode

Return Value

The width of the control in pixels.

Remarks

Exact mode is used if the value parameter is omitted. Calculate the width according to the following table.

Mode Width calculation
-1 Exact The exact width in pixels of the controls is used.
0 Auto The width of the control is calculated automatically and the value parameter is ignored.
1 Column width The layout of the form determines the width of the control.

The width and width calculation mode can be set separately.

Method widthMode

Gets or sets the calculation mode of the width of the control.

public int widthMode([int value])

Parameters

value

Return Value

An integer value that indicates the current calculation mode.

Remarks

Calculate the width according to the following table.

Mode Width calculation
Exact The exact width in pixels of the controls is used.
Auto The width of the control is calculated automatically and the value parameter is ignored.
Column width The layout of the form determines the width of the control.

The width of the control might change when the mode is set to auto or column width.

Method widthValue

Gets or sets the width of the control.

public int widthValue([int value])

Parameters

value

Return Value

The width in pixels of the control.

Remarks

To change the width of the control, use the exact width calculation mode.

Method lostFocus

Indicates that the control has lost focus.

public void lostFocus()

Method registerOverrideMethod

public void registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])

Parameters

methodToOverride

objectMethodToCall

overrideObject

Method mouseEnter

Is called when the user moves the mouse pointer into the control area.

public void mouseEnter(int x, int y, int button, boolean Ctrl, boolean Shift)

Parameters

x
A Boolean value that indicates whether the SHIFT key is down.

y
A Boolean value that indicates whether the SHIFT key is down.

button
A Boolean value that indicates whether the SHIFT key is down.

Ctrl
A Boolean value that indicates whether the SHIFT key is down.

Shift
A Boolean value that indicates whether the SHIFT key is down.

Method dragLeave

Raises the dragLeave event to indicate that a mouse drag operation has left the current control.

public void dragLeave()

Method gotFocus

Indicates that the control has received focus.

public void gotFocus()

Method context

Shows the shortcut menu for the control.

public void context()

Method lockDC

public void lockDC()

Method enter

public void enter()

Method endDrag

Is called when the user has finished dragging a form control.

public void endDrag()

Remarks

This event is not raised unless the DragDrop property is enabled for the control and a beginDrag event has already been started. To drag a control, a user presses the mouse button in the control area and then moves the mouse pointer.

Method OnValidating

private void OnValidating([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method OnEnter

private void OnEnter([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method setDirty

public void setDirty([int x], [int y], [int width], [int height])

Parameters

x

y

width

height

Method resetUserSetting

Resets the user settings for the control.

public void resetUserSetting()

Method OnClicked

private void OnClicked([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method OnLookup

private void OnLookup([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method filter

public void filter([str filterStr])

Parameters

filterStr

Method OnModified

private void OnModified([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method OnValidated

private void OnValidated([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method size

public void size(int width, int height)

Parameters

width

height

Method dropFile

public void dropFile(str FileName)

Parameters

FileName

Method cut

Cuts the contents of the control.

public void cut()

Method lookup

public void lookup()

Method setFocus

Sets the focus on the control.

public void setFocus()

Method undo

public void undo()

Method OnLeaving

private void OnLeaving([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method jumpRef

public void jumpRef()

Method setScrollInfo

public void setScrollInfo()

Method paste

Pastes the contents of the clipboard into the control.

public void paste()

Method OnGotFocus

private void OnGotFocus([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method clicked

public void clicked()

Method inputSearch

Performs data filtering for the control, based on the specified string.

public void inputSearch(str searchStr)

Parameters

searchStr
The string value to use to filter data; optional.

Method OnLostFocus

private void OnLostFocus([FormControl sender], [FormControlEventArgs e])

Parameters

sender

e

Method mouseLeave

Indicates that the mouse pointer has left the control.

public void mouseLeave()

Method copy

Copies the contents of the control to the clipboard.

public void copy()

Method drop

Raises the drop event to indicate that a drop operation is being performed on the current control.

public void drop(FormControl dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.

Method displayControl

Displays the control.

public void displayControl()

Method unlockDC

public void unlockDC()

Method prefColumnSize

Specifies the preferred column width and height for the form control.

public void prefColumnSize(int width, int height)

Parameters

width
The preferred height of the control.

height
The preferred height of the control.

Method dropEx

Raises the dropEx event to indicate that a drop operation is being performed on the current control.

public void dropEx(Array dragSource, FormDrag dragMode, int x, int y)

Parameters

dragSource
An integer value that indicates the vertical client coordinate of the mouse position.

dragMode
An integer value that indicates the vertical client coordinate of the mouse position.

x
An integer value that indicates the vertical client coordinate of the mouse position.

y
An integer value that indicates the vertical client coordinate of the mouse position.