F Classes - FormBuildFilterPaneControl to FormBuildRealControl

System API classes that start with the letter F.

Class FormBuildFilterPaneControl

class FormBuildFilterPaneControl extends FormBuildControl

Remarks

Examples

Methods

Method Description
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 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 bottomMargin([int value], [AutoMode mode])
public AutoMode bottomMarginMode([AutoMode mode])
public int bottomMarginValue([int value])
public str caption([str value]) Gets or set the caption 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 int containerId() Retrieves the ID of the parent container for the control.
public str countryRegionCodes([str value])
public FieldId countryRegionContextField([FieldId value])
public str dataRelationPath([str value])
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])
public int dragDrop([int value]) Determines whether to enable or disable drag-and-drop operations for the control.
public boolean enabled([boolean value]) Determines whether to enable or disable the object.
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 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])
public int id() Retrieves the ID of the control.
public boolean isContainer() Retrieves a value that indicates whether the control is a container control.
public int left(int value, [int mode])
public int leftMargin([int value], [AutoMode mode])
public AutoMode leftMarginMode([AutoMode mode])
public int leftMarginValue([int value])
public int leftMode([int value])
public int leftValue([int value])
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 int rightMargin([int value], [AutoMode mode])
public AutoMode rightMarginMode([AutoMode mode])
public int rightMarginValue([int value])
public SecurityKeyId securityKey([SecurityKeyId value])
public boolean skip([boolean value])
public int top(int value, [int mode])
public int topMargin([int value], [AutoMode mode])
public AutoMode topMarginMode([AutoMode mode])
public int topMarginValue([int value])
public int topMode([int value])
public int topValue([int value])
public int type([int value])
public int userData([int value])
public int userDataItem([int value])
public int userDataItems([int value])
public int verticalSpacing([int value], [AutoMode mode])
public AutoMode verticalSpacingMode([AutoMode mode])
public int verticalSpacingValue([int value])
public boolean visible([boolean value])
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 registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])

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 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 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 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 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 containerId

Retrieves the ID of the parent container for the control.

public int containerId()

Return Value

The ID of the parent container.

Method countryRegionCodes

public str countryRegionCodes([str value])

Parameters

value

Return Value

Method countryRegionContextField

public FieldId countryRegionContextField([FieldId value])

Parameters

value

Return Value

Method dataRelationPath

public str dataRelationPath([str value])

Parameters

value

Return Value

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

public int displayTarget([int value])

Parameters

value

Return Value

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 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 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 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

public str hierarchyParent([str value])

Parameters

value

Return Value

Method id

Retrieves the ID of the control.

public int id()

Return Value

The ID of the control.

Method isContainer

Retrieves a value that indicates whether the control is a container control.

public boolean isContainer()

Return Value

A Boolean value that indicates whether the control is a container control.

Method left

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

Parameters

value

mode

Return Value

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

public int leftMode([int value])

Parameters

value

Return Value

Method leftValue

public int leftValue([int value])

Parameters

value

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:

  • It must start with a letter.
  • It cannot exceed 250 characters.
  • It can include numbers and underscore (_) characters.
  • It cannot include punctuation or spaces.
  • Tables cannot have the same name as other public objects, such as extended data types, base enumerations, or classes.

Method neededPermission

public int neededPermission([int 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 securityKey

public SecurityKeyId securityKey([SecurityKeyId value])

Parameters

value

Return Value

Method skip

public boolean skip([boolean value])

Parameters

value

Return Value

Method top

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

Parameters

value

mode

Return Value

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

public int topMode([int value])

Parameters

value

Return Value

Method topValue

public int topValue([int value])

Parameters

value

Return Value

Method type

public int type([int value])

Parameters

value

Return Value

Method userData

public int userData([int value])

Parameters

value

Return Value

Method userDataItem

public int userDataItem([int value])

Parameters

value

Return Value

Method userDataItems

public int userDataItems([int value])

Parameters

value

Return Value

Method verticalSpacing

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

Parameters

value

mode

Return Value

Method verticalSpacingMode

public AutoMode verticalSpacingMode([AutoMode mode])

Parameters

mode

Return Value

Method verticalSpacingValue

public int verticalSpacingValue([int value])

Parameters

value

Return Value

Method visible

public boolean visible([boolean value])

Parameters

value

Return Value

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 registerOverrideMethod

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

Parameters

methodToOverride

objectMethodToCall

overrideObject

Class FormBuildFunctionButtonControl

class FormBuildFunctionButtonControl extends FormBuildControl

The FormBuildFunctionButtonControl class lets you create, read, update, and delete X++ code and metadata.

Remarks

Make sure that the user has access to the development security key (SysDevelopment) before this API is called.

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 autoDeclaration([boolean value]) Determines whether the system can declare a member variable that has the same name as the control.
public boolean autoRefreshData([boolean value])
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 boolean big([boolean value])
public int bold([int value]) Gets or sets the weight of font that is 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 buttonDisplay([int value]) Gets or sets the appearance of the button control.
public str caption([str value]) Gets or set the caption of the control.
public int characterSet([int value]) Gets or sets the character set of the font.
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 int containerId() Retrieves the ID of the parent container for the control.
public int copyCallerQuery([int value])
public str countryRegionCodes([str value])
public FieldId countryRegionContextField([FieldId value])
public str dataRelationPath([str value])
public int dataSource([AnyType value]) Gets or sets a data source that will be used by the control or the form.
public boolean defaultButton([boolean value]) Determines whether the button should be the default button on the form.
public str disabledImage([str value]) Gets or sets the disabled image of the button.
public int disabledImageLocation([int value])
public int disabledResource([int value]) Gets or sets the resource ID of the image to use as the disabled button image.
public int displayTarget([int value])
public int dragDrop([int value]) Determines whether to enable or disable drag-and-drop operations for the control.
public boolean enabled([boolean value]) Determines whether to enable or disable the object.
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 boolean forcedToOverflow([boolean value])
public int foregroundColor([int value]) Gets or sets the text color for the control to use.
public int formViewOption([int value])
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 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])
public int id() Retrieves the ID of the control.
public int imageLocation([int value])
public boolean isContainer() Retrieves a value that indicates whether the control is a container control.
public boolean italic([boolean value])
public str keyTip([str value])
public int left(int value, [int mode])
public int leftMode([int value])
public int leftValue([int value])
public str menuItemName([str value])
public MenuItemType menuItemType([MenuItemType value])
public int multiSelect([int value])
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 int needsRecord([int value])
public str normalImage([str value])
public int normalResource([int value])
public int openMode([int value])
public str parameters([str value]) Gets or sets the list of parameters that are passed to objects that are run by the MenuFunction class.
public boolean primary([boolean value])
public boolean saveRecord([boolean value])
public SecurityKeyId securityKey([SecurityKeyId value])
public boolean sendExternalContext([boolean value])
public int shortkey([int value])
public boolean showShortCut([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 style([int value])
public str text([str value])
public int top(int value, [int mode])
public int topMode([int value])
public int topValue([int value])
public int type([int value])
public boolean underline([boolean value]) Sets or returns the underline property for the text in the control.
public int userData([int value])
public int userDataItem([int value])
public int userDataItems([int value])
public boolean value([boolean value])
public int verticalSpacing([int value], [AutoMode mode])
public AutoMode verticalSpacingMode([AutoMode mode])
public int verticalSpacingValue([int value])
public boolean visible([boolean value])
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 registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])

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 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

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 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 autoRefreshData

public boolean autoRefreshData([boolean value])

Parameters

value

Return Value

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 big

public boolean big([boolean value])

Parameters

value

Return Value

Method bold

Gets or sets the weight of font that is 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 buttonDisplay

Gets or sets the appearance of the button control.

public int buttonDisplay([int value])

Parameters

value

Return Value

An integer between zero and five, inclusive.

Remarks

The value of the property defines whether the text, the image, or both should be displayed on the button. This property also controls relative positions of text and image if both are displayed. The integer value that is returned contains the appearance of the button control as follows:

Value. Description.
0 Text only.
1 Image Only.
2 Text and image; the image is displayed below the text.
3 Text and image; the image is displayed above the text.
4 Text and image; the image is displayed to the left of the text.
5 Text and image; the image is displayed to the right of the text.

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 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 MicrosoftWindows.

Value. Description.
177 HEBREW_CHARSET
178 ARABIC_CHARSET

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

Value. Description.
222 THAI_CHARSET

The default character set is set to a value that is based 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 Web site, http://go.microsoft.com/fwlink/?LinkID=85972.

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 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 containerId

Retrieves the ID of the parent container for the control.

public int containerId()

Return Value

The ID of the parent container.

Method copyCallerQuery

public int copyCallerQuery([int value])

Parameters

value

Return Value

Method countryRegionCodes

public str countryRegionCodes([str value])

Parameters

value

Return Value

Method countryRegionContextField

public FieldId countryRegionContextField([FieldId value])

Parameters

value

Return Value

Method dataRelationPath

public str dataRelationPath([str value])

Parameters

value

Return Value

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 defaultButton

Determines whether the button should be the default button on the form.

public boolean defaultButton([boolean value])

Parameters

value

Return Value

true if the button should be the default button; otherwise, false.

Method disabledImage

Gets or sets the disabled image of the button.

public str disabledImage([str value])

Parameters

value

Return Value

The full name of an image file. The system supports all of the GDI-supported image formats.

Remarks

This property has precedence over the disabledResource property . It is used if both of these properties are set.

Method disabledImageLocation

public int disabledImageLocation([int value])

Parameters

value

Return Value

Method disabledResource

Gets or sets the resource ID of the image to use as the disabled button image.

public int disabledResource([int value])

Parameters

value

Return Value

The resource ID of the image to use as the disabled button image. Both icon and bitmap images are supported.

Method displayTarget

public int displayTarget([int value])

Parameters

value

Return Value

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 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 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 forcedToOverflow

public boolean forcedToOverflow([boolean value])

Parameters

value

Return Value

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 formViewOption

public int formViewOption([int value])

Parameters

value

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 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 hierarchyParent

public str hierarchyParent([str value])

Parameters

value

Return Value

Method id

Retrieves the ID of the control.

public int id()

Return Value

The ID of the control.

Method imageLocation

public int imageLocation([int value])

Parameters

value

Return Value

Method isContainer

Retrieves a value that indicates whether the control is a container control.

public boolean isContainer()

Return Value

A Boolean value that indicates whether the control is a container control.

Method italic

public boolean italic([boolean value])

Parameters

value

Return Value

Method keyTip

public str keyTip([str value])

Parameters

value

Return Value

Method left

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

Parameters

value

mode

Return Value

Method leftMode

public int leftMode([int value])

Parameters

value

Return Value

Method leftValue

public int leftValue([int value])

Parameters

value

Return Value

Method menuItemName

public str menuItemName([str value])

Parameters

value

Return Value

Method menuItemType

public MenuItemType menuItemType([MenuItemType value])

Parameters

value

Return Value

Method multiSelect

public int multiSelect([int value])

Parameters

value

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:

  • It must start with a letter.
  • It cannot exceed 250 characters.
  • It can include numbers and underscore (_) characters.
  • It cannot include punctuation or spaces.
  • Tables cannot have the same name as other public objects, such as extended data types, base enumerations, or classes.

Method neededPermission

public int neededPermission([int value])

Parameters

value

Return Value

Method needsRecord

