TB API

TB API

Release Date: 11/25/2020
Versions: 8.5 and Higher

Toolbar Functionality

This API affects the appearance and functionality of the Amigos buttons (Notes, Attributes, Contacts, Links, Events, General Events) and Special Functions button on the Elliott legacy screen toolbar:


Following are the details of this API:
  • TB,00:  Clear the Amigo key information.  Reset the state (hot = red) of the Amigo bitmaps.
  • TB,01:  Set the Amigo key information from PASSING-NOTE-FILE-NAME and PASSING-NOTE-FILE-REF-NUMBER.  Set the state of all Amigos buttons if the associated records exist.
  • TB,10:  Clear any special function information for the program in TB-SF-PROGRAM-ID.
  • TB,11,x:   Add a special function.  It stays available until it is removed. TB-SF-Program_ID contains the program to call; TB-SF-Menu-Text contains the menu text; x contains the hot-key letter; TB-SF-Passing-Parameters contains any passing parameters; Screen-SF-DD-Parameters, if it starts with "DD," contains any DD parameters.
  • TB,20,nn:  Disable a specific toolbar button
  •                   nn:  01 = Note, 02 = Attribute, 03 = Contact, 04=Event, 05 = Link01
  • TB,21,nn:   Enable a specific Amigo Toolbar button and, optionally, specify a PASSING-NOTE-FILE-NAME and PASSING-NOTE-FILE-REF-NUMBER.
  • TB,31,01: Allow changing notes by calling the Notes program, using PASSING-NOTE-FILE-NAME, PASSING-NOTE-FILE-REF-NUMBER. Show the Note window even if there are no matched notes.
  • TB,31,01,10,tttttt:  Call the Notes program, using PASSING-NOTE-FILE-NAME, PASSING-NOTE-FILE-REF-NUMBER and, optionally, a specific NoteType (tttttt). Show the Note window only if there is at least one matched note.
  • TB,31,01,11,tttttt: Same as TB,31,01,10,tttttt except that any notes will be presented as ReadOnly, with no ability to add, modify or delete any note. Show the Note window only if there is at least one matched note.
  • TB,31.02:  Call the Attribute program, using PASSING-NOTE-FILE-NAME, PASSING-NOTE-FILE-REF-NUMBER.
  • TB,31,03:  Call the eContacts program using PASSING-NOTE-FILE-NAME, PASSING-NOTE-FILE-REF-NUMBER.
  • TB,31,04:  Call the Events program using PASSING-NOTE-FILE-NAME, PASSING-NOTE-FILE-REF-NUMBER.
  • TB,31,05:  Call the Links program using PASSING-NOTE-FILE-NAME, PASSING-NOTE-FILE-REF-NUMBER.
  • TB,98:   Delete all associated Amigo records for the current Amigo. 
  • TB,99:   Delete all associated Amigo records for the Amigo specified in PASSING-NOTE-FILE-NAME and PASSING-NOTE-FILE-REF-NUMBER.
JEG


    • Related Articles

    • LK: Links API

      LK: Links Modified: 5/12/2019 Default links are established by the TB calls. The LK APIs provide additional links functionality. LK,00 Launch the Link whose type is in SCREEN-ALPHA-FIELD. LK,01 Add a temporary link. SCREEN-ALPHA-FIELD contains the ...

    • Programming API Codes

      This document is provided for Elliott software developers. If you are not an Elliott software developer, this document is not meaningful for you. AP: Get SMA Values This API returns various values from the Shared Memory Area. For example: Move ‘AP’ ...

    • ID API

      Release Date: 3/19/2019 The ID API will return the current Help ID (the current major Application program running in Elliott): MOVE "ID" TO SCREEN-PARAMETERS. PERFORM SCREEN-ROUTINE. MOVE SCREEN-ALPHA-FIELD TO MY-LOCAL-HELP-ID. In certain situations, ...

    • AP API

      AP API This API returns various values from the Shared Memory Area. For example: MOVE "AP" TO SCREEN-PARAMETERS MOVE "EDITOR" TO SCREEN-LITERAL PERFORM SCREEN-ROUTINE This returns the user’s preferred Editor in SCREEN-ALPHA-FIELD. The following ...

    • LF API

      Release Date: 9/7/2021 Versions: 8.0 and higher This API takes a filespec, like C:\WINDOWS\*.*, and returns the next file in the specified directory for each successive call. Screen Parameters Comment LF,nn Input: SCREEN-LITERAL contains the ...