API Documentation

TimeScheduler

Namespace: TagBites.WinSchedulers
Assembly: TagBites.WinSchedulers.dll

Represents a time scheduler control.

public class TimeScheduler : TagBites.WinSchedulers.GridViewControl, TagBites.WinSchedulers.IGridViewAutoRefresh, TagBites.WinSchedulers.IGridViewDiagnosticInfo
C#
Copy

Constructors

TimeScheduler()

Initializes a new instance of the TagBites.WinSchedulers.TimeScheduler class.

public void TimeScheduler()
C#
Copy

Result Type: void

Properties

BehaviorOptions

Gets the set of the behavior options.

public TimeSchedulerBehaviorOptions BehaviorOptions { get; }
C#
Copy

Result Type: TimeSchedulerBehaviorOptions

DataSource

Gets or sets data source for loading data.

public ITimeSchedulerDataSource DataSource { get; set; }
C#
Copy

Result Type: ITimeSchedulerDataSource

HorizontalScroller

protected internal GridViewScroller HorizontalScroller { get; }
C#
Copy

Result Type: GridViewScroller

ResourceScroller

Gets a resource scroll element.

public TimeSchedulerResourceScroller ResourceScroller { get; }
C#
Copy

Result Type: TimeSchedulerResourceScroller

SelectedTask

Gets or sets the selected task.

public object SelectedTask { get; set; }
C#
Copy

Result Type: object

SelectedTasks

Gets the collection of selected tasks.

public IList<object> SelectedTasks { get; }
C#
Copy

Result Type: IList<object>

TimeScroller

Gets a time scroll element.

public TimeSchedulerTimeScroller TimeScroller { get; }
C#
Copy

Result Type: TimeSchedulerTimeScroller

VerticalScroller

protected internal GridViewScroller VerticalScroller { get; }
C#
Copy

Result Type: GridViewScroller

VerticalTimeLine

Gets or sets a value that indicates whether a time line is vertical.

public bool VerticalTimeLine { get; set; }
C#
Copy

Result Type: bool

View

Gets a view storing data for control.

public TimeSchedulerDataSourceView View { get; }
C#
Copy

Result Type: TimeSchedulerDataSourceView

ViewOptions

Gets the set of the view options.

public TimeSchedulerViewOptions ViewOptions { get; }
C#
Copy

Result Type: TimeSchedulerViewOptions

VisibleDateTimeInterval

Gets or sets the interval visible in the content.

public DateTimeInterval VisibleDateTimeInterval { get; set; }
C#
Copy

Result Type: DateTimeInterval

Methods

GetResourceAtPoint(Point)

Returns a resource at the specified point.

public object GetResourceAtPoint(Point point)
C#
Copy

Result Type: object

Parameters

TypeName
PointpointA that specifies the pair of coordinates where a resource is located.

GetResourceHeaderAtPoint(Point)

Returns a resource header at the specified point.

public object GetResourceHeaderAtPoint(Point point)
C#
Copy

Result Type: object

Parameters

TypeName
PointpointA that specifies the pair of coordinates where a resoruce header is located.

GetTaskAtPoint(Point)

Returns a task at the specified point.

public object GetTaskAtPoint(Point point)
C#
Copy

Result Type: object

Parameters

TypeName
PointpointA that specifies the pair of coordinates where a task is located.

OnKeyDown(KeyEventArgs)

protected void OnKeyDown(KeyEventArgs e)
C#
Copy

Result Type: void

Parameters

TypeName
KeyEventArgse

OnMouseDoubleClick(MouseButtonEventArgs)

protected void OnMouseDoubleClick(MouseButtonEventArgs e)
C#
Copy

Result Type: void

Parameters

TypeName
MouseButtonEventArgse

OnMouseDown(MouseButtonEventArgs)

protected void OnMouseDown(MouseButtonEventArgs e)
C#
Copy

Result Type: void

Parameters

TypeName
MouseButtonEventArgse

OnMouseMove(MouseEventArgs)

protected void OnMouseMove(MouseEventArgs e)
C#
Copy

Result Type: void

Parameters

TypeName
MouseEventArgse

OnMouseUp(MouseButtonEventArgs)

protected void OnMouseUp(MouseButtonEventArgs e)
C#
Copy

Result Type: void

Parameters

TypeName
MouseButtonEventArgse

OnMouseWheel(MouseWheelEventArgs)

protected void OnMouseWheel(MouseWheelEventArgs e)
C#
Copy

Result Type: void

Parameters

TypeName
MouseWheelEventArgse

PrepareContentCore(GridViewWindow)

