Oracle Forms Developer – Form Builder Reference, Volume 1

GET_BLOCK_PROPERTY built-in
Description
Returns information about a specified block. You must issue a call to the built-in once for each property
value you want to retrieve.
Syntax
FUNCTION GET_BLOCK_PROPERTY
(block_id Block,
property NUMBER);
FUNCTION GET_BLOCK_PROPERTY
(block_name VARCHAR2,
property NUMBER);
Built-in Type unrestricted function
Returns VARCHAR2
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 to return information about the given
block:
158
ALL_RECORDS Specifies whether all the records matching the query
criteria should be fetched into the data block when a query is executed.
BLOCKSCROLLBAR_X_POS Returns the x position of the block’s
scroll bar as a number specified in the form coordinate units indicated by
the Coordinate System form property.
BLOCKSCROLLBAR_Y_POS Returns the y position of the block’s
scroll bar as a number specified in the form coordinate units indicated by
the Coordinate System form property.
COLUMN_SECURITY Returns the VARCHAR2 value of TRUE if
column security is set to Yes, and the VARCHAR2 string FALSE if it is set
to No.
COORDINATION_STATUS For a block that is a detail block in a
master-detail block relation, this property specifies the coordination status
of the block with respect to its master block(s). Returns the VARCHAR2
value COORDINATED if the block is coordinated with all of its master
blocks. If it is not coordinated with all of its master blocks, the built-in
returns the VARCHAR2 value NON_COORDINATED. Immediately after
records are fetched to the detail block, the status of the detail block is
COORDINATED. When a different record becomes the current record in