New to Telerik UI for WinForms? Start a free 30-day trial

Represents a class that is responsible for handling all the input for a RadGanttView

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

C#
public class BaseGanttViewBehavior

Inheritance: objectBaseGanttViewBehavior

Constructors

Initializes a new instance of the BaseGanttViewBehavior class.

C#
public BaseGanttViewBehavior()

Properties

Gets the timer that delays cell editing after a second click.

C#
protected Timer ClickTimer { get; }

Gets or sets the column-header cell whose column is being resized.

C#
protected GanttViewTextViewHeaderCellElement ColumnHeaderCell { get; set; }

Gets or sets whether the current mouse sequence is a double-click, which suppresses cell editing on mouse-up.

C#
protected bool DoubleClick { get; set; }

Gets or sets the existing task link whose endpoint is being edited.

C#
protected GanttViewLinkDataItem EditedLink { get; set; }

Gets or sets the original task endpoint temporarily detached while editing a link.

C#
protected GanttViewDataItem EditedLinkTaskCache { get; set; }

Gets or sets the link type saved before editing, so it can be restored if the edit is canceled.

C#
protected TasksLinkType EditedLinkTypeCache { get; set; }

Gets or sets the graphical task element currently being resized.

C#
protected GanttGraphicalViewBaseTaskElement EditedTaskElement { get; set; }

Gets the mutable list of exact element types that can initiate kinetic scrolling.

C#
public List<Type> ElementsStartingKineticScrolling { get; }

Gets the GanttView element whose input and interaction state this behavior manages.

C#
public RadGanttViewElement GanttViewElement { get; }

Gets or sets the signed horizontal scrollbar increment used on each horizontal auto-scroll timer tick.

C#
public int HorizontalScrollStep { get; set; }

Gets the timer that advances horizontal scrolling while an interaction is dragged beyond the graphical view.

C#
public Timer HorizontalScrollTimer { get; }

Gets or sets whether a new task link is being created by dragging a link handle.

C#
protected bool IsCreatingLink { get; set; }

Gets or sets whether an existing task link endpoint is being edited.

C#
protected bool IsEditingLink { get; set; }

Gets or sets whether a column resize is in progress.

C#
protected bool IsResizingColumn { get; set; }

Gets or sets whether the end edge of a task is being resized.

C#
protected bool IsResizingEnd { get; set; }

Gets or sets whether the start edge of a task is being resized.

C#
protected bool IsResizingStart { get; set; }

Gets or sets the pointer location recorded when a cell press begins.

C#
protected Point MouseDownLocation { get; set; }

Gets or sets the task link being assembled during a link-creation drag.

C#
protected GanttViewLinkDataItem NewLink { get; set; }

Gets or sets the column width captured before resizing, for restoring it if the operation is canceled.

C#
protected int OriginalColumnWidth { get; set; }

Gets or sets the task end time captured before an end-edge resize, for restoring it if the operation is canceled.

C#
protected DateTime OriginalEnd { get; set; }

Gets or sets the task start time captured before a start-edge resize, for restoring it if the operation is canceled.

C#
protected DateTime OriginalStart { get; set; }

Gets or sets whether the current pointer gesture is eligible for kinetic scrolling.

C#
protected bool ShouldProcessKineticScrolling { get; set; }

Gets or sets the signed pointer-offset increment used on each vertical auto-scroll timer tick.

C#
public int VerticalScrollStep { get; set; }

Gets the timer that advances vertical scrolling while an interaction is dragged beyond the graphical view.

C#
public Timer VerticalScrollTimer { get; }

Gets or sets whether the view was already editing when the pointer was pressed.

C#
protected bool WasInEditModeOnMouseDown { get; set; }

Gets or sets whether the task was already selected when the pointer was pressed, which affects second-click editing.

C#
protected bool WasSelectedOnMouseDown { get; set; }

Methods

Determines whether the element at a point is an editor or a descendant of one.

C#
protected virtual bool IsEditor(Point point)
Parameters:pointPoint

The point to test, in control coordinates.

