Skip to main content

DRAW.CHECKBOX

Define a graphical checkbox button on a given drawing.

Syntax

=DRAW.CHECKBOX(UnqiueId, Container, Name, X, Y, Width, Height, LineFormat, FillFormat, Attributes, Events, Angle, RotCenter, Label[, LabelFont, Value])

Arguments

NameDescription
UniqueIdUnique Id of drawing object. Should not be modified and must be unique.
ContainerOptional. Name of the container object this object is placed within. Coordinates are relative then.
NameName of drawing object. Must be unique.
XX Coordinate in 1/100th mm
YY Coordinate in 1/100th mm
WidthWidth in 1/100th mm
HeightHeight in 1/100th mm
LineFormatOptional. Options:
- None for no line
- Hexadecimal color value (#FF0000 for Red)
- JSON String created using lineformat
FillFormatOptional. Options:
- "None" for no fill
- Hexadecimal color value ("#FF0000" for Red)
- JSON String created using FILLPATTERN, FILLLINEARGRADIENT, FILLRADIALGRADIENT
AttributesOptional. JSON String created using ATTRIBUTES
EventsOptional. JSON String created using EVENTS
AngleOptional. Angle in radians.
RotCenterOptional. This defines, where the object rotates around:
0: Top left corner
1: Top center
2: Top right corner
4: Center (default)
5: Right center
6: Bottom left corner
7: Bottom center
8: Bottom right corner
LabelLabel to display
FontOptional. Options:
- "None" for no fill
- Hexadecimal color value ("#FF0000" for Red)
- JSON String created using FONTFORMAT
ValueOptional. Current state of the button. TRUE for pushed and FALSE for released. If a cell reference is used, a value change from user interaction will be pushed into that cell.

Return Value

TRUE, if checkbox could be created.

Example

FunctionResultComment
=DRAW.CHECKBOX("ID1", "", "Checkbox1", 1000, 1000, 3000, 3000,,,,,,,"Click Me!", FONTFORMAT("Arial", 9))TRUEDraw a checkbox using 'Click Me!' as a label with an 'Arial 9' font.