Class

Key

Initializes a new instance of the Key class.

Declaration

public Key(int keyCode, KeyType keyType, double width, double height, bool sharpStyle = false, bool showSecondaryText = false)

Parameters

Initializes a new instance of the Key class.

Declaration

public Key(int keyCode, string displayText, KeyType keyType, double width, double height, bool sharpStyle = false, bool showSecondaryText = false, Font font = null)

Parameters

Dependency property that indicates whether the key should have more noticeable/sharp style.

Declaration

public static RadProperty IsSharpStyleProperty

Field Value

Dependency property that defines the fore color of secondary text element.

Declaration

public static RadProperty SecondaryForeColorProperty

Field Value

Gets or sets the name of the control for use by accessibility client applications.

Declaration

public override string AccessibleName { get; set; }

Property Value

Overrides RadItem.AccessibleName

Gets or sets the display text.

Declaration

public string DisplayText { get; set; }

Property Value

Gets or sets the font scale coefficient, used when key is larger or smaller than the KeyDefaultSize.

Declaration

public float FontScale { get; set; }

Property Value

Implements IKey.FontScale

Gets or sets the foreground color. Color type represents an ARGB color. Note that then shift key is active and secondary text is shown, the SecondaryForeColor value will be returned as ForeColor.

Declaration

public override Color ForeColor { get; set; }

Property Value

Overrides VisualElement.ForeColor

Gets or sets a value indicating whether the key will have more noticeable/sharp style.

Declaration

public bool IsSharpStyle { get; set; }

Property Value

Gets or sets the logical key height.

Declaration

public float KeyHeight { get; set; }

Property Value

Implements IKey.KeyHeight

Gets or sets the associated key info object.

Declaration

public KeyInfo KeyInfo { get; set; }

Property Value

Implements IKey.KeyInfo

Gets or sets the logical key bounds.

Declaration

public RectangleF KeyRectangle { get; set; }

Property Value

Implements IKey.KeyRectangle

Gets the type of the key.

Declaration

public KeyType KeyType { get; set; }

Property Value

Implements IKey.KeyType

Gets or sets the logical key width.

Declaration

public float KeyWidth { get; set; }

Property Value

Implements IKey.KeyWidth

Gets the owner element used to send the keys.

Declaration

public IVirtualKeyboardKeyInputSender Owner { get; }

Property Value

Implements IKey.Owner

Gets or sets the secondary text fore color.

Declaration

public Color SecondaryForeColor { get; set; }

Property Value

Gets the element that display the secondary text.

Declaration

public LightVisualElement SecondaryTextElement { get; }

Property Value

Gets or sets a value indicating whether to show the secondary text.

Declaration

public bool ShowSecondaryText { get; set; }

Property Value

Gets the type by which this instance is being themed.

Declaration

protected override Type ThemeEffectiveType { get; }

Property Value

Overrides RadElement.ThemeEffectiveType

Gets the virtual key code.

Declaration

public int VirtualKey { get; set; }

Property Value

Implements IKey.VirtualKey

Arranges the key in the specified rectangle.

Declaration

public void ArrangeKey(RectangleF rectangle)

Parameters

Implements IKey.ArrangeKey(RectangleF)

Called by the element when constructed. Allows inheritors to build the element tree.

Declaration

protected override void CreateChildElements()

Overrides RadElement.CreateChildElements()

Creates a SecondaryTextElement used as an element to display the secondary text.

Declaration

protected virtual SecondaryTextElement CreateSecondaryTextElement()

Returns

Gets the font scale coefficient

Declaration

protected virtual float GetKeyScaleCoefficient(float scale, bool reduceDownscale = false)

Parameters

Returns

Scales the Font used by the Paint process. The Font property is not changed.

Declaration

public override Font GetScaledFont(float scale)

Parameters

Returns

Overrides VisualElement.GetScaledFont(float)

Initializes member fields to their default values. This method is called prior the CreateChildItems one and allows for initialization of members on which child elements depend.

Declaration

protected override void InitializeFields()

Overrides LightVisualRepeatButtonElement.InitializeFields()

Raises the Click event.

Declaration

protected override void OnClick(EventArgs e)

Parameters

Overrides RadElement.OnClick(EventArgs)

Called when the element has been successfully loaded. That includes loading of all its children as well.

Declaration

protected override void OnLoaded()

Overrides LightVisualElement.OnLoaded()

Sends a virtual key code or string.

Declaration

public virtual void SendKey()

Implements IKey.SendKey()

Updates key text and other necessary styles.

Declaration

public virtual void UpdateKey()

Implements IKey.UpdateKey()