The canvas that replaces the window's current content canvas must have been
assigned to that window at design time. That is, you cannot replace a window's
content view with a content view from a different window.
If you replace a content canvas that contains the item that currently has
focus, Form Builder will immediately undo the replacement to keep the focus item
visible to the end user.
- Built-in: REPLACE_CONTENT_VIEW
** Example: Replace the 'salary' view with the 'history'
** view in the 'employee_status' window.
*/
BEGIN
Replace_Content_View('employee_status','history');
END;
REPLACE_MENU built-in
(menu_module_name VARCHAR2);
PROCEDURE REPLACE_MENU
(menu_module_name VARCHAR2,
menu_type NUMBER);
PROCEDURE REPLACE_MENU
(menu_module_name VARCHAR2,
menu_type NUMBER,
starting_menu_name VARCHAR2);
PROCEDURE REPLACE_MENU
(menu_module_name VARCHAR2,
menu_type NUMBER,
starting_menu VARCHAR2,
group_name VARCHAR2);
PROCEDURE REPLACE_MENU
(menu_module_name VARCHAR2,
menu_type NUMBER,
starting_menu VARCHAR2,
group_name VARCHAR2,
use_file BOOLEAN); Built-in Type unrestricted procedure Enter Query Mode yes Usage Notes REPLACE_MENU replaces the menu for all windows in the application. If you are using CALL_FORM, REPLACE_MENU will replace the menu for both the calling form and the called form with the specified menu. Parameters menu_module _name Name of the menu module that should replace the current menu module. Datatype is VARCHAR2. This parameter is optional; if it is omitted, Form Builder runs the form without a menu. menu_type The display style of the menu. The following constants can be passed as arguments for this parameter: PULL_DOWN Specifies that you want Form Builder to display the menus in a pull-down style that is characteristic of most GUI platforms and some character mode platforms. BAR Specifies that you want Form Builder to display the menu in a bar style horizontally across the top of the root window. FULL_SCREEN Specifies that you want Form Builder to display the menu in a full-screen style. starting_menu Specifies the menu within the menu module that Form Builder should use as the starting menu. The data type of the name is VARCHAR2. group_name Specifies the security role that Form Builder is to use. If you do not specify a role name, Form Builder uses the current username to determine the role. use_file Indicates how Form Builder should locate the menu .MMX file to be run. Corresponds to the Menu Source form module property. The data type of use_file is BOOLEAN. NULL Specifies that Form Builder should read the current form's Menu Source property and execute REPLACE_MENU accordingly. For example, if the form module Menu Source property is set to Yes for the current form, Form Builder executes REPLACE_MENU as if the use_file actual parameter was TRUE. FALSE Specifies that Form Builder should treat the menu_module value as a reference to a .MMB (binary) menu module in the database, and should query this module to get the actual name of the .MMX (executable). TRUE Specifies that Form Builder should treat the menu_module value as a direct reference to a .MMX menu runfile in the file system.
- Built-in: REPLACE_MENU
** Example: Use a standard procedure to change which root
** menu in the current menu application appears in
** the menu bar. A single menu application may
** have multiple "root-menus" which an application
** can dynamically set at runtime.
*/
PROCEDURE Change_Root_To(root_menu_name VARCHAR2) IS
BEGIN
Replace_Menu('MYAPPLSTD', PULL_DOWN, root_menu_name);
END;
REPORT_OBJECT_STATUS built-in
(report_id VARCHAR2(20)
); Built-in Type unrestricted procedure Enter Query Mode yes Parameters report_id The VARCHAR2 value returned by the RUN_REPORT_OBJECT built-in. This value uniquely identifies the report that is currently running either locally or on a remote report server. Usage Notes
There are eight possible return values for this built-in: finished, running,
canceled, opening_report, enqueued, invalid_job, terminated_with_error, and
crashed.
- rep VARCHAR2(100);
- rep := RUN_REPORT_OBJECT(repid);
(recordgroup_id RecordGroup); PROCEDURE RESET_GROUP_SELECTION
(recordgroup_name VARCHAR2); Built-in Type unrestricted procedure Enter Query Mode yes Parameters recordgroup_id The unique ID that Form Builder assigns when it creates the group. The data type of the ID is RecordGroup. recordgroup_name The name you gave to the record group when creating it. The data type of the name is VARCHAR2.
- Built-in: RESET_GROUP_SELECTION
** Example: If the user presses the (Cancel) button, forget
** all of the records in the 'USERSEL' record
** group that we may have previously marked as
** selected records.
** Trigger: When-Button-Pressed
*/
BEGIN
Reset_Group_Selection( 'usersel' );
END;
RESIZE_WINDOW built-in
(window_id Window,
width NUMBER,
height NUMBER); PROCEDURE RESIZE_WINDOW
(window_name VARCHAR2,
width NUMBER,
height NUMBER); Built-in Type unrestricted procedure Enter Query Mode yes Parameters window_id Specifies the unique ID that Form Builder assigns the window when created. Use the FIND_WINDOW built-in to return the ID to an appropriately typed variable. The data type of the ID is Window. window_name Specifies the name that you gave the window when creating it. The data type of the name is VARCHAR2. width Specifies the new width of the window, in form coordinate units. height Specifies the new height of the window, in form coordinate units.
- Built-in: RESIZE_WINDOW
** Example: Set Window2 to be the same size as Window1
*/
PROCEDURE Make_Same_Size_Win( Window1 VARCHAR2, Window2 VARCHAR2) IS
wn_id1 Window;
w NUMBER;
h NUMBER;
BEGIN
/*
** Find Window1 and get it's width and height.
*/
wn_id1 := Find_Window(Window1);
w := Get_Window_Property(wn_id1,WIDTH);
h := Get_Window_Property(wn_id1,HEIGHT);
/*
** Resize Window2 to the same size
*/
Resize_Window( Window2, w, h );
END;
RETRIEVE_LIST built-in
(list_id ITEM,
recgrp_name VARCHAR2); PROCEDURE RETRIEVE_LIST
(list_id ITEM,
recgrp_id RecordGroup);
PROCEDURE RETRIEVE_LIST
(list_name VARCHAR2,
recgrp_id RecordGroup);
PROCEDURE RETRIEVE_LIST
(list_name VARCHAR2,
recgrp_name VARCHAR2); Built-in Type unrestricted procedure Returns VARCHAR2 Enter Query Mode yes Parameters list_id Specifies the unique ID that Form Builder assigns when it creates the list item. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. The data type of the ID is ITEM. list_name The name you gave to the list item when you created it. The data type of the name is VARCHAR2. recgrp_id Specifies the unique ID that Form Builder assigns when it creates the record group. The data type of the ID is RecordGroup. recgrp_name The VARCHAR2 name you gave to the record group when you created it.
(product NUMBER,
module VARCHAR2,
commmode NUMBER,
execmode NUMBER,
location NUMBER,
paramlist_id VARCHAR2,
display VARCHAR2); PROCEDURE RUN_PRODUCT
(product NUMBER,
module VARCHAR2,
commmode NUMBER,
execmode NUMBER,
location NUMBER,
paramlist_name VARCHAR2,
display VARCHAR2); Built-in Type unrestricted procedure Enter Query Mode yes Parameters product Specifies a numeric constant for the Oracle product you want to invoke: FORMS specifies a Runform session. GRAPHICS specifies Graphics Builder. REPORTS specifies Report Builder. BOOK specifies Oracle Book. module Specifies the VARCHAR2 name of the module or module to be executed by the called product. Valid values are the name of a form module, report, Graphics Builder display, or Oracle Book module. The application looks for the module or module in the default paths defined for the called product. commmode Specifies the communication mode to be used when running the called product. Valid numeric constants for this parameter are SYNCHRONOUS and ASYNCHRONOUS. SYNCHRONOUS specifies that control returns to Form Builder only after the called product has been exited. The end user cannot work in the form while the called product is running. ASYNCHRONOUS specifies that control returns to the calling application immediately, even if the called application has not completed its display. execmode Specifies the execution mode to be used when running the called product. Valid numeric constants for this parameter are BATCH and RUNTIME. When you run Report Builder and Graphics Builder, execmode can be either BATCH or RUNTIME. When you run Form Builder, always set execmode to RUNTIME. location Specifies the location of the module or module you want the called product to execute, either the file system or the database. Valid constants for this property are FILESYSTEM and DB. Paramlist_name or paramlist_ID Specifies the parameter list to be passed to the called product. Valid values for this parameter are the VARCHAR2 name of the parameter list, the ID of the parameter list, or NULL. To specify a parameter list ID, use a variable of type PARAMLIST. You can pass text parameters to called products in both SYNCHRONOUS and ASYNCHRONOUS mode. However, parameter lists that contain parameters of type DATA_PARAMETER (pointers to record groups) can only be passed to Report Builder and Graphics Builder in SYNCHRONOUS mode. (SYNCHRONOUS mode is required when invoking Graphics Builder to return an Graphics Builder display that will be displayed in a form chart item.) Note: You can prevent Graphics Builder from logging on by passing a parameter list that includes a parameter with key set to LOGON and value set to NO. Note: You cannot pass a DATA_PARAMETER to a child query in Report Builder. Data passing is supported only for master queries. display Specifies the VARCHAR2 name of the Form Builder chart item that will contain the display (such as a pie chart, bar chart, or graph) generated by Graphics Builder. The name of the chart item must be specified in the format block_name.item_name. (This parameter is only required when you are using an Graphics Builder chart item in a form.)
- Built-in: RUN_PRODUCT
** Example: Call a Report Builder report, passing the
** data in record group 'EMP_RECS' to substitute
** for the report's query named 'EMP_QUERY'.
** Presumes the Emp_Recs record group already
** exists and has the same column/data type
** structure as the report's Emp_Query query.
*/
PROCEDURE Run_Emp_Report IS
pl_id ParamList;
BEGIN
/*
** Check to see if the 'tmpdata' parameter list exists.
*/
pl_id := Get_Parameter_List('tmpdata');
/*
** If it does, then delete it before we create it again in
** case it contains parameters that are not useful for our
** purposes here.
*/
IF NOT Id_Null(pl_id) THEN
Destroy_Parameter_List( pl_id );
END IF;
/*
** Create the 'tmpdata' parameter list afresh.
*/
pl_id := Create_Parameter_List('tmpdata');
/*
** Add a data parameter to this parameter list that will
** establish the relationship between the named query
** 'EMP_QUERY' in the report, and the record group named
** 'EMP_RECS' in the form.
*/
Add_Parameter(pl_id,'EMP_QUERY',DATA_PARAMETER,'EMP_RECS');
/*
** Run the report synchronously, passing the parameter list
*/
Run_Product(REPORTS, 'empreport', SYNCHRONOUS, RUNTIME,
FILESYSTEM, pl_id, NULL);
END;
RUN_REPORT_OBJECT built-in
(report_id REPORT_OBJECT
); Built-in Type unrestricted procedure Enter Query Mode yes Parameters report_id Specifies the unique ID of the report to be run. You can get the report ID for a particular report using the built-in FIND_REPORT_OBJECT. Usage Notes
Returns a VARCHAR2 value that uniquely identifies the report that is running
either locally or on a remote report server. You can use this report ID string
as a parameter to REPORT_OBJECT_STATUS , COPY_REPORT_OBJECT , and CANCEL_REPORT_OBJECT.
- rep VARCHAR2(100);
- rep := RUN_REPORT_OBJECT(repid);
- Built-in: SCROLL_DOWN
** Example: Scroll records down some.
*/
BEGIN
Scroll_Down;
END;
SCROLL_UP built-in
- Built-in: SCROLL_UP
** Example: Scroll records up some.
*/
BEGIN
Scroll_Up;
END;
SCROLL_VIEW built-in
(view_id ViewPort,
x NUMBER,
y NUMBER); PROCEDURE SCROLL_VIEW
(view_name VARCHAR2,
x NUMBER,
y NUMBER); Built-in Type unrestricted procedure Enter Query Mode yes Parameters
- iew_id
- Built-in: SCROLL_VIEW
** Example: Scroll the view whose name is passed in 10% to
** the right or left depending on the 'direction'
** parameter.
*/
PROCEDURE Scroll_Ten_Percent( viewname VARCHAR2,
direction VARCHAR2 ) IS
vw_id ViewPort;
vw_wid NUMBER;
vw_x NUMBER;
cn_id Canvas;
cn_wid NUMBER;
ten_percent NUMBER;
new_x NUMBER;
old_y NUMBER;
BEGIN
/*
** Get the id's for the View and its corresponding canvas
*/
vw_id := Find_View( viewname );
cn_id := Find_Canvas( viewname );
/*
** Determine the view width and corresponding canvas
** width.
*/
vw_wid := Get_View_Property(vw_id,WIDTH);
cn_wid := Get_Canvas_Property(cn_id,WIDTH);
/*
** Calculate how many units of canvas width are outside of
** view, and determine 10% of that.
*/
ten_percent := 0.10 * (cn_wid - vw_wid);
/*
** Determine at what horizontal position the view
** currently is on the corresponding canvas
*/
vw_x:= Get_View_Property(vw_id,VIEWPORT_X_POS_ON_CANVAS);
/*
** Calculate the new x position of the view on its canvas
** to effect the 10% scroll in the proper direction.
** Closer than ten percent of the distance to the edge
** towards which we are moving, then position the view
** against that edge.
*/
IF direction='LEFT' THEN
IF vw_x > ten_percent THEN
new_x := vw_x - ten_percent;
ELSE
new_x := 0;
END IF;
ELSIF direction='RIGHT' THEN
IF vw_x < cn_wid - vw_wid - ten_percent THEN
new_x := vw_x + ten_percent;
ELSE
new_x := cn_wid - vw_wid;
END IF;
END IF;
/*
** Scroll the view that much horizontally
*/
old_y := Get_View_Property(vw_id,VIEWPORT_Y_POS_ON_CANVAS);
Scroll_View( vw_id, new_x , old_y );
END;
SELECT_ALL built-in
- Built-in: SELECT_RECORDS
** Example: Perform Form Builder standard SELECT processing
** based on a global flag setup at startup by the
** form, perhaps based on a parameter.
** Trigger: On-Select
*/
BEGIN
/*
** Check the flag variable we setup at form startup
*/
IF :Global.Using_Transactional_Triggers = 'TRUE' THEN
User_Exit('my_select block=EMP');
/*
** Otherwise, do the right thing.
*/
ELSE
Select_Records;
END IF;
END;
FORMS_OLE.SERVER_ACTIVE
Returns TRUE if the OLE server is running.
Returns FALSE if the OLE server is not running.
You must define an appropriately typed variable to accept the return value.
Syntax
FUNCTION SERVER_ACTIVE
(item_id Item); FUNCTION SERVER_ACTIVE
(item_name VARCHAR2); Returns BOOLEAN Built-in Type unrestricted function Enter Query Mode no Parameters item_id Specifies the unique ID that Form Builder assigns to the item when created. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. The data type of the ID is Item. item_name Specifies the name of the object created at design time. The data type of the name is VARCHAR2 string.
- Built-in: SERVER_ACTIVE
** Example: Checks to see if the OLE server is active.
** Trigger: When-Button-Pressed
*/
DECLARE
item_id ITEM;
item_name VARCHAR(25) := 'OLEITM';
active_serv BOOLEAN;
BEGIN
item_id := Find_Item(item_name);
IF Id_Null(item_id) THEN
message('No such item: '||item_name);
ELSE
active_serv := Forms_OLE.Server_Active(item_id);
IF active_serv = FALSE THEN
Forms_OLE.Activate_Server(item_id);
END IF;
END IF;
END;
SET_ALERT_BUTTON_PROPERTY built-in
(alert_id ALERT,
button NUMBER,
property VARCHAR2,
value VARCHAR2); PROCEDURE SET_ALERT_BUTTON_PROPERTY
(alert_name VARCHAR2,
button NUMBER,
property VARCHAR2,
value VARCHAR2); Built-in Type unrestricted procedure Enter Query Mode yes Parameters alert_id Specifies the unique ID (data type ALERT) that Form Builder assigns to the alert when it is created. Use FIND_ALERT to return the ID to an appropriately typed variable. alert_name Specifies the VARCHAR2 name of the alert. buttoA constant that specifies the alert button you want to change, either ALERT_BUTTON1, ALERT_BUTTON2, or ALERT_BUTTON3. property LABEL Specifies the label text for the alert button.
- alue
(alert_id ALERT,
property NUMBER,
message VARCHAR2); SET_ALERT_PROPERTY
(alert_name VARCHAR2,
property NUMBER,
message VARCHAR2); Built-in Type unrestricted procedure Enter Query Mode yes Parameters alert_id Specifies the unique ID (data type ALERT) that Form Builder assigns to the alert when it is created. Return the ID to an appropriately typed variable. alert_name Specifies the VARCHAR2 name of the alert. property Specifies the specific alert property you are setting: ALERT_MESSAGE_TEXT Specifies that you are setting the text of the alert message. TITLE Specifies the title of the alert. Overrides the value specified in Form Builder unless the property value is NULL. message Specifies the message that is to replace the current alert message. Pass the message as a string enclosed in single quotes, as a variable, or in a string/variable construction.
- Built-in: SET_ALERT_PROPERTY
** Example: Places the error message into a user-defined alert ** named 'My_Error_Alert' and displays the alert.
** Trigger: On-Error
*/
DECLARE
err_txt VARCHAR2(80) := Error_Text;
al_id Alert;
al_button Number;
BEGIN
al_id := Find_Alert('My_Error_Alert');
Set_Alert_Property(al_id, alert_message_text, err_txt );
al_button := Show_Alert( al_id );
END;
SET_APPLICATION_PROPERTY built-in
(property NUMBER,
value VARCHAR2) Built-in Type unrestricted procedure Enter Query Mode yes Parameters property Specifies the property you want to set for the given application. The possible properties are as follows: CURSOR_STYLE Specifies the cursor style for the given application.
- alue
(block_id Block,
property VARCHAR,
value VARCHAR); SET_BLOCK_PROPERTY
(block_id Block,
property VARCHAR,
x NUMBER); SET_BLOCK_PROPERTY
(block_id Block,
property VARCHAR, x NUMBER
y NUMBER); SET_BLOCK_PROPERTY
(block_name VARCHAR2,
property VARCHAR,
value VARCHAR); SET_BLOCK_PROPERTY
(block_name VARCHAR2,
property VARCHAR,
x NUMBER); SET_BLOCK_PROPERTY
(block_name VARCHAR2,
property VARCHAR,
x NUMBER,
y NUMBER); Built-in Type unrestricted procedure Enter Query Mode yes Parameters block_id The unique ID Form Builder assigned to the block when you created it. Datatype is BLOCK. block_name The name you gave the block when you created it. Datatype is VARCHAR2. property Specify one of the following constants: ALL_RECORDS Specifies whether all the records matching the query criteria should be fetched into the data block when a query is executed. BLOCKSCROLLBAR_POSITION Specifies both the x and y positions of the block's scroll bar in the form coordinate units indicated by the Coordinate System form property. BLOCKSCROLLBAR_X_POS Specifies the x position of the block's scroll bar in the form coordinate units indicated by the Coordinate System form property. BLOCKSCROLLBAR_Y_POS Specifies the y position of the block scroll bar in the form coordinate units indicated by the Coordinate System form property. COORDINATION_STATUS Specifies a status that indicates whether a block that is a detail block in a master-detail relation is currently coordinated with all of its master blocks; that is, whether the detail records in the block correspond correctly to the current master record in the master block. Valid values are COORDINATED and NON_COORDINATED CURRENT_RECORD_ATTRIBUTE Specify the VARCHAR2 name of a named visual attribute to be associated with the given block. If the named visual attribute does not exist, you will get an error message. CURRENT_ROW_BACKGROUND_COLOR The color of the object's background region. CURRENT_ROW_FILL_PATTERN The pattern to be used for the object's fill region. Patterns are rendered in the two colors specified by Background Color and Foreground Color. CURRENT_ROW_FONT_NAME The font family, or typeface, that should be used for text in the object. The list of fonts available is system-dependent. CURRENT_ROW_FONT_SIZE The size of the font, specified in points. CURRENT_ROW_FONT_SPACING The width of the font, that is, the amount of space between characters (kerning). CURRENT_ROW_FONT_STYLE The style of the font. CURRENT_ROW_FONT_WEIGHT The weight of the font. CURRENT_ROW_FOREGROUND_COLOR The color of the object's foreground region. For items, the Foreground Color attribute defines the color of text displayed in the item. CURRENT_ROW_WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. DEFAULT_WHERE Specifies a default WHERE clause for the block, overriding previous WHERE clauses. (Note: this will not override a value established at design time via the Property Palette for the data block’s WHERE clause property.) Enclose in single quotes. The WHERE reserved word is optional. The default WHERE clause can include references to global variables, form parameters, and item values, specified with standard bind variable syntax. DELETE_ALLOWED Specifies whether the operator or the application is allowed to delete records in the given block. Valid values are PROPERTY_TRUE or PROPERTY_FALSE. DML_DATA_TARGET_NAME Specifies the name of the block's DML data source. ENFORCE_PRIMARY_KEY Specifies that any record inserted or updated in the block must have a unique characteristic in order to be committed to the database. Valid values are PROPERTY_TRUE or PROPERTY_FALSE. INSERT_ALLOWED Specifies whether the operator or the application is allowed to insert records in the given block. Valid values are PROPERTY_TRUE or PROPERTY_FALSE. KEY_MODE Specifies the key mode for the block. This is particularly useful when running Form Builder against non-ORACLE data sources. Valid values are UPDATEABLE_PRIMARY_KEY and NONUPDATEABLE_PRIMARY_KEY. LOCKING_MODE Specifies the block's LOCKING_MODE property. Valid values are DELAYED or IMMEDIATE. MAX_QUERY_TIME Specifies the maximum query time. The operator can abort a query when the elapsed time of the query exceeds the value of this property. MAX_RECORDS_FETCHED Specifies the maximum number of records that can be fetched. This property is only useful when the Query All Records property is set to Yes. NAVIGATION_STYLE Specifies the block's NAVIGATION_STYLE property. Valid values are SAME_RECORD, CHANGE_RECORD, or CHANGE_BLOCK. NEXT_NAVIGATION_BLOCK Specifies the name of the block's next navigation block. By default, the next navigation block is the block with the next higher sequence number; however, the NEXT_NAVIGATION_BLOCK block property can be set to override the default block navigation sequence. OPTIMIZER_HINT Specifies a hint that Form Builder passes on to the RDBMS optimizer when constructing queries. This allows the form designer to achieve the highest possible performance when querying blocks. ORDER_BY Specifies a default ORDER BY clause for the block, overriding any prior ORDER BY clause. Enclose in single quotes but do not include the actual words 'ORDER BY'. Form Builder automatically prefixes the statement you supply with "ORDER BY." PRECOMPUTE_SUMMARIES[Under Construction] PREVIOUS_NAVIGATION_BLOCK Specifies the name of the block's previous navigation block. By default, the previous navigation block is the block with the next lower sequence number; however, the NEXT_NAVIGATION_BLOCK block property can be set to override the default block navigation sequence. QUERY_ALLOWED Specifies whether a query can be issued from the block, either by an operator or programmatically. Valid values are PROPERTY_TRUE or PROPERTY_FALSE. QUERY_DATA_SOURCE_NAME Specifies the name of the block's query data source. Note: You cannot set a blocks’ QUERY_DATA_SOURCE_NAME when the block’s datasource is a procedure. QUERY_HITS Specifies the NUMBER value that indicates the number of records identified by the COUNT_QUERY operation. UPDATE_ALLOWED Specifies whether the operator or the application is allowed to update records in the given block. Valid values are PROPERTY_TRUE or PROPERTY_FALSE.
- alue
- Built-in: SET_BLOCK_PROPERTY
** Example: Prevent future inserts, updates, and deletes to
** queried records in the block whose name is
** passed as an argument to this procedure.
*/
PROCEDURE Make_Block_Query_Only( blk_name IN VARCHAR2 )
IS
blk_id Block;
BEGIN
/* Lookup the block's internal ID */
blk_id := Find_Block(blk_name);
/*
** If the block exists (ie the ID is Not NULL) then set
** the three properties for this block. Otherwise signal
** an error.
*/
IF NOT Id_Null(blk_id) THEN
Set_Block_Property(blk_id,INSERT_ALLOWED,PROPERTY_FALSE);
Set_Block_Property(blk_id,UPDATE_ALLOWED,PROPERTY_FALSE);
Set_Block_Property(blk_id,DELETE_ALLOWED,PROPERTY_FALSE);
ELSE
Message('Block '||blk_name||' does not exist.');
RAISE Form_Trigger_Failure;
END IF;
END;
- Built-in: SET_BLOCK_PROPERTY
** Example: Set the x and y position of the block's scrollbar
** to the passed x and y coordinates-
PROCEDURE Set_Scrollbar_Pos( blk_name IN VARCHAR2, xpos IN
-
IS
BEGIN
Set_Block_Property(blk_name, BLOCKSCROLLBAR_POSITION, xpos, ypos); END;
(canvas_id CANVAS,
property NUMBER,
value VARCHAR2); SET_CANVAS_PROPERTY
(canvas_id CANVAS,
property NUMBER,
x NUMBER);
SET_CANVAS_PROPERTY
(canvas_id CANVAS,
property NUMBER,
x NUMBER,
y NUMBER);
SET_CANVAS_PROPERTY
(canvas_name VARCHAR2,
property NUMBER,
value VARCHAR2);
SET_CANVAS_PROPERTY
(canvas_name VARCHAR2,
property NUMBER,
x NUMBER);
SET_CANVAS_PROPERTY
(canvas_name VARCHAR2,
property NUMBER,
x NUMBER,
y NUMBER); Built-in Type unrestricted procedure Enter Query Mode yes Parameters canvas_id The unique ID Form Builder assigned to the canvas object when you created it. Use the FIND_CANVAS built-in to return the ID to a variable of datatype CANVAS. canvas_name The name you gave the canvas object when you defined it. Datatype is VARCHAR2. property The property you want to set for the given canvas. Possible properties are: BACKGROUND_COLOR The color of the object's background region. CANVAS_SIZE The dimensions of the canvas (width, height). FILL_PATTERN The pattern to be used for the object's fill region. Patterns are rendered in the two colors specified by Background Color and Foreground Color. FONT_NAME The font family, or typeface, that should be used for text in the object. The list of fonts available is system-dependent. FONT_SIZE The size of the font, specified in points. FONT_SPACING The width of the font, that is, the amount of space between characters (kerning). FONT_STYLE The style of the font. FONT_WEIGHT The weight of the font. FOREGROUND_COLOR The color of the object's foreground region. For items, the Foreground Color attribute defines the color of text displayed in the item. HEIGHT The height of the canvas in characters. TOPMOST_TAB_PAGE The name of the tab page that will appear to operators as the top-most (i.e., overlaying all other tab pages in the tab canvas). VISUAL_ATTRIBUTE Either a valid named visual attribute that exists in the current form, or the name of a logical attribute definition in a runtime resource file that you want Form Builder to apply to the canvas. WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. WIDTH The width of the canvas in characters.
- alue
You cannot enter a non-existent named visual attribute.
If Form Builder cannot find a named visual attribute by the name you supply,
it looks for the display attribute in your Oracle*Terminal resource file.
- canvas color at runtime to the name of a visual attribute
** you created:
*/
BEGIN
SET_CANVAS_PROPERTY('my_cvs', visual_attribute, 'blue_txt');
END;
SET_CUSTOM_ITEM_PROPERTY_type built-in
(item,
name,
varchar2 value); SET_CUSTOM_ITEM_PROPERTY
(item,
name,
int value); SET_CUSTOM_ITEM_PROPERTY
(item,
name,
boolean value); Built-in Type unrestricted procedure Enter Query Mode yes Parameters item The class name of a user-supplied implementation. name The name of the item to be processed.
- alue
(formmodule_id FormModule,
property NUMBER,
value NUMBER); SET_FORM_PROPERTY
(formmodule_name VARCHAR2,
property NUMBER,
value NUMBER); Built-in Type unrestricted procedure Enter Query Mode yes Parameters formmodule_id Specifies the unique ID that Form Builder assigns to the form when created. The data type of the ID is FormModule. formmodule_name Specifies the name of the form module that you gave the form when creating it. The data type of the name is VARCHAR2. property Specifies the property you want to set for the form: CURRENT_RECORD_ATTRIBUTE Specify the VARCHAR2 name of a named visual attribute to be associated with the given form. If the named visual attribute does not exist, you will get an error message. CURRENT_ROW_BACKGROUND_COLOR The color of the object's background region. CURRENT_ROW_FILL_PATTERN The pattern to be used for the object's fill region. Patterns are rendered in the two colors specified by Background Color and Foreground Color. CURRENT_ROW_FONT_NAME The font family, or typeface, that should be used for text in the object. The list of fonts available is system-dependent. CURRENT_ROW_FONT_SIZE The size of the font, specified in points. CURRENT_ROW_FONT_SPACING The width of the font, that is, the amount of space between characters (kerning). CURRENT_ROW_FONT_STYLE The style of the font. CURRENT_ROW_FONT_WEIGHT The weight of the font. CURRENT_ROW_FOREGROUND_COLOR The color of the object's foreground region. For items, the Foreground Color attribute defines the color of text displayed in the item. CURRENT_ROW_WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. CURSOR_MODE Specifies the cursor state Form Builder should attempt to define. Primarily used when connecting to non-ORACLE data sources. Valid values are OPEN_AT_COMMIT and CLOSE_AT_COMMIT. DEFER_REQUIRED_ENFORCEMENT Specifies whether enforcement of required fields has been deferred from item validation to record validation. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. DIRECTION Specifies the layout direction for bidirectional objects. Valid values are DIRECTION_DEFAULT, RIGHT_TO_LEFT, LEFT_TO_RIGHT. FIRST_NAVIGATION_BLOCK Returns the name of the block into which Form Builder attempts to navigate at form startup. By default, the first navigation block is the first block defined in the Object Navigator; however, the FIRST_NAVIGATION_BLOCK block property can be set to specify a different block as the first block at form startup. SAVEPOINT_MODE Specifies whether Form Builder is to issue savepoints. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. VALIDATION Specifies whether Form Builder is to perform default validation. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. VALIDATION_UNIT Specifies the scope of validation for the form. Valid values are DEFAULT_SCOPE, BLOCK_SCOPE, RECORD_SCOPE, and ITEM_SCOPE.
- alue
- Built-in: SET_FORM_PROPERTY
** Example: Set the Cursor Mode property in the current form
** to CLOSE_AT_COMMIT and changes the form
** Validation unit to the Block level.
*/
DECLARE
fm_id FormModule;
BEGIN
fm_id := Find_Form(:System.Current_Form);
Set_Form_Property(fm_id,CURSOR_MODE,CLOSE_AT_COMMIT);
Set_Form_Property(fm_id,VALIDATION_UNIT,BLOCK_SCOPE);
END;
- Built-in: SET_FORM_PROPERTY
** Example: Setup form and block properties required to run
** against a particular non-Oracle datasource.
** Procedure accepts the appropriate numerical
** constants like DELAYED as arguments.
**
** Usage: Setup_Non_Oracle(PROPERTY_FALSE,
** CLOSE_AT_COMMIT,
** UPDATEABLE_PRIMARY_KEY,
** DELAYED);
*/
PROCEDURE Setup_Non_Oracle( the_savepoint_mode NUMBER,
the_cursor_mode NUMBER,
the_key_mode NUMBER,
the_locking_mode NUMBER ) IS
fm_id FormModule;
bk_id Block;
bk_name VARCHAR2(40);
BEGIN
/* ** Validate the settings of the parameters ** */
IF the_savepoint_mode NOT IN (PROPERTY_TRUE,PROPERTY_FALSE) THEN
Message('Invalid setting for Savepoint Mode.');
RAISE Form_Trigger_Failure;
END IF;
IF the_cursor_mode NOT IN (CLOSE_AT_COMMIT,OPEN_AT_COMMIT) THEN
Message('Invalid setting for Cursor Mode.');
RAISE Form_Trigger_Failure;
END IF;
IF the_key_mode NOT IN (UNIQUE_KEY,UPDATEABLE_PRIMARY_KEY,
NON_UPDATEABLE_PRIMARY_KEY) THEN
Message('Invalid setting for Key Mode.');
RAISE Form_Trigger_Failure;
END IF;
IF the_locking_mode NOT IN (IMMEDIATE,DELAYED) THEN
Message('Invalid setting for Locking Mode.');
RAISE Form_Trigger_Failure;
END IF;
/*
** Get the id of the current form
*/
fm_id := Find_Form(:System.Current_Form);
/*
** Set the two form-level properties
*/
Set_Form_Property(fm_id, SAVEPOINT_MODE, the_savepoint_mode);
Set_Form_Property(fm_id, CURSOR_MODE, the_cursor_mode);
/*
** Set the block properties for each block in the form
*/
bk_name := Get_Form_Property(fm_id,FIRST_BLOCK);
WHILE bk_name IS NOT NULL LOOP
bk_id := Find_Block(bk_name);
Set_Block_Property(bk_id,LOCKING_MODE,the_locking_mode);
Set_Block_Property(bk_id,KEY_MODE,the_key_mode);
IF the_key_mode IN (UPDATEABLE_PRIMARY_KEY,
NON_UPDATEABLE_PRIMARY_KEY) THEN
Set_Block_Property(bk_id,PRIMARY_KEY,PROPERTY_TRUE);
END IF;
bk_name := Get_Block_Property(bk_id, NEXTBLOCK);
END LOOP;
END;
SET_GROUP_CHAR_CELL built-in
(groupcolumn_id GroupColumn,
row_number NUMBER,
cell_value VARCHAR2); SET_GROUP_CHAR_CELL
(groupcolumn_name VARCHAR2,
row_number NUMBER,
cell_value VARCHAR2); Built-in Type unrestricted procedure Enter Query Mode yes Parameters groupcolumn_id The unique ID that Form Builder assigns when it creates the column for the record group. Use the FIND_COLUMN built-in to return the ID to an appropriately typed variable. The data type of the ID is GroupColumn. groupcolumn_name The name you gave to the column when you created it, preceded by the record group name and a dot, as in recordgroup_name.groupcolumn_name. The data type of the name is VARCHAR2. row_number Specifies the row number that contains the cell whose value you intend to set. Specify as a whole NUMBER. cell_value For a VARCHAR2 column, specifies the VARCHAR2 value you intend to enter into a cell; for a LONG column, specifies the LONG value you intend to enter into a cell.
You must create the specified row before setting the value of a cell in that
row. Form Builder does not automatically create a new row when you indicate one
in this built-in. Explicitly add the row with the ADD_GROUP_ROW built-in or
populate the group with either POPULATE_GROUP or POPULATE_GROUP_WITH_QUERY.
Not valid for a static record group. A static record group is a record group
that was created at design time and that has the Record Group Type property set
to Static.
(groupcolumn_id GroupColumn,
row_number NUMBER,
cell_value DATE); SET_GROUP_DATE_CELL
(groupcolumn_name VARCHAR2,
row_number NUMBER,
cell_value DATE); Built-in Type unrestricted procedure Enter Query Mode yes Parameters groupcolumn_id The unique ID that Form Builder assigns when it creates the column for the record group. Use the FIND_COLUMN built-in to return the ID to an appropriately typed variable. The data type of the ID is GroupColumn. groupcolumn_name The name you gave to the column when you created it, preceded by the record group name and a dot, as in recordgroup_name.groupcolumn_name. The data type of the name is VARCHAR2. row_number Specifies the row number that contains the cell whose value you intend to set. Specify as a whole NUMBER. cell_value Specifies the DATE value you intend to enter into a cell.
You must create the specified row before setting the value of a cell in that
row. Form Builder does not automatically create a new row when you indicate one
in this built-in. Explicitly add the row with the ADD_GROUP_ROW built-in or
populate the group with either POPULATE_GROUP or POPULATE_GROUP_WITH_QUERY.
Not valid for a static record group. A static record group is a record group
that was created at design time and that has the Record Group Type property set
to Static.
- Built-in: SET_GROUP_DATE_CELL
** Example: Lookup a row in a record group, and set the
** minimum order date associated with that row in
** the record group. Uses the 'is_value_in_list'
** function from the GET_GROUP_CHAR_CELL example.
*/
PROCEDURE Set_Max_Order_Date_Of( part_no VARCHAR2,
new_date DATE ) IS
fnd_row NUMBER;
BEGIN
/*
** Try to lookup the part number among the temporary part list
** record group named 'TMPPART' in its 'PARTNO' column.
*/
fnd_row := Is_Value_In_List( part_no, 'TMPPART', 'PARTNO');
IF fnd_row = 0 THEN
Message('Part Number '||part_no||' not found.');
RETURN;
ELSE
/*
** Set the corresponding Date cell value from the
** matching row.
*/
Set_Group_Date_Cell('TMPPART.MAXORDDATE',fnd_row,new_date );
END IF;
END;
SET_GROUP_NUMBER_CELL built-in
(groupcolumn_id GroupColumn,
row_number NUMBER,
cell_value NUMBER); SET_GROUP_NUMBER_CELL
(groupcolumn_name VARCHAR2,
row_number NUMBER,
cell_value NUMBER); Built-in Type unrestricted procedure Enter Query Mode yes Parameters groupcolumn_id The unique ID that Form Builder assigns when it creates the column for the record group. Use the FIND_COLUMN built-in to return the ID to an appropriately typed variable. The data type of the ID is GroupColumn. groupcolumn_name The name you gave to the column when you created it, preceded by the record group name and a dot, as in recordgroup_name.groupcolumn_name. The data type of the name is VARCHAR2. row_number Specifies the row number that contains the cell whose value you intend to set. Specify as a whole NUMBER. cell_value Specifies the NUMBER value you intend to enter into a cell.
You must create the specified row before setting the value of a cell in that
row. Explicitly add a row with the ADD_GROUP_ROW built-in or populate the group
with either POPULATE_GROUP or POPULATE_GROUP_WITH_QUERY.
Not valid for a static record group. A static record group is a record group
that was created at design time and that has the Record Group Type property set
to Static.
(recordgroup_id RecordGroup,
row_number NUMBER); SET_GROUP_SELECTION
(recordgroup_name VARCHAR2,
row_number NUMBER); Built-in Type unrestricted procedure Enter Query Mode yes Parameters recordgroup_id Specifies the unique ID that Form Builder assigns to the record group when created. Use the FIND_GROUP built-in to return the ID to a variable. The data type of the ID is RecordGroup. recordgroup_name Specifies the name of the record group that you gave to the group when creating it. The data type of the name is VARCHAR2. row_number Specifies the number of the record group row that you want to select. The value you specify is a NUMBER.
- Built-in: SET_GROUP_SELECTION
** Example: Set all of the even rows as selected in the
** record group whose id is passed-in as a
** parameter.
*/
PROCEDURE Select_Even_Rows ( rg_id RecordGroup ) IS
BEGIN
FOR j IN 1..Get_Group_Row_Count(rg_id) LOOP
IF MOD(j,2)=0 THEN
Set_Group_Selection( rg_id, j );
END IF;
END LOOP;
END;
SET_INPUT_FOCUS built-in
(MENU ); Built-in Type unrestricted procedure Enter Query Mode yes Parameters MENU
- Built-in: SET_INPUT_FOCUS
** Example: Directs the users input focus to the Menu when
** used with the only support parameter, MENU.
** Only has an effect on character-mode or
** block-mode devices.
*/
BEGIN
Set_Input_Focus(MENU);
END;
SET_ITEM_INSTANCE_PROPERTY built-in
the same item instance is referenced by another SET_ITEM_INSTANCE_PROPERTY, or
the same item instance is referenced by the DISPLAY_ITEM built-in, or
the instance of the item is removed (e.g., through a CLEAR_RECORD or a query),
or
the current form is exited
Syntax
SET_ITEM_INSTANCE_PROPERTY
(item_id ITEM,
record_number NUMBER,
property NUMBER,
value VARCHAR2); SET_ITEM_INSTANCE_PROPERTY
(item_name VARCHAR2,
record_number NUMBER,
property NUMBER,
value VARCHAR2); SET_ITEM_INSTANCE_PROPERTY
(item_name VARCHAR2,
record_number NUMBER,
property NUMBER,
value NUMBER); Built-in Type unrestricted procedure Enter Query Mode yes Parameters item_id The unique ID that Form Builder assigned to the object when it created it. Use the FIND_ITEM built-in to return the ID to a variable with datatype of ITEM. record_number The record number that you want to set. The record number is the record's position in the block. Specify as a whole number. You can specify CURRENT_RECORD if you want to set the block's current record. item_name The name you gave the item when you created it. Datatype is VARCHAR2. property The property you want to set for the given item. Possible properties are: BORDER_BEVEL Specifies the item border bevel for the specified item instance. Valid values are RAISED, LOWERED, PLAIN (unbeveled), or " ". A value of " " causes the border bevel to be determined by the value specified at the item level at design-time or by SET_ITEM_PROPERTY at runtime. Note: You cannot set BORDER_BEVEL if the item's Bevel property is set to None in Form Builder. INSERT_ALLOWED Applies only to records not retrieved from the database. When set to PROPERTY_TRUE at the item instance, item, and block levels, allows the end user to modify the item instance. Setting this property to PROPERTY_FALSE at the item instance, item, or block levels, prohibits the end user from modifying the item instance. NAVIGABLE When set to PROPERTY_TRUE at the item instance and item levels, allows the end user to be able to navigate to the item instance using default keyboard navigation. Setting this property to PROPERTY_FALSE at the item instance or item levels, disables default keyboard navigation to the item instance. REQUIRED Specify the constant PROPERTY_TRUE if you want to force the end user to enter a non-null value for the item instance. Setting this property to PROPERTY_FALSE at the item instance and item levels, indicates that the item instance is not required. UPDATE_ALLOWED Applies only to records retrieved from the database. When set to PROPERTY_TRUE at the item instance, item, and block levels, allows the end user to modify the item instance. When set to PROPERTY_FALSE at the instance, item, or block levels, prohibits the end user from modifying the item instance. VISUAL_ATTRIBUTE Specify a valid named visual attribute that exists in the current form or ''. Specifying '' leaves visual attribute unspecified at the item instance level. Usage Notes When working with properties specified at multiple levels (item instance, item, and block), consider the following guidelines:
Required properties specified at multiple levels are ORed together
Other boolean properties specified at multiple levels are ANDed together
The value derived from combining properties specified at the item instance,
item, and block levels is called the effective value. Some of the effects of these two rules are as follows:
setting INSERT_ALLOWED to true has no effect at the item instance level unless
it is set consistently at the block and item levels. For example, your user
cannot type data into an item instance if INSERT_ALLOWED is true at the instance
level, but not at the item or block levels.
setting NAVIGABLE to true has no effect at the item instance level unless it
is set consistently at the item and item instance levels
Setting NAVIGABLE to true may affect whether the block is considered
enterable. A block’s read-only Enterable property will be true if and only if its current record
contains an item instance whose effective value for the NAVIGABLE property is
true.
setting REQUIRED to false has no effect at the item instance level unless it
is set consistently at the item and item instance levels.
setting UPDATE_ALLOWED to true has no effect at the item instance level unless
it is set consistently at the block, item, and item instance levels.
setting BORDER_BEVEL at the item instance level will override the item level
BORDER_BEVEL setting, except when the item instance BORDER_BEVEL property is
unspecified (that is, set to " ").
setting VISUAL_ATTRIBUTE at the item instance level will override the
properties at the item and block levels unless you specify a partial visual attribute,
in which case a merge will occur between the partial visual attribute and the
item's current visual attribute. If VISUAL_ATTRIBUTE is set to " " at the item
instance level, the item-level settings of this property are used.
When a record is fetched or a new record is created, its item instance
properties are set to values that do not override the values specified at higher
levels. For example, the BORDER_BEVEL and VISUAL_ATTRIBUTE properties get set to "
", REQUIRED is set to false, and other boolean properties are set to true.
Setting an item instance property does not affect the item instance properties
of any items that mirror the specified item.
An instance of a poplist will, when selected, display an extra null value if
its current value is NULL or if its Required property is set to false. When
selecting the current value of an instance of a text list (t-list), it will be
unselected (leaving the t-list with no selected value) if its Required property is
set to false. If its Required property is set to true, selecting a t-list
instance's current value will have no effect, that is, the value will remain
selected.
- Built-in: SET_ITEM_INSTANCE_PROPERTY
** Example: Change the visual attribute of each item instance in the
** current record -
DECLARE
cur_itm VARCHAR2(80);
cur_block VARCHAR2(80) := :System.Cursor_Block;
BEGIN
cur_itm := Get_Block_Property( cur_block, FIRST_ITEM );
WHILE ( cur_itm IS NOT NULL ) LOOP
cur_itm := cur_block||'.'||cur_itm;
Set_Item_Instance_Property( cur_itm, CURRENT_RECORD,
VISUAL_ATTRIBUTE,'My_Favorite_Named_Attribute');
cur_itm := Get_Item_Property( cur_itm, NEXTITEM );
END LOOP;
END;
SET_ITEM_PROPERTY built-in
(item_id ITEM,
property NUMBER,
value VARCHAR2); SET_ITEM_PROPERTY
(item_name VARCHAR2,
property NUMBER,
value VARCHAR2); SET_ITEM_PROPERTY
(item_id ITEM,
property NUMBER,
x NUMBER); SET_ITEM_PROPERTY
(item_name VARCHAR2,
property NUMBER,
x NUMBER); SET_ITEM_PROPERTY
(item_id ITEM,
property NUMBER,
x NUMBER,
y NUMBER); SET_ITEM_PROPERTY
(item_name VARCHAR2,
property NUMBER,
x NUMBER,
y NUMBER); Built-in Type unrestricted procedure Enter Query Mode yes Parameters item_id The unique ID that Form Builder assigned to the object when it created it. Use the FIND_ITEM built-in to return the ID to a variable with datatype of ITEM. item_name The name you gave the item when you created it. Datatype is VARCHAR2. property The property you want to set for the given item. Possible properties are: AUTO_HINT Determines if Form Builder will display help hints on the status line automatically when input focus is in the specified item. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. AUTO_SKIP Specifies whether the cursor should skip to the next item automatically when the end user enters the last character in a text item. Valid only for a text item. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. BACKGROUND_COLOR The color of the object's background region. BORDER_BEVEL Specifies the item border bevel for the specified item instance. Valid values are RAISED, LOWERED, or PLAIN (unbeveled). Note: You cannot set BORDER_BEVEL if the item's Bevel property is set to None in Form Builder. CASE_INSENSITIVE_QUERY Specifies whether query conditions entered in the item should be case-sensitive. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. CASE_RESTRICTION Specifies the case restriction applied to any text entered in the indicated text item. Valid values are UPPERCASE, LOWERCASE, or NONE. COMPRESSSpecifies whether the sound data from a sound object should be compressed before Form Builder writes the data to the file. Valid values are COMPRESSION_ON, COMPRESSION_OFF, and ORIGINAL_SETTING (retain the default compression setting of the data). CONCEAL_DATA Specify the constant PROPERTY_TRUE if you want the item to remain blank or otherwise obscured when the end user enters a value. Specify the constant PROPERTY_FALSE if you want any value that is typed into the text item to be visible. CURRENT_RECORD_ATTRIBUTE Specifies the VARCHAR2 name of a named visual attribute to be associated with the given item. If the named visual attribute does not exist, you will get an error message. CURRENT_ROW_BACKGROUND_COLOR The color of the object's background region. CURRENT_ROW_FILL_PATTERN The pattern to be used for the object's fill region. Patterns are rendered in the two colors specified by Background Color and Foreground Color. CURRENT_ROW_FONT_NAME The font family, or typeface, that should be used for text in the object. The list of fonts available is system-dependent. CURRENT_ROW_FONT_SIZE The size of the font, specified in points. CURRENT_ROW_FONT_SPACING The width of the font, that is, the amount of space between characters (kerning). CURRENT_ROW_FONT_STYLE The style of the font. CURRENT_ROW_FONT_WEIGHT The weight of the font. CURRENT_ROW_FOREGROUND_COLOR The color of the object's foreground region. For items, the Foreground Color attribute defines the color of text displayed in the item. CURRENT_ROW_WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. DIRECTION Specifies the layout direction for bidirectional objects. Valid values are DIRECTION_DEFAULT, RIGHT_TO_LEFT, LEFT_TO_RIGHT. ECHO Specifies whether characters an end user types into a text item should be visible. When Echo is false, the characters typed are hidden. Used for password protection. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. ENABLED Specifies whether end users should be able to manipulate an item. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. Note: Setting Enabled to false will cause other item property settings to change. Consult the "Propagation of Property Changes" section for details. FILL_PATTERN The pattern to be used for the object's fill region. Patterns are rendered in the two colors specified by Background Color and Foreground Color. FIXED_LENGTH Specifies whether the item's value should be validated against the setting of the item's Max Length property. When FIXED_LENGTH is true, the item is valid only if the number of characters in its value equals the Max Length setting. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. FONT_NAME The font family, or typeface, that should be used for text in the object. The list of fonts available is system-dependent. FONT_SIZE The size of the font, specified in points. FONT_SPACING The width of the font, that is, the amount of space between characters (kerning). FONT_STYLE The style of the font. FONT_WEIGHT The weight of the font. FOREGROUND_COLOR The color of the object's foreground region. For items, the Foreground Color attribute defines the color of text displayed in the item. FORMAT_MASK Specifies the display format and input accepted for data in text items. HEIGHT Specifies the height of the item. ICON_NAME Specifies the file name of the icon resource associated with a button item having the iconic property set to ON. IMAGE_DEPTH Specifies the depth of color to be applied to an image item. INSERT_ALLOWED In a new record, allows end user to insert items normally when set to PROPERTY_TRUE. Specify PROPERTY_FALSE to specify that the item does not accept modification, but is displayed normally (not grayed out). (Insert_Allowed does not propagate changes to the Enabled property.) ITEM_IS_VALID Specifies whether the current item should be considered valid. Set to PROPERTY_TRUE or PROPERTY_FALSE. ITEM_SIZE Specifies a width and height for the item as two numbers separated by a comma. Use the syntax that includes x, y. JUSTIFICATION The text alignment (text and display items only). Valid values are ALIGNMENT_START, ALIGNMENT_END, ALIGNMENT_LEFT, ALIGNMENT_ CENTER, ALIGNMENT_RIGHT. KEEP_POSITION Specifies whether the Keep Cursor Position property should be true or false. When Keep Cursor Position is true, the cursor returns to the same position it was in when it left the text item. When Keep Cursor Position is false, the cursor returns to the default position in the text item. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. LABEL Specifies the VARCHAR2 string that you want displayed as the label of the item. This property is only valid for items that have labels, such as buttons. LOCK_RECORD_ON_CHANGE Specify the constant PROPERTY_TRUE if you want the record to be locked when this item is changed. Specify the constant PROPERTY_FALSE if you do not want the record locked when this item is changed. Use primarily when connecting to a non-ORACLE data source that does not have row-level locking. LOV_NAME Specify the VARCHAR2 name of an LOV to be associated with the given item. If the LOV name does not exist, you will get an error message. MERGE_CURRENT_ROW_VA Merges the contents of the specified visual attribute with the current row’s visual attribute (rather than replacing it). MERGE_TOOLTIP_ATTRIBUTE Merges the contents of the specified visual attribute with the tooltip’s current visual attribute (rather than replacing it). MERGE_VISUAL_ATTRIBUTE Merges the contents of the specified visual attribute with the object’s current visual attribute (rather than replacing it). MOUSE_NAVIGATE Specifies whether Form Builder should navigate and set focus to the item when the end user activates the item with the mouse. Specify the constant PROPERTY_TRUE if you want the end user to be able to navigate to the item using the mouse. Specify the constant PROPERTY_FALSE if you want a mouse click to keep the input focus in the current item. NAVIGABLE Specify the constant PROPERTY_TRUE if you want the end user to be able to navigate to the item using default keyboard navigation. Specify the constant PROPERTY_FALSE if you want to disable default keyboard navigation to the item. (Keyboard Navigable does not propagate changes to the Enabled property.) NEXT_NAVIGATION_ITEM Specifies the name of the item that is defined as the "next navigation item" with respect to this current item. POPUPMENU_CONTENT_ITEM Specifies the setting for any of the OLE popup menu item properties:
POPUPMENU_COPY_ITEM
POPUPMENU_CUT_ITEM
POPUPMENU_DELOBJ_ITEM
POPUPMENU_INSOBJ_ITEM
POPUPMENU_LINKS_ITEM
POPUPMENU_OBJECT_ITEM
POPUPMENU_PASTE_ITEM
POPUPEMNU_PASTESPEC_ITEM
Specify the character string HIDDEN for the OLE popup menu item not to be
displayed on the OLE popup menu. Specify the character string ENABLED for the OLE
popup menu item to be displayed and enabled. Specify the character string
DISABLED for the OLE popup menu item to be displayed and not enabled.
POSITION Specify the x, y coordinates for the item as NUMBERs separated by a comma.
Use the syntax that includes x, y.
PREVIOUS_NAVIGATION_ITEM Specifies the name of the item that is defined as the "previous navigation
item" with respect to this current item.
PRIMARY_KEY Specify the constant PROPERTY_TRUE to indicate that any record inserted or
updated in the block must have a unique characteristic in order to be committed
to the database. Otherwise, specify the constant PROPERTY_FALSE.
PROMPT_ALIGNMENT_OFFSET Determines the distance between the item and its prompt.
PROMPT_BACKGROUND_COLOR The color of the object's background region.
PROMPT_DISPLAY_STYLE Determines the prompt’s display style, either PROMPT_FIRST_RECORD, PROMPT_HIDDEN, or
PROMPT_ALL_RECORDS.
PROMPT_EDGE Determines which edge the item’s prompt is attached to, either START_EDGE, END_EDGE, TOP_EDGE, or BOTTOM_EDGE.
PROMPT_EDGE_ALIGNMENT Determines which edge the item’s prompt is aligned to, either ALIGNMENT_START, ALIGNMENT_END, or
ALIGNMENT_CENTER.
PROMPT_EDGE_OFFSET Determines the distance between the item and its prompt as a VARCHAR2 value.
PROMPT_FILL_PATTERN The pattern to be used for the object's fill region. Patterns are rendered
in the two colors specified by Background Color and Foreground Color.
PROMPT_FONT_NAME The font family, or typeface, that should be used for text in the object.
The list of fonts available is system-dependent.
PROMPT_FONT_SIZE The size of the font, specified in points.
PROMPT_FONT_SPACING The width of the font, that is, the amount of space between characters
(kerning).
PROMPT_FONT_STYLE The style of the font.
PROMPT_FONT_WEIGHT The weight of the font.
PROMPT_FOREGROUND_COLOR The color of the object's foreground region. For items, the Foreground Color
attribute defines the color of text displayed in the item.
PROMPT_TEXT Determines the text label that displays for an item.
PROMPT_TEXT_ALIGNMENT Determines how the prompt is justified, either ALIGNMENT_START,
ALIGNMENT_LEFT, ALIGNMENT_RIGHT, ALIGNMENT_CENTER, or ALIGNMENT_END.
PROMPT_VISUAL_ATTRIBUTE Specifies the named visual attribute that should be applied to the prompt at
runtime.
PROMPT_WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device
as white text on a black background.
QUERYABLE Specify the constant PROPERTY_TRUE if you want the end user to be able to
initiate a query against the item. Specify the constant PROPERTY_FALSE if you
want to disallow the use of the item in a query.
QUERY_ONLY Specify an item to be queried, preventing that item from becoming part of
insert or update statements. QUERY_ONLY is applicable to text items, radio
groups, and check boxes. Enclose the fully-qualified item name in single quotes.
REQUIRED Specify the constant PROPERTY_TRUE if you want to force the end user to
enter a value for the item. Specify the constant PROPERTY_FALSE if the item is not
to be required.
SHOW_FAST_FORWARD_BUTTON Specify the constant PROPERTY_TRUE to display 
on a sound item, PROPERTY_FALSE to hide it.
SHOW_PLAY_BUTTON Specify the constant PROPERTY_TRUE to display 
on a sound item, PROPERTY_FALSE to hide it. Note that Form Builder will hide
either or 
, but not both.
SHOW_RECORD_BUTTON Specify the constant PROPERTY_TRUE to display on a sound item, PROPERTY_FALSE to hide it. Note that Form Builder will hide
either or , but not both.
SHOW_REWIND_BUTTON Specify the constant PROPERTY_TRUE to display 
on a sound item, PROPERTY_FALSE to hide it.
SHOW_SLIDER Specify the constant PROPERTY_TRUE to display 
on a sound item, PROPERTY_FALSE to hide it.
SHOW_TIME_INDICATOR Specify the constant PROPERTY_TRUE to display 
button on a sound item, PROPERTY_FALSE to hide it.
SHOW_VOLUME_CONTROL Specify the constant PROPERTY_TRUE to display 
on a sound item, PROPERTY_FALSE to hide it.
TOOLTIP_BACKGROUND_COLOR The color of the object's background region.
TOOLTIP_FILL_PATTERN The pattern to be used for the object's fill region. Patterns are rendered
in the two colors specified by Background Color and Foreground Color.
TOOLTIP_FONT_NAME The font family, or typeface, that should be used for text in the object.
The list of fonts available is system-dependent.
TOOLTIP_FONT_SIZE The size of the font, specified in points.
TOOLTIP_FONT_SPACING The width of the font, that is, the amount of space between characters
(kerning).
TOOLTIP_FONT_STYLE The style of the font.
TOOLTIP_FONT_WEIGHT The weight of the font.
TOOLTIP_FOREGROUND_COLOR The color of the object's foreground region. For items, the Foreground Color
attribute defines the color of text displayed in the item.
TOOLTIP_TEXT Determines the item’s tooltip text.
TOOLTIP_WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device
as white text on a black background.
UPDATE_ALLOWED Specify the constant PROPERTY_TRUE if you want the end user to be able to
update the item. Specify the constant PROPERTY_FALSE if you want the item
protected from update.
UPDATE_COLUMN Specify the constant PROPERTY_TRUE if this column should be treated as
updated, and included in the columns to be written to the database. Specify the
constant PROPERTY_FALSE if this column should be treated as not updated, and not
be included in the columns to be written to the database.
UPDATE_NULL Specify the constant PROPERTY_TRUE if you want the end user to be able to
update the item only if its value is NULL. Specify the constant PROPERTY_FALSE
if you want the end user to be able to update the value of the item regardless
of whether the value is NULL.
UPDATE_PERMISSION Use UPDATE_ ALLOWED when you run against non-ORACLE data sources. Specify
the constant PROPERTY_TRUE to turn on the item's UPDATEABLE and UPDATE_NULL
properties. Specify the constant PROPERTY_FALSE to turn off the item's UPDATEABLE
and UPDATE_NULL properties.
VALIDATE_FROM_LIST Specifies that Form Builder should validate the value of the text item
against the values in the attached LOV when set to PROPERTY_TRUE. Specify
PROPERTY_FALSE to specify that Form Builder should not use the LOV for validation.
VISIBLE Specifies whether the indicated item should be visible or hidden. Valid
values are PROPERTY_TRUE and PROPERTY_FALSE.
Note: Setting Visible to false will cause other item property settings to change.
Consult the "Propagation of Property Changes" section for details.
VISUAL_ATTRIBUTE Specify a valid named visual attribute that exists in the current form.
Note: You cannot set the visual attribute for an image item.
WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device
as white text on a black background.
WIDTH Specify the width of the item as a NUMBER. The size of the units depends on
how you set the Coordinate System property and default font scaling for the
form.
X_POS Specify the x coordinate as a NUMBER.
Y_POS Specify the y coordinate as a NUMBER.
- alue
validation of property changes
propagation of property changes
Validation of Property Changes When you specify a change through the SET_ITEM_PROPERTY built-in, Form
Builder validates the change before it adjusts the property. If the change is
validated, Form Builder makes the change and leaves it in effect until another
SET_ITEM_PROPERTY changes the same property or the current form is exited.
Illegal Settings If the change is not validated, Form Builder issues an error message. You
cannot use SET_ITEM_PROPERTY to set the following item properties true or false,
given the following target item conditions.
| You cannot set this property parameter...
| To this restricted setting
| If this target item condition is true:
|
| (All)
| true/false
| NULL-canvas item (item's canvas property is null)
|
| ENABLED
| true/false
true | current item
Visible item property is false
|
| INSERT_ALLOWED
| true
true | Enabled item property is false
Visible item property is false
|
| NAVIGABLE
| true/false
true | current item
Visible item property is false
|
| QUERYABLE
(Query Allowed) | true
| Visible item property is false
|
| UPDATE_ALLOWED
| true
true | Enabled item property is false
Conceal Data item property is true
|
| UPDATE_NULL
(Update if NULL) | true
true | Enabled item property is false
Conceal Data item property is true
|
| VISIBLE
| true/false
| current item
|
THEN :block.item := NULL; Propagation of Property Changes You can only specify a change to one item property at a time through the SET_ITEM_PROPERTY built-in. However, one SET_ITEM_PROPERTY statement can cause changes to more than one item property if the additional changes are necessary to complete, or propagate, the intended change. This is included primarily for compatibility with prior versions. The following table shows the SET_ITEM_PROPERTY settings that cause Form Builder to propagate changes across item properties:
| Setting this property parameter...
| To this setting
| Also causes these propagated changes:
|
| ENABLED
| False
| sets the Navigable item property to False
sets the Update_Null item property to False
sets the Updateable item property to False
sets the Required item property to False
|
| DISPLAYED
| False
| sets the Enabled and Navigable item properties to False
sets the Updateable item property to False
sets the Update_Null item property to False
sets the Required item property to False
sets the Queryable item property to False
|
| UPDATEABLE
| True
| sets the Update_Null item property to False
|
| UPDATE_NULL
| True
| sets the Updateable item property to False
|
- Built-in: SET_ITEM_PROPERTY
** Example: Change the icon of an iconic button dynamically
** at runtime by changing its icon_name. The user
** clicks on this button to go into enter query
** mode, then clicks on it again (after the icon
** changed) to execute the query. After the query
** is executed the user sees the original icon
** again.
** Trigger: When-Button-Pressed
*/
DECLARE
it_id Item;
BEGIN
it_id := Find_Item('CONTROL.QUERY_BUTTON');
IF :System.Mode = 'ENTER-QUERY' THEN
/*
** Change the icon back to the enter query icon, and
** execute the query.
*/
Set_Item_Property(it_id,ICON_NAME,'entquery');
Execute_Query;
ELSE
/*
** Change the icon to the execute query icon and get
** into enter query mode.
*/
Set_Item_Property(it_id,ICON_NAME,'exequery');
Enter_Query;
END IF;
END;
SET_LOV_COLUMN_PROPERTY built-in
(lov_id LOV,
colnum NUMBER,
property NUMBER,
value VARCHAR2); SET_LOV_COLUMN_PROPERTY
(lov_name VARCHAR2,
colnum NUMBER,
property NUMBER,
value VARCHAR2); Built-in Type unrestricted procedure Enter Query Mode yes Parameters lov_id Specifies the unique ID that Form Builder assigns the LOV when created. Use the FIND_LOV built-in to return the ID to an appropriately typed variable. The data type of the ID is LOV. lov_name Specifies the LOV name (as a VARCHAR2). colnum Specifies the column to be modified (as a NUMBER). The first column is column 1. property Specifies the property you want to set for the given LOV. The possible properties are as follows: TITLE Sets the Column Title property that controls the title that displays above an LOV column. Note: Setting the column title to NULL resets the column title to the title specified at design time. WIDTH Specifies the width to be reserved in the LOV for displaying column values. Note: Setting the column width to NULL results in a hidden, or non-displayed, column.
- alue
(lov_id LOV,
property NUMBER,
value NUMBER); SET_LOV_PROPERTY
(lov_name VARCHAR2,
property NUMBER,
value NUMBER);
SET_LOV_PROPERTY
(lov_id LOV,
property NUMBER,
x NUMBER,
y NUMBER);
SET_LOV_PROPERTY
(lov_name VARCHAR2,
property NUMBER,
x NUMBER,
y NUMBER); Built-in Type unrestricted procedure Enter Query Mode yes Parameters lov_id Specifies the unique ID that Form Builder assigns the LOV when created. Use the FIND_LOV built-in to return the ID to an appropriately typed variable. The data type of the ID is LOV. lov_name Specifies the LOV name (as a VARCHAR2). property Specifies the property you want to set for the given LOV. The possible properties are as follows: AUTO_REFRESH Specifies whether Form Builder re-executes the query each time the LOV is invoked. GROUP_NAME Specifies the record group with which the LOV is associated. LOV_SIZE Specifies a width, height pair indicating the size of the LOV. POSITION Specifies an x, y pair indicating the position of the LOV. TITLE Specifies the title of the LOV. Overrides the value specified in the Form Builder unless the property value is NULL.
- alue
You can set only one property per call to the built-in.
- Built-in: SET_LOV_PROPERTY
** Example: if LOV is currently base on GROUP1,
** make LOV use GROUP2
*/
DECLARE
lov_id LOV;
BEGIN
lov_id := Find_LOV('My_LOV_1');
IF Get_LOV_Property(lov_id,GROUP_NAME) = 'GROUP1' THEN
Set_LOV_Property(lov_id,GROUP_NAME,'GROUP2');
ENDIF;
END;
SET_MENU_ITEM_PROPERTY built-in
(menuitem_id MenuItem,
property NUMBER,
value NUMBER); SET_MENU_ITEM_PROPERTY
(menu_name.menuitem_name VARCHAR2,
property NUMBER,
value NUMBER); Built-in Type unrestricted procedure Enter Query Mode yes Parameters menuitem_id Specifies the unique ID Form Builder assigns when it creates the menu item. Use the FIND_MENU_ITEM built-in to return the ID to an appropriately typed variable. The data type of the ID is MenuItem. menu_name.menuitem_name Specifies the VARCHAR2 name you gave to the menu item when you defined it. If you specify the menu item by name, include the qualifying menu name, as shown in the syntax. property Specify one of the following constants to set information about the menu item: CHECKED Specifies the Checked property, which indicates if a check box menu item or a radio menu item is in the checked state or unchecked state. ENABLED Specifies whether the menu item is enabled (thus active) or disabled (thus greyed out and unavailable to the operator). LABEL Specifies the character string for the menu item label. VISIBLE Specifies whether the menu item is visibly displayed.
- alue
If the menu module Use Security property is Yes, whether you can set the
property of a menu item using SET_MENU_ITEM_PROPERTY depends on whether the form
operator has access privileges for that item.
If the menu item is hidden and the operator does not have security access to a
menu item, Runform does not display that item. You cannot set the property of
a menu item using SET_MENU_ITEM_PROPERTY if the item is currently hidden.
If the menu item is displayed, but disabled and the Display w/o Priv property
for this menu item was set in Form Builder, Runform displays the item in a
disabled state. In this case, you can set the menu item properties programmatically.
(obj OLEOBJ, memberid PLS_INTEGER
newval NUMBER, vtype VT_TYPE); ...or... PROCEDURE SET_OLE
(obj OLEOBJ, memberid PLS_INTEGER
newval VARCHAR2, vtype VT_TYPE); ...or... PROCEDURE SET_OLE
(obj OLEOBJ, memberid PLS_INTEGER
newval OLEVAR, vtype VT_TYPE); Built-in Type unrestricted procedure Parameters
| obj
| A pointer to the OLE object.
|
| memberid
| The member ID of the OLE property.
|
| newval
| A new value of the specified type to replace the OLE property.
|
| The VT_TYPE of the original variant.
This is an optional parameter. If not specified, the default value for the NUMBER version of the procedure is VT_R8. For the VARCHAR2 version, the default is VT_BSTR. For the OLEVAR version, the default is VT_VARIANT: that is, whatever type the variant itself actually specifies . |
(list PARAMLIST,
key VARCHAR2,
paramtype NUMBER,
value VARCHAR2); SET_PARAMETER_ATTR
(name VARCHAR2,
key VARCHAR2,
paramtype NUMBER,
value VARCHAR2); Built-in Type unrestricted procedure Enter Query Mode yes Parameters list or name Specifies the parameter list. The actual parameter can be either a parameter list ID of type PARAMLIST, or the VARCHAR2 name of the parameter list. key The VARCHAR2 name of the parameter. paramtype Specifies the type of parameter you intend to pass: DATA_PARAMETER Indicates that the parameter's value is the name of a record group. TEXT_PARAMETER Indicates that the parameter's value is an actual data value.
- alue
(item_id VARCHAR2,
button_name VARCHAR2,
property NUMBER,
value NUMBER); SET_RADIO_BUTTON_PROPERTY
(item_id VARCHAR2,
button_name VARCHAR2,
property NUMBER,
x NUMBER,
y NUMBER);
SET_RADIO_BUTTON_PROPERTY
(item_name VARCHAR2,
button_name VARCHAR2,
property NUMBER,
x NUMBER,
y NUMBER);
SET_RADIO_BUTTON_PROPERTY
(item_name VARCHAR2,
button_name VARCHAR2,
property NUMBER,
value NUMBER); Built-in Type unrestricted procedure Enter Query Mode yes Parameters item_id Specifies the radio group item ID. Form Builder assigns the unique ID at the time it creates the object. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. item_name Specifies the name of the radio group. The radio group is the owner or parent of its subordinate radio buttons. The data type of the name is VARCHAR2. button_name Specifies the name of the radio button whose property you want to set. The data type of the name is VARCHAR2. property Specifies the property you want to set. The possible property constants you can set are as follows: BACKGROUND_COLOR The color of the object's background region. ENABLED Specify PROPERTY_TRUE constant if you want to enable the radio button. Specify PROPERTY_FALSE if you want to disable the radio button from operator control. FILL_PATTERN The pattern to be used for the object's fill region. Patterns are rendered in the two colors specified by Background Color and Foreground Color. FONT_NAME The font family, or typeface, that should be used for text in the object. The list of fonts available is system-dependent. FONT_SIZE The size of the font, specified in points. FONT_SPACING The width of the font, that is, the amount of space between characters (kerning). FONT_STYLE The style of the font. FONT_WEIGHT The weight of the font. FOREGROUND_COLOR The color of the object's foreground region. For items, the Foreground Color attribute defines the color of text displayed in the item. HEIGHT Specify the height of the given radio button. Specify the value as a number. ITEM_SIZE Sets the width and height of the given radio button. Use the syntax that shows an x,y coordinate pair and specify the values as numbers. LABEL Specify the actual string label for that radio button. POSITION Sets the position of the given radio button. Use the syntax that shows an x,y coordinate pair and specify the values as numbers. PROMPT_BACKGROUND_COLOR The color of the object's background region. PROMPT_FILL_PATTERN The pattern to be used for the object's fill region. Patterns are rendered in the two colors specified by Background Color and Foreground Color. PROMPT_FONT_NAME The font family, or typeface, that should be used for text in the object. The list of fonts available is system-dependent. PROMPT_FONT_SIZE The size of the font, specified in points. PROMPT_FONT_SPACING The width of the font, that is, the amount of space between characters (kerning). PROMPT_FONT_STYLE The style of the font. PROMPT_FONT_WEIGHT The weight of the font. PROMPT_FOREGROUND_COLOR The color of the object's foreground region. For items, the Foreground Color attribute defines the color of text displayed in the item. PROMPT_WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. VISIBLE Specify PROPERTY_TRUE constant if you want the radio button to be displayed. Specify PROPERTY_FALSE constant if you want the radio button to be hidden. VISUAL_ATTRIBUTE Specifies either a valid named visual attribute that exists in the current form, or the name of a logical attribute definition in a runtime resource file that you want Form Builder to apply to the radio button. WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. WIDTH Specify the width of the given radio button. Specify the value as a number. X_POS Specify the x-coordinate for the radio button. Specify the value as a number. Y_POS Specify the y-coordinate for the radio button. Specify the value as a number.
- alue
- Built-in: SET_RADIO_BUTTON_PROPERTY
** Example: Set a particular radio button to disabled.
*/
BEGIN
Set_Radio_Button_Property('MYBLOCK.FLIGHT_STATUS',
'GROUNDED',ENABLED,PROPERTY_FALSE);
END;
SET_RECORD_PROPERTY built-in
(record_number NUMBER,
block_name VARCHAR2,
property NUMBER,
value NUMBER); Built-in Type unrestricted procedure Enter Query Mode yes Parameters record_number Specifies the number of the record whose status you want to set. The record number is the record's position in the block. Specify as a whole number. block_name Specifies the name of the block in which the target record exists. The data type of the name is VARCHAR2. property Use the following property: STATUS Specifies that you intend to change the record status. STATUS is a constant.
- alue
| Current Status
| Target Status
|
|
|
|
|
| NEW
| QUERY
| INSERT
| CHANGED
|
| NEW
| yes
| yes1
| yes2
| no
|
| QUERY
| yes4
| yes
| no
| yes
|
| INSERT
| yes4
| yes3
| yes
| no
|
| CHANGED
| yes4
| no
| no
| yes
|
- Adheres to the rules described in footnotes 2 and 3.
- This transition is not allowed in query mode, because QUERY and INSERT are not valid in query mode.
- If this transition is performed while Runform is running in Unique Key mode and not all of the transactional triggers exist, then you must enter a valid value in the ROWID field. Put another way, if you are connected to a non-ORACLE data source that does not support ROWID, but you are using a unique key, you must supply the key for a record that goes from Insert to Query, in one of the transactional triggers, either On-Lock, On-Update, or On-Delete. Otherwise Form Builder returns an error.
- Records that have been changed but not yet committed or cleared cannot be
assigned a status of NEW.
SET_RECORD_PROPERTY examples
- Built-in: SET_RECORD_PROPERTY
** Example: Mark the third record in the EMP block as if it
** were a queried record.
*/
BEGIN
Set_Record_Property( 3, 'EMP', STATUS, QUERY_STATUS);
END;
SET_RELATION_PROPERTY built-in
(relation_id Relation,
property NUMBER,
value NUMBER); SET_RELATION_PROPERTY
(relation_name VARCHAR2,
property NUMBER,
value NUMBER); Built-in Type unrestricted procedure Enter Query Mode yes Parameters relation_id Specifies the unique ID that Form Builder assigns the relation when it creates the relation object. This can occur automatically when you define a master-detail relationship in the Form Builder, or you can explicitly create the relation. The data type of the ID is Relation. relation_name Specifies the name you or Form Builder gave the relation object when defining it. The data type of the name is VARCHAR2. property Use one of the following relation properties, which can be passed to the built-in as a constant: AUTOQUERY Specifies that the detail block of this relation is to be automatically coordinated upon instantiation of the block. This allows potentially expensive processing to be deferred until blocks that are involved in relations are actually visited. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. DEFERRED_COORDINATION Specifies that a block requiring coordination is to be marked but not coordinated until the detail blocks are instantiated. Deferred coordination refers only to the population phase of coordination. Even deferred detail blocks are cleared during the clear phase of coordination to present the form in a visually consistent state. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. MASTER_DELETES Specifies the default relation behavior for deletion of a detail record in the detail block when there is a corresponding master record in the master block. Valid values are NON-ISOLATED, ISOLATED, or CASCADING. The ability to set this property programmatically is included only for designers who are coding their own master-detail coordination. It does not alter a default relation that was created at design time. PREVENT_MASTERLESS_OPERATION Specifies that operations in a detail block are not allowed when no corresponding master record exists. Valid values are PROPERTY_TRUE and PROPERTY_FALSE.
- alue
- Built-in: SET_RELATION_PROPERTY
** Example: Set the coordination behavior of a relation to
** be deferred, and auto-query.
*/
PROCEDURE Make_Relation_Deferred( rl_name VARCHAR2 ) IS
rl_id Relation;
BEGIN
/*
** Look for the relation's ID
*/
rl_id := Find_Relation( rl_name );
/*
** Set the two required properties
*/
Set_Relation_Property(rl_id,AUTOQUERY,PROPERTY_TRUE);
END;
SET_REPORT_OBJECT_PROPERTY built-in
(report_id REPORT_OBJECT,
property NUMBER,
value VARCHAR2
); PROCEDURE SET_REPORT_OBJECT_PROPERTY
(report_name VARCHAR2,
property NUMBER,
value VARCHAR2
); PROCEDURE SET_REPORT_OBJECT_PROPERTY
(report_id REPORT_OBJECT,
property NUMBER,
value NUMBER
); PROCEDURE SET_REPORT_OBJECT_PROPERTY
(report_name VARCHAR2,
property NUMBER,
value NUMBER
); Built-in Type unrestricted procedure Enter Query Mode yes Parameters report_id Specifies the unique ID of the report. You can get the report ID for a particular report using FIND_REPORT_OBJECT . report_name Specifies the unique name of the report. property One of the following constants: REPORT_EXECUTION_MODE: The report execution mode, either BATCH or RUNTIME REPORT_COMM_MODE: The report communication mode, either SYNCHRONOUS or ASYNCHRONOUS REPORT_DESTYPE: The report destination type, either PREVIEW, FILE, PRINTER, MAIL, CACHE or SCREEN One of the following strings: REPORT_FILENAME: The report filename REPORT_SOURCE_BLOCK: The report source block name REPORT_QUERY_NAME: The report query name REPORT_DESNAME: The report destination name REPORT_DESFORMAT: The report destination format REPORT_SERVER: The report server name REPORT_OTHER: The other user-specified report properties
- alue
SET_REPORT_OBJECT_PROPERTY sets properties using constant or string values.
The value type depends on the particular property being set, as specified above.
In contrast, GET_REPORT_OBJECT_PROPERTY returns a string value for all properties.
(tab_page_id TAB_PAGE,
property NUMBER,
value NUMBER); SET_TAB_PAGE_PROPERTY
(tab_page_name VARCHAR2,
property NUMBER,
value NUMBER); Built-in Type unrestricted procedure Enter Query Mode yes Parameters tab_page_id The unique ID Form Builder assigns to the tab page when it creates it. Datatype is TAB_PAGE. tab_page_name The name you gave the tab page when you defined it. Datatype is VARCHAR2. property The property you want to set for the given tab page. Possible values are: BACKGROUND_COLOR The color of the object's background region. ENABLED Specify TRUE to enable the tab page, FALSE to disable it (i.e., make it greyed out and unavailable). FILL_PATTERN The pattern to be used for the object's fill region. Patterns are rendered in the two colors specified by Background Color and Foreground Color. FONT_NAME The font family, or typeface, that should be used for text in the object. The list of fonts available is system-dependent. FONT_SIZE The size of the font, specified in points. FONT_SPACING The width of the font, that is, the amount of space between characters (kerning). FONT_STYLE The style of the font. FONT_WEIGHT The weight of the font. FOREGROUND_COLOR The color of the object's foreground region. For items, the Foreground Color attribute defines the color of text displayed in the item. LABEL The character string for the tab page label. VISIBLE Specify TRUE to make the tab page visible, FALSE to make it not visible. A tab page is reported visible if it is currently mapped to the screen, even if it is entirely hidden behind another tab page. VISUAL_ATTRIBUTE Specifies the name of the visual attribute currently in force. WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background.
- alue
** ENABLED property to TRUE for a tab page (if it currently
** is set to FALSE:
*/
DECLARE
tb_pg_id TAB_PAGE;
BEGIN
tb_pg_id := FIND_TAB_PAGE('tab_page_1');
IF GET_TAB_PAGE_PROPERTY(tb_pg_id, enabled) = 'FALSE' THEN
SET_TAB_PAGE_PROPERTY(tb_pg_id, enabled, property_true);
END IF;
END;
(timer_id Timer,
milliseconds NUMBER,
iterate NUMBER); SET_TIMER
(timer_name VARCHAR2,
milliseconds NUMBER,
iterate NUMBER); Built-in Type unrestricted procedure Enter Query Mode yes Parameters timer_id Specifies the unique ID that Form Builder assigns when it creates the timer, specifically as a response to a successful call to the CREATE_TIMER built-in. Use the FIND_TIMER built-in to return the ID to an appropriately typed variable. The data type of the ID is Timer. timer_name Specifies the name you gave the timer when you defined it. The data type of the name is VARCHAR2. milliseconds Specifies the duration of the timer in milliseconds. The range of values allowed for this parameter is 1 to 2147483648 milliseconds. Values > 2147483648 will be rounded down to 2147483648. Note that only positive numbers are allowed. The data type of the parameter is NUMBER. See Restrictions below for more information. NO_CHANGE Specifies that the milliseconds property is to remain at its current setting. iterate Specifies the iteration of the timer. REPEAT Indicates that the timer should repeat upon expiration. Default. NO_REPEAT Indicates that the timer should not repeat upon expiration, but is to be used once only, until explicitly called again. NO_CHANGE Specifies that the iterate property is to remain at its current setting.
Values > 2147483648 will be rounded down to 2147483648.
A value less than 1 results in a runtime error.
A value greater than the stated upper bound results in an integer overflow.
Milliseconds cannot be expressed as a negative number.
No two timers can share the same name in the same form instance, regardless of
case.
If there is no When-Timer-Expired trigger defined at the execution of a timer,
Form Builder returns an error.
If there is no When-Timer-Expired trigger defined at the execution of a timer,
and the timer is a repeating timer, subsequent repetitions are canceled, but
the timer is retained.
| item_name
| Specifies the name of the object created at design time. The data type of the
name is VARCHAR2 string.
|
| Item_id
| Specifies the unique ID that Form Builder assigns to the item when created.
Use the FIND_ITEM built-in to return the ID to an appropriately typed variable.
The data type of the ID is ITEM.
|
| node
| Specifies a valid node.
|
| property
| Specify one of the following properties:
NODE_STATE Possible values are EXPANDED_NODE, COLLAPSED_NODE, and LEAF_NODE. NODE_LABEL Sets the label of the node. NODE_ICON Sets the icon of the node. NODE_VALUE Sets the value of the node. |
| The actual value you intend to pass.
|
- Built-in: SET_TREE_NODE_PROPERTY
*/
| item_name
| Specifies the name of the object created at design time. The data type of the
name is VARCHAR2 string.
|
| Item_id
| Specifies the unique ID that Form Builder assigns to the item when created.
Use the FIND_ITEM built-in to return the ID to an appropriately typed variable.
The data type of the ID is ITEM.
|
| property
| Specify one of the following properties:
RECORD_GROUP Replaces the data set of the hierarchical tree with a record group and causes it to display. QUERY_TEXT Replaces the data set of the hierarchical tree with an SQL query and causes it to display. ALLOW_EMPTY_BRANCHES Possible values are PROPERTY_TRUE and PROPERTY_FALSE. |
| Specify the value appropriate to the property you are setting:
PROPERTY_TRUE The property is to be set to the TRUE state. PROPERTY_FALSE The property is to be set to the FALSE state. |
- Built-in: SET_TREE_PROPERTY
*/
| item_name
| Specifies the name of the object created at design time. The data type of the
name is VARCHAR2 string.
|
| Item_id
| Specifies the unique ID that Form Builder assigns to the item when created.
Use the FIND_ITEM built-in to return the ID to an appropriately typed variable.
The data type of the ID is ITEM.
|
| node
| Specifies a valid node.
|
| selection_type
| Specifies the type of selection.
SELECT_ON Selects the node. SELECT_OFF Deselects the node. SELECT_TOGGLE Toggles the selection state of the node. |
- Built-in: SET_TREE_SELECTION
*/
| The unique ID Form Builder assinged to the visual attribute when you created
it. The data type is VISUALATTRIBUTE.
|
| The name you gave the visual attribute when you created it. The data type is
VARCHAR2.
|
Property
| Specify one of the following properties:
BACKGROUND_COLOR The color of the object's background region. FILL_PATTERN The pattern to be used for the object's fill region. Patterns are rendered in the two colors specified by Background Color and Foreground Color. FONT_NAME The font family, or typeface, that should be used for text in the object. The list of fonts available is system-dependent. FONT_SIZE The size of the font, specified in hundreds of points. FONT_SPACING The width of the font, that is, the amount of space between characters (kerning). FONT_STYLE The style of the font. FONT_WEIGHT The weight of the font. FOREGROUND_COLOR The color of the object's foreground region. For items, the Foreground Color attribute defines the color of text displayed in the item. WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. Specify the value to be applied to the given property. The data type of the property determines the data type of the value you enter. For instance, if you want to set the WHITE_ON_BLACK property to true, specify the constant PROPERTY_TRUE for the value. If you want to change the FONT_NAME for the item, specify the value, in other words, the label, as a VARCHAR2 string. PROPERTY_TRUE Specifies that the property is to be set to the TRUE state. PROPERTY_FALSE Specifies that the property is to be set to the FALSE state. If you want to reset the value of the property to be the value originally established for it at design time, enter two single quotes with no space between: ''. For example, SET_ITEM_PROPERTY('DEPTNO', FONT_SIZE, ''); would reset that format size to its design-time value. |
(var OLEVAR, newval CHAR
vtype VT_TYPE, arrspec VARCHAR2); ...or... PROCEDURE SET_VAR
(var OLEVAR, newval NUMBER
vtype VT_TYPE, arrspec VARCHAR2); ...or... PROCEDURE SET_VAR
(var OLEVAR, newval OLEVAR
vtype VT_TYPE, arrspec VARCHAR2); ...or... PROCEDURE SET_VAR
(var OLEVAR, source_table,
vtype VT_TYPE, arrspec VARCHAR2); Built-in Type unrestricted procedure Parameters
| The variant to be set.
|
| newval
| The value to be given to the variant.
|
| The OLE VT_TYPE to be given to the variant.
This is an optional parameter. If not specified, the default value for the NUMBER version of the procedure is VT_R8. For the VARCHAR2 version, the default is VT_BSTR. For the OLEVAR version, the default is VT_VARIANT: that is, whatever type the variant value actually specifies . |
| source_table
| A PL/SQL table whose dimensions and element values are to be given to the
variant.
|
| arrspec
| Indicates which selected element or elements of the source table are to be
used in the creation of the new variant. For more information, see Specifiers for OLE Arrays
This is an optional parameter. If not specified, the entire source table is used.. |
(view_id ViewPort,
property NUMBER,
value NUMBER); SET_VIEW_PROPERTY
(view_id ViewPort,
property NUMBER,
x NUMBER,
y NUMBER);
SET_VIEW_PROPERTY
(view_name VARCHAR2,
property NUMBER,
value NUMBER);
SET_VIEW_PROPERTY
(view_name ViewPort,
property NUMBER,
x NUMBER,
y NUMBER); Built-in Type unrestricted procedure Enter Query Mode yes Parameters
- iew_id
- alue
(window_id Window,
property NUMBER,
value NUMBER); SET_WINDOW_PROPERTY
(window_id Window,
property NUMBER,
x NUMBER);
SET_WINDOW_PROPERTY
(window_id Window,
property NUMBER,
x NUMBER,
y NUMBER);
SET_WINDOW_PROPERTY
(window_name VARCHAR2,
property NUMBER,
value NUMBER);
SET_WINDOW_PROPERTY
(window_name VARCHAR2,
property NUMBER,
x NUMBER);
SET_WINDOW_PROPERTY
(window_name VARCHAR2,
property NUMBER,
x NUMBER,
y NUMBER); Built-in Type unrestricted procedure Enter Query Mode yes Parameters window_id Specifies the unique ID that Form Builder assigns the window when created. Use the FIND_WINDOW built-in to return the ID to an appropriately typed variable. The data type of the ID is Window. window_name Specifies the name that you gave the window when creating it. The data type of the name is VARCHAR2. property Specify one of the following window properties: BACKGROUND_COLOR The color of the object's background region. DIRECTION Specifies the layout direction for bidirectional objects. Valid values are DIRECTION_DEFAULT, RIGHT_TO_LEFT, LEFT_TO_RIGHT. FILL_PATTERN The pattern to be used for the object's fill region. Patterns are rendered in the two colors specified by Background Color and Foreground Color. FONT_NAME The font family, or typeface, that should be used for text in the object. The list of fonts available is system-dependent. FONT_SIZE The size of the font, specified in points. FONT_SPACING The width of the font, that is, the amount of space between characters (kerning). FONT_STYLE The style of the font. FONT_WEIGHT The weight of the font. FOREGROUND_COLOR The color of the object's foreground region. For items, the Foreground Color attribute defines the color of text displayed in the item. HEIGHT Specifies the height of the window. HIDE_ON_EXIT Specifies whether Form Builder hides the current window automatically when the operator navigates to an item in another window. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. POSITION Specifies an x, y pair indicating the location for the window on the screen. TITLE Sets the title of the window. VISIBLE Specifies whether the window is to be displayed. Valid values are PROPERTY_TRUE and PROPERTY_FALSE. WHITE_ON_BLACK Specifies that the object is to appear on a monochrome bitmap display device as white text on a black background. WINDOW_SIZE Specifies a width, height pair indicating the size of the window on the screen. WINDOW_STATE Specifies the current display state of the window. Valid values are NORMAL, MAXIMIZE, or MINIMIZE. WIDTH Specifies the width of the window. X_POS Sets the x coordinate for the window's upper left corner on the screen. Y_POS Sets the y coordinate for the window's upper left corner on the screen.
- alue
TITLE
POSITION
WIDTH, HEIGHT
WINDOW_SIZE
WINDOW_STATE
X_POS, Y_POS
To reference the MDI application window in a call to SET_WINDOW_PROPERTY, use
the constant FORMS_MDI_WINDOW:
Set_Window_Property(FORMS_MDI_WINDOW, POSITION, 5,10)
Set_Window_Property(FORMS_MDI_WINDOW, WINDOW_STATE, MINIMIZE)
If you change the size or position of a window, the change remains in effect
for as long as the form is running, or until you explicitly change the window's
size or position again. Closing the window and reopening it does not reset the
window to its design-time defaults. You must assign the design-time defaults
to variables if you intend to set the window back to those defaults.
(alert_id Alert); SHOW_ALERT
(alert_name VARCHAR2); Built-in Type unrestricted function Returns A numeric constant corresponding to the button the operator selected from the alert. Button mappings are specified in the alert design.
| If the operator selects...
| Form Builder returns
|
| Button 1
| ALERT_BUTTON1
|
| Button 2
| ALERT_BUTTON2
|
| Button 3
| ALERT_BUTTON3
|
(editor_id Editor,
message_in VARCHAR2,
message_out VARCHAR2,
result BOOLKAN); SHOW_EDITOR
(editor_id Editor,
message_in VARCHAR2,
x NUMBER,
y NUMBER,
message_out VARCHAR2,
result BOOLEAN);
SHOW_EDITOR
(editor_name VARCHAR2,
message_in VARCHAR2,
message_out VARCHAR2,
result BOOLEAN);
SHOW_EDITOR
(editor_name VARCHAR2,
message_in VARCHAR2,
x NUMBER,
y NUMBER,
message_out VARCHAR2,
result BOOLEAN); Built-in Type unrestricted procedure that returns two OUT parameters (result and message_out) Enter Query Mode yes Parameters editor_id Specifies the unique ID that Form Builder assigns when it creates the editor. Use the FIND_EDITOR built-in to return the ID to a variable of the appropriate data type. The data type of the ID is Editor. editor_name Specifies the name you gave to the editor when you defined it. The data type of the name is VARCHAR2. message_i Specifies a required IN parameter of VARCHAR2 data type. The value passed to this parameter can be NULL. You can also reference a text item or variable. x Specifies the x coordinate of the editor. Supply a whole number for this argument. y Specifies the y coordinate of the editor. Supply a whole number for this argument. message_out Specifies a required OUT parameter of VARCHAR2 data type. You can also reference a text item or variable. If the operator cancels the editor, result is FALSE and message_out is NULL. result Specifies a required OUT parameter of BOOLEAN data type. If the operator accepts the editor, result is TRUE. If the operator cancels the editor, result is FALSE and message_out is NULL.
Message_out should be at least as long as message_in, because the length of the variable or text item specified for message_out determines the maximum number of characters the editor can accept.
The message_in parameter values are always converted to VARCHAR2 by Form Builder when passed
to the editor. However, if you are passing message_out to something other than a VARCHAR2 type object, you must first perform the
conversion by passing the value to a variable and then perform type conversion on
that variable with PL/SQL functions TO_DATE or TO_NUMBER.
The Width must be at least wide enough to display the buttons at the bottom of
the editor window.
- Built-in: SHOW_EDITOR
** Example: Accept input from the operator in a user-defined
** editor. Use the system editor if the user has
** checked the "System_Editor" menu item under the
** "Preferences" menu in our custom menu module.
*/
DECLARE
ed_id Editor;
mi_id MenuItem;
ed_name VARCHAR2(40);
val VARCHAR2(32000);
ed_ok BOOLEAN;
BEGIN
mi_id := Find_Menu_Item('PREFERENCES.SYSTEM_EDITOR');
IF Get_Menu_Item_Property(mi_id,CHECKED) = 'TRUE' THEN
ed_name := 'system_editor';
ELSE
ed_name := 'my_editor1';
END IF;
ed_id := Find_Editor( ed_name );
/*
** Show the appropriate editor at position (10,14) on the
** screen. Pass the contents of the :emp.comments item
** into the editor and reassign the edited contents if
** 'ed_ok' returns boolean TRUE.
*/
val := :emp.comments;
Show_Editor( ed_id, val, 10,14, val, ed_ok);
IF ed_ok THEN
:emp.comments := val;
END IF;
END;
SHOW_KEYS built-in
- Built-in: SHOW_KEYS
** Example: Display valid function key bindings
*/
BEGIN
Show_Keys;
END;
SHOW_LOV built-in
(lov_id LOV); SHOW_LOV
(lov_id LOV,
x NUMBER,
y NUMBER);
SHOW_LOV
(lov_name VARCHAR2);
SHOW_LOV
(lov_name VARCHAR2,
x NUMBER,
y NUMBER); Built-in Type unrestricted function Returns BOOLEAN Enter Query Mode yes Parameters lov_id Specifies the unique ID that Form Builder assigns the LOV when created. Use the FIND_LOV built-in to return the ID to an appropriately typed variable. The data type of the ID is LOV. lov_name The name you gave to the LOV when you defined it. The data type of the name is VARCHAR2. x Specifies the x coordinate of the LOV. y Specifies the y coordinate of the LOV. Usage Notes When SHOW_LOV is used to display an LOV, Form Builder ignores the LOV's Automatic Skip property. If you want to move the cursor to the next navigable item, use the LIST_VALUES built-in.
- Built-in: SHOW_LOV
** Example: Display a named List of Values (LOV)
*/
DECLARE
a_value_chosen BOOLEAN;
BEGIN
a_value_chosen := Show_Lov('my_employee_status_lov');
IF NOT a_value_chosen THEN
Message('You have not selected a value.');
Bell;
RAISE Form_Trigger_Failure;
END IF;
END;
SHOW_MENU built-in
- Built-in: SHOW_MENU
** Example: Display the menu if no canvas overlays it.
*/
BEGIN
Show_Menu;
END;
SHOW_VIEW built-in
(view_id ViewPort); SHOW_VIEW
(view_name VARCHAR2); Built-in Type unrestricted procedure Enter Query Mode yes Parameters
- iew_id
- Built-in: SHOW_VIEW
** Example: Programmatically display a view in the window to
** which it was assigned at design time.
*/
BEGIN
Show_View('My_Stacked_Overlay');
END;
SHOW_WINDOW built-in
(window_id Window); SHOW_WINDOW
(window_id Window,
x NUMBER,
y NUMBER);
SHOW_WINDOW
(window_name VARCHAR2);
SHOW_WINDOW
(window_name VARCHAR2,
x NUMBER,
y NUMBER); Built-in Type unrestricted procedure Enter Query Mode yes Parameters window_id Specifies the unique ID that Form Builder assigns the window when created. Use the FIND_WINDOW built-in to return the ID to an appropriately typed variable. The data type of the ID is Window. window_name Specifies the name that you gave the window when defining it. The data type of the name is VARCHAR2. x Specifies the x coordinate of the window. Supply a whole number for this argument. y Specifies the y coordinate of the window. Specify this value as a whole NUMBER.
- Built-in: SHOW_WINDOW
** Example: Override the default (x,y) coordinates for a
** windows location while showing it.
*/
BEGIN
Show_Window('online_help',20,5);
END;
SYNCHRONIZE built-in
Form Builder is at the item level in the forms hierarchy (i.e.,
SYSTEM.CURRENT_ITEM is not NULL).
- Built-in: SYNCHRONIZE
** Example: Achieve an odometer effect by updating the
** screen as an items value changes quickly.
** Without synchronize, the screen is typically
** only updated when Form Builder completes all trigger
** execution and comes back for user input.
*/
BEGIN
FOR j IN 1..1000 LOOP
:control.units_processed := j;
SYNCHRONIZE;
Process_Element(j);
END LOOP;
END;
TERMINATE built-in
(newval NUMBER,
vtype VT_TYPE
persistence BOOLEAN)
RETURN newvar OLEVAR; ...or... FUNCTION TO_VARIANT
(newval VARCHAR2,
vtype VT_TYPE
persistence BOOLEAN)
RETURN newvar OLEVAR; ...or... FUNCTION TO_VARIANT
(source_table,
vtype VT_TYPE
arrspec VARCHAR2, persistence BOOLEAN)
RETURN newvar OLEVAR; ...or... FUNCTION TO_VARIANT
(var OLEVAR,
vtype VT_TYPE
arrspec VARCHAR2, persistence BOOLEAN)
RETURN newvar OLEVAR; Built-in Type unrestricted function Returns the newly-created OLE variant. Parameters
| newval
| The value to be given to the newly-created OLE variant.
|
| The OLE VT_TYPE to be given to the newly-created variant.
This is an optional parameter. If not specified, the default value for the NUMBER version of the function is VT_R8. For the VARCHAR2 version, the default is VT_BSTR. For the table version, the default is determined from the PL/SQL types of the table For the OLEVAR version, the default is the type of the source variant. |
| persistence
| Controls the persistence of the variant after its creation. A boolean value
of TRUE establishes the variant as persistent; a value of FALSE establishes the
variant as non-persistent.
This is an optional parameter. If not specified, the default value is non-persistent. |
| source_table
| An existing PL/SQL table that is used to establish the bounds and values of
the newly-created variant table. The source table can be of any type.
|
| arrspec
| Indicates which selected element or elements of a source table are to be used
in the creation of the new variant. The lower bound always starts at 1. For
more information, see Specifiers for OLE Arrays.
This is an optional parameter. If not specified, the entire source table or source variant is used. |
| An existing OLE variant whose value is to be given to the new variant. (This
source variant may be a table.)
|
- This function first creates an empty variant and then gives it a value. It offers a combined version of the CREATE_VAR and SET_VAR operations.
- This TO_VARIANT function can also be thought of as the inverse version of the VAR_TO_* function.
- Note that the OLEVAR version of this function differs from the NUMBER,
VARCHAR2, and table versions in that it uses an existing OLE variant as the source,
rather than a PL/SQL equivalent value.
UNSET_GROUP_SELECTION built-in
(recordgroup_id RecordGroup,
row_number NUMBER); UNSET_GROUP_SELECTION
(recordgroup_name VARCHAR2,
row_number NUMBER); Built-in Type unrestricted procedure Enter Query Mode yes Description Unmarks the specified row in the indicated record group. Use the procedure to unmark rows that have been programmatically selected by a previous call to SET_GROUP_SELECTION. Rows are numbered sequentially starting at 1. If you select rows 3, 8, and 12, for example, those rows are considered by Form Builder to be selections 1, 2, and 3. You can undo any row selections for the entire group by calling the RESET_GROUP_SELECTION built-in. Parameters recordgroup_id Specifies the unique ID that Form Builder assigns to the record group when created. Use the FIND_GROUP built-in to return the ID to a variable. The data type of the ID is RecordGroup. recordgroup_name Specifies the name of the record group that you gave to the group when creating it. The data type of the name is VARCHAR2. row_number Specifies the number of the record group row that you want to select. The value you specify is a NUMBER.
- Built-in: UNSET_GROUP_SELECTION
** Example: Clear all of the even rows as selected in the
** record group whose id is passed-in as a
** parameter.
*/
PROCEDURE Clear_Even_Rows ( rg_id RecordGroup ) IS
BEGIN
FOR j IN 1..Get_Group_Row_Count(rg_id) LOOP
IF MOD(j,2)=0 THEN
Unset_Group_Selection( rg_id, j );
END IF;
END LOOP;
END;
UP built-in
(chart_name VARCHAR2,
param_list_id TOOLS.PARAMLIST
); PROCEDURE UPDATE_CHART
(chart_name VARCHAR2,
param_list_name VARCHAR2
); PROCEDURE UPDATE_CHART
(chart_id FORMS4C.ITEM,
param_list_id TOOLS.PARAMLIST
); PROCEDURE UPDATE_CHART
(chart_id FORMS4C.ITEM,
param_list_name VARCHAR2
); PROCEDURE UPDATE_CHART
(chart_id FORMS4C.ITEM
); PROCEDURE UPDATE_CHART
(chart_name VARCHAR2
); Built-in Type unrestricted procedure Enter Query Mode yes Parameters chart_id Specifies the unique ID of the chart. chart_name Specifies the unique name of the chart. param_list_id Specifies the unique ID of the chart parameter list. param_list_name Specifies the unique name of the chart parameter list.
(user_exit_string VARCHAR2); USER_EXIT
(user_exit_string VARCHAR2,
error_string VARCHAR2); Built-in Type unrestricted procedure Enter Query Mode yes Parameters user_exit_string Specifies the name of the user exit you want to call, including any parameters. error_string Specifies a user-defined error message that Form Builder should display if the user exit fails.
- Built-in: USER_EXIT
** Example: Invoke a 3GL program by name which has been
** properly linked into your current Form Builder
** executable. The user exit subprogram must parse
** the string argument it is passed to decide what
** functionality to perform.
*/
PROCEDURE Command_Robotic_Arm( cmd_string VARCHAR2 ) IS
BEGIN
/*
** Call a C function 'RobotLnk' to initialize the
** communication card before sending the robot a message.
*/
User_Exit('RobotLnk INITIALIZE Unit=6,CmdToFollow=1');
IF NOT Form_Success THEN
Message('Failed to initialize Robot 6');
RAISE Form_Trigger_Failure;
END IF;
/*
** Pass the string argument as a command to the robot
*/
User_Exit('RobotLnk SEND Unit=6,Msg='||cmd_string );
IF NOT Form_Success THEN
Message('Command not understood by Robot 6');
RAISE Form_Trigger_Failure;
END IF;
/*
** Close the robot's communication channel
*/
User_Exit('RobotLnk DEACTIVATE Unit=6');
IF NOT Form_Success THEN
Message('Failed to Deactivate Robot');
RAISE Form_Trigger_Failure;
END IF;
/*
** The user exit will deposit a timing code into the item
** called 'CONTROL.ROBOT_STATUS'.
*/
Message('Command Successfully Completed by Robot 6'||
' in '||TO_CHAR(:control.robot_timing)||
' seconds.');
END;
VALIDATE built-in
(validation_scope NUMBER); Built-in Type: unrestricted procedure Enter Query Mode yes Parameters
- alidation scope
- Built-in: VALIDATE
** Example: Deposits the primary key value, which the user
** has typed, into a global variable, and then
** validates the current block.
** Trigger: When-New-Item-Instance
*/
BEGIN
IF :Emp.Empno IS NOT NULL THEN
:Global.Employee_Id := :Emp.Empno;
Validate(block_scope);
IF NOT Form_Success THEN
RAISE Form_Trigger_Failure;
END IF;
Execute_Query;
END IF;
END;
VARPTR_TO_VAR
(variant OLEVAR, vtype VT_TYPE)
RETURN changed OLEVAR; Built-in Type unrestricted function Returns the transformed variant. Parameters
| The OLE variant pointer to be changed into a variant.
|
| The OLE VT_TYPE to be given to the transformed variant.
This is an optional parameter. If not specified, the default value is VT_VARIANT. |
- This function removes VT_BYREF typing from the variant.
- If the variant's type was not VT_BYREF, the variant is assumed to hold an address to the type specified in the vtype, and is de-referenced accordingly.
- If the pointer was NULL or the variant was of type VT_NULL, then VT_EMPTY is
returned.
VAR_TO_TABLE
(var OLEVAR,
target_table,
arrspec VARCHAR2); Built-in Type unrestricted procedure Parameters
| The OLE variant that is the source array.
|
| target_table
| The PL/SQL table to be populated.
|
| arrspec
| Indicates which rows, columns, or elements of the source array are to be used.
See Specifiers for OLE Arrays for more information.
This is an optional parameter. If not specified, all elements in the source array are used. |
(var OLEVAR, arrspec VARCHAR2)
RETURN retval VARCHAR2; ...or... FUNCTION VAR_TO_NUMBER
(var OLEVAR, arrspec VARCHAR2)
RETURN retval NUMBER; ...or... FUNCTION VAR_TO_OBJ
(var OLEVAR, arrspec VARCHAR2)
RETURN retval OLEOBJ; Built-in Type unrestricted function Returns The variant with its value changed into an equivalent PL/SQL-type. Note that the type of the return depends on the version of the function chosen. Parameters
| The OLE variant to be read.
|
| arrspec
| This parameter is used only if the OLE variant is an array. It indicates
which element of the array is to be read and returned.
See Specifiers for OLE Arrays for more information. |
- To return a table, use the procedure VAR_TO_TABLE .
- In the VAR_TO_OBJ version of this function, the returned object is local
(non-persistent).
VAR_TO_VARPTR
(variant OLEVAR, vtype VT_TYPE)
RETURN newpointer OLEVAR; Built-in Type unrestricted function Returns the created variant Parameters
| The existing OLE variant to be pointed to.
|
| The type to be assigned to the created OLE variant.
Permissible types are VT_BYREF, VT_PTR, and VT_NULL. This is an optional parameter. If not specified, the default value is VT_BYREF. |
- If the variant to be pointed to is of type VT_EMPTY, then the created pointer will be of type VT_NULL, regardless of the vtype specification in the function.
- If vtype is specified as VT_BYREF, or defaults to VT_BYREF, then the created pointer will be of type VT_BYREF plus the source variant's type.
- If the vtype does not have a VT_BYREF in it, then the created pointer will be
of type VT_PTR, and it will point to the content within the variant.
VBX.FIRE_EVENT
(item_id ITEM,
event_name VARCHAR2,
paramlist_id PARAMLIST); VBX.FIRE_EVENT
(item_id ITEM,
event_name VARCHAR2,
paramlist_name VARCHAR2);
VBX.FIRE_EVENT
(item_name VARCHAR2,
event_name VARCHAR2,
paramlist_id PARAMLIST);
VBX.FIRE_EVENT
(item_name VARCHAR2,
event_name VARCHAR2,
paramlist_name VARCHAR2); Built-in Type unrestricted procedure Enter Query Mode yes Parameters item_id Specifies the unique ID that Form Builder assigns to the item when created. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. The data type of the ID is ITEM. item_name Specifies the name of the object created at design time. The data type of the name is VARCHAR2 string. event_name Specifies the name of a VBX event sent to the VBX control. The data type of the name is VARCHAR2 string. paramlist_id Specifies the unique ID Form Builder assigns when a parameter list is created. The data type of the ID is PARAMLIST. paramlist_name The name you give the parameter list object when it is defined. The data type of the name is VARCHAR2 string.
- Built-in: VBX.FIRE_EVENT
** Example: The VBX.FIRE_EVENT built-in triggers a SpinDown
** event for the SpinButton VBX control.
** Trigger: When-Button-Pressed
*/
DECLARE
ItemName VARCHAR2(40) := 'SPINBUTTON';
PL_ID PARAMLIST;
PL_NAME VARCHAR2(20) := 'EName';
BEGIN
PL_ID := Get_Parameter_List(PL_NAME);
IF id_null(PL_ID) THEN
PL_ID := Create_Parameter_List(PL_NAME);
END IF;
VBX.FIRE_EVENT(ItemName,'SpinDown',PL_ID);
END;
VBX.GET_PROPERTY
(item_id ITEM,
property VARCHAR2); VBX.GET_PROPERTY
(item_name VARCHAR2,
property VARCHAR2); Built-in Type unrestricted function Returns VARCHAR2 Enter Query Mode yes Parameters item_id Specifies the unique ID that Form Builder assigns to the item when created. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. The data type of the ID is ITEM. item_name Specifies the name of the object created at design time. The data type of the name is VARCHAR2 string. property Specifies a property or an element of a property array for a VBX control. A set of VBX properties exists for any given VBX control. Examples of VBX properties are Width, Height, and FontSize. The data type of property is a VARCHAR2 string.
- Built-in: VBX.GET_PROPERTY
** Example: Uses the VBX.GET_PROPERTY built-in to obtain the
** CURRTAB property of the VBX item named TABCONTROL.
** The property value of CURRTAB is returned to the
** TabNumber variable and is used as input in the
** user-defined Goto_Tab_Page subprogram.
** Trigger: When-Custom-Item-Event
*/
DECLARE
TabEvent varchar2(80);
TabNumber char;
BEGIN
TabEvent := :system.custom_item_event;
IF (UPPER(TabEvent) = 'CLICK') then
TabNumber := VBX.Get_Property('TABCONTROL','CurrTab');
Goto_Tab_Page(TO_NUMBER(TabNumber));
END IF;
END;
VBX.GET_VALUE_PROPERTY
(item_id ITEM); VBX.GET_VALUE_PROPERTY
(item_name VARCHAR2); Built-in Type unrestricted function Returns property Enter Query Mode yes Parameters item_id Specifies the unique ID that Form Builder assigns to the item when created. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. The data type of the ID is ITEM. item_name Specifies the name of the object created at design time. The data type of the name is VARCHAR2 string.
- Built-in: VBX.GET_VALUE_PROPERTY
** Example: Passes the VBX Control Value to the user-defined
** Verify_Item_Value subprogram. Verify_Item_Value
** ensures the display value is the expected value.
*/
DECLARE
ItemName VARCHAR2(40) := 'SPINBUTTON';
VBX_VAL_PROP VARCHAR2(40);
BEGIN
VBX_VAL_PROP := VBX.Get_Value_Property(ItemName);
Verify_Item_Value(VBX_VAL_PROP);
END;
VBX.INVOKE_METHOD
- Built-in: VBX.INVOKE_METHOD_PROPERTY
** Example: Adds an entry to a combobox. The entry to
** add to the combobox is the first optional argument.
** The position where the entry appears is the second
** optional argument.
*/
DECLARE
ItemName VARCHAR2(40) := 'COMBOBOX';
BEGIN
VBX.Invoke_Method(ItemName,'ADDITEM','blue','2');
END;
VBX.SET_PROPERTY
(item_id ITEM,
property VARCHAR2,
value VARCHAR2); VBX.SET_PROPERTY
(item_name VARCHAR2,
property VARCHAR2,
value VARCHAR2); Built-in Type: unrestricted procedure Enter Query Mode yes Parameters item_id Specifies the unique ID that Form Builder assigns to the item when created. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. The data type of the ID is ITEM. item_name Specifies the name of the object created at design time. The data type of the name is VARCHAR2 string. property Specifies a property or an element of a property array for a VBX control. A set of VBX properties exists for any given VBX control. Examples of VBX properties are Width, Height, and FontSize. The data type of property is a VARCHAR2 string.
- alue
- Built-in: VBX.SET_PROPERTY
** Example: Uses the VBX.SET_PROPERTY built-in to set the Index
** property of the SpinButton VBX control.
** Trigger: When-Button-Pressed
*/
DECLARE
ItemName VARCHAR2(40) := 'SPINBUTTON';
VBX_VAL_PROP VARCHAR2(40);
VBX_VAL VARCHAR2(40);
BEGIN
IF :System.Custom_Item_Event = 'SpinDown' THEN
VBX_VAL_PROP := 'Index';
VBX_VAL := '5';
VBX.Set_Property(ItemName,VBX_VAL_PROP,VBX_VAL);
END IF;
END;
VBX.SET_VALUE_PROPERTY
(item_id ITEM,
property VARCHAR2); VBX.SET_VALUE_PROPERTY
(item_name VARCHAR2,
property VARCHAR2); Built-in Type unrestricted procedure Enter Query Mode yes Parameters item_id Specifies the unique ID that Form Builder assigns to the item when created. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. The data type of the ID is ITEM. item_name Specifies the name of the object created at design time. The data type of the name is VARCHAR2 string. property Specifies a property for the Form Builder VBX Control Value Property. A set of VBX properties exists for any given VBX control. Examples of VBX properties are Width, Height, and FontSize. The data type of property is a VARCHAR2 string.
- Built-in: VBX.SET_VALUE_PROPERTY
** Example: Uses the VBX.SET_VALUE_PROPERTY built-in to set the
** VBX Control Value property.
*/
DECLARE
ItemName VARCHAR2(40) := 'SPINBUTTON';
VBX_VAL_PROP VARCHAR2(40);
BEGIN
IF :System.Custom_Item_Event = 'SpinDown' THEN
VBX_VAL_PROP := 'Index';
VBX.Set_Value_Property(ItemName,VBX_VAL_PROP);
END IF;
END;
WEB.SHOW_DOCUMENT
- Built-in: WEB.SHOW_DOCUMENT
** Example: Display the specified URL in the target window.
*/
BEGIN
Web.Show_Document(‘www.abc.com’, ‘_self’);
END;
WHERE_DISPLAY built-in
(file_name VARCHAR2,
file_type VARCHAR2,
item_id ITEM,
compression_quality NUMBER,
image_depth NUMBER); WRITE_IMAGE_FILE
(file_name VARCHAR2,
file_type VARCHAR2,
item_name VARCHAR2,
compression_quality NUMBER,
image_depth NUMBER); Built-in Type unrestricted procedure Enter Query Mode yes Parameters file_name The name of the file where the image is stored. The file name must adhere to your operating system requirements. file_type The file type of the image: BMP, CALS, GIF, JFIF, PICT, RAS, TIFF, or TPIC. The parameter takes a VARCHAR2 argument. item_id The unique ID Form Builder assigned to the image item when you created it. Use the FIND_ITEM built-in to return the ID to an appropriately typed variable. Datatype is ITEM. item_name The name you gave the image item when you defined it. Datatype is VARCHAR2. compression_quality The degree of compression Form Builder will apply to the image when it stores it to the file (optional). Datatype is VARCHAR2. Valid values are:NO_COMPRESSIONMINIMIZE_COMPRESSIONLOW_COMPRESSIONMEDIUM_COMPRESSIONHIGH_COMPRESSIONMAXIMIZE_COMPRESSION image_depth The degree of depth Form Builder will apply to the image when it stores it to the file (optional). Datatype is VARCHAR2. Valid values are:ORIGINAL_DEPTHMONOCHROMEGRAYSCALELUT (Lookup Table)RGB (Red, Green, Blue)
The indicated file type must be compatible with the actual file type of the
image.
As with any file, if you write the image to an existing file, you overwrite
the contents of that file with the contents of the image item.
Though you can read PCD and PCX files from the filesystem or the database, you
cannot write image files to the filesystem in PCD or PCX format (using
WRITE_IMAGE_FILE). (If you use a restricted file type when writing images to the
filesystem, Form Builder defaults the image file to TIFF format.)
Writing a JPEG file from a Form Builder image item will result in loss of
resolution.
-
** Save the contents of an image item out to a file
** on the filesystem in a supported image format.
*/
BEGIN
WRITE_IMAGE_FILE('output.tif',
'TIFF',
'emp.photo_image_data',
maximize_compression,
original_depth);
END;
WRITE_SOUND_FILE built-in
file_type VARCHAR2,
item_id ITEM,
compression NUMBER,
sound_quality NUMBER,
channels NUMBER); WRITE_SOUND_FILE(file_name VARCHAR2,
file_type VARCHAR2,
item_name VARCHAR2,
compression NUMBER,
sound_quality NUMBER,
channels NUMBER); Built-in Type unrestricted Enter Query Mode Yes Parameters: file_name The fully-qualified file name of the file to which you wish to write sound data. file_type The file type for the sound data file. Valid values are: AU, AIFF, AIFF-C, and WAVE. Note: File type is optional, but should be specified if known for increased performance. If omitted, Form Builder applies a default file type: WAVE (Microsoft Windows), AIFF-C (Macintosh), or AU (all others). item_id The unique ID Form Builder gave the sound item when you created it. item_name The name you gave the sound item when you created it. compression Whether the sound data should be compressed before Form Builder writes the data to the file. Possible values are COMPRESSION_ON, COMPRESSION_OFF, and ORIGINAL_SETTING (retain the default compression setting of the data). Compression is optional: the default value, if omitted, is ORIGINAL_SETTING. sound_quality The quality of data sampling rate and depth for the sound data. Possible values are: HIGHEST_SOUND_QUALITY, HIGH_SOUND_QUALITY, MEDIUM_SOUND_QUALITY, LOW_SOUND_QUALITY, LOWEST_SOUND_QUALITY, and ORIGINAL_QUALITY. Sound quality is optional: the default value, if omitted, is ORIGINAL_QUALITY. channels Whether Form Builder should write the sound data to the file as monophonic or stereophonic. Valid values are MONOPHONIC, STEREOPHONIC, and ORIGINAL_SETTING (retain the default channel setting of the data). Channels is optional: the default value, if omitted, is ORIGINAL_SETTING.
To use the PLAY_SOUND, READ_SOUND_FILE and WRITE_SOUND_FILE built-ins to play
and/or record sound data in a file, you must create a sound item and place
focus in that item before the call to the built-ins are executed. Although the
sound item will be represented by the sound item control at design-time, the
control will not function for end users at runtime. Therefore, you must "hide" the
sound item behind another object on the canvas so users will not see the
control at runtime. (To place focus in an item, it cannot be assigned to a null
canvas or have its Displayed property set to No.) For example, to call the
READ_SOUND_FILE and PLAY_SOUND built-ins from a When-Button-Pressed trigger, place
focus in the "hidden" sound item by including a call to the built-in procedure
GO_ITEM in the trigger code prior to calling READ_SOUND_FILE and PLAY_SOUND.
- check box
- display item
- list item
- radio group
- text item
- VBX control
Guidelines for working with calculated items
- Calculated items are display-only control items.
- Calculated items cannot be database items.
- While you can set a calculated item's Enabled, Mouse Navigate, and Keyboard
Navigable properties to Yes, you cannot set the Insert Allowed or Update Allowed
properties to Yes.
About calculation modes
- Summary—the calculated item's value is the summary of all values of a single item in a single block
- Formula—the calculated item's value is the result of a formula that performs calculations involving one or more values
About summary calculation
- The summary item is the calculated item to which you will assign a value. It must reside either in a control block with the Single Record property set to Yes, or in the same block as the summarized item.
- The summarized item's values are summarized (i.e., averaged, summed up, etc.) and then assigned to the summary item. The summarized item must reside in a data block with the Query All Records or Precompute Summaries property set to Yes, or in a control block.
DUMMY_REFERENCE(:emp.sal); Note: DUMMY_REFERENCE need not be executed for the referenced bind variable to be recognized by Form Builder (thereby causing the related calculated item to be marked for recalculation). RECALCULATE Built-in Use RECALCULATE to explicitly mark a formula item for recalculation. Do this if a formula references a system variable or built-in function, and a change has occurred that would cause the system variable or built-in function to return a different value. Note that even when RECALCULATE is called on a formula item, recalculation does not happen immediately. The item will be recalculated sometime before the next reference to the item. Warning: Regarding formula items, avoid a scenario where the formula for calculated item A calls a subprogram that changes the value of a bind variable that affects the value of calculated item B. In a case like this, it is difficult to ensure that the value of the bind variable will be accurate in relation to its effect on the value of items A or B (since Form Builder cannot guarantee precisely when A and B will be recalculated).
- In the Object Navigator, create a new interface item (make sure it is a control item).
- Double-click the item's object icon to display the Property Palette.
- Under the Calculation node, set the item's Calculation Mode property to Formula or Summary.
- If you set Calculation Mode to:
Formula, click on the Formula property, click the More button to display the Formula dialog, and type a PL/SQL expression to define
the formula. Click OK to compile the expression.
Summary, use the Summary Function poplist to select a summary type, then use the
Summarized Block and Summarized Item poplists to select the block and item whose
values will be summarized to compute a value for the calculated item.
- The following item properties are defaulted to No at compilation time: Database Item, Insert Allowed, Primary Key, Query Allowed, Required, Update Allowed, and Update Only if NULL.
- The following item properties are ignored at compilation time: Copy Value from Item, Initial Value, Highest Allowed Value, and Lowest Allowed Value.
- You cannot use PL/SQL to directly assign a value to a calculated item.
- End users cannot insert or modify a calculated item.
- A calculated item cannot be an LOV return item.
- A calculated item cannot be a master or subordinate mirror item.
- If the value of a formula item in a master block depends on values of detail block items—and more than one row of the master block is displayed—then values of the calculated item for non-current master-block rows are meaningless.
- A formula (and all user-written subprograms called by the formula) cannot reference a restricted built-in subprogram.
- A formula (and all user-written subprograms called by the formula) cannot execute DML statements.
- You cannot create any circular dependencies among a form's calculated items.
- You cannot use a When-Validate-Item trigger in conjunction with a calculated
item. Since a calculated item is by definition a valid item, this trigger event
never will occur.
Creating a calculated item examples
- maximum salary of all employees. Create display item MAX_SAL
** in the EMP block, set its Calculation Mode property to
** Summary, set its Summary Function property to Max, set its
** Summarized Block property to EMP, and set its Summarized
** Item property to SAL.
**
** Example 2: Define a formula calculation to compute an
** employee's gross total compensation. Create display item
** TOTAL_COMP in the EMP block, set its Calculation Mode
** property to Formula, and set its Formula property to the
** following PL/SQL expression:
*/
:emp.sal + :emp.comm
/* Example 3: Define a Formula item to compute a different
** value for total compensation depending on the block where
** the cursor currently is positioned. Form has 3 blocks:
** 2 data blocks (EMP1 and EMP2), and one control block
** (COMP). Create a display item TOTAL_COMP in the COMP block
** that displays total compensation. Set the Formula property
** for COMP.TOTAL_COMP to an expression (a function call):
*/
total_comp_func
/* Function TOTAL_COMP_FUNC is defined as follows: */
FUNCTION total_comp_func RETURN number IS
BEGIN
IF :system.cursor_block = 'emp1' THEN
RETURN :emp1.sal + :emp1.comm;
END IF;
IF :system.cursor_block = 'emp2' THEN
RETURN :emp2.sal + :emp2.comm;
END IF;
RETURN null;
END;
/* Form Builder automatically recalculates COMP.TOTAL_COMP
** whenever a change occurs to the value of :EMP1.SAL,
** :EMP1.COMM, :EMP2.SAL, or :EMP2.COMM. Form Builder
** will not, however, recalculate COMP.TOTAL_COMP when an
** end user navigates between blocks, since changes to
** system variables don't automatically cause recalculation.
** To ensure that the correct value always is displayed,
** define a PRE-BLOCK trigger at the form level, containing
** the statement:
*/
RECALCULATE('comp.total_comp');
Server support
| Property
| Status and Use
|
| Alias
| New. Creates an alias for an Oracle8 table name.
|
| Column Name
| Extended. Now includes dot notation for items from column objects.
|
| Detail Reference
| New. Identifies the REF item that forms a master-detail link.
|
| DML Returning Value
| New. Controls Forms’ refreshing of screen with changed values after a
database insert or update.
|
| Include REF Item
| New. Creates a hidden item called REF in the master block.
|
| Relation Type
| New. Identifies the type of master-detail link (either relational join or
object REF).
|
When validation occurs (differences in navigation rules)
Standard validation checks (validation steps for various types of items)
Validation and the Defer Required Enforcement property
Initialization of mirror (synchronized) items
Validation of mirror items
Converting between date and string formats
Implicitly setting an item's Required property
Null values in poplists and T-lists
Null values and firing the POST-CHANGE trigger
When Validation Occurs
Form Builder 4.5 validation rules for navigation are as follows:
When you navigate from item A to item B in the same block, and item-level
validation is in effect, the action taken depends on how the navigation was done:
If the navigation is the result of a GO_ITEM (mouse click), or the result of a
PREVIOUS_ITEM (shift-tab key), then only item A is validated. (This is the
same as Form Builder 5.0.)
If the navigation is the result of a NEXT_ITEM (tab key), then item A and all
items between A and B (in terms of their sequence number within the block, not in terms of their position in the block's navigation sequence) are validated.
This may cause redundant validation. For example, if you use the Next
Navigable Item property to establish a navigation sequence that's the reverse of the
items' sequence within the block (as shown in the object navigator), then every
time you hit tab, all items in the block (except the one you're tabbing to)
will be validated. (In Form Builder 5.0, only item A is validated.)
For item-level validation, when Form Builder needs to position you at the
first navigable item in a block, all earlier items in the block are validated.
This sometimes causes Form Builder to exit if one of those earlier items fails
validation. (In Form Builder 5.0, the earlier items are not validated.)
For item-level validation, when you attempt to navigate out of a null-valued,
Required item and the Defer Required Enforcement is set to No, the action
taken depends on how the navigation was done:
If the navigation is the result of a GO_ITEM (mouse click), or the result of a
NEXT_ITEM (tab key), then you will get the error: FRM-40202 Field must be
entered. (This is the same as Form Builder 5.0.)
If the navigation is the result of a PREVIOUS_ITEM (shift-tab key), then no
error will occur, and the navigation will succeed. (In Form Builder 5.0, error
FRM-40202 is issued.)
Standard Validation Checks
There are certain steps that are performed whenever an item of a particular
type is validated. The validation steps for Form Builder 4.5 text items are performed in the following order. If any step fails, the item is
marked invalid, and the remaining steps are skipped:
- Verify that a Required item is not null.
combo boxes
poplist and T-list items that do not allow other values
navigable list items that mirror other items
navigable text items
A failure on combo boxes or poplist and T-list items that do not allow other
values produces the message:
FRM-40212 Invalid value for field Other failures produce the message : FRM-40202 Field must be entered This validation is performed on item instances that are protected against update, even when the form's Validation Unit is ITEM.
- Verify that a non-null value is the correct format for its data type.
navigable combo boxes
text items
- Verify that a Fixed Length item does not contain a non-null value of the wrong length.
- Verify that the item's non-null value falls within the range specified for the item.
- If the item’s Use LOV for Validation property is Yes, verify that the item's non-null value appears in the item's list of values (LOV).
- If the item value is non-null, fire the POST-CHANGE trigger.
- Fire the WHEN-VALIDATE-ITEM trigger.
The Defer Required Enforcement property is ignored for list items.
When item-level validation occurs on a required item that contains a null
value, the item's WHEN-VALIDATE-ITEM trigger (if any) fires. If that succeeds, the
item is marked as valid (that is, the ITEM_IS_VALID property is set to Yes).
During record-level validation, null-valued required items that have already
been marked as valid are re-validated.
Initialization of Mirror (Synchronized) Items
Assume there are three items (A, B, and C) in the same data block. If you set
the Synchronize With Item property of A and B to item C, items A and B are
considered as subordinate mirror items. Item C is the master mirror item.
Form Builder 4.5 initialization rules for mirror items differ from 5.0 rules
in the following respects:
Within a group of items that mirror each other (including the master mirror
item), the initial value is taken from the last item within the group (in terms
of sequence within the block) that specifies a displayable initial value. That
is, each initial value is applied in turn at runtime, and the last one that can
be displayed by its item's widget overrides any earlier initial values. The
ON-SEQUENCE-NUMBER trigger (if present) is fired when its item's initial value is
being set (assuming it is a sequence number).
The initial value will be ignored at run time if the item is a poplist,
T-list, radio group, or checkbox that does not allow other values and which has no
element corresponding to the initial value. Mirroring items are not inspected.
Validation of Mirror Items
Form Builder 4.5 validation rules for mirror items differ from 5.0 rules in
the following respects:
For a subordinate mirror item, the Required, RANGE_HIGH, and RANGE_LOW
properties, and the POST-CHANGE and WHEN-VALIDATE-ITEM triggers, are taken from the
subordinate mirror item.
During item-level validation, validation rules are always taken from the item
currently being validated. This means that the validation rules for an item
set programmatically are determined by the item that is first visited by the end
user. This may be an item that mirrors it or the item itself.
During record-level validation, within a group of mirror items, Form Builder
validates the item that appears earliest in the block. This may cause a
validation problem if invalid data is entered into a text item or combo box that is
mirrored by another item that appears earlier in the block.
Converting Between Date and String Formats
To convert an item of data type DATE or DATETIME into an internal string (a
string that is not user-visible) or vice versa, Form Builder chooses a date
format mask to do the conversion.
In 5.0, Form Builder uses a built-in date format mask to do the conversion. This does not include conversions
performed by PL/SQL.
In Form Builder 4.5 runtime compatibility mode, Form Builder uses the input , output, or built-in date format masks for the following cases (see About format masks for dates for information about input, output, and built-in date format masks):
When executing GET_ITEM_PROPERTY on an item of data type DATE or DATETIME, for
the properties RANGE_HIGH and RANGE_LOW.
When executing GET_ITEM_PROPERTY on an item of data type DATE or DATETIME, for
the property DATABASE_VALUE. Form Builder 4.5 runtime compatibility mode gives
you the behavior of Form Builder 4.5.7. (Earlier releases exhibit 5.0
behavior.)
When setting the value of an LOV column's return item, when the LOV column is
of data type CHAR and the return item is of data type DATE or DATETIME, or vice
versa. Form Builder 4.5 runtime compatibility mode gives you the behavior of
Form Builder 4.5.7. (Earlier releases exhibit 5.0 behavior.)
When setting the initial value of an item of data type DATE or DATETIME, where
the initial value is taken from a variable (using colon notation) of data type
CHAR. Form Builder 4.5 runtime compatibility mode gives you the behavior of
Form Builder 4.5.7. (Earlier releases exhibit 5.0 behavior.)
When setting the initial value of an item of data type CHAR, where the initial
value is specified as $$DATE$$, $$DATETIME$$, $$DBDATE$$, or $$DBDATETIME$$.
Form Builder 4.5 runtime compatibility mode gives you the behavior of Form
Builder 4.5.7. (Earlier releases exhibit 5.0 behavior.)
For all other cases, Form Builder uses the built-in date format mask. For
information about various date format masks, see Format Masks in the online help.
Implicitly Setting an Item’s Required Property
In Form Builder 4.5 runtime compatibility mode, an item's Required property is
implicitly set to false if the item is disabled by setting its Enabled
property to PROPERTY_FALSE using the SET_ITEM_PROPERTY built-in.
Null Values in Poplists and T-Lists
In Form Builder 4.5 runtime compatibility mode, programmatically assigning a
null value to a poplist or T-list will fail if all of the following conditions
are true:
Required property set to true
the item does not contain an explicitly-specified, null-valued element
the item does not allow other values
Under these conditions, Form Builder will issue the error: FRM-40212: Invalid
value for field).
If a fetched row contains a null value in a column that is to be assigned to
such a poplist or T-list, the fetched row will be rejected (it will not appear
in the block).
In both Form Builder 4.5 and 5.0 runtime compatibility modes, a null value can
always be displayed in any list item, even if the list item contains no
explicitly-specified, null-valued element and does not allow other values. In a
T-list, the null value is displayed by selecting none of the elements. In a
poplist, an implicit null value is temporarily added to the poplist.
Null Values and Firing the POST-CHANGE Trigger
In Form Builder 4.5 runtime compatibility mode, the POST-CHANGE trigger is
never fired for a null value that was fetched into an item by a query. But for a
null value assigned programmatically to an item, or entered into an item by the
end user, the POST-CHANGE trigger is fired. The only exception is when the item is a text item. We do not
recommend using the POST-CHANGE trigger for new applications.
| Element
| Constraint/Note
|
| blocks per form
| no practical limit
|
| canvases/windows
| no practical limit
|
| canvas width
| no practical limit
|
| column name length
| 30 characters
|
| boilerplate text
| no practical limit
|
| database field references
| no practical limit
|
| detail blocks per master
| no practical limit
|
| global variable length
| 255 characters
|
| identifiers (block names, field names, parameter list names, etc.)
| 30 characters
|
| item max length
| 2,048 characters, for CHAR values
|
| items per block
| no practical limit
|
| join condition
| 255 characters
|
| levels of menu nesting
|
|
| list of values
| no practical limit
|
| menu items
| no practical limit
|
| menus
| no practical limit
|
| named visual attributes
| 255 named visual attributes
|
| PL/SQL strings
| no practical limit
|
| WHERE Clause and ORDER BY Clause
| total of 32,000 characters
|
| record group character columns
| 255 characters
|
| record groups
| 255 columns
|
| substitution parameters
| no practical limit
|
| text item range checks per block
| no practical limit
|
| triggers
| no practical limit
|
| user-defined local variable name length
| 30 characters
|
| Element
| Constraint/Note
|
| open cursors (maximum)
|
|
| open cursors (minimum)
| 5 per ORACLE connection.
|
|
| 4 per runtime session when running against ORACLE or SQL*Connect.
|
|
| 5 per block (1 for SELECT, 1 for UPDATE, 1 for INSERT, 1 for DELETE, and 1 for
QUERY ).The first 4 listed are opened as needed, but can be suppressed by
running in OPTIMIZETP=YES mode. This restriction applies under normal
circumstances, but it is possible to change the number of cursors by altering settings on
the Set Options form or by using command line switches.One cursor for query is
always opened for each block as needed and is never shared even when running in
OPTIMIZETP=NO mode.
|
| open cursors (minimum)
| 1 per record group created with query.
|
|
| 1 cursor is used if database date or time default values ($$DBDATE$$) are
referenced for any item.
|
|
| 1 for any SQL statement.These can be in triggers, procedures, or functions.
This restriction applies under normal circumstances, but it is possible to
change the number of cursors by altering settings on the Set Options form or by
using command line switches. V2 style trigger cursor consumption can be tailored
using the OPTIMIZESQL command line parameter.
|
What related information is needed to complete the task? What amount of
information does the user need to ignore?
What is the frequency of use and volume of data for the screen?
What widgets are most appropriate? Will the screen be used by high-speed data
entry clerks?
What level of training do you anticipate the user having on this particular
task and screen?
What if a user makes a mistake at a particular step, or attempts to bypass a
step? Must the task steps be done sequentially, or can they be done in
parallel?
What decisions is the user required to make along the way? What if those
decisions are only in exceptional cases?
What other tools might the user be familiar with? What are their expectations
of your product based on these other tools?
Platform portability: the ability to deploy the same application across
platforms.
Example Develop on UNIX, deploy on Microsoft Windows and Macintosh.
Device portability (including variations in screen size and resolution, as
well as monochrome/color differences): the ability to develop and deploy on the
same platform, but different devices.
Example Develop on Microsoft Windows, deploy on both Microsoft Windows large screen,
high resolution and Microsoft Windows small screen, low resolution.
UI portability: the ability to deploy the same application on GUI and
character-mode devices.
Example Develop on Microsoft Windows, deploy on Microsoft Windows and a VT220.
- Create standards for the application to ensure a similar "look and feel" both within the application and across platforms.
- Create the application on the base platform.
- Copy, re-compile, and run on the target platform, testing for any areas where adjustment is needed for optimum appearance.
Fonts are monospaced and thus consume much more space, on average, than
proportional fonts. Screens must be designed so that boilerplate and textual widgets
can be rendered with one character per cell.
Most objects must be laid out snapped to the character cell grid, including
boilerplate (prompts and lines) and widgets (text items, check boxes, etc.)
Each widget must be operable from the keyboard, including when it does not
have the focus.
All screens must fit in a character cell grid of 80 x 24 characters.
Anything that requires scrolling is very hard to use.
Iconic buttons should be hidden, thus any functionality they provide must
either not be needed in character mode, or must have an alternative invocation
method (such as the Special menu).
Encoding of data with font or color variations can only be used as a secondary
method to present such information.
Products or screens that do not need to run in character mode are not bound by
these limitations, although often a GUI form is easier to develop, and more
usable, if many of them are followed. For example, design a screen so that it is
fully operable from the keyboard, whether it is to be run in character mode or
not.
Have certain commands available as entries on the Special menu rather than as
buttons on the form.
Change horizontal scrolling areas into alternative regions showing only a
subset of the columns at a time.
Reduce the number of windows by using multiple alternative regions in one
window or by improving the window flow.
Display multiple rows of certain information (primary key and descriptor
fields) and one row of less important information by using overflow regions or
combination blocks.
Orient screen layouts based on a top-to-bottom task sequence. Blocks,
regions, and items are arranged by order of precedence, from left-to-right, then
top-to-bottom.
Don't waste screen space. Make windows only as large as is necessary. Use
blank space as a way to group information.
Most widgets are 0.25 inches high, and multiples of 0.1 inches wide.
Two-dimensional widgets (multiline text items, TLists) are multiples of 0.25 inches
high. Textual button heights differ depending on the platform.
In single-record blocks, items should be left aligned where possible. In
multi-record blocks items should be stacked horizontally and aligned along their
top.
Place titles and prompts toward the top or left of the element they are
describing. Prompts in single-record blocks are always to the left of the field;
prompts in multi-record blocks are above the field, and aligned similarly to the
data within the field they describe. Exceptional cases exist for matrix-style
layouts, fields that do not require prompts, connecting prompts, and multiline
prompts.
At least a one-character wide space should be left between the items on a
canvas and the window frame. It is also preferable to leave one row at the top and
bottom empty too, but this is not required. Exceptional cases exist for lines
and rectangles used to denote blocks and regions.
Indicate things that are similar, and things that are different, when it is
meaningful for the user. That is, do not create regions or use boilerplate lines
to group items unless it improves the usability of the screen.
Make data stand out, and controls to access that data intuitive but
non-obtrusive.
Use the same widget for the same attribute in all windows.
- Create modules.
- Create blocks and items.
- Apply user interface standards to your objects.
- Fine-tune the layout.
- Set properties.
- Add code.
- Test your application.
| To do this:
| Use this Form Builder tool:
|
| Create modules.
| Object Navigator
|
| Create blocks and items.
| Data Block Wizard
|
| Apply standards.
| Object Library
|
| Fine-tune the layout.
| Layout Wizard or Layout Editor
|
| Set properties.
| Property Palette
|
| Add code.
| PL/SQL Editor
|
| Test the form.
| Forms Runtime Debugger
|
A single-record block displays one record at a time.
A multi-record block displays more than one record at a time.
In addition, a data block can also be a master or detail block:
A master block displays a master record associated with detail records displayed in a
detail block.
A detail block displays detail records associated with a master record displayed in
master block.
table
view
FROM clause (query datasource only)
procedure
transactional trigger
Will the block be used only to query records?
Will the block be used to perform INSERTS, UPDATES, and DELETES (DML)?
Will the block be used to perform both query and DML?
A table is the most commonly used block datasource. Unless you have special
needs, a table is the best choice for a block datasource.
Consider also the functional restrictions for each datasource type.
| Datasource
| Allows Query
| Allows DML (INSERTS, UPDATES, and DELETES
| Allows Array Processing
| Allows Query by Example
|
| Table
| yes
| yes
| yes
| yes
|
| View
| yes
| yes (certain Join views may not allow DML)
| yes
| yes
|
| FROM clause
| yes
| no
| yes (only for queried records)
| no
|
| Procedure
| yes
| no (if your procedure uses a ref cursor variable)
| no (if your procedure uses a table of records)
| no
|
| Transactional trigger
| yes
| yes
| no (if your trigger uses a table of records)
| no
|
query records
INSERT, UPDATE, and DELETE records
query by example
A data block based on a table, also reduces network traffic through array
processing.
The Query Array Size property enables array processing for records queried,
and the DML Array Size property enables array processing for records used in DML
operations.
increase control and security
query and update multiple tables
perform complex computations
perform validation and DML on the server-side
encapsulate logic within a subprogram
reduce network traffic through array processing
A stored procedure returns data to a data block by using either a ref cursor
or a table of records.
a stored procedure that uses a ref cursor can only be used as a query block
datasource
a stored procedure that uses a table of records can be used as both a query
and DML block datasource
a stored procedure that uses a ref cursor can only be used as a query block
datasource
a stored procedure that uses a table of records can be used as both a query
and DML block datasource
Data Block Wizard to invoke a wizard that guides you through the process of building a data
block.
Or,
- In the Object Navigator, click the Data Blocks node.
- Click the Create button
in the toolbar.
- In the New Data Block dialog box, choose Build a New Data Block Manually and click OK.
- Double-click the Block object icon
to display the Property Palette.
- Under the Database node:
Set the Query Data Source Type property to Table.
Type the name of a database table in the Query Data Source Name text box.
- Under the Advanced Database node:
Set the DML Data Target Type property to Table.
Type the name of your datasource in the DML Data Target Name text box.
- Under the General node, click the Name property, then type a name or accept the default name.
Data Block Wizard to invoke a wizard that guides you through the process of building a data
block.
Or,
- In the Object Navigator, click the Data Blocks node.
- Click the Create button in the toolbar.
- In the New Data Block dialog, choose Build a New Data Block Manually and click OK.
- Double-click the Block object icon to display the Property Palette.
- Under the Database node, set the Query Data Source Type property to Transactional Triggers.
- Define the appropriate transactional triggers.
- Under the Advanced Database node, set the DML Data Target Type property to Transactional Triggers.
- Define the appropriate transactional triggers.
- Under the General node, click the Name property, then type a name or accept the default name.
Data Block Wizard to invoke a wizard that guides you through the process of building a data
block.
Or,
- In the Object Navigator, click the Data Blocks node.
- Click the Create button in the toolbar.
- In the New Data Block dialog box, choose Build a New Data Block Manually and click OK.
- Double-click the Block object icon to display the Property Palette.
- Under the Database node:
Set the Query Data Source Type property to Procedure.
Type the name of a procedure in the Query Data Source Name text box.
Type the name of a procedure in the Query Data Source Name text box.
Double-click the Query Data Source Columns property and in the Query Data
Source Columns dialog box, type in the column names, type, length, precision, and
scale for the result set returned from the ref cursor.
Double-click the Query Data Source Arguments property and in the Query Data
Source Arguments dialog box, type in the names, data types, mode, and value for
the arguments passed to and from the procedure.
- Under the General node, click the Name property, then type a name or accept the default name.
If the query datasource of a block is a stored procedure returning a cursor
variable, and the block is a detail block in a relation, only the isolated
deletes option is supported. Non-isolated deletes and cascading deletes cannot be
supported, because the appropriate SQL statements cannot be constructed (cursors
are a single active set of records resulting from a single select statement
that is issued). To enforce non-isolated deletes and cascading deletes, provide
checks in the ON-DELETE or PRE-DELETE triggers.
Count Query Hits is disabled when using stored procedures as a datasource. An
error message occurs if you attempt to count query hits at runtime. Instead,
you can use the ON-COUNT trigger to count the query hits.
You cannot pass a WHERE or ORDER BY clause to a stored procedure.
*/
PACKAGE cv_datasource IS
TYPE emprec is RECORD (empno emp.empno%TYPE,
ename emp.ename%TYPE,
job emp.job%TYPE,
mgr emp.mgr%TYPE,
sal emp.sal%TYPE,
comm emp.comm%TYPE,
deptno emp.deptno%TYPE);
TYPE empcur is REF CURSOR RETURN emprec;
PROCEDURE empquery(resultset IN OUT empcur,
p_deptno IN NUMBER);
END;
PACKAGE BODY cv_datasource IS
PROCEDURE empquery(resultset IN OUT empcur,
p_deptno IN NUMBER) IS;
BEGIN
OPEN resultset FOR
SELECT empno, ename, job, mgr, sal, comm, deptno
FROM emp
WHERE deptno = p_deptno
ORDER BY empno;
END;
END;
Data Block Wizard to invoke a wizard that guides you through the process of building a data
block.
Or,
- In the Object Navigator, click the Data Blocks node.
- Click the Create button in the toolbar.
- In the New Data Block dialog box, choose Build a New Data Block Manually and click OK.
- Double-click the Block object icon to display the Property Palette.
- Under the Database node:
Set the Query Data Source Type property to Procedure.
Type the name of a database procedure in the Query Procedure Name text box.
Double-click the Query Data Source Columns property. Then in the Query Data
Source Columns dialog box, type in the column names, type, length, precision,
and scale for the result set returned from the table of records.
Double-click the Query Data Source Arguments property. Then in the Query Data
Source Arguments dialog box, type in the name, data types, mode, and value for
the arguments passed to and from the procedure.
- Under the Advanced Database node:
Set the DML Data Target Type property to Procedure.
If you are performing an INSERT from your procedure, type the name of the
procedure in the Insert Procedure Name text box, double-click the Insert Procedure
Result Set Columns property to provide the result set information (name, type,
length, precision, and scale), and double-click the Insert Procedure Arguments
property to provide the argument information (name, data type, mode, value).
If you are performing an UPDATE from your procedure, type the name of the
procedure in the Update Procedure Name text box, double-click the Update Procedure
Result Set Columns property to provide the result set information (name, type,
length, precision, and scale), and double-click the Update Procedure Arguments
property to provide the argument information (name, data type, mode, value).
If you are performing a DELETE from your procedure, type the name of the
procedure in the Delete Procedure Name text box, double-click the Delete Procedure
Result Set Columns property to provide the result set information (name, type,
length, precision, and scale), and double-click the Delete Procedure Arguments
property to provide the argument information (name, data type, mode, value).
If you are performing a LOCK from your procedure, type the name of the
procedure in the Lock Procedure Name text box, double-click on the Lock Procedure
Result Set Columns property to provide the result set information (name, type,
length, precision, and scale), and double-click the Lock Procedure Arguments
property to provide the argument information (name, data type, mode, value).
- Under the General node, click the Name property, then type a name or accept the default name.
In a block based on a stored procedure performing an UPDATE, always reference
the same columns in both the procedure and the block. Do not pass back values
from the procedure or function that you do not use as database items in your
form. If the procedure or function returns more columns than those used in the
block, the procedure or function returns null values for the columns that are
not used.
Because Update Changed Columns is not supported with procedures or functions
as block datasources, the procedure or function should always pass back all the
column values (Updated Changed Columns specifies that only columns whose values
have changed are included in the UPDATE statement). It is impossible to
determine whether a null value passed to procedure or function is an unused column
in the block or an intentional null value for a column that is used. If you do
not have a procedure or function that requires you to pass back all the column
values, you will not be able to set a column to a null value in an UPDATE
statement.
Count Query Hits is disabled when using stored procedures as a datasource. An
error message occurs if you attempt to count query hits at runtime. Instead,
you can use the ON-COUNT trigger to count the query hits.
You cannot pass a WHERE or ORDER BY clause to a stored procedure.
Data Block Wizard to invoke a wizard that guides you through the process of building a data
block.
Or,
- In the Object Navigator, click the Data Blocks node.
- Click the Create button in the toolbar.
- In the New Data Block dialog, choose Build a New Data Block Manually and click OK.
- Double-click the Block object icon to display the Property Palette.
- Under the Database node:
Set the Query Data Source Type property to FROM clause.
Type the a SELECT statement (sub-query) in the Query Data Source Name text box.
- Under the General node, click the Name property, then type a name or accept the default name.
- In the Object Navigator, click the Data Blocks node.
- Click the Create button in the toolbar.
- In the New Data Block dialog box, choose Build a New Data Block Manually and click OK.
- Double-click the Block object icon to display the Property Palette.
- Under the General node, click the Name property, then type a name or accept the default name.
- In the Object Navigator, click the Data Blocks node.
- Double-click the desired block object icon to display the Property Palette.
- Under the Records node, set the Number of Records Displayed property to the desired number of records.
- In the Object Navigator, click the desired block object icon.
- Choose NavigatorDelete.
- In the Layout Editor, double-click the scroll bar to display the Property Palette.
- Set the Show Scroll Bar block property to No.
Scroll Bar interaction at runtime
- In the Object Navigator, double-click the Block object icon for the desired block to display the Property Palette.
- Under the Scroll bar node:
Set the Show Scroll Bar block property to Yes.
Set the Scroll Bar Canvas property to specify on which canvas the scroll bar should be displayed.
- Choose FileConnect.
- In the Connect dialog box:
Type your user name, password, and database name.
Click Connect.
When a connection to the database is made successfully, the status bar
displays the Connect lamp: <Con>.
Display totals, averages, rankings, and other summary information calculated
from values in data items and database tables.
Accept input from operators that is required by the application, but that is
not stored in the database.
Display "look-up values," that is, database values derived from a different
table.
When building a block, consider this:
data blocks can contain both data items and control items
For example, a data block might contain four data items that display queried
database values and a fifth item that displays calculated values but does not
correspond to any column in the database. The fifth item would be a control item
populated by an assignment statement in the trigger that does the calculation.
control blocks cannot contain data items
Because control blocks are not associated with the database, none of the items
they contain can be data items. (Control items may be populated with database
values by writing SQL statements in trigger code.)
buttons and chart items are always control items
Because buttons and chart items do not store values, they cannot relate to
columns in the database, and are always control items.
the values of control items may be referenced in code, in the same fashion as
local and global variables.
Data Block Wizard to invoke a wizard that guides you through the process of creating a data
item.
Or,
- In the Object Navigator, click the plus icon
beside the desired Data Blocks node.
- Click the plus icon beside the Items node.
- Click the Create button in the toolbar.
- Double-click the object icon beside the newly created item to display the Property Palette.
- Under the General node:
Set the Name property to the name of the desired database column.
Set the new item's Type property to specify the type of item you want.
The default item type is text item. You can change the default by setting the
Type property to the item type desired (check box, radio group, list item, and
so on).
- Under the Physical node, set the Canvas property to the name of the desired canvas.
- In the Object Navigator, click the plus icon beside the desired Data Blocks node.
- Click the plus icon beside the Items node.
- Click the Create button in the toolbar.
- Double-click the object icon beside the newly created item to display the Property Palette.
- Under the Database node:
Set the Database Item property to No.
Note: When you create an item in a data block, Form Builder assumes the item is a
data item, and sets the Database Item property to Yes. Data items are
automatically included in any SELECT, UPDATE, and INSERT statements issued to the
database. If the item being created is a control item in a data block, you must
explicitly set its Database Item property to No.
Set the Type property to specify the type of item you want.
The default item type is text item. You can change the default by setting the
Type property to the item type desired (check box, radio group, list item, and
so on).
- Under the Physical node, set the Canvas property to the name of the desired canvas.
Items that you create in the Layout Editor are automatically assigned to the
current block.
Items that are selected when you issue the Set Block command are re-assigned
to the new block.
- In the Layout Editor, choose a block from the Block drop-down located in the upper region of the Layout Editor.
- Click the drop-down list box to display a list of all blocks.
About assigning items to canvases
In the Property Palette, set the item's Canvas property to the name of the
desired canvas. The canvas specified must already be defined in the current form.
- Or -
In a Layout Editor, Cut the desired item, then Paste it to a different canvas
in another Layout Editor window.
- Or -
In the Object Navigator, choose NavigatorVisual View to display the form hierarchy in the Visual View. In Visual View, items
appear under the canvas to which they are assigned, and no blocks are displayed.
Click the item which will be changed, and use the mouse to drag an item to a
different canvas.
- In the Object Navigator or the Layout Editor, double-click the item you want to convert to display the Property Palette.
- Under the General node, set the Type property to the desired item type.
Properties that apply only to the new item type are set to the default
settings for that item type.
Properties that are common to both the original item type and the new item
type retain their current settings.
For example, when you convert a text item to a check box, the Label property
(which applies only to check box items) is set to the default setting, but the
Data Type property (which applies to both text items and check boxes) retains
its current setting.
- Double-click the desired item in the Object Navigator or in the Layout Editor to display the Property Palette.
- Under the Records node, set the Number of Items Displayed property to specify the number of records the item should display.
To display the number of records indicated by the block's Number of Records
Displayed property setting, set Number of Items Displayed to 0 (the default).
To display fewer records, set Number of Items Displayed to a number less than
the block's Number of Records Displayed property setting, but greater than 0.
Number of Items Displayed cannot be set greater than the block's Number of
Records Displayed property setting.
- In the Layout Editor, select the desired item.
- Click and drag one of the spacing handles up or down.
- In the Object Navigator, click the desired item.
- Choose NavigatorDelete.
- In the Object Navigator, arrange all of the blocks in the form according to the desired navigation sequence.
- Arrange all of the items in each block according to the desired navigation sequence.