Progress
AppBuilder
Developer’s Guide


AppBuilder Information (adeuib/_uibinfo.p)

Use the adeuib/_uibinfo.p procedure to obtain information about the widgets and SmartObject instances in a design window:

Calling Sequence
RUN adeuib/_uibinfo.p
  ( INPUT  pi_context ,
    INPUT  pc_name ,
    INPUT  pc_request ,
    OUTPUT pc_info
   ) . 

Input Parameters

The adeuib/_uibinfo.p procedure takes the following input parameters:

pi_context

The context ID of the widget, SmartObject instance, code section, or procedure to access. If unknown (?), AppBuilder assumes the current procedure. The value of pi_context can be the context ID for any of the following:

pc_name

A quoted character string that specifies the name of an object. This string has the following syntax:

SYNTAX
{     object
        [ IN FRAME frame-name ] 
        [ IN WINDOW window-name ]
   |  object
        [ IN FRAME frame-name ] 
        [ IN PROCEDURE file-name ]
   |  HANDLE handle
} 

In this syntax:

pc_request

A quoted character string that specifies what to request. Valid requests are:

Other Options

To return a comma-separated list of procedure names:

RUN adeuib/_uibinfo.p
    (INPUT ?,                             /* P_context (INTEGER)    */
     INPUT "SESSION",                     /* p_name    (CHARACTER)  */
     INPUT "PROCEDURES RETURN NAME",      /* P_request (CHARACTER)  */
     OUTPUT name-list).                     /* p_info     (CHARACTER)  */ 

The following returns the same list but uses context IDs instead of names:

RUN adeuib/_uibinfo.p
    (INPUT ?,                             /* P_context (INTEGER)    */
     INPUT "SESSION",                     /* p_name    (CHARACTER)  */
     INPUT "PROCEDURES RETURN CONTEXT",   /* P_request (CHARACTER)  */
     OUTPUT name-list).                    /* p_info      (CHARACTER)  */ 

SECTIONS

You can ask a procedure for the list of internal procedures and functions defined in AppBuilder. The list can return the names or context IDs of the procedure and function sections, which you can use in adeuib/_accsect.p to get, modify, or delete the contents of code blocks:

SYNTAX
SECTIONS PROCEDURE [ ,FUNCTION ]
  [ RETURN { CONTEXT | NAME } ] 

If you do not specify either RETURN CONTEXT or RETURN NAME, it returns the list in context ID order.

To obtain a list of all internal procedures in a file by name, use the following:

SECTIONS PROCEDURE RETURN NAME 

To obtain all of the procedures and functions defined in a file, use the following:

SECTIONS PROCEDURE,FUNCTION 

This returns the list in context ID order.

HTML-FILE-NAME

Returns the HTML filename associated with an HTML mapping object procedure.

BROKERURL

Returns the broker URL set in Web Preferences:

RUN adeuib/_uibinfo.p(?,"SESSION":U,"BrokerURL":U,OUTPUT BrokerURL). 

REMOTE

Returns TRUE if the Remote File Management button in AppBuilder is set to ’Remote’, otherwise returns FALSE:

RUN adeuib/_uibinfo.p(?,"SESSION":U,"REMOTE":U, OUTPUT RemoteFlag). 

WEBBROWSER

Returns the Web Browser set in Web Preferences.

DATAOBJECT

Returns the SmartDataObject associated with the procedure:

RUN adeuib/_uibinfo.p(INT(hProc),"","DataObject":U, OUTPUT SDOName). 

DATAOBJECT-INCLUDE

Returns the name of the include file associated with the SmartDataObject of the procedure:

RUN adeuib/_uibinfo.p(INT(hProc),"","DataObject-Include":U,
  OUTPUT SDOiName). 

PALETTE-ITEM

For a given custom definition in a .cst file, returns the settings for ATTRIBUTES, LABEL, TEMPLATE, and FILES:

SYNTAX
PALETTE-ITEM cst-obj-name
  [ ATTRIBUTES | LABEL | TEMPLATE | FILES ] 

RUN adeuib/_uibinfo.p ( INPUT ?, INPUT "PALETTE-ITEM SmartDataObject":U,
  INPUT "ATTRIBUTES":U, OUTPUT Attributes). 

Output Parameter

The adeuib/_uibinfo.p procedure uses the following output parameter:

pc_info

Output value, cast as a character string.


Copyright © 2004 Progress Software Corporation
www.progress.com
Voice: (781) 280-4000
Fax: (781) 280-4095