Class
ComponentInputBehavior

Extends ComponentBehavior to provide comprehensive input handling capabilities including mouse, keyboard, and gesture input processing for RadControl components.

Definition

Namespace:Telerik.WinControls

Assembly:Telerik.WinControls.dll

Syntax:

cs-api-definition

public class ComponentInputBehavior : ComponentBehavior, IDisposable

Inheritance: objectComponentBehaviorComponentInputBehavior

Derived Classes: RadSpreadsheetComponentInputBehaviorRadRibbonBar.RibbonBarInputBehaviorRadRibbonBarBackstageView.RibbonBackstageViewInputBehaviorRadRichTextEditorComponentInputBehaviorRadSyntaxEditorComponentInputBehavior

Implements: IDisposable

Inherited Members ComponentBehavior.ItemCaptureStateComponentBehavior.Dispose()ComponentBehavior.GetActivatedItem(Control, char)ComponentBehavior.GetActivatedItem(RadElement, char)ComponentBehavior.ProcessMnemonic(char)ComponentBehavior.GetThemedChildControlsList(Control, List<Control>)ComponentBehavior.GetValidChildControlByMnemonic(List<Control>, char)ComponentBehavior.GetMnemonicText(string)ComponentBehavior.ProcessMnemonicChar(char)ComponentBehavior.OnGotFocus(EventArgs)ComponentBehavior.OnLostFocus(EventArgs)ComponentBehavior.IsFocusWithin(RadElement)ComponentBehavior.SetElementValue(RadElement, RadProperty, object)ComponentBehavior.HideScreenTip()ComponentBehavior.DisposeKeyTips()ComponentBehavior.SetKeyMap()ComponentBehavior.InitializeKeyMap()ComponentBehavior.ResetKeyMap()ComponentBehavior.ResetKeyMapInternal()ComponentBehavior.GetKeyMapFocus()ComponentBehavior.SetInternalKeyMapFocus()ComponentBehavior.ReturnKeyMapFocus()ComponentBehavior.OnEnableKeyTipsChanged()ComponentBehavior.InitializeAdornerLayer()ComponentBehavior.DisposeAdornerLayer()ComponentBehavior.GetRootItems()ComponentBehavior.ActivateSelectedItem(RadItem)ComponentBehavior.ProcessUnmappedItems(List<RadItem>)ComponentBehavior.IsIndexOfItemKeyTip(RadItem, string)ComponentBehavior.IsExactMatch(RadItem, string)ComponentBehavior.IsPartOfKeyTip(Keys, string)ComponentBehavior.GetCurrentKeyMap(RadItem)ComponentBehavior.GetKeyFocusChildren(RadItem)ComponentBehavior.GetKeyStringRepresentation(Keys)ComponentBehavior.FocusedElementComponentBehavior.AllowShowFocusCuesComponentBehavior.ToolTipComponentBehavior.ToolTipOffsetYComponentBehavior.ToolTipOffsetXComponentBehavior.DefaultShowItemToolTipsComponentBehavior.ShowItemToolTipsComponentBehavior.ShowScreenTipsBellowControlComponentBehavior.CommandBindingsComponentBehavior.IsParentFormActiveComponentBehavior.EnableKeyMapComponentBehavior.MouseOverComponentBehavior.OwnerComponentBehavior.OwnerControlComponentBehavior.SelectedElementComponentBehavior.BitmapRepository

Constructors

ComponentInputBehavior(IComponentTreeHandler)

Initializes a new instance of the ComponentInputBehavior class for the specified component tree handler.

Declaration

cs-api-definition

public ComponentInputBehavior(IComponentTreeHandler owner)

Parameters

owner

IComponentTreeHandler

The IComponentTreeHandler that owns this input behavior instance.

Remarks

The constructor calls the base ComponentBehavior constructor and initializes input-specific settings. By default, it enables item tooltips based on the ShowItemToolTips setting.