Returns:

bool

true when the point is within an editor element; otherwise, false.

Determines whether the element at a point is a scrollbar or a descendant of one.

C#
protected virtual bool IsScrollBar(Point point)
Parameters:pointPoint

The point to test, in control coordinates.

Returns:

bool

true when the point is within a scrollbar element; otherwise, false.

Advances the horizontal scrollbar by the configured step, extending the timeline by a day when scrolling reaches an edge.

C#
protected virtual void OnHorizontalScrollTimerTick()

Converts the configured pointer offset to a row-scroll change and clamps it to the available vertical range.

C#
protected virtual void OnVerticalScrollTimerTick()

Expands the selected task, if any.

C#
public virtual bool ProcessAddKey(KeyEventArgs e)
Parameters:eKeyEventArgs

The key event data.

Returns:

bool

false in the base implementation.

Opens the task-specific, control-level, or allowed default context menu at the specified point.

C#
public virtual bool ProcessContextMenu(Point location)
Parameters:locationPoint

The menu location in control coordinates.

Returns:

bool

true when a menu is shown and the opening event is not canceled; otherwise, false.

Removes the selected link when the GanttView is not read-only; it does not delete selected tasks.

C#
public virtual bool ProcessDeleteKey(KeyEventArgs e)
Parameters:eKeyEventArgs

The key event data.

Returns:

bool

false in the base implementation.

Routes Escape to cancellation and Enter to the edit toggle for dialog keys.

C#
public virtual bool ProcessDialogKey(Keys keyData)
Parameters:keyDataKeys

The key and modifier data.

Returns:

bool

false in the base implementation so the dialog key is not marked handled.

Provides a customization hook for double-click handling; the base implementation does not handle the event.

C#
public virtual bool ProcessDoubleClick(MouseEventArgs e)
Parameters:eMouseEventArgs

The mouse event data.

Returns:

bool

false in the base implementation.

Selects the next traversed item, or the first item when nothing is selected.

C#
public virtual bool ProcessDownKey(KeyEventArgs e)
Parameters:eKeyEventArgs

The key event data.

Returns:

bool

false in the base implementation.

Selects the last item reached by the GanttView item traverser.

C#
public virtual bool ProcessEndKey(KeyEventArgs e)
Parameters:eKeyEventArgs

The key event data.

Returns:

bool

false in the base implementation.

Releases pointer capture and cancels the active resize or edit, restoring the value captured when resizing began.

C#
protected virtual void ProcessEscapeKey(KeyEventArgs e)
Parameters:eKeyEventArgs

The Escape key event data.

Ends the current edit or begins editing the selected item.

C#
public virtual bool ProcessF2Key(KeyEventArgs e)
Parameters:eKeyEventArgs

The key event data.

Returns:

bool

false in the base implementation.

Selects the first item reached by the GanttView item traverser.

C#
public virtual bool ProcessHomeKey(KeyEventArgs e)
Parameters:eKeyEventArgs

The key event data.

Returns:

bool

false in the base implementation.

Routes supported key-down commands to navigation, expansion, editing, and link-deletion handlers when the view is not editing.

C#
public virtual bool ProcessKeyDown(KeyEventArgs e)
Parameters:eKeyEventArgs

The key event data.

Returns:

bool

false in the base implementation so the key event is not marked handled.

Provides an override hook for character input; the base implementation does not handle the key press.

C#
public virtual bool ProcessKeyPress(KeyPressEventArgs e)
Parameters:eKeyPressEventArgs

The key-press event data.

Returns:

bool

false in the base implementation.

Provides an override hook for key release; the base implementation does not handle the event.

C#
public virtual bool ProcessKeyUp(KeyEventArgs e)
Parameters:eKeyEventArgs

The key event data.

Returns:

bool

false in the base implementation.

Moves to the previous column, collapses an expanded selected task, or moves to the previous task.

C#
public virtual bool ProcessLeftKey(KeyEventArgs e)
Parameters:eKeyEventArgs

The key event data.

Returns:

bool

false in the base implementation.

