Older Newer
Tue, 18 Mar 2003 07:54:02 . . . . SyneRyder


Changes by last author:

Added:
= CHECKBOX =

== Syntax ==

:ctl[n]: CHECKBOX(Class Specific Properties), Other Properties

== Description ==

:The checkbox acts as a toggle for two or three states. You should use this control when the user has a choice of enabling or disabling some function (eg disabling previewing, enabling a part of your filter's algorithm). The three state option should be used when the state can become "partially enabled". A common use for checkboxes is to toggle between horizontal and vertical orientation, for example in a blurring, or scanline filter.

== Class Specific Properties ==

:3STATE

::Allows the checkbox to returns one of three values (third state is a grayed check)

:BORDER

::Draws a border around the checkbox.

:BOTTOM

::Aligns text at the bottom of the checkbox's text area.

:CENTER

::Centers text within the checkbox's text area.

:CLIENTEDGE

::Draws a 3D-border around the checkbox.

:FLAT

::Gives the checkbox a flat, 2D appearance.

:LEFT

::Left-aligns text within the checkbox's text area. (default)

:LEFTTEXT

::Places the text label on the left of the checkbox (same as RIGHTBUTTON).

:MODALFRAME

::Draws a 3D-socket around the checkbox.

:MULTILINE

::Allows word-wrapping within the checkbox's text area.

:PUSHLIKE

::Makes the checkbox appear as a depressable pushbutton.

:RIGHT

::Right-aligns text within the checkbox's text area.

:RIGHTBUTTON

::Places the text label on the left of the checkbox (same as LEFTTEXT).

:STATICEDGE

::Draws a 3D-border around the checkbox.

:TOP

::Aligns text at the top of the checkbox's text area.

:VCENTER

::Vertically-centers text within the checkbox's text area.

== Other Properties ==

:Color

::Sets text background color in plain English format (default = transparent)

:FontColor

::Sets font color in hexadecimal format (default = #FFFFFF)

:Text

::Defines the text label next to the checkbox (default = no text)

== Example ==

<code>

ctl[5]: CHECKBOX, "Horizontal/Vertical Lines", FontColor=Darkblue

ctl[7]: CHECKBOX(3STATE), "White/Black/Gray"

</code>

== Notes ==

:If you are using the class-specific property 3STATE , these are the values a function like ctl(n) returns (also applies if the class-specific property PUSHLIKE is defined):

::0 not checked

::1 checked (black check in the checkbox)

::2 checked (gray check in the checkbox)

:There is a bug in Windows XP that causes checkboxes to show a black background, even if a background image hasn't been defined for the dialog. Currently, the only solution is to use the Pushlike property, define another color using the Color property, or simulate a checkbox using your own code and bitmaps.