Represents a class that hosts all BaseVirtualKeyboardLayout instances and contains the layout implementation. This class also has several predefined layouts panels.
Definition
Namespace:Telerik.WinControls.VirtualKeyboard
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class VirtualKeyboardLayoutPanel : BaseVirtualKeyboardLayout, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IStylableNode, IVirtualKeyboardLayout
Inheritance: objectDisposableObjectRadObjectRadElementBaseVirtualKeyboardLayoutVirtualKeyboardLayoutPanel...
Derived Classes:
Implements:
Inherited Members
Constructors
Initializes a new instance of the VirtualKeyboardLayoutPanel class.
public VirtualKeyboardLayoutPanel()
Initializes a new instance of the VirtualKeyboardLayoutPanel class.
public VirtualKeyboardLayoutPanel(Orientation orientation)
The orientation of KeyboardLayouts.
Properties
Gets a collection of all added BaseVirtualKeyboardLayout instances.
public ObservableCollection<BaseVirtualKeyboardLayout> KeyboardLayouts { get; }
Gets or sets the default size in pixels for keys.
public static SizeF KeyDefaultSize { get; set; }
Gets or sets the spacing between each BaseVirtualKeyboardLayout in KeyboardLayouts.
public double LayoutSpacing { get; set; }
Gets or sets the way how KeyboardLayouts are arranged. Default value is Horizontal.
public Orientation Orientation { get; set; }
Gets the total number of logical columns.
public override double TotalColumnsCount { get; }
Overrides:
Gets the total number of logical rows.
public override double TotalRowsCount { get; }
Overrides:
Methods
Arranges the KeyboardLayouts horizontally.
protected virtual void ArrangeHorizontally(SizeF finalSize)
The final size.
Arranges the VirtualKeyboardLayoutPanel to its final location. The element must call the Arrange method of each of its children.
protected override SizeF ArrangeOverride(SizeF finalSize)
The size that is available for element.
Returns:The rectangle occupied by the element. Usually finalSize. Should you return different size, the Layout system will restart measuring and rearranging the items. That could lead to infinite recursion.
Overrides:
In this method call to the Arrange method of each child must be made.
Arranges the KeyboardLayouts vertically.
protected virtual void ArrangeVertically(SizeF finalSize)
The final size.
Creates a new instance of the VirtualKeyboardLayoutPanel class with added panels, layouts and buttons for extended keyboard layout. This includes the functions keys, main keys, home buttons and numpad keyboard groups.
public static VirtualKeyboardLayoutPanel CreateExtendedKeyboardLayout(bool addFunctionKeys = true)
A value indicating whether to include the function keys group.
Returns:The created instance.
Creates a new instance of the VirtualKeyboardLayoutPanel class with added panels, layouts and buttons. This may include the functions keys, main keys, home buttons and/or numpad keyboard groups based on passed parameters.
public static VirtualKeyboardLayoutPanel CreateKeyboardLayout(bool addFunctionKeys = true, bool addNumpadGroup = true, bool addHomeGroup = true, bool addArrowsInMainGroup = false)
A value indicating whether to include the function keys group.
addNumpadGroupboolA value indicating whether to include the numpad keys group.
addHomeGroupboolA value indicating whether to include the home keyboard buttons group.
addArrowsInMainGroupboolA value indicating whether to include the arrow keys in the main group.
Returns:The created instance.
Creates a new instance of the VirtualKeyboardLayoutPanel class with added panels, layouts and buttons for numpad keyboard layout. This includes the numpad buttons group.
public static VirtualKeyboardLayoutPanel CreateNumpadLayout(bool defaultLayout = true)
If true loads the default Numpad buttons layout(numlock button is on the bottom), otherwise the traditional(numlock is on top).
Returns:The created instance.
Creates a new instance of the VirtualKeyboardLayoutPanel class with added panels, layouts and buttons for simplified keyboard layout. This includes the main buttons group.
public static VirtualKeyboardLayoutPanel CreateSimplifiedKeyboardLayout(bool addHomeGroup = false)
A value indicating whether to include the home keyboard buttons group.
Returns:The created instance.
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.
protected override void InitializeFields()
Overrides:
Measures the space required by the VirtualKeyboardLayoutPanel
Used by the layout system.
protected override SizeF MeasureOverride(SizeF availableSize)
The size that is available to the VirtualKeyboardLayoutPanel. The available size can be infinity (to take the full size of the element)
Returns:The minimum size required by the element to be completely visible. Cannot be infinity.
Overrides:
In this method call to the Measure method of each child must be made.
Resets the logical layout. When VirtualKeyboardLayoutPanels, VirtualKeyboardLayout and/or IKeys are added, removed or changed, this method needs to be called to refresh and update the logical layout.
public override void ResetLayout()
Overrides:
Gets a value indicating, whether a child will be arranged during the ArrangeOverride.
protected override bool ShouldArrangeChild(RadElement child)
The child.
Returns:Whether the child will be arranged in ArrangeOverride.
Overrides: