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

SET_CANVAS_PROPERTY Built-in

Description

Sets the given canvas property for the given canvas.

Syntax

SET_CANVAS_PROPERTY
(canvas_id CANVAS,
property
NUMBER,
value
VARCHAR2);

SET_CANVAS_PROPERTY
(canvas_id CANVAS,
property
NUMBER,
x
NUMBER);

SET_CANVAS_PROPERTY
(canvas_id CANVAS,
property
NUMBER,
x
NUMBER,
y
NUMBER);

SET_CANVAS_PROPERTY
(canvas_name VARCHAR2,
property
NUMBER,
value
VARCHAR2);

SET_CANVAS_PROPERTY
(canvas_name VARCHAR2,
property
NUMBER,
x
NUMBER);

SET_CANVAS_PROPERTY
(canvas_name VARCHAR2,
property
NUMBER,
x
NUMBER,
y
NUMBER);

Built-in Type unrestricted procedure

Enter Query Mode yes

Parameters

canvas_id 
 
The unique ID Oracle Forms assigned to the canvas object when you created it. Use the FIND_CANVAS Built-in to return the ID to a variable of datatype CANVAS.
 
canvas_name 
 
The name you gave the canvas object when you defined it. Datatype is VARCHAR2.
 
property 
 
The property you want to set for the given canvas. Possible properties are:

BACKGROUND_COLOR The color of the object's background region.

CANVAS_SIZE The dimensions of the canvas (width, height).

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 The height of the canvas in characters.

TOPMOST_TAB_PAGE The name of the tab page that will appear to operators as the top-most (i.e., overlaying all other tab pages in the tab canvas).

VISUAL_ATTRIBUTE A valid named visual attribute that exists in the current form that you want Oracle Forms to apply to the canvas.

WIDTH The width of the canvas in characters.

value
 
The VARCHAR2 value to be applied to the property you specified.
 
x 
 
The NUMBER value of the x coordinate or the width, depending on the property you specified. Specify the argument in form coordinate system units.
 
y 
 
The NUMBER value of the y coordinate or the height, depending on the property you specified. Specify the argument in form coordinate system units.

SET_CANVAS_PROPERTY Restrictions

  • You cannot enter a non-existent named visual attribute.
  • SET_CANVAS_PROPERTY Examples

    /* Change the "background color" by dynamically setting the

    ** canvas color at runtime to the name of a visual attribute
    ** you created:
    */
    BEGIN
    SET_CANVAS_PROPERTY('my_cvs', visual_attribute, 'blue_txt');
    END;