Returns information about the given form. If your application is a multi-form application, then you can call this Built-in to return information about the calling form, as well as about the current, or called form.
FUNCTION GET_FORM_PROPERTY
(formmodule_id FormModule,
property NUMBER);
FUNCTION GET_FORM_PROPERTY
(formmodule_name VARCHAR2,
property NUMBER);
Built-in Type unrestricted function
Returns VARCHAR2
Enter Query Mode yes
CHARACTER_CELL_HEIGHT Returns the dimensions of the character cell in the form units specified by the Coordinate System property. When Coordinate System is Character Cells, the value is returned in pixels.
CHARACTER_CELL_WIDTH Returns the dimensions of the character cell in the form units specified by the Coordinate System property. When Coordinate System is Character Cells, the value is returned in pixels.
COORDINATE_SYSTEM Returns a VARCHAR2 string indicating the coordinate system used in the form module.
CURRENT_RECORD_ATTRIBUTE Returns the VARCHAR2 name of the named visual attribute that should be used for the current row.
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.
CURSOR_MODE Returns the setting that indicates the intended effect of a commit action on existing cursors.
DEFER_REQUIRED_ENFORCEMENT Returns the setting that indicates whether enforcement of required fields has been deferred from item validation to record validation. Valid return values are TRUE, 4.5, and FALSE.
DIRECTION Returns the layout direction for bidirectional objects. Valid return values are RIGHT_TO_LEFT, LEFT_TO_RIGHT.
FILE_NAME Returns the name of the file where the named form is stored.
FIRST_BLOCK Returns the name of the block with the lowest sequence number in the indicated form.
FIRST_NAVIGATION_BLOCK Returns the name of the block into which Oracle Forms 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.
FORM_NAME Returns the name of the form.
INTERACTION_MODE Returns the interaction mode for the form. Valid return values are BLOCKING or NONBLOCKING.
ISOLATION_MODE Returns the form’s isolation mode setting, either READ_COMMITTED or SERIALIZABLE.
LAST_BLOCK Returns the name of the block with the highest sequence number in the indicated form.
MAX_QUERY_TIME Returns the VARCHAR2 value that indicates the current setting of the Maximum Query Time property. This property determines whether the operator can abort a query when the elapsed time of the query exceeds the value of this property.
MAX_RECORDS_FETCHED Returns a number representing the maximum number of records that can be fetched. This property is only useful when the Query All Records property is set to Yes.
MODULE_NLS_CHARACTER_SET Returns the current value of the character set portion only of the DEVELOPER_NLS_LANG environment variable defined for the form. If DEVELOPER_NLS_LANG is not explicitly set, it defaults to the setting of NLS_LANG.
MODULE_NLS_LANG Returns the complete current value for national language support contained in the DEVELOPER_NLS_LANG environment variable defined for the form. If DEVELOPER_NLS_LANG is not explicitly set, it defaults to the setting of NLS_LANG. MODULE_NLS_LANG is the equivalent of concatenating MODULE_NLS_LANGUAGE, MODULE_NLS_TERRITORY, and MODULE_NLS_CHARACTER_SET.
MODULE_NLS_LANGUAGE Returns the current value of the language portion only of the DEVELOPER_NLS_LANG environment variable defined for the form. If DEVELOPER_NLS_LANG is not explicitly set, it defaults to the setting of NLS_LANG.
MODULE_NLS_TERRITORY Returns the current value of the territory portion only of the DEVELOPER_NLS_LANG environment variable defined for the form. If DEVELOPER_NLS_LANG is not explicitly set, it defaults to the setting of NLS_LANG.
SAVEPOINT_MODE Returns PROPERTY_ON or PROPERTY_OFF to indicate whether savepoints are supported in the data source.
VALIDATION Returns TRUE or FALSE to indicate whether default Oracle Forms validation is enabled.
VALIDATION_UNIT Returns a VARCHAR2 string indicating the current validation unit for the form:
/*
** Built-in: GET_FORM_PROPERTY
** Example: Determine the name of the first block in the form.
*/
DECLARE
curform VARCHAR2(40);
blkname VARCHAR2(40);
BEGIN
curform := :System.Current_Form;
blkname := Get_Form_Property(curform,FIRST_BLOCK);
END;
/*
** Built-in: GET_FORM_PROPERTY
** Example: Evaluate the current setting of the
** Validate property.
*/
BEGIN
IF Get_Form_Property('curform', VALIDATION) = 'FALSE'
THEN
Message ('Form currently has Validation turned OFF');
END IF;
END;