Style Customizer Window
The Style Customizer window has multiple parts to it.
- Driving Property - The value of the selected property will be used to determine the style used. Only certain properties on the component can be used as drivin properties, but the most common are discrete state properties. Custom Properties can also be used here.
- Styled Properties - Here you can select which properties will be used in the styles. Any properties that are in the left panel are available to be used in the styles, while properties in the right panel are already being used in the style. Properties can be moved between the panels by selecting it and clicking the appropriate arrow button.
- Styles - The list of styles that will be available for this component. Each style has a Value property on the left. When the value of the Driving Property is greater than or equal to the value of a style, that style will be applied to the component. Each style gives a preview of what it looks like, and can be expanded to edit the properties within that style. You will notice in the example below that the properties being used in the Styled Properties are the Background Color, Border, Foreground Color, and Text, which corresponds to the properties we have available within each style in the Styles area. Each style can also be animated by clicking the animation checkbox. This allows you to add different steps to the style, where each step of the style can have its own unique style. Each step also gains a Step Duration (ms) property that is used to determine how long the step is active for. This is typically used to create a flashing effect, where the component will flash between two different colors.
You can bind a property that is already being used by a style, but a warning icon will appear on the property, and the property name turns red in the In the Property Editor. This means there is a conflict between the binding on the property, and the style on the component. As a general practice, only the style or binding should write to the property, not both.
Style Customizer Example
The best example of the Style Customizer in action is the Multi-State Indicator, as this component uses the style customizer to work properly and switch between different states, so it can be used as an example already built in. However, the many other components can use the Style Customizer, so this example will set up styles for a Cylindrical Tank.
- Add a Cylindrical Tank component to the window, and right click on it and go to Customizers > Style Customizer.
- Select a Driving Property. Here, the Value is a good choice as we can change the tank to flash when the contents get too high.
- We can then select the Styled Properties. I have selected the Border, Liquid Color, and Show Value.
- Lastly, we need to set up the different styles. I have added three styles, and set the values to be 0.00, 50.00, and 90.00.
- For the style at 0 and above, I have left everything at the default, so that the tank looks normal.
- For the style at 50 and above, I have added a large yellow border. This way, it is obvious the tank is filling up.
- For the style at 90 and above, I have animated the style, and created two steps, to alert the user that the tank is almost full.
- The first step has a duration of 500ms, a red border, an orange liquid color, and I have opted to show the value of the tank.
- The second step has a duration of 1000ms, an orange border, a red liquid color, and is also showing the value of the tank.
- Once we have saved our style, we can try it out by changing the value of the tank.