Provides a customization hook for mouse-click handling; the base implementation does not handle the event.

C#
public virtual bool ProcessMouseClick(MouseEventArgs e)
Parameters:eMouseEventArgs

The mouse event data.

Returns:

bool

false in the base implementation.

Coordinates selection, editing, task and column interaction, link operations, and kinetic-scrolling startup for a mouse press.

C#
public virtual bool ProcessMouseDown(MouseEventArgs e)
Parameters:eMouseEventArgs

The mouse event data.

Returns:

bool

true if the input is handled; this base implementation returns false.

Ends an active edit when needed, selects the owning task, and records the press state for click-to-edit handling.

C#
protected virtual void ProcessMouseDownOnCellElement(GanttViewTextViewCellElement cellElement, MouseEventArgs e)
Parameters:cellElementGanttViewTextViewCellElement

The pressed task cell.

eMouseEventArgs

The mouse event data.

For a left-button press, starts resizing the column when the press is on its resize grip; otherwise, starts dragging the header cell.

C#
protected virtual void ProcessMouseDownOnCellHeaderElement(GanttViewTextViewHeaderCellElement element, MouseEventArgs e)
Parameters:elementGanttViewTextViewHeaderCellElement

The pressed column-header cell.

eMouseEventArgs

The mouse event data.

For a left-button press on an editable task, starts resizing an edge when its resize grip is pressed, or starts dragging the task otherwise.

C#
protected virtual void ProcessMouseDownOnTaskElement(GanttGraphicalViewBaseTaskElement element, MouseEventArgs e)
Parameters:elementGanttGraphicalViewBaseTaskElement

The pressed graphical task element.

eMouseEventArgs

The mouse event data.

For a left-button press on an editable view, creates a pending link from the task endpoint represented by the pressed handle.

C#
protected virtual void ProcessMouseDownOnTaskLinkHandleElement(GanttViewTaskLinkHandleElement element, MouseEventArgs e)
Parameters:elementGanttViewTaskLinkHandleElement

The pressed link handle.

eMouseEventArgs

The mouse event data.

For a left-button press on an editable view, temporarily detaches the selected link endpoint so it can be reconnected.

C#
protected virtual void ProcessMouseDownOnTaskLinkHandleElementWhenEditingLink(GanttViewTaskLinkHandleElement element, MouseEventArgs e)
Parameters:elementGanttViewTaskLinkHandleElement

The pressed handle on the selected link.

eMouseEventArgs

The mouse event data.

Provides a customization hook for mouse-enter handling; the base implementation does not handle the event.

C#
public virtual bool ProcessMouseEnter(EventArgs e)
Parameters:eEventArgs

The event data.

Returns:

bool

false in the base implementation.

Provides a customization hook for mouse-hover handling; the base implementation does not handle the event.

C#
public virtual bool ProcessMouseHover(EventArgs e)
Parameters:eEventArgs

The event data.

Returns:

bool

false in the base implementation.

Provides a customization hook for mouse-leave handling; the base implementation does not handle the event.

C#
public virtual bool ProcessMouseLeave(EventArgs e)
Parameters:eEventArgs

The event data.

Returns:

bool

false in the base implementation.

Updates an active resize or link operation and forwards the pointer movement to kinetic scrolling.

C#
public virtual bool ProcessMouseMove(MouseEventArgs e)
Parameters:eMouseEventArgs

The mouse event data.

Returns:

bool

true if the input is handled; this base implementation returns false.

Chooses a candidate task endpoint and link type from the pointer position, then updates the pending link preview.

C#
protected virtual void ProcessMouseMoveWhenCreatingLink(MouseEventArgs e)
Parameters:eMouseEventArgs

The mouse event data.

Updates the detached endpoint and link type from the pointer position, then refreshes the edited link preview.

C#
protected virtual void ProcessMouseMoveWhenEditingLink(MouseEventArgs e)
Parameters:eMouseEventArgs

The mouse event data.

Adjusts the header column width while the pointer is captured for resizing.

