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

• Add Method

  • UI API

  • • Description

      Adds an item to the collection.

      In version 2004, the DataBrowser object was added to support activating the application navigation icons  for your form. The browsing sequence is automatically inherited from the database record.

      The UI API will continue to support activating navigation icons via Form.EnableMenu for backward compatibility.

  • • Syntax

      Visual Basic
      Public Function Add( _    ByVal UID As String, _    ByVal Type As BoFormItemTypes _ ) As Item

  • • Parameters

      UID

      The unique ID of the item; maximum 10 characters.

      • 1  is reserved for the Add button and includes automatic management of form mode by the application (changing the button caption when the form mode changes).

      • 2 is reserved for the Cancel button.

      Type

      Value	Description
      it_BUTTON	Button (not relevant for column type)
      it_STATIC	StaticText  (not relevant for column type)
      it_EDIT	EditText
      it_FOLDER	Folder (not relevant for column type)
      it_RECTANGLE	Frame (not relevant for column type)
      it_COMBO_BOX	ComboBox
      it_LINKED_BUTTON	LinkedButton
      it_PICTURE	PictureBox
      it_EXTEDIT	EditText with multiple lines
      it_CHECK_BOX	CheckBox
      it_OPTION_BUTTON	OptionBtn  (not relevant for column type)
      it_MATRIX	Matrix  (not relevant for column type)
      it_GRID	Grid
      it_PANE_COMBO_BOX	PaneComboBox (not relevant for column type)
      it_ACTIVE_X	ActiveX
      it_BUTTON_COMBO	ButtonCombo (not relevant for column type)
      it_WEB_BROWSER	WebBrowser

      The type of item to add

  • • Remarks

      An item UID is limited to 10 characters and must be unique per form.

      Note that when adding new elements to a form, by default, the elements are positioned to the left-hand side of the first element. To position the elements correctly, set real values to the Left and Top properties.

  • • Example

      The following sample code shows how to add items to a form.

      (Visual Basic)
      Public Sub AddItemToForm()     Dim oForm As SAPbouiCOM.Form     Dim oItem As SAPbouiCOM.Item     '// add a new form     Set oForm = SBO_Application.Forms.Add("MatrixForm")     '// Adding a Button item     Set oItem = oForm.Items.Add("Button1", it_BUTTON) End Sub

      The following sample code shows how to activate navigation icons.

      Activating Navigation Icons (Visual Basic)
      oItem = oForm.Items.Add("BrsBtn", SAPbouiCOM.BoFormItemTypes.it_BROWSE_BUTTON) New form item Type oItem.LinkTo = "NameEdit1" '// link it to the field that sets the browsing sequence

  • • See Also

      Items Collection