This constructor establishes the input handling system for the component, preparing it to process mouse, keyboard, and gesture input events and route them appropriately through the element tree.

Properties

Enable

Gets or sets a value indicating whether input processing is enabled for this component.

Declaration

cs-api-definition

[Browsable(false)]
public bool Enable { get; set; }

Property Value

true if input events should be processed; otherwise, false. The default is true.

Remarks

When this property is set to false, the component will not process mouse, keyboard, or other input events. This can be useful for temporarily disabling interaction during certain operations or states.

MouseHoverTimer

Gets the mouse hover timer used to detect and handle mouse hover events.

Declaration

cs-api-definition

protected MouseHoverTimer MouseHoverTimer { get; }

Property Value

MouseHoverTimer

A MouseHoverTimer instance used for hover detection and timing.

Remarks

This timer is used internally to manage mouse hover detection, determining when the mouse has remained stationary over an element long enough to trigger hover-related events and visual feedback such as tooltips.

Methods

Dispose(bool)

Declaration

cs-api-definition

protected override void Dispose(bool disposing)

Parameters

disposing

Overrides ComponentBehavior.Dispose(bool)

GetHoveredRadElement()

Declaration

cs-api-definition

public RadElement GetHoveredRadElement()

Returns

HandleMouseLeave(EventArgs)

Declaration

cs-api-definition

protected void HandleMouseLeave(EventArgs e)

Parameters

e

HandleMouseLeave(EventArgs, RadElement)

Declaration

cs-api-definition

protected void HandleMouseLeave(EventArgs e, RadElement elementUnderMouse)

Parameters

e

elementUnderMouse

OnClick(EventArgs)

Declaration

cs-api-definition

public virtual bool OnClick(EventArgs e)

Parameters

e

Returns

OnDoubleClick(EventArgs)

Declaration

cs-api-definition

public virtual bool OnDoubleClick(EventArgs e)

Parameters

e

Returns

OnGesture(GestureEventArgs)

Declaration

cs-api-definition

protected virtual void OnGesture(GestureEventArgs e)

Parameters

e

GestureEventArgs

OnHoveredElementChanged(HoveredElementChangedEventArgs)

Declaration

cs-api-definition

protected virtual void OnHoveredElementChanged(HoveredElementChangedEventArgs e)

Parameters

e

HoveredElementChangedEventArgs

OnMouseCaptureChanged(EventArgs)

Declaration

cs-api-definition

public virtual void OnMouseCaptureChanged(EventArgs e)

Parameters

e

OnMouseDown(MouseEventArgs)

Declaration

cs-api-definition

public virtual bool OnMouseDown(MouseEventArgs e)

Parameters

e

Returns

OnMouseEnter(EventArgs)

Declaration

cs-api-definition

public virtual bool OnMouseEnter(EventArgs e)

Parameters

e

Returns

OnMouseHover(EventArgs)

Declaration

cs-api-definition

public virtual bool OnMouseHover(EventArgs e)

Parameters

e

Returns

OnMouseLeave(EventArgs)

Declaration

cs-api-definition

public virtual bool OnMouseLeave(EventArgs e)

Parameters

e

Returns

OnMouseMove(MouseEventArgs)

Declaration

cs-api-definition

public virtual bool OnMouseMove(MouseEventArgs e)

Parameters

e

Returns

OnMouseUp(MouseEventArgs)

Declaration

cs-api-definition

public virtual bool OnMouseUp(MouseEventArgs e)

Parameters

e

Returns

OnMouseWheel(MouseEventArgs)

Declaration

cs-api-definition

public virtual bool OnMouseWheel(MouseEventArgs e)

Parameters

e

Returns

Events

HoveredElementChanged

Fires when hovered element is changed.

Declaration

cs-api-definition

public event HoveredElementChangedEventHandler HoveredElementChanged

Event Value

HoveredElementChangedEventHandler