Led Light
Led supports on, off, or blinking states, and includes several options for customizing the look of the led light.
State
The led light can be in one of three states (on, off, or blinking), which is set using the LedState property.
Two Led controls with the led light on (left) and off (right)
When blinking, the light will be toggle between on and off at the interval specified by the BlinkInterval.
Appearance
Light Shape
The led light defaults to a circle, but supports several shapes including arrows, triangles, rectangles, etc. The led light type is specified using the LedType property.
Led using an arrow that points down for the led light
When the built-in led types are not flexible enough to achieve the look desired, a custom Geometry
can be used.
When LedType is set to to CustomGeometry, then the Geometry
specified by LedGeometry is used when rendering the led light.
Light Size
The size of the led light is control by the LedRadiusRatio property, which is defined as a percentage of the Radius.
Note
When using led light that is not circular, the associated shape is sized such that it would fit inside a circle with the associated radius computed from LedRadiusRatio
and Radius
.
Two Led controls with a led radius ratio of 80% (left) and 60% (right)
Brush and Effect
The led background and foreground colors can be customized by setting the LedBackground and LedForeground, respectively. The led effect can be disabled entirely by setting IsLedEffectEnabled to false
.
Two Led controls with a red light; the right image has the led effect disabled
Note
The led effect is only supported when IsLedEffectEnabled is set to true
andLedBackground/LedForeground are set to a SolidColorBrush
.
The LedState
of the Led
determines how the foreground of the light is rendered, but regardless of the state the led light background is rendered using the LedBackground
brush. Using the LedState
, the led light foreground is rendered on top of the background, using a varying opacity. If the the light is On
then LedOnOpacity is used. If the the light is Off
then LedOffOpacity is used. If the the light is Blinking
then the opacity is animated to and from LedOnOpacity
and LedOffOpacity
.
By default, the led light includes a thin black border, but this can be customzied by setting the LedBorderBrush and/or LedBorderThickness appropriately.
Value Converters
A value converter, that can be used in data binding, is provided to convert between Boolean and LedState
types. See the Advanced Features\Converters topic for more information.