Documentation

Class AppointmentDraggingBehavior

Inheritance
System.Object
DisposableObject
RadObject
RadService
RadDragDropService
AppointmentDraggingBehavior
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.Scheduler.dll

Syntax

public class AppointmentDraggingBehavior : RadDragDropService, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, IMessageListener

Constructors

AppointmentDraggingBehavior(RadScheduler)

Declaration
public AppointmentDraggingBehavior(RadScheduler scheduler)
Parameters
RadScheduler scheduler

AppointmentDraggingBehavior(SchedulerVisualElement)

Declaration
public AppointmentDraggingBehavior(SchedulerVisualElement activeOwner)
Parameters
SchedulerVisualElement activeOwner

Properties

ActiveFeedback

Gets the active feedback.

Declaration
public DragFeedbackElement ActiveFeedback { get; }
Property Value
DragFeedbackElement

ActiveOwner

Gets the behavior's active owner.

Declaration
public SchedulerVisualElement ActiveOwner { get; }
Property Value
SchedulerVisualElement

AutoScrollDayViewOnDrag

Gets or sets a value indicating whether the appointment areas in DayView should be automatically scrolled when dragging off their bounds.

Declaration
public bool AutoScrollDayViewOnDrag { get; set; }
Property Value
System.Boolean

DragNavigationInterval

Gets or sets the minimum time interval between automatic view navigations.

Declaration
public TimeSpan DragNavigationInterval { get; set; }
Property Value
System.TimeSpan

DragNavigationOffset

Gets or sets the offset from the bounds of the control in pixels after which the automatic view navigation will be triggered.

Declaration
public int DragNavigationOffset { get; set; }
Property Value
System.Int32

IsDragging

Indicates whether there is an active drag operation.

Declaration
public bool IsDragging { get; }
Property Value
System.Boolean

Scheduler

The RadScheduler that owns the behaviors.

Declaration
public RadScheduler Scheduler { get; }
Property Value
RadScheduler

ShowCreateExceptionDialog

Gets or sets a value indicating whether a prompt dialog box should be shown when the user is about to create occurrence exception via drag and drop.

Declaration
public bool ShowCreateExceptionDialog { get; set; }
Property Value
System.Boolean

ShowOccurrenceValidationMessages

Gets or sets a value indicating whether a message box should be shown when an occurrence is dragged to an invalid location.

Declaration
public bool ShowOccurrenceValidationMessages { get; set; }
Property Value
System.Boolean

Methods

AddToOwnerCollection()

Adds the active feedback to the active owner.

Declaration
public virtual bool AddToOwnerCollection()
Returns
System.Boolean

BeginDrag(SchedulerVisualElement, AppointmentElement)

Request move operation.

Declaration
public bool BeginDrag(SchedulerVisualElement newOwner, AppointmentElement appointment)
Parameters
SchedulerVisualElement newOwner

AppointmentElement appointment

Returns
System.Boolean

CanStart(Object)

Declaration
protected override bool CanStart(object context)
Parameters
System.Object context

Returns
System.Boolean

Overrides

CreateFeedback(RadScheduler, SchedulerView, AppointmentElement)

Creates a new appointment feedback of a given appointment.

Declaration
public virtual DragFeedbackElement CreateFeedback(RadScheduler scheduler, SchedulerView view, AppointmentElement appointment)
Parameters
RadScheduler scheduler

SchedulerView view

AppointmentElement appointment

Returns
DragFeedbackElement

DoDragOver(Point)

Handles dragging the active feedback to a given point.

Declaration
public void DoDragOver(Point controlDropLocation)
Parameters
System.Drawing.Point controlDropLocation

The destination point in control coordinates.

Drop()

Handles the Drop operation.

Declaration
public virtual void Drop()

GetAllDayHeaderAtPoint(Point)

Gets a DayViewAllDayHeader at a specified location.

Declaration
protected DayViewAllDayHeader GetAllDayHeaderAtPoint(Point location)
Parameters
System.Drawing.Point location

The location in control coordinates.
Returns
DayViewAllDayHeader

The DayViewAllDayHeader at that location.

GetCellAtPoint(Point)

Gets a SchedulerCellElement at a specified location.

Declaration
protected SchedulerCellElement GetCellAtPoint(Point location)
Parameters
System.Drawing.Point location

The location in control coordinates.
Returns
SchedulerCellElement

The SchedulerCellElement at that location.

GetCellDate(SchedulerCellElement)

Gets the destination date for an appointment that was dropped on a given cell.

Declaration
protected virtual DateTime GetCellDate(SchedulerCellElement cell)
Parameters
SchedulerCellElement cell

The SchedulerCellElement.
Returns
System.DateTime

The destination date.

GetDayViewTableAtPoint(Point)

Gets a DayViewAppointmentsTable at a specified location.

Declaration
protected DayViewAppointmentsTable GetDayViewTableAtPoint(Point location)
Parameters
System.Drawing.Point location

The location in control coordinates.
Returns
DayViewAppointmentsTable

The DayViewAppointmentsTable at that location.

GetFeedback(SchedulerVisualElement)

Gets a specific feedback.

Declaration
public DragFeedbackElement GetFeedback(SchedulerVisualElement feedbackOwnerElement)
Parameters
SchedulerVisualElement feedbackOwnerElement

Returns
DragFeedbackElement

GetMonthViewAreaAtPoint(Point)

Gets a MonthViewAreaElement at a specified location.

Declaration
protected MonthViewAreaElement GetMonthViewAreaAtPoint(Point location)
Parameters
System.Drawing.Point location

The location in control coordinates.
Returns
MonthViewAreaElement

The MonthViewAreaElement at that location.

GetTimelinePresenterAtPoint(Point)

Gets a TimelineAppointmentsPresenter at a specified location.

Declaration
protected TimelineAppointmentsPresenter GetTimelinePresenterAtPoint(Point location)
Parameters
System.Drawing.Point location

The location in control coordinates.
Returns
TimelineAppointmentsPresenter

The TimelineAppointmentsPresenter at that location.

HandleMouseMove(Point)

Declaration
protected override void HandleMouseMove(Point mousePos)
Parameters
System.Drawing.Point mousePos

Overrides

HandleMouseMoveOutsideControlBounds(Point, Rectangle)

Declaration
protected virtual void HandleMouseMoveOutsideControlBounds(Point mousePos, Rectangle controlRect)
Parameters
System.Drawing.Point mousePos

System.Drawing.Rectangle controlRect

HideFeedbacks()

Hides the active feedbacks.

Declaration
protected virtual bool HideFeedbacks()
Returns
System.Boolean

[true] if successful, [false] otherwise

InitializeSettings(AppointmentElement)

Declaration
protected virtual void InitializeSettings(AppointmentElement appointment)
Parameters
AppointmentElement appointment

IsElementOwner(SchedulerVisualElement)

Gets whether the element is found in the owners collection.

Declaration
public bool IsElementOwner(SchedulerVisualElement owner)
Parameters
SchedulerVisualElement owner

Returns
System.Boolean

IsRealDrag(Point, Point)

Gets whether this is a valid drag operation.

Declaration
public virtual bool IsRealDrag(Point mouseOffsetPosition, Point mouseDownPosition)
Parameters
System.Drawing.Point mouseOffsetPosition

System.Drawing.Point mouseDownPosition

Returns
System.Boolean

Move(DateTime, SchedulerCellElement, SchedulerVisualElement)

Moves the feedback to a specific date in a specific resource.

Declaration
public virtual bool Move(DateTime newDate, SchedulerCellElement cell, SchedulerVisualElement newOwner)
Parameters
System.DateTime newDate

The destination date.
SchedulerCellElement cell

The destination cell.
SchedulerVisualElement newOwner

The destination visual element.
Returns
System.Boolean

[true] if the move was performed, [false] otherwise

MoveFeedback(SchedulerVisualElement)

Moves the active feedback to a new owner.

Declaration
public virtual void MoveFeedback(SchedulerVisualElement newOwner)
Parameters
SchedulerVisualElement newOwner

The new owner of the feedback.

OnAppointmentDropped(AppointmentMovedEventArgs)

Declaration
protected virtual void OnAppointmentDropped(AppointmentMovedEventArgs args)
Parameters
AppointmentMovedEventArgs args