C#
protected virtual void ProcessMouseMoveWhenResizingColumn(MouseEventArgs e)
Parameters:eMouseEventArgs

The mouse event data.

Changes the task start or end time, enforces the minimum task width, and updates link lines during a resize.

C#
protected virtual void ProcessMouseMoveWhenResizingTask(GanttGraphicalViewBaseTaskElement element, MouseEventArgs e)
Parameters:elementGanttGraphicalViewBaseTaskElement

The graphical task element being resized.

eMouseEventArgs

The mouse event data.

Completes the active interaction, releases pointer capture, stops auto-scroll timers, and refreshes the graphical view.

C#
public virtual bool ProcessMouseUp(MouseEventArgs e)
Parameters:eMouseEventArgs

The mouse event data.

Returns:

bool

true if the input is handled; this base implementation returns false.

Applies click-to-edit modes when the recorded press point lies within the released task item's bounds and the release is not on an editor, scrollbar, or double-click.

C#
protected virtual void ProcessMouseUpOnCellElement(GanttViewTextViewCellElement cellElement, MouseEventArgs e)
Parameters:cellElementGanttViewTextViewCellElement

The cell under the release point.

eMouseEventArgs

The mouse event data.

Adds the pending link when released on another task's link handle; otherwise discards the unfinished link.

C#
protected virtual void ProcessMouseUpWhenCreatingLink(MouseEventArgs e)
Parameters:eMouseEventArgs

The mouse event data.

Reconnects the edited endpoint when released on a link handle, or restores the original endpoint and type when canceled.

C#
protected virtual void ProcessMouseUpWhenEditingLink(MouseEventArgs e)
Parameters:eMouseEventArgs

The mouse event data.

Clears the column-resize state after the pointer is released.

C#
protected virtual void ProcessMouseUpWhenResizingColumn(MouseEventArgs e)
Parameters:eMouseEventArgs

The mouse event data.

Clears the task-resize element and edge flags after the pointer is released.

C#
protected virtual void ProcessMouseUpWhenResizingTask(GanttGraphicalViewBaseTaskElement element, MouseEventArgs e)
Parameters:elementGanttGraphicalViewBaseTaskElement

The graphical task element that was resized.

eMouseEventArgs

The mouse event data.

Scrolls the column or timeline horizontally when Ctrl is held, or the graphical view vertically otherwise.

C#
public virtual bool ProcessMouseWheel(MouseEventArgs e)
Parameters:eMouseEventArgs

The mouse-wheel event data.

Returns:

bool

false while editing; otherwise, true to indicate that the wheel event is handled.

Moves to the next column, expands a collapsed selected task, or moves to the next task.

C#
public virtual bool ProcessRightKey(KeyEventArgs e)
Parameters:eKeyEventArgs

The key event data.

Returns:

bool

false in the base implementation.

Starts or stops edge auto-scrolling according to the pointer's position relative to the graphical view.

C#
protected virtual void ProcessScrolling(Point mousePosition, bool scrollVertical)
Parameters:mousePositionPoint

The pointer position in screen coordinates.

scrollVerticalbool

Whether vertical edge scrolling is allowed for the active interaction.

Collapses the selected task, if any.

C#
public virtual bool ProcessSubtractKey(KeyEventArgs e)
Parameters:eKeyEventArgs

The key event data.

Returns:

bool

false in the base implementation.

Selects the previous traversed item, or the first item when nothing is selected.

C#
public virtual bool ProcessUpKey(KeyEventArgs e)
Parameters:eKeyEventArgs

The key event data.

Returns:

bool

false in the base implementation.

Enables kinetic scrolling for a left-button press on an element type listed in ElementsStartingKineticScrolling.

C#
protected virtual bool ShouldHandleKineticScrolling(MouseEventArgs e)
Parameters:eMouseEventArgs

The mouse event data.

Returns:

bool

true when the pressed element's exact type is in the eligible-type list; otherwise, false.

Determines whether the specified link handle can be used to move an endpoint for the link's current type.