protected void PrepareContentCore(GridViewWindow view)
C#
Copy

Result Type: void

Parameters

TypeName
GridViewWindowview

PrepareHeaders()

protected void PrepareHeaders()
C#
Copy

Result Type: void

Refresh()

Resets data in the TagBites.WinSchedulers.TimeScheduler.DataSource and refreshes the view.

public void Refresh()
C#
Copy

Result Type: void

ScrollTo(object)

Scrolls the content within the to the specified task

public void ScrollTo(object task)
C#
Copy

Result Type: void

Parameters

TypeName
objecttaskAn representing the task that the content scrolls to.

ScrollTo(DateTime, Alignment)

Scrolls the content within the to the specified task and alignment.

public void ScrollTo(DateTime dateTime, Alignment alignment)
C#
Copy

Result Type: void

Parameters

TypeName
DateTimedateTimeThe date time that the content scrolls to.
AlignmentalignmentAlignment of the task relative to its content rectangle.

ScrollTo(DateTime, DateTime)

Scrolls the content within the to the specified interval.

public void ScrollTo(DateTime start, DateTime end)
C#
Copy

Result Type: void

Parameters

TypeName
DateTimestartThe date time that the begin of content scrolls to.
DateTimeendThe date time that the end of content scrolls to.

Select(object)

Marks task as the TagBites.WinSchedulers.TimeScheduler.SelectedTask and scroll to it.

public void Select(object task)
C#
Copy

Result Type: void

Parameters

TypeName
objecttaskAn representing the task that will be marked as selected.

Events

CustomDrawTask

Occurs when the task is drawn.

public EventHandler<TimeSchedulerCustomDrawObjectEventArgs> CustomDrawTask
C#
Copy

Result Type: EventHandler<TimeSchedulerCustomDrawObjectEventArgs>

CustomDrawTaskBackground

Occurs when the background of the task is drawn.

public EventHandler<TimeSchedulerCustomDrawObjectEventArgs> CustomDrawTaskBackground
C#
Copy

Result Type: EventHandler<TimeSchedulerCustomDrawObjectEventArgs>

MouseMove

Occurs when the mouse pointer moves while over this element.

public EventHandler<MouseEventArgs> MouseMove
C#
Copy

Result Type: EventHandler<MouseEventArgs>

OrientationChanged

Occurs when the orientation of control is changed.

public EventHandler OrientationChanged
C#
Copy

Result Type: EventHandler

ResourceHeaderClick

Occurs when the user clicks the header of resource.

public EventHandler<TimeSchedulerResourceHeaderEventArgs> ResourceHeaderClick
C#
Copy

Result Type: EventHandler<TimeSchedulerResourceHeaderEventArgs>

ResourceHeaderDoubleClick

Occurs when the user double-clicks the header of resource.

public EventHandler<TimeSchedulerResourceHeaderEventArgs> ResourceHeaderDoubleClick
C#
Copy

Result Type: EventHandler<TimeSchedulerResourceHeaderEventArgs>

SelectedTasksChanged

Occurs after the selected tasks are changed.

public EventHandler SelectedTasksChanged
C#
Copy

Result Type: EventHandler

SettingsMenuResolved

Occurs when the menu of the settings is resolved.

public EventHandler<TimeSettingsMenuResolvedEventArgs> SettingsMenuResolved
C#
Copy

Result Type: EventHandler<TimeSettingsMenuResolvedEventArgs>

TaskClick

Occurs when the user clicks the task.

public EventHandler<TimeSchedulerTaskEventArgs> TaskClick
C#
Copy

Result Type: EventHandler<TimeSchedulerTaskEventArgs>

TaskDoubleClick

Occurs when the user double-clicks the task.

public EventHandler<TimeSchedulerTaskEventArgs> TaskDoubleClick
C#
Copy

Result Type: EventHandler<TimeSchedulerTaskEventArgs>

TaskMoved

Occurs when the task is moved.

public EventHandler<TimeSchedulerTaskMovedEventArgs> TaskMoved
C#
Copy

Result Type: EventHandler<TimeSchedulerTaskMovedEventArgs>

TaskMoving

Occurs when the task is moving.

public EventHandler<TimeSchedulerTaskMovingEventArgs> TaskMoving
C#
Copy

Result Type: EventHandler<TimeSchedulerTaskMovingEventArgs>

TaskSelected

Occurs after the task is selected.

public EventHandler<TimeSchedulerTaskEventArgs> TaskSelected
C#
Copy

Result Type: EventHandler<TimeSchedulerTaskEventArgs>