Ratings
Type
widget
Summary
The ratings widget provides information about the opinions and experiences of others, and can allow the user to submit their own rating.
Description
The ratings widget provides information about the opinions and experiences of others, and can allow the user to submit their own rating.
Compatibility and Support
OS
mac
windows
linux
ios
android
Platforms
desktop
mobile
web
Associated Syntax
Property
| Name | Summary | Syntax |
|---|---|---|
| iconFilledColor | Specifies the color applied to the icon when it is filled. | set the iconFilledColor of widget to {<RGB Color>} get the iconFilledColor of widget |
| iconNameEmpty | Specifies the name of the icon that is displayed when empty. | set the iconNameEmpty of widget to <iconName> get the iconNameEmpty of widget |
| iconNamesFilled | Specifies the icon name that is displayed when filled, for each icon. | set the iconNamesFilled of widget to {<iconName>,<iconName>,...,<iconName>} get the iconNamesFilled of widget |
| maxValue | Specifies the max value of the rating bar. | set the maxValue of widget to <integer> get the maxValue of widget |
| readOnly | Defines if the user can modify the value of the grades using the mouse or not. | set the readOnly of widget to {<true> | <false>} get the readOnly of widget |
| iconHoveredColor | Specifies the color that is applied to the icon when the pointer is over it. | set the iconHoveredColor of widget to {<RGB Color>} get the iconHoveredColor of widget |
| iconNamesEmpty | Specifies the icon name that is displayed when empty, for each icon. | set the iconNamesEmpty of widget to <iconName> get the iconNamesEmpty of widget |
| toggle | Defines if it behaves as a toggle when the same icon is selected. | set the toggle of widget to {<true> | <false>} get the toggle of widget |
| currentValue | Specifies the value of the rating bar. | set the currentValue of widget to <integer> get the currentValue of widget |
| iconNameFilled | Specifies the name of the icon that is displayed when filled. | set the iconNameFilled of widget to <iconName> get the iconNameFilled of widget |
| disableHover | Disable hover effects if set to true. | set the disableHover of widget to {<true> | <false>} get the disableHover of widget |
| iconEmptyColor | Specifies the color applied to the icon when it is not filled. | set the iconEmptyColor of widget to {<RGB Color>} get the iconEmptyColor of widget |
| highlightSelectedOnly | If `true`, only the selected icon will be highlighted. | set the highlightSelectedOnly of widget to {<true> | <false>} get the highlightSelectedOnly of widget |
Message
| Name | Summary | Syntax |
|---|---|---|
| hiliteChanged | Message generated when changing the current value of the ratings widget. | hiliteChanged <pNewValue>, <pOldValue> |