public int needsRecord([int value])

Parameters

value

Return Value

Method normalImage

public str normalImage([str value])

Parameters

value

Return Value

Method normalResource

public int normalResource([int value])

Parameters

value

Return Value

Method openMode

public int openMode([int value])

Parameters

value

Return Value

Method parameters

Gets or sets the list of parameters that are passed to objects that are run by the MenuFunction class.

public str parameters([str value])

Parameters

value

Return Value

The list of parameters that are passed to the object.

Remarks

The parameters string format is Parameter1=Value1, Parameter2=Value2, and so on. Objects ignore passed, unrecognized parameters.

Method primary

public boolean primary([boolean value])

Parameters

value

Return Value

Method saveRecord

public boolean saveRecord([boolean value])

Parameters

value

Return Value

Method securityKey

public SecurityKeyId securityKey([SecurityKeyId value])

Parameters

value

Return Value

Method sendExternalContext

public boolean sendExternalContext([boolean value])

Parameters

value

Return Value

Method shortkey

public int shortkey([int value])

Parameters

value

Return Value

Method showShortCut

public boolean showShortCut([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.

Method style

public int style([int value])

Parameters

value

Return Value

Method text

public str text([str value])

Parameters

value

Return Value

Method top

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

Parameters

value

mode

Return Value

Method topMode

public int topMode([int value])

Parameters

value

Return Value

Method topValue

public int topValue([int value])

Parameters

value

Return Value

Method type

public int type([int value])

Parameters

value

Return Value

Method underline

Sets or returns the underline property for the text in the control.

public boolean underline([boolean value])

Parameters

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

Return Value

true if the text in the control is underlined; otherwise, false.

Method userData

public int userData([int value])

Parameters

value

Return Value

Method userDataItem

public int userDataItem([int value])

Parameters

value

Return Value

Method userDataItems

public int userDataItems([int value])

Parameters

value

Return Value

Method value

public boolean value([boolean value])

Parameters

value

Return Value

Method verticalSpacing

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

Parameters

value

mode

Return Value

Method verticalSpacingMode

public AutoMode verticalSpacingMode([AutoMode mode])

Parameters

mode

Return Value

Method verticalSpacingValue

public int verticalSpacingValue([int value])

Parameters

value

Return Value

Method visible

public boolean visible([boolean value])

Parameters

value

Return Value

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 registerOverrideMethod

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

Parameters

methodToOverride

objectMethodToCall

overrideObject

Class FormBuildGridControl

class FormBuildGridControl extends FormBuildControl

The FormBuildGridControl class lets you create, read, update, and delete X++ code and metadata.

Remarks

Make sure that the user has access to the development security key (SysDevelopment) before this API is called.

Examples

Methods

Method Description
public int activeBackColor([int value])
public int activeForeColor([int 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 int alternateRowShading([int value])
public boolean autoDataGroup([boolean 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 border([int value]) Gets or sets the style of the borderline of the control.
public int bottomMargin([int 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 int containerId() Retrieves the ID of the parent container for the control.
public str countryRegionCodes([str value])
public FieldId countryRegionContextField([FieldId value])
public str dataGroup([str value])
public str dataRelationPath([str value])
public int dataSource([AnyType value]) Gets or sets a data source that is used by the control or the form.
public str defaultAction([str value])
public str defaultActionLabel([str value])
public int displayTarget([int value])
public int dragDrop([int value]) Determines whether to enable or disable drag-and-drop operations for the control.
public boolean enabled([boolean value]) Determines whether to enable or disable the object.
public boolean exportAllowed([boolean value])
public str exportLabel([str value])
public boolean gridLines([boolean value])
public int gridLinesStyle([int value])
public str groupBy([str value])
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 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])
public boolean highlightActive([boolean value])
public int id() Retrieves the ID of the control.
public boolean isContainer() Retrieves a value that indicates whether the control is a container control.
public int left(int value, [int mode])
public int leftMargin([int value])
public int leftMode([int value])
public int leftValue([int value])
public int moreRowsIndicator([int value])
public int moveControl(int controlId, [int insertAfterControlId]) Moves a specified control to the control.
public boolean multiSelect([boolean value])
public str name([str value]) Gets or sets the name that is used in code to identify a form, report, table, query, or other Finance and Operations application object.
public int neededPermission([int value])
public int rightMargin([int value])
public int scrollbars([int value])
public SecurityKeyId securityKey([SecurityKeyId value])
public boolean showColLabels([boolean value])
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 int style([int value])
public int top(int value, [int mode])
public int topMargin([int value])
public int topMode([int value])
public int topValue([int value])
public int type([int value])
public int userData([int value])
public int userDataItem([int value])
public int userDataItems([int value])
public boolean useUserLayout([boolean value])
public int verticalSpacing([int value], [AutoMode mode])
public AutoMode verticalSpacingMode([AutoMode mode])
public int verticalSpacingValue([int value])
public boolean visible([boolean value])
public int visibleCols([int value], [AutoMode mode])
public AutoMode visibleColsMode([AutoMode mode])
public int visibleColsValue([int value])
public int visibleRows([int value], [AutoMode mode])
public AutoMode visibleRowsMode([AutoMode mode])
public int visibleRowsValue([int value])
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 registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])

Method activeBackColor

public int activeBackColor([int value])

Parameters

value

Return Value

Method activeForeColor

public int activeForeColor([int 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 alternateRowShading

public int alternateRowShading([int value])

Parameters

value

Return Value

Method autoDataGroup

public boolean autoDataGroup([boolean 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

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 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 bottomMargin

public int bottomMargin([int 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 MicrosoftWindows 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

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 containerId

Retrieves the ID of the parent container for the control.

public int containerId()

Return Value

The ID of the parent container.

Method countryRegionCodes

public str countryRegionCodes([str value])

Parameters

value

Return Value

Method countryRegionContextField

public FieldId countryRegionContextField([FieldId value])

Parameters

value

Return Value

Method dataGroup

public str dataGroup([str value])

Parameters

value

Return Value

Method dataRelationPath

public str dataRelationPath([str value])

Parameters

value

Return Value

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 identifier of the data source to use.

Method defaultAction

public str defaultAction([str value])

Parameters

value

Return Value

Method defaultActionLabel

public str defaultActionLabel([str value])

Parameters

value

Return Value

Method displayTarget

public int displayTarget([int value])

Parameters

value

Return Value

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 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 exportAllowed

public boolean exportAllowed([boolean value])

Parameters

value

Return Value

Method exportLabel

public str exportLabel([str value])

Parameters

value

Return Value

Method gridLines

public boolean gridLines([boolean value])

Parameters

value

Return Value

Method gridLinesStyle

public int gridLinesStyle([int value])

Parameters

value

Return Value

Method groupBy

public str groupBy([str value])

Parameters

value

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 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

public str hierarchyParent([str value])

Parameters

value

Return Value

Method highlightActive

public boolean highlightActive([boolean value])

Parameters

value

Return Value

Method id

Retrieves the ID of the control.

public int id()

Return Value

The ID of the control.

Method isContainer

Retrieves a value that indicates whether the control is a container control.

public boolean isContainer()

Return Value

A Boolean value that indicates whether the control is a container control.

Method left

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

Parameters

value

mode

Return Value

Method leftMargin

public int leftMargin([int value])

Parameters

value

Return Value

Method leftMode

public int leftMode([int value])

Parameters

value

Return Value

Method leftValue

public int leftValue([int value])

Parameters

value

Return Value

Method moreRowsIndicator

public int moreRowsIndicator([int value])

Parameters

value

Return Value

Method moveControl

Moves a specified control to the control.

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

Parameters

controlId

insertAfterControlId

Return Value

1 if the control was moved successfully; otherwise, 0.

Remarks

In general, if the specified control can be contained in the control and can be moved from the container that it is currently in, this method should succeed. However, in some cases, such as for the reference group control instance, controls cannot be moved.

Method multiSelect

public boolean multiSelect([boolean value])

Parameters

value

Return Value

Method name

Gets or sets the name that is used in code to identify a form, report, table, query, or other 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:

  • It must start with a letter.
  • It cannot exceed 250 characters.
  • It can include numbers and underscore (_) characters.
  • It cannot include punctuation or spaces.
  • Tables cannot have the same name as other public objects, such as extended data types, base enumerations, or classes.

Method neededPermission

public int neededPermission([int value])

Parameters

value

Return Value

Method rightMargin

public int rightMargin([int value])

Parameters

value

Return Value

Method scrollbars

public int scrollbars([int value])

Parameters

value

Return Value

Method securityKey

public SecurityKeyId securityKey([SecurityKeyId value])

Parameters

value

Return Value

Method showColLabels

public boolean showColLabels([boolean value])

Parameters

value

Return Value

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.

Return Value

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

Method style

public int style([int value])

Parameters

value

Return Value

Method top

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

Parameters

value

mode

Return Value

Method topMargin

public int topMargin([int value])

Parameters

value

Return Value

Method topMode

public int topMode([int value])

Parameters

value

Return Value

Method topValue

public int topValue([int value])

Parameters

value

Return Value

Method type

public int type([int value])

Parameters

value

Return Value

Method userData

public int userData([int value])

Parameters

value

Return Value

Method userDataItem

public int userDataItem([int value])

Parameters

value

Return Value

Method userDataItems

public int userDataItems([int value])

Parameters

value

Return Value

Method useUserLayout

public boolean useUserLayout([boolean value])

Parameters

value

Return Value

Method verticalSpacing

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

Parameters

value

mode

Return Value

Method verticalSpacingMode

public AutoMode verticalSpacingMode([AutoMode mode])

Parameters

mode

Return Value

Method verticalSpacingValue

public int verticalSpacingValue([int value])

Parameters

value

Return Value

Method visible

public boolean visible([boolean value])

Parameters

value

Return Value

Method visibleCols

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

Parameters

value

mode

Return Value

Method visibleColsMode

public AutoMode visibleColsMode([AutoMode mode])

Parameters

mode

Return Value

Method visibleColsValue

public int visibleColsValue([int value])

Parameters

value

Return Value

Method visibleRows

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

Parameters

value

mode

Return Value

Method visibleRowsMode

public AutoMode visibleRowsMode([AutoMode mode])

Parameters

mode

Return Value

Method visibleRowsValue

public int visibleRowsValue([int value])

Parameters

value

Return Value

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 registerOverrideMethod

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

Parameters

methodToOverride

objectMethodToCall

overrideObject

Class FormBuildGroupControl

class FormBuildGroupControl extends FormBuildControl

The FormBuildGroupControl class lets you create, read, update, and delete X++ code and metadata.

Remarks

Make sure that the user has access to the development security key (SysDevelopment) before this API is called.

Examples

Methods

Method Description
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 int allowUserSetup([int value])
public int arrangeGuide([int value])
public int arrangeMethod([int value])
public int arrangeWhen([int value])
public boolean autoDataGroup([boolean 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 bold([int value]) Gets or sets the weight of font that is used to output text in the control.
public int bottomMargin([int value], [AutoMode mode])
public AutoMode bottomMarginMode([AutoMode mode])
public int bottomMarginValue([int value])
public boolean breakable([boolean value])
public str caption([str value]) Gets or set the caption of the control.
public int characterSet([int value]) Gets or sets the character set of the font.
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 int containerId() Retrieves the ID of the parent container for the control.
public str countryRegionCodes([str value])
public FieldId countryRegionContextField([FieldId value])
public str dataGroup([str value])
public str dataRelationPath([str value])
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])
public int dragDrop([int value]) Determines whether to enable or disable drag-and-drop operations for the control.
public boolean enabled([boolean value]) Determines whether to enable or disable the object.
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 frameOptionButton([int value])
public int framePosition([int value])
public int frameType([int value])
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 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])
public int id() Retrieves the ID of the control.
public boolean isContainer() Retrieves a value that indicates whether the control is a container control.
public boolean italic([boolean value])
public int labelBold([int value])
public int labelCharacterSet([int value])
public str labelFont([str value])
public int labelFontSize([int value])
public boolean labelItalic([boolean value])
public boolean labelUnderline([boolean value])
public int left(int value, [int mode])
public int leftMargin([int value], [AutoMode mode])
public AutoMode leftMarginMode([AutoMode mode])
public int leftMarginValue([int value])
public int leftMode([int value])
public int leftValue([int value])
public int moveControl(int controlId, [int insertAfterControlId]) Moves a specified control to the control.
public str name([str value]) Gets or sets the name that is used in code to identify a form, report, table, query, or other Finance and Operations application object.
public int neededPermission([int value])
public int optionValue([int value])
public int rightMargin([int value], [AutoMode mode])
public AutoMode rightMarginMode([AutoMode mode])
public int rightMarginValue([int value])
public boolean saveFilter([boolean value])
public SecurityKeyId securityKey([SecurityKeyId 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 style([int value])
public int top(int value, [int mode])
public int topMargin([int value], [AutoMode mode])
public AutoMode topMarginMode([AutoMode mode])
public int topMarginValue([int value])
public int topMode([int value])
public int topValue([int value])
public int type([int value])
public boolean underline([boolean value]) Sets or returns the underline property for the text in the control.
public int userData([int value])
public int userDataItem([int value])
public int userDataItems([int value])
public boolean useUserLayout([boolean value])
public int verticalSpacing([int value], [AutoMode mode])
public AutoMode verticalSpacingMode([AutoMode mode])
public int verticalSpacingValue([int value])
public int viewEditMode([int value])
public boolean visible([boolean value])
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 registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])

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 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 autoDataGroup

public boolean autoDataGroup([boolean 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

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 bold

Gets or sets the weight of font that is 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 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 breakable

public boolean breakable([boolean value])

Parameters

value

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 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 Microsoft Windows.

Value. Description.
130 JOHAB_CHARSET

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

Value. Description.
177 HEBREW_CHARSET
178 ARABIC_CHARSET

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

Value. Description.
222 THAI_CHARSET

The default character set is set to a value based 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 Web site, http://go.microsoft.com/fwlink/?LinkID=85972.

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 Microsoft Windows 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 containerId

Retrieves the ID of the parent container for the control.

public int containerId()

Return Value

The ID of the parent container.

Method countryRegionCodes

public str countryRegionCodes([str value])

Parameters

value

Return Value

Method countryRegionContextField

public FieldId countryRegionContextField([FieldId value])

Parameters

value

Return Value

Method dataGroup

public str dataGroup([str value])

Parameters

value

Return Value

Method dataRelationPath

public str dataRelationPath([str value])

Parameters

value

Return Value

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

public int displayTarget([int value])

Parameters

value

Return Value

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 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 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 frameOptionButton

public int frameOptionButton([int value])

Parameters

value

Return Value

Method framePosition

public int framePosition([int value])

Parameters

value

Return Value

Method frameType

public int frameType([int value])

Parameters

value

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 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 hideIfEmpty

public boolean hideIfEmpty([boolean value])

Parameters

value

Return Value

Method hierarchyParent

public str hierarchyParent([str value])

Parameters

value

Return Value

Method id

Retrieves the ID of the control.

public int id()

Return Value

The ID of the control.

Method isContainer

Retrieves a value that indicates whether the control is a container control.

public boolean isContainer()

Return Value

A Boolean value that indicates whether the control is a container control.

Method italic

public boolean italic([boolean 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 labelItalic

public boolean labelItalic([boolean value])

Parameters

value

Return Value

Method labelUnderline

public boolean labelUnderline([boolean value])

Parameters

value

Return Value

Method left

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

Parameters

value

mode

Return Value

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

public int leftMode([int value])

Parameters

value

Return Value

Method leftValue

public int leftValue([int value])

Parameters

value

Return Value

Method moveControl

Moves a specified control to the control.

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

Parameters

controlId

insertAfterControlId

Return Value

1 if the control was moved successfully; otherwise, 0.

Remarks

In general, if the specified control can be contained in the control and can be moved from the container that it is currently in, this method should succeed. However, in some cases, such as for the reference group control instance, controls cannot be moved.

Method name

Gets or sets the name that is used in code to identify a form, report, table, query, or other 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:

  • It must start with a letter.
  • It cannot exceed 250 characters.
  • It can include numbers and underscore (_) characters.
  • It cannot include punctuation or spaces.
  • Tables cannot have the same name as other public objects, such as extended data types, base enumerations, or classes.

Method neededPermission

public int neededPermission([int value])

Parameters

value

Return Value

Method optionValue

public int optionValue([int 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 saveFilter

public boolean saveFilter([boolean value])

Parameters

value

Return Value

Method securityKey

public SecurityKeyId securityKey([SecurityKeyId 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.

Method style

public int style([int value])

Parameters

value

Return Value

Method top

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

Parameters

value

mode

Return Value

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

public int topMode([int value])

Parameters

value

Return Value

Method topValue

public int topValue([int value])

Parameters

value

Return Value

Method type

public int type([int value])

Parameters

value

Return Value

Method underline

Sets or returns the underline property for the text in the control.

public boolean underline([boolean value])

Parameters

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

Return Value

true if the text in the control is underlined; otherwise, false.

Method userData

public int userData([int value])

Parameters

value

Return Value

Method userDataItem

public int userDataItem([int value])

Parameters

value

Return Value

Method userDataItems

public int userDataItems([int value])

Parameters

value

Return Value

Method useUserLayout

public boolean useUserLayout([boolean value])

Parameters

value

Return Value

Method verticalSpacing

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

Parameters

value

mode

Return Value

Method verticalSpacingMode

public AutoMode verticalSpacingMode([AutoMode mode])

Parameters

mode

Return Value

Method verticalSpacingValue

public int verticalSpacingValue([int value])

Parameters

value

Return Value

Method viewEditMode

public int viewEditMode([int value])

Parameters

value

Return Value

Method visible

public boolean visible([boolean value])

Parameters

value

Return Value

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 registerOverrideMethod

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

Parameters

methodToOverride

objectMethodToCall

overrideObject

Class FormBuildGuidControl

class FormBuildGuidControl extends FormBuildControl

The FormBuildGuidControl class lets you create, read, update, and delete X++ code and metadata.

Remarks

Make sure that the user has access to the development security key (SysDevelopment) before this API is called.

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 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 bold([int value]) Gets or sets the weight of font that is 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 int characterSet([int value]) Gets or sets the character set of the font.
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 int containerId() Retrieves the ID of the parent container for the control.
public str countryRegionCodes([str value])
public FieldId countryRegionContextField([FieldId value])
public FieldId dataField([FieldId value])
public str dataMethod([str value])
public str dataRelationPath([str value])
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])
public int dragDrop([int value]) Determines whether to enable or disable drag-and-drop operations for the control.
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 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 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])
public int id() Retrieves the ID of the control.
public int iMEMode([int value])
public boolean isContainer() Retrieves a value that indicates whether the control is a container control.
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 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 int left(int value, [int mode])
public int leftMode([int value])
public int leftValue([int value])
public int limitText([int value], [AutoMode mode])
public AutoMode limitTextMode([AutoMode mode])
public int limitTextValue([int value])
public int lookupButton([int value])
public boolean mandatory([boolean value])
public str name([str value]) Gets or sets the name that is used in code to identify a form, report, table, query, or other Finance and Operations application object.
public int neededPermission([int 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])
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 style([int value])
public int top(int value, [int mode])
public int topMode([int value])
public int topValue([int value])
public int type([int value])
public boolean underline([boolean value]) Sets or returns the underline property for the text in the control.
public int userData([int value])
public int userDataItem([int value])
public int userDataItems([int value])
public Guid value([Guid value])
public int verticalSpacing([int value], [AutoMode mode])
public AutoMode verticalSpacingMode([AutoMode mode])
public int verticalSpacingValue([int value])
public int viewEditMode([int value])
public boolean visible([boolean value])
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 registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])

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 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

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 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

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 bold

Gets or sets the weight of font that is 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 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 Microsoft Windows.

Value. Description.
130 JOHAB_CHARSET

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

Value. Description.
177 HEBREW_CHARSET
178 ARABIC_CHARSET

The value in the following table is for the Thai language edition of Microsoft 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 Web site, http://go.microsoft.com/fwlink/?LinkID=85972.

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 Microsoft 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

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 containerId

Retrieves the ID of the parent container for the control.

public int containerId()

Return Value

The ID of the parent container.

Method countryRegionCodes

public str countryRegionCodes([str value])

Parameters

value

Return Value

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

public str dataRelationPath([str value])

Parameters

value

Return Value

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

public int displayTarget([int value])

Parameters

value

Return Value

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 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 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 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 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

public str hierarchyParent([str value])

Parameters

value

Return Value

Method id

Retrieves the ID of the control.

public int id()

Return Value

The ID of the control.

Method iMEMode

public int iMEMode([int value])

Parameters

value

Return Value

Method isContainer

Retrieves a value that indicates whether the control is a container control.

public boolean isContainer()

Return Value

A Boolean value that indicates whether the control is a container control.

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 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 left

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

Parameters

value

mode

Return Value

Method leftMode

public int leftMode([int value])

Parameters

value

Return Value

Method leftValue

public int leftValue([int value])

Parameters

value

Return Value

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 lookupButton

public int lookupButton([int value])

Parameters

value

Return Value

Method mandatory

public boolean mandatory([boolean value])

Parameters

value

Return Value

Method name

Gets or sets the name that is used in code to identify a form, report, table, query, or other 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:

  • It must start with a letter.
  • It cannot exceed 250 characters.
  • It can include numbers and underscore (_) characters.
  • It cannot include punctuation or spaces.
  • Tables cannot have the same name as other public objects, such as extended data types, base enums, or classes.

Method neededPermission

public int neededPermission([int 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

public SecurityKeyId securityKey([SecurityKeyId value])

Parameters

value

Return Value

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.

Return Value

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

Method style

public int style([int value])

Parameters

value

Return Value

Method top

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

Parameters

value

mode

Return Value

Method topMode

public int topMode([int value])

Parameters

value

Return Value

Method topValue

public int topValue([int value])

Parameters

value

Return Value

Method type

public int type([int value])

Parameters

value

Return Value

Method underline

Sets or returns the underline property for the text in the control.

public boolean underline([boolean value])

Parameters

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

Return Value

true if the text in the control is underlined; otherwise, false.

Method userData

public int userData([int value])

Parameters

value

Return Value

Method userDataItem

public int userDataItem([int value])

Parameters

value

Return Value

Method userDataItems

public int userDataItems([int value])

Parameters

value

Return Value

Method value

public Guid value([Guid value])

Parameters

value

Return Value

Method verticalSpacing

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

Parameters

value

mode

Return Value

Method verticalSpacingMode

public AutoMode verticalSpacingMode([AutoMode mode])

Parameters

mode

Return Value

Method verticalSpacingValue

public int verticalSpacingValue([int value])

Parameters

value

Return Value

Method viewEditMode

public int viewEditMode([int value])

Parameters

value

Return Value

Method visible

public boolean visible([boolean value])

Parameters

value

Return Value

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 registerOverrideMethod

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

Parameters

methodToOverride

objectMethodToCall

overrideObject

Class FormBuildHTMLControl

class FormBuildHTMLControl extends FormBuildControl

The FormBuildHTMLControl class lets you create, read, update, and delete X++ code and metadata.

Remarks

Make sure that the user has access to the development security key (SysDevelopment) before this API is called.

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 autoDeclaration([boolean value]) Determines whether the system can declare a member variable that has the same name as the control.
public str caption([str value]) Gets or set the caption of the control.
public str className([str value])
public ConfigurationKeyId configurationKey([ConfigurationKeyId value]) Gets or sets the configuration key that is assigned to the control.
public int containerId() Retrieves the ID of the parent container for the control.
public str countryRegionCodes([str value])
public str custom([str value])
public str dataRelationPath([str value])
public int displayTarget([int value])
public int dragDrop([int value]) Determines whether to enable or disable drag-and-drop operations for the control.
public boolean enabled([boolean value]) Determines whether to enable or disable the object.
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 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])
public int id() Retrieves the ID of the control.
public boolean isContainer() Retrieves a value that indicates whether the control is a container control.
public int left(int value, [int mode])
public int leftMode([int value])
public int leftValue([int value])
public str name([str value]) Gets or sets the name that is used in code to identify a form, report, table, query, or other Finance and Operations application object.
public int neededPermission([int value])
public boolean rTLCapable([boolean value])
public SecurityKeyId securityKey([SecurityKeyId 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 top(int value, [int mode])
public int topMode([int value])
public int topValue([int value])
public int type([int value])
public int userData([int value])
public int userDataItem([int value])
public int userDataItems([int value])
public int verticalSpacing([int value], [AutoMode mode])
public AutoMode verticalSpacingMode([AutoMode mode])
public int verticalSpacingValue([int value])
public boolean visible([boolean value])
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 registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])

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 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 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 className

public str className([str 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 containerId

Retrieves the ID of the parent container for the control.

public int containerId()

Return Value

The ID of the parent container.

Method countryRegionCodes

public str countryRegionCodes([str value])

Parameters

value

Return Value

Method custom

public str custom([str value])

Parameters

value

Return Value

Method dataRelationPath

public str dataRelationPath([str value])

Parameters

value

Return Value

Method displayTarget

public int displayTarget([int value])

Parameters

value

Return Value

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 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 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 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 HelpTextproperty for an object by using the property dialog box.The help text must not exceed 250 characters.

Method hierarchyParent

public str hierarchyParent([str value])

Parameters

value

Return Value

Method id

Retrieves the ID of the control.

public int id()

Return Value

The ID of the control.

Method isContainer

Retrieves a value that indicates whether the control is a container control.

public boolean isContainer()

Return Value

A Boolean value that indicates whether the control is a container control.

Method left

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

Parameters

value

mode

Return Value

Method leftMode

public int leftMode([int value])

Parameters

value

Return Value

Method leftValue

public int leftValue([int value])

Parameters

value

Return Value

Method name

Gets or sets the name that is used in code to identify a form, report, table, query, or other 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:

  • It must start with a letter.
  • It cannot exceed 250 characters.
  • It can include numbers and underscore (_) characters.
  • It cannot include punctuation or spaces.
  • Tables cannot have the same name as other public objects, such as extended data types, base enums, or classes.

Method neededPermission

public int neededPermission([int value])

Parameters

value

Return Value

Method rTLCapable

public boolean rTLCapable([boolean value])

Parameters

value

Return Value

Method securityKey

public SecurityKeyId securityKey([SecurityKeyId 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.

Method top

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

Parameters

value

mode

Return Value

Method topMode

public int topMode([int value])

Parameters

value

Return Value

Method topValue

public int topValue([int value])

Parameters

value

Return Value

Method type

public int type([int value])

Parameters

value

Return Value

Method userData

public int userData([int value])

Parameters

value

Return Value

Method userDataItem

public int userDataItem([int value])

Parameters

value

Return Value

Method userDataItems

public int userDataItems([int value])

Parameters

value

Return Value

Method verticalSpacing

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

Parameters

value

mode

Return Value

Method verticalSpacingMode

public AutoMode verticalSpacingMode([AutoMode mode])

Parameters

mode

Return Value

Method verticalSpacingValue

public int verticalSpacingValue([int value])

Parameters

value

Return Value

Method visible

public boolean visible([boolean value])

Parameters

value

Return Value

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 registerOverrideMethod

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

Parameters

methodToOverride

objectMethodToCall

overrideObject

Class FormBuildIntControl

class FormBuildIntControl extends FormBuildControl

The FormBuildIntControl class lets you create, read, update, and delete X++ code and metadata.

Remarks

Make sure that the user has access to the development security key (SysDevelopment) before this API is called.

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 int allowNegative([int value])
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 bold([int value]) Gets or sets the weight of font that is 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 int characterSet([int value]) Gets or sets the character set of the font.
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 int containerId() Retrieves the ID of the parent container for the control.
public str countryRegionCodes([str value])
public FieldId countryRegionContextField([FieldId value])
public FieldId dataField([FieldId value])
public str dataMethod([str value])
public str dataRelationPath([str value])
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 displaceNegative([int value], [AutoMode mode])
public AutoMode displaceNegativeMode([AutoMode mode])
public int displaceNegativeValue([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])
public int dragDrop([int value]) Determines whether to enable or disable drag-and-drop operations for the control.
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 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 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])
public int id() Retrieves the ID of the control.
public int iMEMode([int value])
public boolean isContainer() Retrieves a value that indicates whether the control is a container control.
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 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 int left(int value, [int mode])
public int leftMode([int value])
public int leftValue([int value])
public int limitText([int value], [AutoMode mode])
public AutoMode limitTextMode([AutoMode mode])
public int limitTextValue([int value])
public int lookupButton([int value])
public boolean mandatory([boolean value])
public str name([str value]) Gets or sets the name that is used in code to identify a form, report, table, query, or other Finance and Operations application object.
public int neededPermission([int value])
public int promptrect([int value])
public boolean replaceOnLookup([boolean value])
public int rotateSign([int value])
public int searchAfterInput([int value])
public int searchMode([int value])
public SecurityKeyId securityKey([SecurityKeyId value])
public boolean showLabel([boolean value])
public int showZero([int value])
public int signDisplay([int 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 style([int value])
public int top(int value, [int mode])
public int topMode([int value])
public int topValue([int value])
public int type([int value])
public boolean underline([boolean value]) Sets or returns the underline property for the text in the control.
public int userData([int value])
public int userDataItem([int value])
public int userDataItems([int value])
public int value([int value])
public int verticalSpacing([int value], [AutoMode mode])
public AutoMode verticalSpacingMode([AutoMode mode])
public int verticalSpacingValue([int value])
public int viewEditMode([int value])
public boolean visible([boolean value])
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 registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])

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 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

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 allowNegative

public int allowNegative([int value])

Parameters

value

Return Value

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

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 bold

Gets or sets the weight of font that is 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 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 Microsoft Windows.

Value. Description.
130 JOHAB_CHARSET

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

Value. Description.
177 HEBREW_CHARSET
178 ARABIC_CHARSET

The value in the following table is for the Thai language edition of Microsoft 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 Web site, http://go.microsoft.com/fwlink/?LinkID=85972.

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 Microsoft 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

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 containerId

Retrieves the ID of the parent container for the control.

public int containerId()

Return Value

The ID of the parent container.

Method countryRegionCodes

public str countryRegionCodes([str value])

Parameters

value

Return Value

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

public str dataRelationPath([str value])

Parameters

value

Return Value

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 displaceNegative

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

Parameters

value

mode

Return Value

Method displaceNegativeMode

public AutoMode displaceNegativeMode([AutoMode mode])

Parameters

mode

Return Value

Method displaceNegativeValue

public int displaceNegativeValue([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

public int displayTarget([int value])

Parameters

value

Return Value

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 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 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 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 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

public str hierarchyParent([str value])

Parameters

value

Return Value

Method id

Retrieves the ID of the control.

public int id()

Return Value

The ID of the control.

Method iMEMode

public int iMEMode([int value])

Parameters

value

Return Value

Method isContainer

Retrieves a value that indicates whether the control is a container control.

public boolean isContainer()

Return Value

A Boolean value that indicates whether the control is a container control.

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 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 left

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

Parameters

value

mode

Return Value

Method leftMode

public int leftMode([int value])

Parameters

value

Return Value

Method leftValue

public int leftValue([int value])

Parameters

value

Return Value

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 lookupButton

public int lookupButton([int value])

Parameters

value

Return Value

Method mandatory

public boolean mandatory([boolean value])

Parameters

value

Return Value

Method name

Gets or sets the name that is used in code to identify a form, report, table, query, or other 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:

  • It must start with a letter.
  • It cannot exceed 250 characters.
  • It can include numbers and underscore (_) characters.
  • It cannot include punctuation or spaces.
  • Tables cannot have the same name as other public objects, such as extended data types, base enums, or classes.

Method neededPermission

public int neededPermission([int 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 rotateSign

public int rotateSign([int 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

public SecurityKeyId securityKey([SecurityKeyId value])

Parameters

value

Return Value

Method showLabel

public boolean showLabel([boolean value])

Parameters

value

Return Value

Method showZero

public int showZero([int value])

Parameters

value

Return Value

Method signDisplay

public int signDisplay([int 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.

Method style

public int style([int value])

Parameters

value

Return Value

Method top

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

Parameters

value

mode

Return Value

Method topMode

public int topMode([int value])

Parameters

value

Return Value

Method topValue

public int topValue([int value])

Parameters

value

Return Value

Method type

public int type([int value])

Parameters

value

Return Value

Method underline

Sets or returns the underline property for the text in the control.

public boolean underline([boolean value])

Parameters

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

Return Value

true if the text in the control is underlined; otherwise, false.

Method userData

public int userData([int value])

Parameters

value

Return Value

Method userDataItem

public int userDataItem([int value])

Parameters

value

Return Value

Method userDataItems

public int userDataItems([int value])

Parameters

value

Return Value

Method value

public int value([int value])

Parameters

value

Return Value

Method verticalSpacing

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

Parameters

value

mode

Return Value

Method verticalSpacingMode

public AutoMode verticalSpacingMode([AutoMode mode])

Parameters

mode

Return Value

Method verticalSpacingValue

public int verticalSpacingValue([int value])

Parameters

value

Return Value

Method viewEditMode

public int viewEditMode([int value])

Parameters

value

Return Value

Method visible

public boolean visible([boolean value])

Parameters

value

Return Value

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 registerOverrideMethod

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

Parameters

methodToOverride

objectMethodToCall

overrideObject

Class FormBuildListBoxControl

class FormBuildListBoxControl extends FormBuildControl

The FormBuildListBoxControl class lets you create, read, update, and delete X++ code and metadata.

Remarks

Make sure that the user has access to the development security key (SysDevelopment) before this API is called.

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 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 bold([int value]) Gets or sets the weight of font that is 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 int characterSet([int value]) Gets or sets the character set of the font.
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 int containerId() Retrieves the ID of the parent container for the control.
public str countryRegionCodes([str value])
public FieldId countryRegionContextField([FieldId value])
public FieldId dataField([FieldId value])
public str dataMethod([str value])
public str dataRelationPath([str value])
public int dataSource([AnyType value]) Gets or sets a data source that will be used by the control or the form.
public int displayLength([int value], [AutoMode mode])
public AutoMode displayLengthMode([AutoMode mode])
public int displayLengthValue([int value])
public int displayTarget([int value])
public int dragDrop([int value]) Determines whether to enable or disable drag-and-drop operations for the control.
public boolean enabled([boolean value]) Determines whether to enable or disable the object.
public EnumId enumType([EnumId value])
public ExtendedTypeId extendedDataType([ExtendedTypeId 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 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 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 hideFirstEntry([boolean value])
public str hierarchyParent([str value])
public int id() Retrieves the ID of the control.
public boolean isContainer() Retrieves a value that indicates whether the control is a container control.
public boolean italic([boolean value])
public int item([int value])
public int items([int 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 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 int left(int value, [int mode])
public int leftMode([int value])
public int leftValue([int value])
public str name([str value]) Gets or sets the name that is used in code to identify a form, report, table, query, or other Finance and Operations application object.
public int neededPermission([int value])
public int promptrect([int value])
public SecurityKeyId securityKey([SecurityKeyId value])
public int selection([int value])
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 str text([str value])
public int top(int value, [int mode])
public int topMode([int value])
public int topValue([int value])
public int type([int value])
public boolean underline([boolean value]) Sets or returns the underline property for the text in the control.
public int userData([int value])
public int userDataItem([int value])
public int userDataItems([int value])
public int verticalSpacing([int value], [AutoMode mode])
public AutoMode verticalSpacingMode([AutoMode mode])
public int verticalSpacingValue([int value])
public int viewEditMode([int value])
public boolean visible([boolean value])
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 registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])

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 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

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 bold

Gets or sets the weight of font that is 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 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 MicrosoftWindows.

Value. Description.
177 HEBREW_CHARSET
178 ARABIC_CHARSET

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

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 Web site, http://go.microsoft.com/fwlink/?LinkID=85972.

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 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 containerId

Retrieves the ID of the parent container for the control.

public int containerId()

Return Value

The ID of the parent container.

Method countryRegionCodes

public str countryRegionCodes([str value])

Parameters

value

Return Value

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

public str dataRelationPath([str value])

Parameters

value

Return Value

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 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

public int displayTarget([int value])

Parameters

value

Return Value

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 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 enumType

public EnumId enumType([EnumId value])

Parameters

value

Return Value

Method extendedDataType

public ExtendedTypeId extendedDataType([ExtendedTypeId 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 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 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 hideFirstEntry

public boolean hideFirstEntry([boolean value])

Parameters

value

Return Value

Method hierarchyParent

public str hierarchyParent([str value])

Parameters

value

Return Value

Method id

Retrieves the ID of the control.

public int id()

Return Value

The ID of the control.

Method isContainer

Retrieves a value that indicates whether the control is a container control.

public boolean isContainer()

Return Value

A Boolean value that indicates whether the control is a container control.

Method italic

public boolean italic([boolean value])

Parameters

value

Return Value

Method item

public int item([int value])

Parameters

value

Return Value

Method items

public int items([int 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 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 left

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

Parameters

value

mode

Return Value

Method leftMode

public int leftMode([int value])

Parameters

value

Return Value

Method leftValue

public int leftValue([int value])

Parameters

value

Return Value

Method name

Gets or sets the name that is used in code to identify a form, report, table, query, or other 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:

  • It must start with a letter.
  • It cannot exceed 250 characters.
  • It can include numbers and underscore (_) characters.
  • It cannot include punctuation or spaces.
  • Tables cannot have the same name as other public objects, such as extended data types, base enums, or classes.

Method neededPermission

public int neededPermission([int value])

Parameters

value

Return Value

Method promptrect

public int promptrect([int value])

Parameters

value

Return Value

Method securityKey

public SecurityKeyId securityKey([SecurityKeyId value])

Parameters

value

Return Value

Method selection

public int selection([int value])

Parameters

value

Return Value

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.

Method text

public str text([str value])

Parameters

value

Return Value

Method top

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

Parameters

value

mode

Return Value

Method topMode

public int topMode([int value])

Parameters

value

Return Value

Method topValue

public int topValue([int value])

Parameters

value

Return Value

Method type

public int type([int value])

Parameters

value

Return Value

Method underline

Sets or returns the underline property for the text in the control.

public boolean underline([boolean value])

Parameters

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

Return Value

true if the text in the control is underlined; otherwise, false.

Method userData

public int userData([int value])

Parameters

value

Return Value

Method userDataItem

public int userDataItem([int value])

Parameters

value

Return Value

Method userDataItems

public int userDataItems([int value])

Parameters

value

Return Value

Method verticalSpacing

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

Parameters

value

mode

Return Value

Method verticalSpacingMode

public AutoMode verticalSpacingMode([AutoMode mode])

Parameters

mode

Return Value

Method verticalSpacingValue

public int verticalSpacingValue([int value])

Parameters

value

Return Value

Method viewEditMode

public int viewEditMode([int value])

Parameters

value

Return Value

Method visible

public boolean visible([boolean value])

Parameters

value

Return Value

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 registerOverrideMethod

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

Parameters

methodToOverride

objectMethodToCall

overrideObject

Class FormBuildListControl

class FormBuildListControl extends FormBuildControl

The FormBuildListControl class lets you create, read, update, and delete X++ code and metadata.

Remarks

Make sure that the user has access to the development security key (SysDevelopment) before this API is called.

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 autoArrange([boolean 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 bold([int value]) Gets or sets the weight of font that is used to output text in the control.
public int border([int value]) Gets or sets the style of the borderline of the control.
public boolean canScroll([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 boolean columnHeader([boolean value])
public boolean columnHeaderButton([boolean value])
public boolean columnImages([boolean value])
public ConfigurationKeyId configurationKey([ConfigurationKeyId value]) Gets or sets the configuration key that is assigned to the control.
public int containerId() Retrieves the ID of the parent container for the control.
public str countryRegionCodes([str value])
public str dataRelationPath([str value])
public int displayTarget([int value])
public int dragDrop([int value]) Determines whether to enable or disable drag-and-drop operations for the control.
public boolean editLabels([boolean value])
public boolean enabled([boolean value]) Determines whether to enable or disable the object.
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 boolean gridLines([boolean value])
public boolean headerdragdrop([boolean value])
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 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])
public int id() Retrieves the ID of the control.
public boolean isContainer() Retrieves a value that indicates whether the control is a container control.
public boolean italic([boolean value])
public int itemAlign([int value])
public int left(int value, [int mode])
public int leftMode([int value])
public int leftValue([int value])
public str name([str value]) Gets or sets the name that is used in code to identify a form, report, table, query, or other Finance and Operations application object.
public int neededPermission([int value])
public boolean oneClickActivate([boolean value])
public boolean rowSelect([boolean value])
public SecurityKeyId securityKey([SecurityKeyId value])
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 int sort([int value])
public int top(int value, [int mode])
public int topMode([int value])
public int topValue([int value])
public boolean trackSelect([boolean value])
public boolean twoClickActivate([boolean value])
public int type([int value])
public boolean underline([boolean value]) Sets or returns the underline property for the text in the control.
public int userData([int value])
public int userDataItem([int value])
public int userDataItems([int value])
public int verticalSpacing([int value], [AutoMode mode])
public AutoMode verticalSpacingMode([AutoMode mode])
public int verticalSpacingValue([int value])
public int viewType([int value])
public boolean visible([boolean value])
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 registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])

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 autoArrange

public boolean autoArrange([boolean 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 bold

Gets or sets the weight of font that is 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 canScroll

public boolean canScroll([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 Microsoft Windows.

Value. Description.
130 JOHAB_CHARSET

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

Value. Description.
177 HEBREW_CHARSET
178 ARABIC_CHARSET

The value in the following table is for the Thai language edition of Microsoft 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 Web site, 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 Microsoft Windows palette.
2 The true-color scheme.

Method columnHeader

public boolean columnHeader([boolean value])

Parameters

value

Return Value

Method columnHeaderButton

public boolean columnHeaderButton([boolean value])

Parameters

value

Return Value

Method columnImages

public boolean columnImages([boolean 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 containerId

Retrieves the ID of the parent container for the control.

public int containerId()

Return Value

The ID of the parent container.

Method countryRegionCodes

public str countryRegionCodes([str value])

Parameters

value

Return Value

Method dataRelationPath

public str dataRelationPath([str value])

Parameters

value

Return Value

Method displayTarget

public int displayTarget([int value])

Parameters

value

Return Value

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 editLabels

public boolean editLabels([boolean value])

Parameters

value

Return Value

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 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 gridLines

public boolean gridLines([boolean value])

Parameters

value

Return Value

Method headerdragdrop

public boolean headerdragdrop([boolean value])

Parameters

value

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 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

public str hierarchyParent([str value])

Parameters

value

Return Value

Method id

Retrieves the ID of the control.

public int id()

Return Value

The ID of the control.

Method isContainer

Retrieves a value that indicates whether the control is a container control.

public boolean isContainer()

Return Value

A Boolean value that indicates whether the control is a container control.

Method italic

public boolean italic([boolean value])

Parameters

value

Return Value

Method itemAlign

public int itemAlign([int value])

Parameters

value

Return Value

Method left

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

Parameters

value

mode

Return Value

Method leftMode

public int leftMode([int value])

Parameters

value

Return Value

Method leftValue

public int leftValue([int value])

Parameters

value

Return Value

Method name

Gets or sets the name that is used in code to identify a form, report, table, query, or other 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:

  • It must start with a letter.
  • It cannot exceed 250 characters.
  • It can include numbers and underscore (_) characters.
  • It cannot include punctuation or spaces.
  • Tables cannot have the same name as other public objects, such as extended data types, base enums, or classes.

Method neededPermission

public int neededPermission([int value])

Parameters

value

Return Value

Method oneClickActivate

public boolean oneClickActivate([boolean value])

Parameters

value

Return Value

Method rowSelect

public boolean rowSelect([boolean value])

Parameters

value

Return Value

Method securityKey

public SecurityKeyId securityKey([SecurityKeyId value])

Parameters

value

Return Value

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; optional.

Return Value

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

Method sort

public int sort([int value])

Parameters

value

Return Value

Method top

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

Parameters

value

mode

Return Value

Method topMode

public int topMode([int value])

Parameters

value

Return Value

Method topValue

public int topValue([int value])

Parameters

value

Return Value

Method trackSelect

public boolean trackSelect([boolean value])

Parameters

value

Return Value

Method twoClickActivate

public boolean twoClickActivate([boolean value])

Parameters

value

Return Value

Method type

public int type([int value])

Parameters

value

Return Value

Method underline

Sets or returns the underline property for the text in the control.

public boolean underline([boolean value])

Parameters

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

Return Value

true if the text in the control is underlined; otherwise, false.

Method userData

public int userData([int value])

Parameters

value

Return Value

Method userDataItem

public int userDataItem([int value])

Parameters

value

Return Value

Method userDataItems

public int userDataItems([int value])

Parameters

value

Return Value

Method verticalSpacing

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

Parameters

value

mode

Return Value

Method verticalSpacingMode

public AutoMode verticalSpacingMode([AutoMode mode])

Parameters

mode

Return Value

Method verticalSpacingValue

public int verticalSpacingValue([int value])

Parameters

value

Return Value

Method viewType

public int viewType([int value])

Parameters

value

Return Value

Method visible

public boolean visible([boolean value])

Parameters

value

Return Value

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 registerOverrideMethod

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

Parameters

methodToOverride

objectMethodToCall

overrideObject

Class FormBuildManagedHostControl

class FormBuildManagedHostControl extends FormBuildControl

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 str assemblyName([str value])
public boolean autoDeclaration([boolean value]) Determines whether the system can declare a member variable that has the same name as the control.
public ConfigurationKeyId configurationKey([ConfigurationKeyId value]) Gets or sets the configuration key that is assigned to the control.
public int containerId() Retrieves the ID of the parent container for the control.
public str countryRegionCodes([str value])
public str dataRelationPath([str value])
public int displayTarget([int value])
public int dragDrop([int value]) Determines whether to enable or disable drag-and-drop operations for the control.
public boolean enabled([boolean value]) Determines whether to enable or disable the object.
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 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])
public int id() Retrieves the ID of the control.
public boolean isContainer() Retrieves a value that indicates whether the control is a container control.
public int left(int value, [int mode])
public int leftMode([int value])
public int leftValue([int value])
public str name([str value]) Gets or sets the name that is used in the code to identify a form, report, table, query, or another Finance and Operations application object.
public int neededPermission([int value])
public boolean rTLCapable([boolean value])
public SecurityKeyId securityKey([SecurityKeyId value])
public int sizing([int value])
public boolean skip([boolean value])
public int top(int value, [int mode])
public int topMode([int value])
public int topValue([int value])
public int type([int value])
public str typeName([str value])
public int userData([int value])
public int userDataItem([int value])
public int userDataItems([int value])
public int verticalSpacing([int value], [AutoMode mode])
public AutoMode verticalSpacingMode([AutoMode mode])
public int verticalSpacingValue([int value])
public boolean visible([boolean value])
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 registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])

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 assemblyName

public str assemblyName([str 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 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 containerId

Retrieves the ID of the parent container for the control.

public int containerId()

Return Value

The ID of the parent container.

Method countryRegionCodes

public str countryRegionCodes([str value])

Parameters

value

Return Value

Method dataRelationPath

public str dataRelationPath([str value])

Parameters

value

Return Value

Method displayTarget

public int displayTarget([int value])

Parameters

value

Return Value

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 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 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 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

public str hierarchyParent([str value])

Parameters

value

Return Value

Method id

Retrieves the ID of the control.

public int id()

Return Value

The ID of the control.

Method isContainer

Retrieves a value that indicates whether the control is a container control.

public boolean isContainer()

Return Value

A Boolean value that indicates whether the control is a container control.

Method left

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

Parameters

value

mode

Return Value

Method leftMode

public int leftMode([int value])

Parameters

value

Return Value

Method leftValue

public int leftValue([int value])

Parameters

value

Return Value

Method name

Gets or sets the name that is used in the 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 the 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 enums, classes, and so on.

Method neededPermission

public int neededPermission([int value])

Parameters

value

Return Value

Method rTLCapable

public boolean rTLCapable([boolean value])

Parameters

value

Return Value

Method securityKey

public SecurityKeyId securityKey([SecurityKeyId value])

Parameters

value

Return Value

Method sizing

public int sizing([int value])

Parameters

value

Return Value

Method skip

public boolean skip([boolean value])

Parameters

value

Return Value

Method top

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

Parameters

value

mode

Return Value

Method topMode

public int topMode([int value])

Parameters

value

Return Value

Method topValue

public int topValue([int value])

Parameters

value

Return Value

Method type

public int type([int value])

Parameters

value

Return Value

Method typeName

public str typeName([str value])

Parameters

value

Return Value

Method userData

public int userData([int value])

Parameters

value

Return Value

Method userDataItem

public int userDataItem([int value])

Parameters

value

Return Value

Method userDataItems

public int userDataItems([int value])

Parameters

value

Return Value

Method verticalSpacing

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

Parameters

value

mode

Return Value

Method verticalSpacingMode

public AutoMode verticalSpacingMode([AutoMode mode])

Parameters

mode

Return Value

Method verticalSpacingValue

public int verticalSpacingValue([int value])

Parameters

value

Return Value

Method visible

public boolean visible([boolean value])

Parameters

value

Return Value

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 registerOverrideMethod

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

Parameters

methodToOverride

objectMethodToCall

overrideObject

Class FormBuildMenuButtonControl

class FormBuildMenuButtonControl extends FormBuildControl

The FormBuildMenuButtonControl class lets you create, read, update, and delete X++ code and metadata.

Remarks

Make sure that the user has access to the development security key (SysDevelopment) before this API is called.

Examples

Methods

Method Description
public int acquireFocus([int value])
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 autoDeclaration([boolean value]) Determines whether the system can declare a member variable that has the same name as the control.
public boolean autoRefreshData([boolean value])
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 boolean big([boolean value])
public int bold([int value]) Gets or sets the weight of font that is 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 bottomMargin([int value])
public int buttonDisplay([int value]) Gets or sets the appearance of the button control.
public int characterSet([int value]) Gets or sets the character set of the font.
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 int containerId() Retrieves the ID of the parent container for the control.
public str countryRegionCodes([str value])
public str dataRelationPath([str value])
public boolean defaultButton([boolean value]) Determines whether the button should be the default button on the form.
public str disabledImage([str value]) Gets or sets the disabled image of the button.
public int disabledImageLocation([int value])
public int disabledResource([int value]) Gets or sets the resource ID of the image to use as the disabled button image.
public int displayTarget([int value])
public int dragDrop([int value]) Determines whether to enable or disable drag-and-drop operations for the control.
public boolean enabled([boolean value]) Determines whether to enable or disable the object.
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 boolean forcedToOverflow([boolean value])
public int foregroundColor([int value]) Gets or sets the text color for the control to use.
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 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])
public int id() Retrieves the ID of the control.
public int imageLocation([int value])
public boolean isContainer() Retrieves a value that indicates whether the control is a container control.
public boolean italic([boolean value])
public str keyTip([str value])
public int left(int value, [int mode])
public int leftMargin([int value])
public int leftMode([int value])
public int leftValue([int value])
public int moveControl(int controlId, [int insertAfterControlId]) Moves a specified control to the control.
public int multiSelect([int value])
public str name([str value]) Gets or sets the name that is used in the code to identify a form, report, table, query, or another Finance and Operations application object.
public int neededPermission([int value])
public int needsRecord([int value])
public str normalImage([str value])
public int normalResource([int value])
public boolean primary([boolean value])
public int rightMargin([int value])
public boolean saveRecord([boolean value])
public SecurityKeyId securityKey([SecurityKeyId value])
public int shortkey([int value])
public boolean showShortCut([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 style([int value])
public str text([str value])
public int top(int value, [int mode])
public int topMargin([int value])
public int topMode([int value])
public int topValue([int value])
public int type([int value])
public boolean underline([boolean value]) Sets or returns the underline property for the text in the control.
public int userData([int value])
public int userDataItem([int value])
public int userDataItems([int value])
public boolean useUserLayout([boolean value])
public boolean value([boolean value])
public int verticalSpacing([int value], [AutoMode mode])
public AutoMode verticalSpacingMode([AutoMode mode])
public int verticalSpacingValue([int value])
public boolean visible([boolean value])
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 registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])

Method acquireFocus

public int acquireFocus([int 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 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

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 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 autoRefreshData

public boolean autoRefreshData([boolean value])

Parameters

value

Return Value

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 big

public boolean big([boolean value])

Parameters

value

Return Value

Method bold

Gets or sets the weight of font that is 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 bottomMargin

public int bottomMargin([int value])

Parameters

value

Return Value

Method buttonDisplay

Gets or sets the appearance of the button control.

public int buttonDisplay([int value])

Parameters

value

Return Value

An integer between zero and five, inclusive.

Remarks

The value of the property defines whether the text, the image, or both should be displayed on the button. This property also controls relative positions of text and image if both are displayed. The integer value that is returned contains the appearance of the button control as follows:

Value. Description.
0 Text only.
1 Image Only.
2 Text and image; the image is displayed under the text.
3 Text and image; the image is displayed above the text.
4 Text and image; the image is displayed to the left of the text.
5 Text and image; the image is displayed to the right of the text.

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 MicrosoftWindows.

Value. Description.
177 HEBREW_CHARSET
178 ARABIC_CHARSET

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

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 Web site, http://go.microsoft.com/fwlink/?LinkID=85972.

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 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 containerId

Retrieves the ID of the parent container for the control.

public int containerId()

Return Value

The ID of the parent container.

Method countryRegionCodes

public str countryRegionCodes([str value])

Parameters

value

Return Value

Method dataRelationPath

public str dataRelationPath([str value])

Parameters

value

Return Value

Method defaultButton

Determines whether the button should be the default button on the form.

public boolean defaultButton([boolean value])

Parameters

value

Return Value

true if the button should be the default button; otherwise, false.

Method disabledImage

Gets or sets the disabled image of the button.

public str disabledImage([str value])

Parameters

value

Return Value

The full name of an image file. The system supports all of the GDI-supported image formats.

Remarks

This property has precedence over the disabledResource property . It is used if both of these properties are set.

Method disabledImageLocation

public int disabledImageLocation([int value])

Parameters

value

Return Value

Method disabledResource

Gets or sets the resource ID of the image to use as the disabled button image.

public int disabledResource([int value])

Parameters

value

Return Value

The resource ID of the image to use as the disabled button image. Both icon and bitmap images are supported.

Method displayTarget

public int displayTarget([int value])

Parameters

value

Return Value

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 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 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 forcedToOverflow

public boolean forcedToOverflow([boolean value])

Parameters

value

Return Value

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 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 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 hierarchyParent

public str hierarchyParent([str value])

Parameters

value

Return Value

Method id

Retrieves the ID of the control.

public int id()

Return Value

The ID of the control.

Method imageLocation

public int imageLocation([int value])

Parameters

value

Return Value

Method isContainer

Retrieves a value that indicates whether the control is a container control.

public boolean isContainer()

Return Value

A Boolean value that indicates whether the control is a container control.

Method italic

public boolean italic([boolean value])

Parameters

value

Return Value

Method keyTip

public str keyTip([str value])

Parameters

value

Return Value

Method left

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

Parameters

value

mode

Return Value

Method leftMargin

public int leftMargin([int value])

Parameters

value

Return Value

Method leftMode

public int leftMode([int value])

Parameters

value

Return Value

Method leftValue

public int leftValue([int value])

Parameters

value

Return Value

Method moveControl

Moves a specified control to the control.

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

Parameters

controlId

insertAfterControlId

Return Value

1 if the control was moved successfully; otherwise, 0.

Remarks

In general, if the specified control can be contained in the control and can be moved from the container that it is currently in, this method should succeed. However, in some cases, such as for the reference group control instance, controls cannot be moved.

Method multiSelect

public int multiSelect([int value])

Parameters

value

Return Value

Method name

Gets or sets the name that is used in the 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 the 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 enums, classes, and so on.

Method neededPermission

public int neededPermission([int value])

Parameters

value

Return Value

Method needsRecord

public int needsRecord([int value])

Parameters

value

Return Value

Method normalImage

public str normalImage([str value])

Parameters

value

Return Value

Method normalResource

public int normalResource([int value])

Parameters

value

Return Value

Method primary

public boolean primary([boolean value])

Parameters

value

Return Value

Method rightMargin

public int rightMargin([int value])

Parameters

value

Return Value

Method saveRecord

public boolean saveRecord([boolean value])

Parameters

value

Return Value

Method securityKey

public SecurityKeyId securityKey([SecurityKeyId value])

Parameters

value

Return Value

Method shortkey

public int shortkey([int value])

Parameters

value

Return Value

Method showShortCut

public boolean showShortCut([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.

Method style

public int style([int value])

Parameters

value

Return Value

Method text

public str text([str value])

Parameters

value

Return Value

Method top

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

Parameters

value

mode

Return Value

Method topMargin

public int topMargin([int value])

Parameters

value

Return Value

Method topMode

public int topMode([int value])

Parameters

value

Return Value

Method topValue

public int topValue([int value])

Parameters

value

Return Value

Method type

public int type([int value])

Parameters

value

Return Value

Method underline

Sets or returns the underline property for the text in the control.

public boolean underline([boolean value])

Parameters

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

Return Value

true if the text in the control is underlined; otherwise, false.

Method userData

public int userData([int value])

Parameters

value

Return Value

Method userDataItem

public int userDataItem([int value])

Parameters

value

Return Value

Method userDataItems

public int userDataItems([int value])

Parameters

value

Return Value

Method useUserLayout

public boolean useUserLayout([boolean value])

Parameters

value

Return Value

Method value

public boolean value([boolean value])

Parameters

value

Return Value

Method verticalSpacing

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

Parameters

value

mode

Return Value

Method verticalSpacingMode

public AutoMode verticalSpacingMode([AutoMode mode])

Parameters

mode

Return Value

Method verticalSpacingValue

public int verticalSpacingValue([int value])

Parameters

value

Return Value

Method visible

public boolean visible([boolean value])

Parameters

value

Return Value

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 registerOverrideMethod

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

Parameters

methodToOverride

objectMethodToCall

overrideObject

Class FormBuildObjectSet

class FormBuildObjectSet extends Object

The FormBuildObjectSet class lets you create, read, update, and delete X++ code and metadata.

Remarks

Make sure that the user has access to the development security key (SysDevelopment) before this API is called.

Examples

Methods

Method Description
public int id()
public str name([str value]) Gets or sets the name that is used in code to identify a form, report, table, query, or other Finance and Operations application object.
public void finalize()

Method id

public int id()

Return Value

Method name

Gets or sets the name that is used in code to identify a form, report, table, query, or other 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:

  • It must start with a letter.
  • It cannot exceed 250 characters.
  • It can include numbers and underscore (_) characters.
  • It cannot include punctuation or spaces.
  • Tables cannot have the same name as other public objects, such as extended data types, base enums, or classes.

Method finalize

public void finalize()

Class FormBuildProgressControl

class FormBuildProgressControl extends FormBuildControl

The FormBuildProgressControl class lets you create, read, update, and delete X++ code and metadata.

Remarks

Make sure that the user has access to the development security key (SysDevelopment) before this API is called.

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 autoDeclaration([boolean value]) Determines whether the system can declare a member variable that has the same name as the control.
public ConfigurationKeyId configurationKey([ConfigurationKeyId value]) Gets or sets the configuration key that is assigned to the control.
public int containerId() Retrieves the ID of the parent container for the control.
public str countryRegionCodes([str value])
public str dataRelationPath([str value])
public int direction([int value])
public int displayTarget([int value])
public int dragDrop([int value]) Determines whether to enable or disable drag-and-drop operations for the control.
public boolean enabled([boolean value]) Determines whether to enable or disable the object.
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 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])
public int id() Retrieves the ID of the control.
public boolean isContainer() Retrieves a value that indicates whether the control is a container control.
public int left(int value, [int mode])
public int leftMode([int value])
public int leftValue([int value])
public str name([str value]) Gets or sets the name that is used in code to identify a form, report, table, query, or other Finance and Operations application object.
public int neededPermission([int value])
public int pos([int value])
public int progressType([int value])
public int rangeHi([int value])
public int rangeLo([int value])
public SecurityKeyId securityKey([SecurityKeyId 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 step([int value])
public int style([int value])
public int top(int value, [int mode])
public int topMode([int value])
public int topValue([int value])
public int type([int value])
public int userData([int value])
public int userDataItem([int value])
public int userDataItems([int value])
public int verticalSpacing([int value], [AutoMode mode])
public AutoMode verticalSpacingMode([AutoMode mode])
public int verticalSpacingValue([int value])
public boolean visible([boolean value])
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 registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])

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 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 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 containerId

Retrieves the ID of the parent container for the control.

public int containerId()

Return Value

The ID of the parent container.

Method countryRegionCodes

public str countryRegionCodes([str value])

Parameters

value

Return Value

Method dataRelationPath

public str dataRelationPath([str value])

Parameters

value

Return Value

Method direction

public int direction([int value])

Parameters

value

Return Value

Method displayTarget

public int displayTarget([int value])

Parameters

value

Return Value

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 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 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 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 hierarchyParent

public str hierarchyParent([str value])

Parameters

value

Return Value

Method id

Retrieves the ID of the control.

public int id()

Return Value

The ID of the control.

Method isContainer

Retrieves a value that indicates whether the control is a container control.

public boolean isContainer()

Return Value

A Boolean value that indicates whether the control is a container control.

Method left

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

Parameters

value

mode

Return Value

Method leftMode

public int leftMode([int value])

Parameters

value

Return Value

Method leftValue

public int leftValue([int value])

Parameters

value

Return Value

Method name

Gets or sets the name that is used in code to identify a form, report, table, query, or other 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:

  • It must start with a letter.
  • It cannot exceed 250 characters.
  • It can include numbers and underscore (_) characters.
  • It cannot include punctuation or spaces.
  • Tables cannot have the same name as other public objects, such as extended data types, base enums, or classes.

Method neededPermission

public int neededPermission([int value])

Parameters

value

Return Value

Method pos

public int pos([int value])

Parameters

value

Return Value

Method progressType

public int progressType([int value])

Parameters

value

Return Value

Method rangeHi

public int rangeHi([int value])

Parameters

value

Return Value

Method rangeLo

public int rangeLo([int value])

Parameters

value

Return Value

Method securityKey

public SecurityKeyId securityKey([SecurityKeyId 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.

Method step

public int step([int value])

Parameters

value

Return Value

Method style

public int style([int value])

Parameters

value

Return Value

Method top

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

Parameters

value

mode

Return Value

Method topMode

public int topMode([int value])

Parameters

value

Return Value

Method topValue

public int topValue([int value])

Parameters

value

Return Value

Method type

public int type([int value])

Parameters

value

Return Value

Method userData

public int userData([int value])

Parameters

value

Return Value

Method userDataItem

public int userDataItem([int value])

Parameters

value

Return Value

Method userDataItems

public int userDataItems([int value])

Parameters

value

Return Value

Method verticalSpacing

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

Parameters

value

mode

Return Value

Method verticalSpacingMode

public AutoMode verticalSpacingMode([AutoMode mode])

Parameters

mode

Return Value

Method verticalSpacingValue

public int verticalSpacingValue([int value])

Parameters

value

Return Value

Method visible

public boolean visible([boolean value])

Parameters

value

Return Value

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 registerOverrideMethod

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

Parameters

methodToOverride

objectMethodToCall

overrideObject

Class FormBuildRadioControl

class FormBuildRadioControl extends FormBuildControl

The FormBuildRadioControl class lets you create, read, update, and delete X++ code and metadata.

Remarks

Make sure that the user has access to the development security key (SysDevelopment) before this API is called.

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 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]) Determines whether the control background can be transparent.
public int bold([int value]) Gets or sets the weight of font that is used to output text in the control.
public int bottomMargin([int value], [AutoMode mode])
public AutoMode bottomMarginMode([AutoMode mode])
public int bottomMarginValue([int value])
public int cacheDataMethod([int value])
public str caption([str value]) Gets or set the caption of the control.
public int characterSet([int value]) Gets or sets the character set of the font.
public int colorScheme([int value]) Gets or sets the color scheme of the control.
public int columns([int value])
public ConfigurationKeyId configurationKey([ConfigurationKeyId value]) Gets or sets the configuration key that is assigned to the control.
public int containerId() Retrieves the ID of the parent container for the control.
public str countryRegionCodes([str value])
public FieldId countryRegionContextField([FieldId value])
public FieldId dataField([FieldId value])
public str dataMethod([str value])
public str dataRelationPath([str value])
public int dataSource([AnyType value]) Gets or sets a data source that will be used by the control or the form.
public int displayLength([int value], [AutoMode mode])
public AutoMode displayLengthMode([AutoMode mode])
public int displayLengthValue([int value])
public int displayTarget([int value])
public int dragDrop([int value]) Determines whether to enable or disable drag-and-drop operations for the control.
public boolean enabled([boolean value]) Determines whether to enable or disable the object.
public EnumId enumType([EnumId value])
public ExtendedTypeId extendedDataType([ExtendedTypeId 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 int framePosition([int value])
public int frameType([int value])
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 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 hideFirstEntry([boolean value])
public str hierarchyParent([str value])
public int id() Retrieves the ID of the control.
public boolean isContainer() Retrieves a value that indicates whether the control is a container control.
public boolean italic([boolean value])
public int item([int value])
public int items([int value])
public int left(int value, [int mode])
public int leftMargin([int value], [AutoMode mode])
public AutoMode leftMarginMode([AutoMode mode])
public int leftMarginValue([int value])
public int leftMode([int value])
public int leftValue([int value])
public str name([str value]) Gets or sets the name that is used in code to identify a form, report, table, query, or other Finance and Operations application object.
public int neededPermission([int value])
public int rightMargin([int value], [AutoMode mode])
public AutoMode rightMarginMode([AutoMode mode])
public int rightMarginValue([int value])
public SecurityKeyId securityKey([SecurityKeyId value])
public int selection([int 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 text([str value])
public int top(int value, [int mode])
public int topMargin([int value], [AutoMode mode])
public AutoMode topMarginMode([AutoMode mode])
public int topMarginValue([int value])
public int topMode([int value])
public int topValue([int value])
public int type([int value])
public boolean underline([boolean value]) Sets or returns the underline property for the text in the control.
public int userData([int value])
public int userDataItem([int value])
public int userDataItems([int value])
public int verticalSpacing([int value], [AutoMode mode])
public AutoMode verticalSpacingMode([AutoMode mode])
public int verticalSpacingValue([int value])
public int viewEditMode([int value])
public boolean visible([boolean value])
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 registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])

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 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

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 bold

Gets or sets the weight of font that is 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 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 cacheDataMethod

public int cacheDataMethod([int value])

Parameters

value

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 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 MicrosoftWindows.

Value. Description.
177 HEBREW_CHARSET
178 ARABIC_CHARSET

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

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 Web site, http://go.microsoft.com/fwlink/?LinkID=85972.

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])

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 containerId

Retrieves the ID of the parent container for the control.

public int containerId()

Return Value

The ID of the parent container.

Method countryRegionCodes

public str countryRegionCodes([str value])

Parameters

value

Return Value

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

public str dataRelationPath([str value])

Parameters

value

Return Value

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 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

public int displayTarget([int value])

Parameters

value

Return Value

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 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 enumType

public EnumId enumType([EnumId value])

Parameters

value

Return Value

Method extendedDataType

public ExtendedTypeId extendedDataType([ExtendedTypeId 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 framePosition

public int framePosition([int value])

Parameters

value

Return Value

Method frameType

public int frameType([int value])

Parameters

value

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 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 hideFirstEntry

public boolean hideFirstEntry([boolean value])

Parameters

value

Return Value

Method hierarchyParent

public str hierarchyParent([str value])

Parameters

value

Return Value

Method id

Retrieves the ID of the control.

public int id()

Return Value

The ID of the control.

Method isContainer

Retrieves a value that indicates whether the control is a container control.

public boolean isContainer()

Return Value

A Boolean value that indicates whether the control is a container control.

Method italic

public boolean italic([boolean value])

Parameters

value

Return Value

Method item

public int item([int value])

Parameters

value

Return Value

Method items

public int items([int value])

Parameters

value

Return Value

Method left

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

Parameters

value

mode

Return Value

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

public int leftMode([int value])

Parameters

value

Return Value

Method leftValue

public int leftValue([int value])

Parameters

value

Return Value

Method name

Gets or sets the name that is used in code to identify a form, report, table, query, or other 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:

  • It must start with a letter.
  • It cannot exceed 250 characters.
  • It can include numbers and underscore (_) characters.
  • It cannot include punctuation or spaces.
  • Tables cannot have the same name as other public objects, such as extended data types, base enums, or classes.

Method neededPermission

public int neededPermission([int 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 securityKey

public SecurityKeyId securityKey([SecurityKeyId value])

Parameters

value

Return Value

Method selection

public int selection([int 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.

Method text

public str text([str value])

Parameters

value

Return Value

Method top

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

Parameters

value

mode

Return Value

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

public int topMode([int value])

Parameters

value

Return Value

Method topValue

public int topValue([int value])

Parameters

value

Return Value

Method type

public int type([int value])

Parameters

value

Return Value

Method underline

Sets or returns the underline property for the text in the control.

public boolean underline([boolean value])

Parameters

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

Return Value

true if the text in the control is underlined; otherwise, false.

Method userData

public int userData([int value])

Parameters

value

Return Value

Method userDataItem

public int userDataItem([int value])

Parameters

value

Return Value

Method userDataItems

public int userDataItems([int value])

Parameters

value

Return Value

Method verticalSpacing

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

Parameters

value

mode

Return Value

Method verticalSpacingMode

public AutoMode verticalSpacingMode([AutoMode mode])

Parameters

mode

Return Value

Method verticalSpacingValue

public int verticalSpacingValue([int value])

Parameters

value

Return Value

Method viewEditMode

public int viewEditMode([int value])

Parameters

value

Return Value

Method visible

public boolean visible([boolean value])

Parameters

value

Return Value

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 registerOverrideMethod

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

Parameters

methodToOverride

objectMethodToCall

overrideObject

Class FormBuildRealControl

class FormBuildRealControl extends FormBuildControl

The FormBuildRealControl class lets you create, read, update, and delete X++ code and metadata.

Remarks

Make sure that the user has access to the development security key (SysDevelopment) before this API is called.

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 int allowNegative([int value])
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 autoInsSeparator([int value])
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 bold([int value]) Gets or sets the weight of font that is 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 int characterSet([int value]) Gets or sets the character set of the font.
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 int containerId() Retrieves the ID of the parent container for the control.
public str countryRegionCodes([str value])
public FieldId countryRegionContextField([FieldId value])
public FieldId dataField([FieldId value])
public str dataMethod([str value])
public str dataRelationPath([str value])
public int dataSource([AnyType value]) Gets or sets a data source that will be used by the control or the form.
public int decimalSeparator([int value])
public int direction([int value])
public int displaceNegative([int value], [AutoMode mode])
public AutoMode displaceNegativeMode([AutoMode mode])
public int displaceNegativeValue([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])
public int dragDrop([int value]) Determines whether to enable or disable drag-and-drop operations for the control.
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 int formatMST([int value])
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 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])
public int id() Retrieves the ID of the control.
public int iMEMode([int value])
public boolean isContainer() Retrieves a value that indicates whether the control is a container control.
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 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 int left(int value, [int mode])
public int leftMode([int value])
public int leftValue([int value])
public int limitText([int value], [AutoMode mode])
public AutoMode limitTextMode([AutoMode mode])
public int limitTextValue([int value])
public int lookupButton([int value])
public boolean mandatory([boolean value])
public int minNoOfDecimals([int value], [AutoMode mode])
public AutoMode minNoOfDecimalsMode([AutoMode mode])
public int minNoOfDecimalsValue([int value])
public str name([str value]) Gets or sets the name that is used in code to identify a form, report, table, query, or other Finance and Operations application object.
public int neededPermission([int value])
public int noOfDecimals([int value], [AutoMode mode])
public AutoMode noOfDecimalsMode([AutoMode mode])
public int noOfDecimalsValue([int value])
public int promptrect([int value])
public Real realValue([Real value])
public boolean replaceOnLookup([boolean value])
public int rotateSign([int value])
public int searchAfterInput([int value])
public int searchMode([int value])
public SecurityKeyId securityKey([SecurityKeyId value])
public boolean showLabel([boolean value])
public int showZero([int value])
public int signDisplay([int 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 style([int value])
public int thousandSeparator([int value])
public int top(int value, [int mode])
public int topMode([int value])
public int topValue([int value])
public int type([int value])
public boolean underline([boolean value]) Sets or returns the underline property for the text in the control.
public int userData([int value])
public int userDataItem([int value])
public int userDataItems([int value])
public int verticalSpacing([int value], [AutoMode mode])
public AutoMode verticalSpacingMode([AutoMode mode])
public int verticalSpacingValue([int value])
public int viewEditMode([int value])
public boolean visible([boolean value])
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 registerOverrideMethod(str methodToOverride, str objectMethodToCall, [Object overrideObject])

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 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

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 allowNegative

public int allowNegative([int value])

Parameters

value

Return Value

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

Return Value

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

Remarks

Controls cannot have identical names.

Method autoInsSeparator

public int autoInsSeparator([int value])

Parameters

value

Return Value

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 bold

Gets or sets the weight of font that is 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 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 Microsoft Windows.

Value. Description.
130 JOHAB_CHARSET

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

Value. Description.
177 HEBREW_CHARSET
178 ARABIC_CHARSET

The value in the following table is for the Thai language edition of Microsoft 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 Web site, http://go.microsoft.com/fwlink/?LinkID=85972.

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 Microsoft 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

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 containerId

Retrieves the ID of the parent container for the control.

public int containerId()

Return Value

The ID of the parent container.

Method countryRegionCodes

public str countryRegionCodes([str value])

Parameters

value

Return Value

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

public str dataRelationPath([str value])

Parameters

value

Return Value

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 decimalSeparator

public int decimalSeparator([int value])

Parameters

value

Return Value

Method direction

public int direction([int value])

Parameters

value

Return Value

Method displaceNegative

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

Parameters

value

mode

Return Value

Method displaceNegativeMode

public AutoMode displaceNegativeMode([AutoMode mode])

Parameters

mode

Return Value

Method displaceNegativeValue

public int displaceNegativeValue([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

public int displayTarget([int value])

Parameters

value

Return Value

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 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 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 formatMST

public int formatMST([int value])

Parameters

value

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 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

public str hierarchyParent([str value])

Parameters

value

Return Value

Method id

Retrieves the ID of the control.

public int id()

Return Value

The ID of the control.

Method iMEMode

public int iMEMode([int value])

Parameters

value

Return Value

Method isContainer

Retrieves a value that indicates whether the control is a container control.

public boolean isContainer()

Return Value

A Boolean value that indicates whether the control is a container control.

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 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 left

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

Parameters

value

mode

Return Value

Method leftMode

public int leftMode([int value])

Parameters

value

Return Value

Method leftValue

public int leftValue([int value])

Parameters

value

Return Value

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 lookupButton

public int lookupButton([int value])

Parameters

value

Return Value

Method mandatory

public boolean mandatory([boolean value])

Parameters

value

Return Value

Method minNoOfDecimals

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

Parameters

value

mode

Return Value

Method minNoOfDecimalsMode

public AutoMode minNoOfDecimalsMode([AutoMode mode])

Parameters

mode

Return Value

Method minNoOfDecimalsValue

public int minNoOfDecimalsValue([int value])

Parameters

value

Return Value

Method name

Gets or sets the name that is used in code to identify a form, report, table, query, or other 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:

  • It must start with a letter.
  • It cannot exceed 250 characters.
  • It can include numbers and underscore (_) characters.
  • It cannot include punctuation or spaces.
  • Tables cannot have the same name as other public objects, such as extended data types, base enums, or classes.

Method neededPermission

public int neededPermission([int value])

Parameters

value

Return Value

Method noOfDecimals

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

Parameters

value

mode

Return Value

Method noOfDecimalsMode

public AutoMode noOfDecimalsMode([AutoMode mode])

Parameters

mode

Return Value

Method noOfDecimalsValue

public int noOfDecimalsValue([int value])

Parameters

value

Return Value

Method promptrect

public int promptrect([int value])

Parameters

value

Return Value

Method realValue

public Real realValue([Real value])

Parameters

value

Return Value

Method replaceOnLookup

public boolean replaceOnLookup([boolean value])

Parameters

value

Return Value

Method rotateSign

public int rotateSign([int 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

public SecurityKeyId securityKey([SecurityKeyId value])

Parameters

value

Return Value

Method showLabel

public boolean showLabel([boolean value])

Parameters

value

Return Value

Method showZero

public int showZero([int value])

Parameters

value

Return Value

Method signDisplay

public int signDisplay([int 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.

Method style

public int style([int value])

Parameters

value

Return Value

Method thousandSeparator

public int thousandSeparator([int value])

Parameters

value

Return Value

Method top

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

Parameters

value

mode

Return Value

Method topMode

public int topMode([int value])

Parameters

value

Return Value

Method topValue

public int topValue([int value])

Parameters

value

Return Value

Method type

public int type([int value])

Parameters

value

Return Value

Method underline

Sets or returns the underline property for the text in the control.

public boolean underline([boolean value])

Parameters

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

Return Value

true if the text in the control is underlined; otherwise, false.

Method userData

public int userData([int value])

Parameters

value

Return Value

Method userDataItem

public int userDataItem([int value])

Parameters

value

Return Value

Method userDataItems

public int userDataItems([int value])

Parameters

value

Return Value

Method verticalSpacing

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

Parameters

value

mode

Return Value

Method verticalSpacingMode

public AutoMode verticalSpacingMode([AutoMode mode])

Parameters

mode

Return Value

Method verticalSpacingValue

public int verticalSpacingValue([int value])

Parameters

value

Return Value

Method viewEditMode

public int viewEditMode([int value])

Parameters

value

Return Value

Method visible

public boolean visible([boolean value])

Parameters

value

Return Value

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 registerOverrideMethod

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

Parameters

methodToOverride

objectMethodToCall

overrideObject