## Multi-state Symbol Image

A Multi-state symbol control widget uses multiple images to represent its different state. It supports GIF, PNG and SVG format.

"On/Off" colors of the symbol image can be selected. "Off" refers to "state 0" and "On" to all other states. These colors will affect only black elements in the symbol (strokes or filled forms). A label displaying the current state can be activated.

The multistate image file name must include the state value in order to be displayed when the variable has this value, otherwise the widget will display "??".

The File Path Browser automatically filters the filename with a regular expression which is based on the PV name. This option can be unchecked in the browser. The regular expression is defined in the preferences.ini file (`org.csstudio.boy.symbol.filter.regex`).

### Special Properties

- Symbol Image (image_file)
    The images used by the widget.
- Stretch to Fit (stretch_to_fit)
    Stretch the images to fit the widget size.
- Auto Size (auto_size)
    Automatically adjust the size of the widget to the images size. This only works if `Stretch to Fit` is not enabled.
- Show Symbol Label (show_symbol_label)
    If the label should be visible. Label is current state
- Symbol Label Position (symbol_label_pos)
    Label position picked in the following list:
    - DEFAULT
    - TOP
    - LEFT
    - CENTER
    - RIGHT
    - BOTTOM
    - TOP_LEFT
    - TOP_RIGHT
    - BOTTOM_LEFT
    - BOTTOM_RIGHT

### See Also

- Properties Common to PV Widgets
- Properties Common to All Widgets