OnAppointmentDropping(AppointmentMovingEventArgs)

Declaration
protected virtual void OnAppointmentDropping(AppointmentMovingEventArgs args)
Parameters
AppointmentMovingEventArgs args

OnAppointmentMoved()

Declaration
protected virtual void OnAppointmentMoved()

OnAppointmentMovingEventArgs(AppointmentMovingEventArgs)

Declaration
protected virtual void OnAppointmentMovingEventArgs(AppointmentMovingEventArgs args)
Parameters
AppointmentMovingEventArgs args

OnFeedbackCreating(FeedbackCreatingEventArgs)

Declaration
protected virtual void OnFeedbackCreating(FeedbackCreatingEventArgs args)
Parameters
FeedbackCreatingEventArgs args

OnInitializing(FeedbackInitializingEventArgs)

Declaration
protected virtual void OnInitializing(FeedbackInitializingEventArgs args)
Parameters
FeedbackInitializingEventArgs args

OnPreviewDragDrop(RadDropEventArgs)

Declaration
protected override void OnPreviewDragDrop(RadDropEventArgs e)
Parameters
RadDropEventArgs e

Overrides

OnPreviewDragHint(PreviewDragHintEventArgs)

Declaration
protected override void OnPreviewDragHint(PreviewDragHintEventArgs e)
Parameters
PreviewDragHintEventArgs e

Overrides

OnPreviewDragOver(RadDragOverEventArgs)

Declaration
protected override void OnPreviewDragOver(RadDragOverEventArgs e)
Parameters
RadDragOverEventArgs e

Overrides

PerformStop()

Declaration
protected override void PerformStop()
Overrides

PrepareAppointment(IEvent)

Declaration
protected virtual IEvent PrepareAppointment(IEvent appointment)
Parameters
IEvent appointment

Returns
IEvent

RemoveFeedback(SchedulerVisualElement)

Removes the visual feedback. Cancels the drag operation.

Declaration
public virtual bool RemoveFeedback(SchedulerVisualElement owner)
Parameters
SchedulerVisualElement owner

Returns
System.Boolean

ResetAppointmentVisibility(IEvent)

Declaration
protected void ResetAppointmentVisibility(IEvent appointment)
Parameters
IEvent appointment

ResetCellsHoverState()

Declaration
protected virtual void ResetCellsHoverState()

SetAppointmentVisibility(IEvent, ElementVisibility)

Declaration
protected void SetAppointmentVisibility(IEvent appointment, ElementVisibility visibility)
Parameters
IEvent appointment

ElementVisibility visibility

ValidateOccurrenceDropTarget(DateTime, DateTime, Boolean)

Declaration
protected virtual bool ValidateOccurrenceDropTarget(DateTime targetStartDate, DateTime targetEndDate, bool allDay)
Parameters
System.DateTime targetStartDate

System.DateTime targetEndDate

System.Boolean allDay

Returns
System.Boolean

Events

AppointmentDropped

Occurs when drag drop has finished.

Declaration
public event EventHandler<AppointmentMovedEventArgs> AppointmentDropped
Event Type
System.EventHandler<AppointmentMovedEventArgs>

AppointmentDropping

Occurs when drag drop is finishing.

Declaration
public event EventHandler<AppointmentMovingEventArgs> AppointmentDropping
Event Type
System.EventHandler<AppointmentMovingEventArgs>

AppointmentMoved

Occurs when an appointment is moved.

Declaration
public event EventHandler AppointmentMoved
Event Type
System.EventHandler

AppointmentMoving

Occurs when an appointment is moving.

Declaration
public event EventHandler<AppointmentMovingEventArgs> AppointmentMoving
Event Type
System.EventHandler<AppointmentMovingEventArgs>

FeedbackCreating

Occurs when the feedback is creating.

Declaration
public event EventHandler<FeedbackCreatingEventArgs> FeedbackCreating
Event Type
System.EventHandler<FeedbackCreatingEventArgs>

FeedbackInitialized

Occurs when the feedback is initialized.

Declaration
public event EventHandler<FeedbackInitializingEventArgs> FeedbackInitialized
Event Type
System.EventHandler<FeedbackInitializingEventArgs>

Extension Methods