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

GET_WINDOW_PROPERTY Built-in

Description

Returns the current setting for the indicated window property for the given window.

Syntax

FUNCTION GET_WINDOW_PROPERTY
(window_id Window,
property
NUMBER);

FUNCTION GET_WINDOW_PROPERTY
(window_name VARCHAR2,
property
NUMBER);

Built-in Type unrestricted function

Returns VARCHAR2

Enter Query Mode yes

Usage Notes

Parameters

window_id 
 
Specifies the unique ID that Oracle Forms assigns the window at the time it creates it. 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.
 
property 
 
You must make a separate call to GET_WINDOW_PROPERTY for each property you need, as shown in the FIND_WINDOW example. Specify one of the following constants to get the current value or state of the property:

BACKGROUND_COLOR The color of the object's background region.

DIRECTION Returns the layout direction for bidirectional objects. Valid return values are 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 Returns the height of the window.

HIDE_ON_EXIT Returns the VARCHAR2 value TRUE if the window has the Remove On Exit property set to Yes, otherwise, it is FALSE.

ICON_NAME Returns the file name of the icon resource associated with a window item when it is minimized.

TITLE Returns the title of the window.

VISIBLE Returns the VARCHAR2 value TRUE if the window is visible, FALSE if it is not. A window is reported visible if it is currently mapped to the screen, even if it is entirely hidden behind another window or iconified (minimized).

WIDTH Returns the width of the window.

WINDOW_HANDLE Returns the a unique internal VARCHAR2 constant that is used to refer to objects. Returns the number 0 if the platform is not Microsoft Windows.

WINDOW_SIZE Returns the width and height of the window as a string, separated by commas.

WINDOW_STATE Returns the current display state of the window. The display state of a window is the VARCHAR2 string NORMAL.

X_POS Returns the x coordinate that reflects the window's current display position on the screen.

Y_POS Returns the y coordinate that reflects the window's current display position on the screen.


GET_CANVAS_PROPERTY Built-in
SET_VIEW_PROPERTY Built-in
SET_WINDOW_PROPERTY Built-in