Dgs-dxcheckbox

DGS Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxcheckbox that you could use.

Main Functions

• dgsSetProperty
• dgsGetProperty

Properties

alignment

Alignment of the text within the checkbox.

The functions as follows are basic on this property.

dgsCheckBoxSetHorizontalAlign/dgsCheckBoxGetHorizontalAlign

dgsCheckBoxSetVerticalAlign/dgsCheckBoxGetVerticalAlign

dgsSetProperty(checkbx,"alignment",{alignX,alignY})

• alignX: Horizontal alignment of the text within the checkbox. Can be "left", "center" or "right".
• alignY: Vertical alignment of the text within the checkbox. Can be "top", "center" or "bottom".

buttonSize

This property determines the button size of the check box.

dgsSetProperty(checkbox,"buttonSize",{size,relative})

• size: A number of the size of the button on screen.
• relative: A bool indicates whether the size is relative or absolute.

dgsSetProperty(checkbox,"buttonSize",{width,height,relative})

• width: A number of the width of the button on screen.
• height: A number of the height of the button on screen.
• relative: A bool indicates whether the size is relative or absolute.

clip

Whether the clip property is enabled or not. Learn More dxDrawText

dgsSetProperty(checkbox,"clip",clip)

• clip: If set to true, the parts of the text that don't fit within the bounding box will be cut off.

colorIndeterminate

This property determines the color of the icon under 3 conditions when the check box is indeterminate.

dgsSetProperty(checkbox,"colorIndeterminate",{ColorNormal,ColorHover,ColorClick})

• ColorNormal: An integer of the color of the icon under normal state. (indeterminate)
• ColorHover: An integer of the color of the icon under hovering state. (indeterminate)
• ColorClick: An integer of the color of the icon under clicked state. (indeterminate)

colorUnchecked

This property determines the color of the icon under 3 conditions when the check box is unchecked.

dgsSetProperty(checkbox,"colorUnchecked",{ColorNormal,ColorHover,ColorClick})

• ColorNormal: An integer of the color of the icon under normal state. (unchecked)
• ColorHover: An integer of the color of the icon under hovering state. (unchecked)
• ColorClick: An integer of the color of the icon under clicked state. (unchecked)

colorChecked

This property determines the color of the icon under 3 conditions when the check box is checked.

dgsSetProperty(checkbox,"colorChecked",{ColorNormal,ColorHover,ColorClick})

• ColorNormal: An integer of the color of the icon under normal state. (checked)
• ColorHover: An integer of the color of the icon under hovering state. (checked)
• ColorClick: An integer of the color of the icon under clicked state. (checked)

colorCoded

Whether the color code is enabled or not. Learn More dxDrawText

dgsSetProperty(checkbox,"colorCoded",colorCoded)

• colorCoded: Set to true to enable embedded #FFFFFF color codes.

font

This is equivalent to dgsSetFont/dgsGetFont. Learn More dxDrawText

dgsSetProperty(checkbox,"font",font)

• font: A string or a dx font element of the text font of the checkbox.

imageUnchecked

This property determines the icon under 3 conditions when the check box is unchecked.

dgsSetProperty(checkbox,"imageUnchecked",{ImageNormal,ImageHover,ImageClick})

• ImageNormal: An image element of the icon under normal state. (unchecked)
• ImageHover: An image element of the icon under hovering state. (unchecked)
• ImageClick: An image element of the icon under clicked state. (unchecked)

imageIndeterminate

This property determines the icon under 3 conditions when the check box is indeterminate.

dgsSetProperty(checkbox,"imageIndeterminate",{ImageNormal,ImageHover,ImageClick})

• ImageNormal: An image element of the icon under normal state. (indeterminate)
• ImageHover: An image element of the icon under hovering state. (indeterminate)
• ImageClick: An image element of the icon under clicked state. (indeterminate)

image_t

This property determines the icon under 3 conditions when the check box is checked.

dgsSetProperty(checkbox,"image_t",{ImageNormal,ImageHover,ImageClick})

• ImageNormal: An image element of the icon under normal state. (checked)
• ImageHover: An image element of the icon under hovering state. (checked)
• ImageClick: An image element of the icon under clicked state. (checked)

shadow

The shadow text of the checkbox.

dgsSetProperty(checkbox,"shadow",{offsetX,offsetY,color,outline})

• offsetX: A float of the 2D X offset of the shadow text of the checkbox.
• offsetY: A float of the 2D Y offset of the shadow text of the checkbox.
• color: An integer of the color of the shadow text of the checkbox.
• outline: A bool of the outline state of the shadow text.

state

This property stores the state of the check box.

dgsSetProperty(checkbox,"state",state)

• state: A bool/nil of the state. Values can be as follows:
  • true: Checked
  • false: Unchecked
  • nil: indeterminate

text

This is equivalent to dgsSetText/dgsGetText.

dgsSetProperty(checkbox,"text",text)

• text: A string of the text of the checkbox.

textColor

The color which can be translated by tocolor of the text of the checkbox.

dgsSetProperty(checkbox,"textColor",textColor)

• textColor: An integer of the color of the text of the checkbox.

textPadding

This property determines the padding between the text and icon.

dgsSetProperty(checkbox,"textPadding",textPadding)

• textPadding A float of the distance from the icon to the text of the check box.

textSize

The scale of the text of the checkbox. Learn More dxDrawText

dgsSetProperty(checkbox,"textSize",{scaleX,scaleY})

• scaleX: A float of the 2D X scale of the text of the checkbox.
• scaleY: A float of the 2D Y scale of the text of the checkbox.

wordBreak

Whether the word-break is enabled or not. Learn More dxDrawText

dgsSetProperty(checkbox,"wordBreak",wordBreak)

• wordBreak: If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

See Also

General Properties

• DGS General Basic Properties

Unique Properties For DGS Core Elements

• dgs-dx3dinterface
• dgs-dx3dimage
• dgs-dx3dtext
• dgs-dx3dline
• dgs-dxbutton
• dgs-dxcheckbox
• dgs-dxcombobox
• dgs-dxdetectarea
• dgs-dxedit
• dgs-dxgridlist
• dgs-dximage
• dgs-dxlabel
• dgs-dxline
• dgs-dxmemo
• dgs-dxprogressbar
• dgs-dxradiobutton
• dgs-dxscrollbar
• dgs-dxscrollpane
• dgs-dxselector
• dgs-dxswitchbutton
• dgs-dxtabpanel
• dgs-dxtab
• dgs-dxwindow