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

• UI API Overview

  • UI API

  • • Description

      This help provides complete reference information for the UI API objects and enumerations.

  • • Class

      Class Module	Description
      ActiveX	Represents an ActiveX object.
      Application	This is the root object for the UI API, reflecting the current SAP Business One application on which the connection is made. Access the object via the SboGuiApi.GetApplication method.
      BusinessObject	Represents a user-defined object connected to a form. Access the object via the Form.BusinessObject property.
      BusinessObjectInfo	Contains information about the current FormDataEvent.
      Button	Represents a button in a form.
      ButtonCombo	Represents an item that provides the functionality of a ComboBox and Button in a single control.
      Cell	Represents a matrix cell, specified by its column and row.
      CellPosition	The position of the cell.
      Cells	The collection of Cell objects in a matrix column.
      CheckBox	Represents a check box in a form.
      CheckBoxColumn	Represents a column with an check box. Access the object via Column.Item when the column type is gct_CheckBox.
      ChooseFromList	Represents a ChooseFromList form.
      ChooseFromListCollection	A collection of ChooseFromList objects in a form. Access the collection via the Form.ChooseFromLists property.
      ChooseFromListCreationParams	Contains information for defining a new ChooseFromList. Mandatory properties: UniqueID and ObjectType
      ChooseFromListEvent	Contains information about the current choose from list event, which is an ItemEvent event of type et_CHOOSE_FROM_LIST. To access this object, cast the ItemEvent object into this object.
      Cockpit	Represents a cockpit, which is a personalized work center where you can view, search, organize, and perform your regular work and related activities.
      Cockpits	A collection of Cockpit objects. This object holds all the cockpits in the application.
      Column	Represents a matrix column. Use this object to set column properties and to access specific cells.
      Columns	A collection of Column objects in a matrix.
      ColumnSetting	Represents the settings for a special column cell in a grid or matrix.
      ColumnTitle	Represents the title of a column in a grid or matrix.
      ComboBox	Represents a combo box in a form.
      ComboBoxColumn	Represents a column with an combo box. Access the object via Column.Item when the column type is gct_ComboBox.
      CommonSetting	Represents the common settings for cells or rows in a grid or matrix.
      Company	Represents the company database to which the SAP Business One application is connected.
      Condition	Represents an SQL condition (Where statement), for use with ChooseFromList and DBDataSource objects.
      Conditions	A collection of Condition objects.
      ContextMenuInfo	Contains information about the current RightClickEvent.
      DataBind	Represents data that is bounded to a form item.
      DataBrowser	An object that enables navigation buttons and menus for moving from one record to the next. To enable the navigation buttons, set the BrowseBy property.
      DataCell	Represents a cell in a DataTable object.
      DataCells	A collection of DataCell objects. Access the object via the DataColumn.Cells property.
      DataColumn	Represents a column in a data tabe. Access the object via the DataTable.Columns property.
      DataColumns	A collection of DataColumn objects. Access the object via the DataTable.Columns property.
      DataRows	Represents rows in a data table. Access the object via the DataTable.Rows property.
      DataSource	Contains the open data sources of a form.
      DataTable	Represents data in matrix form, for Matrix and Grid objects.
      DataTables	A collection of DataTable objects.
      DBDataSource	Represents a SAP Business One database table to be attached to a form.
      DBDataSources	A collection of DBDataSource objects.
      Desktop	Represents the SAP Business One desktop (main window).  Use this object to change window properties.
      EditText	Represents a text box in a form.
      EditTextColumn	Represents a column with an edit text. Access the object via Column.Item when the column type is gct_EditText.
      EventFilter	Represents an event filter, which holds a collection of form types on which this event filter applies.  Each event filter filters in a single event type, as specified in the EventFilters.Add method.
      EventFilters	A collection of EventFilter objects. By default, the UI API gets every event triggered by the SAP Business One application. Most of these events may not be useful to your add-on and handling all of them can hurt performance. This object lets you filter the events your add-on receives and also specify the forms to which these filtered events apply.
      EventForm	Contains information about the object level events for forms in the SAP Business One application.
      ExtendedItemEvent	ExtendedItemEvent Class
      Field	Contains metadata for a field in a database table (DBDataSource).
      Fields	A collection of Field objects. Access the collection from DBDataSource.Fields.
      Folder	Represents a folder in a form.
      Form	Represents a form in the SAP Business One application. The form is identified by its unique ID, but only for the lifecycle of the form.
      FormCreationParams	Contains information for defining a new form. Using this interface to create a new form enables you to specify the form type as string, so you can add your partner namespace to the form type. In addition, you can set a reference to a user-defined object with the ObjectType property. For more information, see User-Defined Objects in the UI API.
      FormInfo	Contains resource information for a form. Access the object via the ResourceData object.
      Forms	A collection of Form objects. This object holds all the open forms in the application.
      FormSettings	Represents form preferences for a Form object.
      FormType	Represents a form type, for example, the Business Partners Master Data form type, which is 134.
      Grid	Represents a grid, which displays data in a table.
      GridColumn	Represents a column in a grid.
      GridColumns	A collection of GridColumn objects.
      GridRows	Represents the rows of a Grid.
      Item	Represents an item in a form. The Item object is uniquely identified by its UniqueID property and holds all the data of the referenced form item. Use the this object to set item properties such as size, string, location, etc and to get its specific item properties.
      ItemDragEvent	Inherited from the ItemEvent object. Contains information about the current ItemEvent and the drag position.
      ItemEvent	Contains information about the current ItemEvent.
      ItemInfo	Contains resource information (alias name) for an item. Access the object via the FormInfo.GetItemInfo method.
      Items	A collection of Item objects. Use this collection to access a form's items.
      LayoutKeyInfo	Contains information about the current LayoutKeyEvent.
      LinkedButton	Represents an arrow link in a form. An arrow link enables quick navigation between relevant objects. For example, an arrow link next to the Customer field in the A/R Invoice form opens the Business Partner Master Data form for the relevant customer. Note: You can also use this feature to link to the UDO default forms and the user-defined forms.
      Matrix	Represents a matrix, which displays data in a table.
      MenuCreationParams	Defines the properties for new menu items. With the Menus.AddEx method, you can use this object to do the following: Add and update application menus: To create or modify application menus, use the unique ID provided with each menu in the application. This ensures that your menu modifications are not affected by future versions. Add dynamic menu to your add-on forms: Using Form.Menu, you can add dynamic menus to your add-on forms. Dynamic menus appear under the Goto menu when the form gets focus.
      MenuEvent	Represents a menu event in SAP Business One application (click on a menu item only). You use this object to interfere with SAP Business One process for this event.
      MenuItem	Represents an item in a menu.
      Menus	Represents a menu, that is, a collection of MenuItem objects. The menu may be the top-level menu, or a submenu.
      OptionBtn	Represents an option button.
      PaneComboBox	No longer supported. Use ComboBox instead.
      PickerEvent	Contains information about the current picker event, which is an ItemEvent event of type et_PICKER_CLICKED.
      PictureBox	Represents a picture box.
      PictureColumn	Represents a column with an image. Access the object via the Column.Item method when the column type is gct_picture.
      PrintEventInfo	Contains information about the current PrintEvent.
      ProgressBar	Represents a progress bar created using StatusBar.CreateProgressBar.
      ProgressBarEvent	Contains information about the current ProgressBarEvent.
      ReportDataInfo	Contains information about the current ReportDataEvent. Use this object to get the data of a report that was sent for print or print preview. To get the data, call the RegisterForReport method in the before notification of the event. The data is provided in the after notification.
      ResourceData	Contains resource information for forms and items. Access the object via the ResourceData property.
      RowHeaders	Represents the row header column of a grid, which is the first column in a grid.
      SBOChooseFromListEventArg	Contains information about the current choose from list event. To access this object, cast the SBOItemEventArg object into this object.
      SboGuiApi	The object for establishing a connection to an active SAP Business One application.
      SBOItemEventArg	Contains information about the current ItemEvent.
      SBOPickerEventArg	Contains information about the current picker event. To access this object, cast the SBOItemEventArg object into this object.
      SBOWebMessageEventArg	Contains information about the current Web message event. To access this object, cast the SBOItemEventArg object into this object.
      SelectedRows	Represents the selected rows of a Grid object. Use this object to set lines as selected or as unselected. Access the object via the SelectedRows property.
      StaticText	Represents a label item.
      StatusBar	Represents the SAP Business One status bar. Use this object to create a progress bar within the status bar or to set a status bar message.
      UDOEvent	Occurs when you open a new UDO default form (with the header-line style) in SAP Business One.
      UserDataSource	A container for item data that is not stored in the database.
      UserDataSources	A collection of UserDataSource objects.
      ValidValue	Represents a valid value for an item, such as a ComboBox or ButtonCombo.
      ValidValues	A collection of ValidValue objects.
      WebBrowser	Represents a web browser.
      WebMessageEvent	Contains information about the current Web message event, which is an ItemEvent of type et_ITEM_WEBMESSAGE.
      Widget	Represents a widget instance in the cockpit. The widget can help users to perform a certain kind of task.
      WidgetCategoryRegParams	The registration parameters of the widget category.
      WidgetData	Contains the general information of a widget.
      WidgetKeyParams	Widget key parameters are used to differentiate all instances of the same widget. The parameters are a pair of key-value strings.
      WidgetKeysParams	A collection of WidgetKeyParams objects.
      WidgetRegParams	The registration parameters of the widget.
      Widgets	A collection of Widget objects. This object holds all the widget instances in the cockpit.

  • • Enumerations

      Enumeration	Description
      BoAppEventTypes	Application event types.
      BoAutoFormMode	User modes available to your add-on form, used for automatic management of form modes.
      BoAutoManagedAttr	Determines the item attribute for which you want to set automatic behavior in Item.SetAutoManagedAttribute.
      BoButtonTypes	Button types.
      BoCellClickType	Types of mouse clicks on a cell.
      BoClientType	Identifies if the SAP Business One client is operating in Windows desktop mode or Browser Access mode.
      BoColumnDisplayType	Types of column cells displayed in a matrix or a grid.
      BoColumnSumType	Types of the sum cell.
      BoComboDisplayType	Types of items displayed in a combo box.
      BoConditionOperation	Comparison operations.
      BoConditionRelationship	Logical operations.
      BoCreatableObjectType	Types of objects created by Application.CreateObject.
      BoDataTableXmlSelect	The types of XML that is returned from the SerializeAsXML method of a DataTable object, or the XML that is uploaded by the LoadSerializedXML method.
      BoDataType	Data types.
      BoEventLevelType	The event level.
      BoEventTypes	Item, form data, right-click, print, and report data event types. All events are item events, unless otherwise indicated in italics in parentheses.
      BoExpandType	The expand types of the combo box.
      BoExtensionLCMStageType	The stage of your extension lifecycle management.
      BoFieldsType	Field types for fields in the DataTable and DBDataSource objects. The decimal precision of some of the fields is determined by settings located at Administration --> System Initialization --> General Settings.
      BoFontStyle	Types of the font styles in a cell.
      BoFormBorderStyle	Types of form borders.
      BoFormItemTypes	Types of form items.
      BoFormModality	A modal form is a child form to a parent form and suppresses parent's control. A user may not press any controls or enter any information on the parent form until the modal has been closed.
      BoFormMode	Modes in which a form can appear.
      BoFormObjectEnum	The form objects.
      BoFormSizeableItemTypes	The item that is sizable in a form.
      BoFormStateEnum	States of the SAP Business One main window.
      BoFormTypes	Determines a visual attributes of the form border.
      BoGridColumnType	Types of GridColumn objects.
      BoGridSortType	Sort orders for grid columns.
      BoLanguages	Languages and localizations for the user interface of SAP Business One.
      BoLicenseStatus	Access rights for a form.
      BoLinkedObject	Target objects of a LinkedButton object.
      BoMatrixLayoutType	Matrix layouts.
      BoMatrixSelect	Matrix selection formats.
      BoMatrixXmlSelect	The type of XML that is returned from the SerializeAsXML method of a Matrix object.
      BoMenuType	Types of menu items.
      BoMessageTime	Timespans for a message to appear in the SAP Business One application.
      BoModeVisualBehavior	Determines the item behavior in the selected item attribute and form mode set by Item.SetAutoManagedAttribute.
      BoModifiersEnum	Modifier keys that can pressed at the same time as a standard key.
      BoOrderType	Indicates how the GetNextSelectedRow method of the Matrix object returns results.
      BoPickerType	Picker types, used to find out what type of picker triggered an event or is active in an EditText item.
      BoPrintEventTypes	Print event types.
      BoProgressBarEventTypes	Progress bar event types.
      BoScrollBars	Types of scroll bars for the extended EditText item (text box with multiple lines).
      BoSearchKey	Indicates how the Select and SelectExclusive methods of the ComboBox object locates items within its valid values.
      BoSeparateLineType	The type of the separate line.
      BoSeriesMode	Indicates which series to load into valid values.
      BoSkinStyle	The skin for the SAP Business One user interface.
      BoStatusBarMessageType	Types of status bar messages.
      BoTextStyle	Font styles for items and columns, used with the TextStyle property.
      BoUDOObjectType	The object type of the user-defined object.
      BoValidValueDefaults	Default valid values.
      BoWallpaperDisplayTypes	Indicates how a wallpaper image is displayed on the SAP Business One desktop.
      BoWidgetEventTypes	Widget event types.
      BoWindowsMessageType	Message types for the RemoveWindowsMessage method.