Properties

<< Click to Display Table of Contents >>

Manual > Control Reference > Basics > Toggle button control >

Properties

Property Name

explanation

All common properties

For details, please refer to Common Properties.

 

 

Property Name

explanation

SwitchValue

A value indicating the ON/OFF state of the switch.

PushType

The type of depression state when the button is pressed.

NONE

Do not leave it in a dented state.

MOUSE

Make it dent when you press the mouse.

VALUE

SwitchValue Depresses when the value is ON.

 

 

 

Property Name

explanation

GroupObject

Specify this when grouping multiple toggle switches.

This property should only be set for parent controls. Specify the names of other controls to be grouped, separated by commas (do not include the parent control name itself).

 

Example) Grouping Toggle01 to Toggle05 with Toggle01 as the parent

Toggle02, Toggle03, Toggle04, Toggle05

GroupThisValue

A value to represent your control.

Please set a unique value within the group.

GroupValue

A value that represents which control within a grouping is currently selected.

The value of GroupThisValue of the currently selected control is dynamically set. Please set the binding to this property only to the parent control of the grouping (the control that defines GroupObject).

 

 

Property Name

explanation

Text

text.

TextFont

Font of the text.

TextColor

Text color.

TextLineSpace

Space between lines of text when there is more than one line of text.

TextColorOn

The text color when SwitchValue is ON.

TextCenterX

The X position of the center of the text (0 to 1).

TextCenterY

The Y position of the center of the text (0 to 1).

 

 

Property Name

explanation

Border

Whether to show the border.

BorderColor

Border color.

Only valid when BorderStyle is set to FLAT.

BorderWidth

Border thickness.

Only valid when BorderStyle is FLAT or 3D_FRAME.

BorderLine

Border style.

Only valid when BorderWidth is 1.

SOLID

Straight Line

DASH

dotted line

DOT

Dotted line

DASHDOT

Dotted line + dotted line

DASHDOTDOT

Dotted line + dotted line + dotted line

 

BorderStyle

Border style.

FLAT

flat

3D_FRAME

3D

3D_RAISE1

3D (convex)

3D_RAISE2

3D (high convex)

TABTOP

Specify this if you want to use a toggle button for the tab display. For details, please refer to the sample (toggle button) in here (Control Reference Sample).

TABBOTTOM

As above. For more information, please refer to the sample (toggle button) in here (Control Reference Sample).

＠BorderStyleX

Thematic Settings

 

BorderRound

Roundness of the vertices. Only effective when BorderStyle is FLAT.

Border3DLight

The color of the 3D border where light hits.

This is only valid when BorderStyle is 3D_RAISE or 3D_SUNK.

Border3DShadow

The color of the shadow part of the 3D border.

This is only valid when BorderStyle is 3D_RAISE or 3D_SUNK.

 

 

hmtoggle_plus0Fill

Property Name

explanation

FillColor

Background color.

FillStyle

Background fill style.

SOLID

fill

HORIZONTAL

Yokoshima

VERTICALSOLID

Vertical stripes

FORWARD DIAGONAL

diagonal

BACKWARD DIAGONAL

diagonal

CROSS

cross

DIAGONAL CROSS

Diagonal Cross

 

FillColorOn

Background color when SwitchValue is TRUE.

If not specified, it will remain unchanged as FillColor.

FillColorPush

Background color of the button when it is pressed.

If not specified, it will remain unchanged as FillColor.

FillColorHover

The background color when the mouse is passing over the control.

If not specified, it will remain unchanged as FillColor.

FillType

Type of fill.

NONE

Do not fill in.

FULL

Fill the whole area.

TOP

Fill the top area by FillSize.

BOTTOM

Fill the bottom area by FillSize.

LEFT

Fill the left part by FillSize.

RIGHT

Fill the right part with FillSize.

 

FillSize

The size of the fill when FillType is TOP/BOTTOM/LEFT/RIGHT.

 

 

Property Name

explanation

ImageFile

The path to the image file.

ImageLeft

The left X position of the image to be displayed on the button (0 to 1). Decimal values can be specified.

ImageTop

The upper Y position of the image to be displayed on the button (0 to 1). Decimal values can be specified.

ImageRight

The right position of the image to be displayed on the button in the X direction (0 to 1). Decimal values can be specified.

ImageBottom

The bottom Y position of the image to be displayed on the button (0 to 1). Decimal values can be specified.

ImageColor

Specify this if you want to change the color of the image to a single color.

ImageSizeX

0: Display full size in the display area

-1: Display the image file in its original size

-2: Display at full size in the display area (maintain aspect ratio)

1 or more: Display at the specified size (pixels)

ImageSizeY

0: Display full size in the display area

-1: Display the image file in its original size

-2: Display at full size in the display area (maintain aspect ratio)

1 or more: Display at the specified size (pixels)

 

 

Property Name

explanation

All common properties (library)

For details, please refer to Common Properties (Library).