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

GET_CANVAS_PROPERTY Built-in

Description

Returns the given canvas property for the given canvas. .

Syntax

FUNCTION GET_CANVAS_PROPERTY
(canvas_id Canvas,
property
NUMBER);

FUNCTION GET_CANVAS_PROPERTY
(canvas_name VARCHAR2,
property
NUMBER);

Built-in Type unrestricted function

Returns VARCHAR2

Enter Query Mode yes

Parameters

canvas_id 
 
The unique ID that Oracle Forms assigns the canvas object when it creates it. Use the FIND_CANVAS Built-in to return the ID to a variable with datatype of CANVAS.
 
canvas_name 
 
The name you gave the canvas object when you defined it.
 
property 
 
The property for which you want to get a value for the given canvas. You can enter the following constants for return values:

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 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 canvas, specified in the form coordinate units indicated by the Coordinate System form property.

TAB_PAGE_X_OFFSET Returns the distance between the left edge of the tab canvas and the left edge of the tab page. The value returned depends on the form coordinate system—pixel, centimeter, inch, or point.

TAB_PAGE_Y_OFFSET Returns the distance between the top edge of the tab canvas and the top edge of the tab page. The value returned depends on the form coordinate system—pixel, centimeter, inch, or point.

TOPMOST_TAB_PAGE Returns the name of the tab page currently top-most on the named tab canvas.

WIDTH Returns the width of the canvas, specified in the form coordinate units indicated by the Coordinate System form property.

VISUAL_ATTRIBUTE Returns the name of the visual attribute currently in force. If no named visual attribute is assigned to the canvas, returns CUSTOM for a custom visual attribute or DEFAULT for a default visual attribute.

GET_CANVAS_PROPERTY Examples

/*

** Built-in: GET_CANVAS_PROPERTY
** Example: Can get the width/height of the canvas.
*/
DECLARE
the_width NUMBER;
the_height NUMBER;
cn_id CANVAS;
BEGIN
cn_id := FIND_CANVAS('my_canvas_1');
the_width := GET_CANVAS_PROPERTY(cn_id, WIDTH);
the_height := GET_CANVAS_PROPERTY(cn_id,HEIGHT);
END;