C#
protected virtual bool ShouldStartLinkEditOperation(GanttViewLinkDataItem link, GanttViewTaskLinkHandleElement element)
Parameters:linkGanttViewLinkDataItem

The selected link being edited.

elementGanttViewTaskLinkHandleElement

The handle that was pressed.

Returns:

bool

true when the handle is eligible to start endpoint editing; otherwise, false.

Stops both auto-scroll timers used during pointer interactions.

C#
public virtual void StopScrollTimers()
In this article
DefinitionConstructorsBaseGanttViewBehavior()PropertiesClickTimerColumnHeaderCellDoubleClickEditedLinkEditedLinkTaskCacheEditedLinkTypeCacheEditedTaskElementElementsStartingKineticScrollingGanttViewElementHorizontalScrollStepHorizontalScrollTimerIsCreatingLinkIsEditingLinkIsResizingColumnIsResizingEndIsResizingStartMouseDownLocationNewLinkOriginalColumnWidthOriginalEndOriginalStartShouldProcessKineticScrollingVerticalScrollStepVerticalScrollTimerWasInEditModeOnMouseDownWasSelectedOnMouseDownMethodsIsEditor(Point)IsScrollBar(Point)OnHorizontalScrollTimerTick()OnVerticalScrollTimerTick()ProcessAddKey(KeyEventArgs)ProcessContextMenu(Point)ProcessDeleteKey(KeyEventArgs)ProcessDialogKey(Keys)ProcessDoubleClick(MouseEventArgs)ProcessDownKey(KeyEventArgs)ProcessEndKey(KeyEventArgs)ProcessEscapeKey(KeyEventArgs)ProcessF2Key(KeyEventArgs)ProcessHomeKey(KeyEventArgs)ProcessKeyDown(KeyEventArgs)ProcessKeyPress(KeyPressEventArgs)ProcessKeyUp(KeyEventArgs)ProcessLeftKey(KeyEventArgs)ProcessMouseClick(MouseEventArgs)ProcessMouseDown(MouseEventArgs)ProcessMouseDownOnCellElement(GanttViewTextViewCellElement, MouseEventArgs)ProcessMouseDownOnCellHeaderElement(GanttViewTextViewHeaderCellElement, MouseEventArgs)ProcessMouseDownOnTaskElement(GanttGraphicalViewBaseTaskElement, MouseEventArgs)ProcessMouseDownOnTaskLinkHandleElement(GanttViewTaskLinkHandleElement, MouseEventArgs)ProcessMouseDownOnTaskLinkHandleElementWhenEditingLink(GanttViewTaskLinkHandleElement, MouseEventArgs)ProcessMouseEnter(EventArgs)ProcessMouseHover(EventArgs)ProcessMouseLeave(EventArgs)ProcessMouseMove(MouseEventArgs)ProcessMouseMoveWhenCreatingLink(MouseEventArgs)ProcessMouseMoveWhenEditingLink(MouseEventArgs)ProcessMouseMoveWhenResizingColumn(MouseEventArgs)ProcessMouseMoveWhenResizingTask(GanttGraphicalViewBaseTaskElement, MouseEventArgs)ProcessMouseUp(MouseEventArgs)ProcessMouseUpOnCellElement(GanttViewTextViewCellElement, MouseEventArgs)ProcessMouseUpWhenCreatingLink(MouseEventArgs)ProcessMouseUpWhenEditingLink(MouseEventArgs)ProcessMouseUpWhenResizingColumn(MouseEventArgs)ProcessMouseUpWhenResizingTask(GanttGraphicalViewBaseTaskElement, MouseEventArgs)ProcessMouseWheel(MouseEventArgs)ProcessRightKey(KeyEventArgs)ProcessScrolling(Point, bool)ProcessSubtractKey(KeyEventArgs)ProcessUpKey(KeyEventArgs)ShouldHandleKineticScrolling(MouseEventArgs)ShouldStartLinkEditOperation(GanttViewLinkDataItem, GanttViewTaskLinkHandleElement)StopScrollTimers()
Not finding the help you need?
Contact Support