Placard

From Xojo Documentation

Revision as of 18:56, 19 November 2009 by WikiSysop (talk) (1 revision)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)


Description

Used to add a placard to a window. A placard is a control that you can use as an information display or as background fill for a control area. Placards have three states: normal, pressed, and disabled.

Perhaps the most familiar use of the Placard control is as a small information panel, often placed at the bottom of a window to the left of the horizontal scroll bar.


Super Class

RectControl

Because this is a RectControl, see the RectControl for other properties and events that are common to all RectControl objects.


Events

Name Parameters Return Type Description
MouseDown X as Integer,

Y as Integer

Boolean The mouse button has been pressed inside the window at the x,y local coordinates passed.

Return True if you are going to handle the MouseDown.

MouseDrag X as Integer,

Y as Integer

The mouse button was pressed inside the window and moved (dragged) at the location local to the window passed in to x,y.

This event will not occur unless you return True in the MouseDown event.

MouseUp X as Integer,

Y as Integer

The mouse button has been released inside the window at the x,y local coordinates passed.


Properties

Name Type Description
Enabled Boolean If True, draws a shaded border around the object; if False, the border is a line drawing and the placard is disabled.
Value Boolean If Enabled is True, Value shades the interior of the placard (Pressed state). If Enabled is True and Value is False, the interior is unshaded (Normal state).


Notes

On Mac OS X, you can solve some display problems with Placards by turning on the parent window's Composite property. For an example, see the Notes on the Window class.


See Also

RectControl class; Canvas control.