SAP Business One UI API 10.0 - Objects Reference (10.00.270)

• Application Object Members

  • UI API

  • • Public Methods

      ActivateMenuItem	Simulates a user click on a menu item.
      ActivateToolbar	Simulates a user click on a toolbar icon.
      CreateObject	Creates an object of the specified type. Use this method to create forms, menus, or conditions for DBDataSource.Query.
      ExportRptAsXML	Returns an XML string representation of the report.
      GetFileFromBrowser	Triggers the Web browser to upload a file to the server. After the file is uploaded, returns the full path of the file that is saved in the server.
      GetFilter	Returns the current event filter on the Application object.
      GetFormItemDefaultHeight	Returns the default height of the item.
      GetFormItemDefaultWidth	Returns the default width of the item.
      GetLastBatchResults	Returns a string indicating the results (errors or warnings) of the last call to the LoadBatchActions method.
      LoadBatchActions	Loads XML in order to create forms, items, menus, and matrix columns in a single API call. Define the forms, items, menus, and matrix columns by created an XML file based on the schema described in Adding Forms with XML.
      MessageBox	Sends a modal message box to the SAP Business One application.
      OpenForm	Opens an SAP Business One system form or a user-defined object (UDO) form.
      RemoveWindowsMessage	This method enables you to deal with extreme scenarios. When an add-on needs to take a long time to process a UI API event, it prevents SAP Business One from processing the Windows message queue. Consequently, the message queue overflows, and if the add-on performs any other call back to SAP Business One via COM, it causes a system RPC failure.
      SendFileToBrowser	Sends a file that is stored in the server to a Web browser.
      SendKeys	Simulates a user pressing one or more keys in the active form.
      Serialize	Serialize
      ServerInvoke	method ServerInvoke
      SetFilter	Sets an event filter for a specific form.
      SetStatusBarMessage	Deprecated in UI API 2004. The method is supported in the next two releases for backward compatibility. Instead, use Application. StatusBar to get a status bar object, and then call StatusBar.SetText.

  • • Public Properties

      AppId	The application ID.
      ClientType	Identifies if the SAP Business One client is operating in Windows desktop mode or Browser Access mode.
      Cockpits	A Cockpits object that represents the cockpits in the application.
      Company	A Company object that represents the company database to which the SAP Business One application is connected.
      Desktop	A Desktop object representing the SAP Business One application desktop.
      EventLevel	Indicates the level of UI event (such as click or form load) takes place.
      FocusRestored	Indicates whether the focus is restored.
      FontHeight	The current font height which the SAP Business One client uses.
      FontName	The current font name which the SAP Business One client uses.
      Forms	A collection of the forms that have been opened in the SAP Business One application. Access a specific form by supplying one of the following: By FormUID (internal form ID supplied as a parameter in the ItemEvent event method and in the several event objects, such as ItemEvent) By index (the position with this collection, 0-based) By form type and instance count Use the Forms.Item method when supplying a FormUID or index. Use the Forms.GetForm method when supplying a type and instance count.
      IsHostedEnvironment	Indicates whether the application is a hosted environment or not.
      Language	The user interface language of the SAP Business One application.
      Menus	A collection of the current menu items in the SAP Business One menu tree. Use the Menus collection to access a menu item: By unique ID By index (0-based) You can directly access any menu item in the application's menu tree by using its unique ID, or you can traverse the menu tree by using an index at each level, which returns the menu item at a specified position in the current level. This property (Application.Menus) returns the top-level menu items.
      MetadataAutoRefresh	Indicates whether the auto-refresh mechanism in the SAP Business One application is active. The default is true.
      ResourceData	Resource information about system forms and items.
      SkinStyle	Indicates the skin for the SAP Business One user interface.
      StatusBar	A StatusBar object that represents the application status bar. Use this object to: Set a status bar message Create a progress bar
      XSEngineBaseURL	Returns the XS Engine base URL in SAP HANA enabled landscape. In non-SAP HANA enabled landscape, the return value is an empty string.

  • • Events

      AppEvent	Occurs when one of the following changes takes place in the SAP Business One application: Application shutdown Company database was changed Interface language was changed UI server shutdown
      FormDataEvent	Occurs when the application performs the following actions on forms connected to business objects: Add Update Delete Load form data via browse, link button, or find The event provides the unique ID (BusinessObjectInfo.ObjectKey) of the modified business object. Use this as an input object to the DI API DataBrowser.GetByKeys method to get a DI object. Note: You can also use this feature in the UDO new default forms with the header-line style.
      ItemEvent	Occurs when a UI event (such as click or form load) takes place on a form in the SAP Business One application.
      LayoutKeyEvent	Occurs when you print or print preview a layout of an add-on form. When the layout needs the key of the add-on form, the add-on catches and sets LayoutKeyInfo.LayoutKey to the key.
      MenuEvent	Occurs when a UI event (click) takes place on menu item in the SAP Business One application.
      PrintEvent	Occurs when one of the following takes place: End user clicks on Print or Print Preview icons. End user sends documents to print using the Document Printing option. A document is sent to print by the Document Generation Wizard.
      ProgressBarEvent	Occurs when a progress bar is created, stopped, or released in the status bar of the application.
      ReportDataEvent	Occurs when a report is sent to the printer.
      RightClickEvent	Occurs when an end user clicks the right mouse button on a form. Use this event to create a right-click menu for your add-on forms, or to modify the right-click menu for system forms.
      ServerInvokeCompletedEvent	method ServerInvokeCompletedEvent
      StatusBarEvent	Occurs when a message is created in the application status bar. Use the StatusBar object to display messages.
      UDOEvent	Occurs when you open a UDO default form with the header-line style.
      WidgetEvent	Occurs when a widget instance is created (dragged into the cockpit or created by the CreateWidgetInstance method of the Cockpit object).

  • • See Also

      Application Overview