A script-enabled browser is required for this page to function properly.

SHOW_EDITOR Built-in

Description

Displays the given editor at the given coordinates and passes a string to the editor, or retrieves an existing string from the editor. If no coordinate is supplied, the editor displays in its default position specified at design time.

Syntax

SHOW_EDITOR
(editor_id Editor,
message_in
VARCHAR2,
message_out
VARCHAR2,
result
BOOLEAN);

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 Oracle Forms 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.

SHOW_EDITOR Restrictions

SHOW_EDITOR Examples

/*

** 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;