📚 SAP Business One SDK Help

Form Object Members
See Also  Overview 

Public Methods

Public Method CloseCloses an open form.
Public Method EnableFormatSearchEnables format search.
Public Method EnableMenuEnables activating and disabling toolbar items when your add-on form is in focus.

In the SAP Business One application, forms control the status of toolbar items. During the form life-cycle, toolbars check their items and enable or disable items depending on the form currently in focus.

Public Method FreezeFreezes and unfreezes the form. When frozen, no changes in the form are displayed.

Use this method to update the form without causing flickering.

Public Method GetAsXMLReturns an XML string representation of the object.
Public Method RefreshDeprecated in UI API 2004.
The method is supported in the next two releases for backward compatibility. In the current release, the form is always updated so there is no need for refreshing the form.
Public Method ResetMenuStatusClears user actions on the application toolbar.
Public Method ResizeResizes the form.

Use this method to resize the form and keep the relative locations of items on the form.

Public Method SelectSets the focus to the form.
Public Method UpdateReloads the form from the application.

Use this method to update an object from the database.

Public Properties

Public Property ActiveItem

The unique ID of the item currently in focus on the form.

When you set this property, the form sets the focus on the specified item, which must be able to get focus (EditText or ComboBox).

Public Property AutoManagedIndicates whether the application manages your add-on form modes automatically.

When set to true, the application controls the form mode when the form is loaded and manages the status of items and menus (relevant to a specific mode) in mode changes.

Specify the modes that are to be managed on the form with the SupportedModes property.

Public Property BorderStyleThe form's border style.
Public Property BusinessObjectA BusinessObject holding a reference to the user-defined object connected to the form.

The user-defined object is specified in FormCreationParams.ObjectType.

Public Property ChooseFromListsA collection of the ChooseFromList items on the form.
Public Property ClientHeightThe height of the form's client rectangle, which is the form area that is available for adding items. This area does not include the title area of the form, on which you cannot add items.
Public Property ClientWidthThe width of the form's client rectangle, which is the form area that is available for adding items. This area does not include the title area of the form, on which you cannot add items.
Public Property DataBrowserDataBrowser object enabling you to display navigation buttons and menus for moving from one record to the next.
Public Property DataSourcesThe data source of the form.
Public Property DefButtonThe default item of the form.
Public Property HeightThe height of the form.
Public Property IsSystemIndicates whether the form is a system form.
Public Property ItemsA collection of all the items in the form.
Public Property LeftThe form's left position.
Public Property MaxHeightThe maximum height of the form.
Public Property MaxWidthThe maximum width of the form.
Public Property MenuReturns the form's Menus collection, enabling you to add a dynamic menu to your add-on form.
Public Property ModalIndicates whether the form is a modal window.
Public Property ModeThe form's mode.
Public Property PaneLevelThe form's pane level. This property determines what items are visible based on the items FromPane and ToPane properties.
Public Property ReportTypeThe report type code. By setting this property, you can relate the form with a report type.
Public Property SelectedIndicates whether the form has focus.
Public Property SettingsThe form settings object for the form.
Public Property StateThe window state of the form, such as whether the form in minimized.
Public Property SupportedModesThe range of modes available to the form. You can use one mode only, more than one mode (using OR), or all modes available in the application.

In SAP Business One, forms can appear in several modes that determine the type of actions users can perform on the form. For example, Add mode is used to add records to a form, while OK mode is used to display the form information.

Public Property TitleThe form's title.
Public Property TopThe form's top position.
Public Property TypeDeprecated in UI API 2004.
The property is supported for backward compatibility in the next two releases. Use TypeEX instead.
Public Property TypeCountThe number of open forms of the same type.
Public Property TypeExThe form's type.
Public Property UDFFormUIDThe user-defined field form's unique ID.
Public Property UniqueIDThe form's unique ID.
Public Property VisibleIndicates whether the form is visible.
Public Property VisibleExIndicates whether the form is visible.
Public Property WidthThe width of the form.

See Also