ClassRadScheduleView
Represents the RadScheduleView control wrapper. Serves as a main entry point for the entire RadScheduleView API.
Definition
Namespace:Telerik.WebAii.Controls.Xaml.Wpf
Assembly:Telerik.WebAii.Controls.Xaml.Wpf.dll
Syntax:
public class RadScheduleView : Control, IAutomationPeer, IPeerConverter, IRadScheduleView, IControl, IFrameworkElement, ITargetElementInheritance: objectAutomationObject<FrameworkElement>FrameworkElementWpfTestElementControlRadScheduleView
Implements:
Inherited Members
Constructors
RadScheduleView()
Initializes a new instance of the RadScheduleView class.
Declaration
public RadScheduleView()Properties
ActiveViewDefinitionIndex
Gets the ActiveViewDefinitionIndex of the ScheduleView Uses an automation property (i.e. the RadScheduleView control property called).
Declaration
public int ActiveViewDefinitionIndex { get; set; }Property Value
Implements
AppointmentsPanel
Get the panel holding the RadScheduleView appoinments.
Declaration
public IAppointmentsPanel AppointmentsPanel { get; }Property Value
Implements
AppointmentsPanelGrid
Get the panel holding the RadScheduleView appoinments and TimeRuler items.
Declaration
public FrameworkElement AppointmentsPanelGrid { get; }Property Value
Implements
CurrentDate
Get the CurrentDate of the ScheduleView Uses an automation property (i.e. the RadScheduleView control property called).
Declaration
public DateTime CurrentDate { get; set; }Property Value
Implements
DateHeaderText
Gets the current date header text.
Declaration
[Obsolete("The property is deprecated. Please use RadScheduleView.NavigationHeader.NavigationPanel.DateHeaderText property instead.")]
public string DateHeaderText { get; }Property Value
Implements
DragDropHighlightedItems
The collection holding the drag and drop highlighted items.
Declaration
public List<HighlightItem> DragDropHighlightedItems { get; }Property Value
GroupHeadersOrientation
Get the orientation of the group headers panel.
Declaration
public Orientation GroupHeadersOrientation { get; }Property Value
Implements
HeadersHeight
Get the Border indicating the height of the Headers panel.
Declaration
public FrameworkElement HeadersHeight { get; }Property Value
Implements
HeadersWidth
Get the Border indicating the width of the Headers panel.
Declaration
public FrameworkElement HeadersWidth { get; }Property Value
Implements
HighlightedItem
Declaration
[Obsolete("The HighlightedItem property is obsolated. Please use MouseOverHighlightedItem, SelectedHighlightedItems, SpecialSlotsHighlightedItems, ReadOnlyHighlightedItems, DragDropHighlightedItems or ResizeHighlightedItem.")]
public IHighlightItem HighlightedItem { get; }Property Value
HorizontalScrollBar
Get the Border indicating the width of the Headers panel.
Declaration
public ScrollBar HorizontalScrollBar { get; }Property Value
MouseOverHighlightedItem
The mouse over highlighted item.
Declaration
public HighlightItem MouseOverHighlightedItem { get; }Property Value
NavigationDatePicker
Get the navigation RadDatePicker control residing below the ScheduleView header.
Declaration
[Obsolete("The property is deprecated. Please use RadScheduleView.NavigationHeader.NavigationPanel.NavigationDatePicker property instead.")]
public IRadDatePicker NavigationDatePicker { get; }Property Value
Implements
NavigationHeader
Get the panel holding the RadScheduleView header items.
Declaration
public INavigationHeader NavigationHeader { get; }Property Value
Implements
NavigationPanel
Get the stack panel holding the navigation buttons and date picker.
Declaration
[Obsolete("The property is deprecated. Please use RadScheduleView.NavigationHeader.NavigationPanel property instead.")]
public FrameworkElement NavigationPanel { get; }Property Value
Implements
OpenedDialogWindow
Get the last opened SchedulerWindow.
Declaration
public ISchedulerWindow OpenedDialogWindow { get; }Property Value
Implements
ReadOnlyHighlightedItems
The collection holding the read only highlighted items.
Declaration
public List<HighlightItem> ReadOnlyHighlightedItems { get; }Property Value
ResizeHighlightedItem
The resize highlighted item shown when appointmetn is beeng resized.
Declaration
public HighlightItem ResizeHighlightedItem { get; }Property Value
SelectedHighlightedItems
The collection holding the selected highlighted item.
Declaration
public List<HighlightItem> SelectedHighlightedItems { get; }Property Value
SpecialSlotsHighlightedItems
The collection holding the special slots highlighted items.
Declaration
public List<HighlightItem> SpecialSlotsHighlightedItems { get; }Property Value
TimeRulerLinesPanel
Gets the panel that holds the TimeRuler lines.
Declaration
public ITimeRulerLinesPanel TimeRulerLinesPanel { get; }Property Value
Implements
TimeRulerPanel
Get the panel holding the RadScheduleView appoinments and TimeRuler items.
Declaration
public ITimeRulerPanel TimeRulerPanel { get; }Property Value
Implements
TimeRulerPanels
Get all of the TimerullerPanels.
Declaration
public IList<ITimeRulerPanel> TimeRulerPanels { get; }Property Value
Implements
VerticalScrollBar
Get the Border indicating the width of the Headers panel.
ViewButtonsListBox
Get the top ListBox holding the change view buttons.
Declaration
[Obsolete("The property is deprecated. Please use RadScheduleView.NavigationHeader.ViewButtonsListBox property instead.")]
public ListBox ViewButtonsListBox { get; }Property Value
Implements
Methods
ChangeView(int)
Change the view with the given index.
Declaration
public void ChangeView(int viewIndex)Parameters
viewIndex
The ScheduleView viewIndex to change to.
Implements
ChangeView(string)
Change to view with spesifc text.
Declaration
public void ChangeView(string viewText)Parameters
viewText
The ScheduleView view text to change to.
Implements
ClickInSlot(MouseClickType, IGroupHeader, ITimeRulerItem, bool)
Performs spesific mouse action on spesific slot.
Declaration
public void ClickInSlot(MouseClickType clickType, IGroupHeader groupHeader, ITimeRulerItem timeRulerItem, bool shouldScrollToSlot)Parameters
clickType
The mouse click action to perform.
groupHeader
The group header of the slot.
timeRulerItem
The time ruler item of the slot.
shouldScrollToSlot
Indicates whether to scroll in order to locate the slot.
Implements
ClickInSlot(MouseClickType, string, string, bool)
Performs spesific mouse action on spesific slot.
Declaration
public void ClickInSlot(MouseClickType clickType, string groupHeaderText, string timeRulerItemText, bool shouldScrollToSlot)Parameters
clickType
The mouse click action to perform.
groupHeaderText
The group header of the slot.
timeRulerItemText
The time ruler item of the slot.
shouldScrollToSlot
Indicates whether to scroll in order to locate the slot.
Implements
DragAppointmentToAppointment(IAppointmentItem, IAppointmentItem, DropLocationType)
Drag and drop appointment to spesific side of another appointment.
Declaration
public bool DragAppointmentToAppointment(IAppointmentItem sourceAppointment, IAppointmentItem destinationAppointment, DropLocationType dropLocation)Parameters
sourceAppointment
The appointment to drag.
destinationAppointment
The appointment to drop to.
dropLocation
The drop location.
Returns
Implements
DragAppointmentToAppointment(string, string, DropLocationType)
Indicates wheather the highlighted item is withing a spesific slot.
Declaration
public bool DragAppointmentToAppointment(string sourceAppointmentSubject, string destinationAppointmentSubject, DropLocationType dropLocation)Parameters
sourceAppointmentSubject
The group header of the slot.
destinationAppointmentSubject
The time ruler of the slot.
dropLocation
The time ruler of the slot.
Returns
Implements
DragAppointmentToSlot(IAppointmentItem, IGroupHeader, ITimeRulerItem)
Drag and Drop appointment in spesific slot.
Declaration
public bool DragAppointmentToSlot(IAppointmentItem sourceAppointment, IGroupHeader groupHeader, ITimeRulerItem timeRulerItem)Parameters
sourceAppointment
The appointment to drag.
groupHeader
The group header of the slot.
timeRulerItem
The time ruler of the slot.
Returns
Implements
DragAppointmentToSlot(IAppointmentItem, IGroupHeader, ITimeRulerItem, bool)
Drag and Drop or Drag and Hold appointment in spesific slot.
Declaration
public bool DragAppointmentToSlot(IAppointmentItem sourceAppointment, IGroupHeader groupHeader, ITimeRulerItem timeRulerItem, bool shouldDrop)Parameters
sourceAppointment
The appointment to drag.
groupHeader
The group header of the slot.
timeRulerItem
The time ruler of the slot.
shouldDrop
Indicates whter to perform drag and drop or drag and hold operation.
Returns
Implements
DragAppointmentToSlot(IAppointmentItem, OffsetReference, int, int, IGroupHeader, OffsetReference, int, int, ITimeRulerItem, OffsetReference, int, int, bool)
Drag and Drop or Drag and Hold appointment in spesific slot.
Declaration
public bool DragAppointmentToSlot(IAppointmentItem sourceAppointment, OffsetReference appointmentOffsetRef, int appointmentXOffset, int appointmentYOffset, IGroupHeader groupHeader, OffsetReference headertOffsetRef, int headerXOffset, int headerYOffset, ITimeRulerItem timeRulerItem, OffsetReference timeRulerOffsetRef, int timeRulerXOffset, int timeRulerYOffset, bool shouldDrop)Parameters
sourceAppointment
The appointment to drag.
appointmentOffsetRef
The appointment to drag.
appointmentXOffset
The appointment to drag.
appointmentYOffset
The appointment to drag.
groupHeader
The group header of the slot.
headertOffsetRef
The group header of the slot.
headerXOffset
The group header of the slot.
headerYOffset
The group header of the slot.
timeRulerItem
The time ruler of the slot.
timeRulerOffsetRef
The time ruler of the slot.
timeRulerXOffset
The time ruler of the slot.
timeRulerYOffset
The time ruler of the slot.
shouldDrop
Indicates whter to perform drag and drop or drag and hold operation.
Returns
Implements
DragAppointmentToSlot(string, string, string)
Drag and Drop appointment in spesific slot.
Declaration
public bool DragAppointmentToSlot(string sourceAppointmentSubject, string groupHeaderText, string timeRulerItemText)Parameters
sourceAppointmentSubject
The appointment to drag.
groupHeaderText
The group header of the slot.
timeRulerItemText
The time ruler of the slot.
Returns
Implements
DragAppointmentToSlot(string, string, string, bool)
Drag and Drop appointment in spesific slot.
Declaration
public bool DragAppointmentToSlot(string sourceAppointmentSubject, string groupHeaderText, string timeRulerItemText, bool shouldDrop)Parameters
sourceAppointmentSubject
The appointment to drag.
groupHeaderText
The group header of the slot.
timeRulerItemText
The time ruler of the slot.
shouldDrop
Indicates whter to perform drag and drop or drag and hold operation.
Returns
DragToSelectSlots(IGroupHeader, ITimeRulerItem, IGroupHeader, ITimeRulerItem, bool)
Drag from one slot to another.
Declaration
public void DragToSelectSlots(IGroupHeader startGroupHeader, ITimeRulerItem startTimeRulerItem, IGroupHeader endGroupHeader, ITimeRulerItem endTimeRulerItem, bool shouldDrop = true)Parameters
startGroupHeader
The group header of the start slot.
startTimeRulerItem
The time ruler of the start slot.
endGroupHeader
The group header of the end slot.
endTimeRulerItem
The time ruler of the end slot.
shouldDrop
Indicates whter to perform drag and drop or drag and hold operation.
DragToSelectSlots(IGroupHeader, OffsetReference, int, int, ITimeRulerItem, OffsetReference, int, int, IGroupHeader, OffsetReference, int, int, ITimeRulerItem, OffsetReference, int, int, bool)
Drag from one slot to another.
Declaration
public void DragToSelectSlots(IGroupHeader startGroupHeader, OffsetReference startHeadertOffsetRef, int startHeaderXOffset, int startHeaderYOffset, ITimeRulerItem startTimeRulerItem, OffsetReference startTimeRulerOffsetRef, int startTimeRulerXOffset, int startTimeRulerYOffset, IGroupHeader endgroupHeader, OffsetReference endHeadertOffsetRef, int endHeaderXOffset, int endHeaderYOffset, ITimeRulerItem endTimeRulerItem, OffsetReference endTimeRulerOffsetRef, int endTimeRulerXOffset, int endTimeRulerYOffset, bool shouldDrop)Parameters
startGroupHeader
The group header of the start slot.
startHeadertOffsetRef
The offset reference from the start header.
startHeaderXOffset
The X offset from the start header offset reference
startHeaderYOffset
The Y offset from the start header offset reference
startTimeRulerItem
The time ruler of the start slot
startTimeRulerOffsetRef
The offset reference from the start time ruler.
startTimeRulerXOffset
The X offset from the start time ruler offset reference
startTimeRulerYOffset
The Y offset from the start time ruler offset reference
endgroupHeader
The group header of the end slot.
endHeadertOffsetRef
The offset reference from the end header.
endHeaderXOffset
The X offset from the end header offset reference
endHeaderYOffset
The Y offset from the end header offset reference
endTimeRulerItem
The offset reference from the end time ruler.
endTimeRulerOffsetRef
The offset reference from the end time ruler.
endTimeRulerXOffset
The X offset from the end time ruler offset reference
endTimeRulerYOffset
The Y offset from the end time ruler offset reference
shouldDrop
DragToSelectSlots(string, string, string, string, bool)
Drag from one slot to another.
Declaration
public void DragToSelectSlots(string startGroupHeaderText, string startTimeRulerItemText, string endGroupHeaderText, string endTimeRulerItemText, bool shouldDrop)Parameters
startGroupHeaderText
The group header of the start slot.
startTimeRulerItemText
The time ruler of the start slot.
endGroupHeaderText
The group header of the end slot.
endTimeRulerItemText
The time ruler of the end slot.
shouldDrop
Indicates whter to perform drag and drop or drag and hold operation.
GetActiveViewDefinitionIndex()
Gets the index of the current selected ListBoxItem indicating the current active view.
GetActiveViewDefinitionText()
Gets the Text of the current selected ListBoxItem indicating the current active view.
GetMonthViewTimeRulerItemByTextAndGroupHeader(string, string)
Gets MonthView time ruler item by spesific text and group header.
Declaration
public ITimeRulerMonthViewItem GetMonthViewTimeRulerItemByTextAndGroupHeader(string timeRulerText, string groupHeaderText)Parameters
timeRulerText
The text of the MonthView time ruler item.
groupHeaderText
The text of the group header.
Returns
Implements
HorizontalScrollToVisible(FrameworkElement)
Performs scrolling until item is in the view port. Return true if the item is visible in the view port after the scrolling is performed.
Declaration
public bool HorizontalScrollToVisible(FrameworkElement item)Parameters
item
Item to scroll to.
Returns
Implements
IsAppoinmentInGroupHeader(IAppointmentItem, IGroupHeader)
Indicates wheather appointment is withing the bounderies of spesific group header.
Declaration
public bool IsAppoinmentInGroupHeader(IAppointmentItem appointment, IGroupHeader groupHeader)Parameters
appointment
The appointment to check with.
groupHeader
The group header to check with.
Returns
Implements
IsAppoinmentInGroupHeader(string, string)
Indicates wheather appointment with subject is withing the bounderies of spesific group header with text.
IsAppoinmentInSlot(IAppointmentItem, IGroupHeader, ITimeRulerItem)
Indicates wheather appointment is withing a spesific slot.
Declaration
public bool IsAppoinmentInSlot(IAppointmentItem appointment, IGroupHeader groupHeader, ITimeRulerItem timeRulerItem)Parameters
appointment
The appointment to check with.
groupHeader
The group header of the slot.
timeRulerItem
The time ruler of the slot.
Returns
Implements
IsAppoinmentInSlot(IAppointmentItem, IGroupHeader, ITimeRulerItem, ITimeRulerItem)
Indicates wheather appointment is withing a spesific slot.
Declaration
public bool IsAppoinmentInSlot(IAppointmentItem appointment, IGroupHeader groupHeader, ITimeRulerItem startTimeRulerItem, ITimeRulerItem endTimeRulerItem)Parameters
appointment
The appointment to check with.
groupHeader
The group header of the slot.
startTimeRulerItem
The start time ruler item to check with.
endTimeRulerItem
The end time ruler item to check with.
Returns
Implements
IsAppoinmentInSlot(string, string, string)
Indicates wheather appointment is withing a spesific slot.
Declaration
public bool IsAppoinmentInSlot(string appointmentSubject, string groupHeaderText, string timeRulerItemText)Parameters
appointmentSubject
The appointment to check with.
groupHeaderText
The group header of the slot.
timeRulerItemText
The time ruler of the slot.
Returns
Implements
IsAppoinmentInSlot(string, string, string, string)
Indicates wheather appointment is withing a spesific slot.
Declaration
public bool IsAppoinmentInSlot(string appointmentSubject, string groupHeaderText, string startTimeRulerItemText, string endTimeRulerItemText)Parameters
appointmentSubject
The appointment to check with.
groupHeaderText
The group header of the slot.
startTimeRulerItemText
The time ruler of the slot.
endTimeRulerItemText
The time ruler of the slot.
Returns
Implements
IsAppoinmentInTimeInterval(IAppointmentItem, ITimeRulerItem)
Indicates wheather appointment is withing the bounderies of spesific time interval.
Declaration
public bool IsAppoinmentInTimeInterval(IAppointmentItem appointment, ITimeRulerItem timeRulerItem)Parameters
appointment
The appointment to check with.
timeRulerItem
The time ruler item to check with.
Returns
Implements
IsAppoinmentInTimeInterval(IAppointmentItem, ITimeRulerItem, ITimeRulerItem)
Indicates wheather appointment is withing the bounderies of spesific time interval.
Declaration
public bool IsAppoinmentInTimeInterval(IAppointmentItem appointment, ITimeRulerItem startTimeRulerItem, ITimeRulerItem endTimeRulerItem)Parameters
appointment
The appointment to check with.
startTimeRulerItem
The start time ruler item to check with.
endTimeRulerItem
The end time ruler item to check with.
Returns
Implements
IsAppoinmentInTimeInterval(string, string)
Indicates wheather appointment is withing the bounderies of spesific time interval.
IsAppoinmentInTimeInterval(string, string, string)
Indicates wheather appointment with subject is withing the bounderies of spesific group header with text.
Declaration
public bool IsAppoinmentInTimeInterval(string appointmentSubject, string startTimeRulerItemText, string endTimeRulerItemText)Parameters
appointmentSubject
The appointment subject to check with.
startTimeRulerItemText
The start time ruler item text to check with.
endTimeRulerItemText
The end time ruler item text to check with.
Returns
Implements
IsAppointmentShownInTheAllDayArea(string)
Indicates wheather appointment with spesific subject is shown in the all day area.
IsElementInGroupHeader(FrameworkElement, IGroupHeader)
Indicates wheather element is withing the bounderies of spesific group header.
Declaration
public bool IsElementInGroupHeader(FrameworkElement element, IGroupHeader groupHeader)Parameters
element
The element to check with.
groupHeader
The group header to check with.
Returns
Implements
IsElementInSlot(FrameworkElement, IGroupHeader, ITimeRulerItem)
Indicates wheather element is withing a spesific slot.
Declaration
public bool IsElementInSlot(FrameworkElement element, IGroupHeader groupHeader, ITimeRulerItem timeRulerItem)Parameters
element
The appointment to check with.
groupHeader
The group header of the slot.
timeRulerItem
The time ruler of the slot.
Returns
Implements
IsElementInSlot(FrameworkElement, IGroupHeader, ITimeRulerItem, ITimeRulerItem)
Indicates wheather element is withing a spesific slot.
Declaration
public bool IsElementInSlot(FrameworkElement element, IGroupHeader groupHeader, ITimeRulerItem startTimeRulerItem, ITimeRulerItem endTimeRulerItem)Parameters
element
The element to check with.
groupHeader
The group header of the slot.
startTimeRulerItem
The start time ruler item to check with.
endTimeRulerItem
The end time ruler item to check with.
Returns
Implements
IsElementInTimeInterval(FrameworkElement, ITimeRulerItem)
Indicates wheather element is withing the bounderies of spesific time interval.
Declaration
public bool IsElementInTimeInterval(FrameworkElement element, ITimeRulerItem timeRulerItem)Parameters
element
The element to check with.
timeRulerItem
The time ruler item to check with.
Returns
Implements
IsElementInTimeInterval(FrameworkElement, ITimeRulerItem, ITimeRulerItem)
Indicates wheather element is withing the bounderies of spesific time interval.
Declaration
public bool IsElementInTimeInterval(FrameworkElement element, ITimeRulerItem startTimeRulerItem, ITimeRulerItem endTimeRulerItem)Parameters
element
The element to check with.
startTimeRulerItem
The start time ruler item to check with.
endTimeRulerItem
The end time ruler item to check with.
Returns
Implements
IsHighlightedItemInSlot(string, string)
Indicates wheather the selected item is withing a spesific slot.
NavigateBack()
Simulates user clicking on the 'Back' navigation button below the ScheduleView header.
Declaration
public void NavigateBack()Implements
NavigateForward()
Simulates user clicking on the 'Forward' navigation button below the ScheduleView header.
Declaration
public void NavigateForward()Implements
PerformActionOnTheOpenedDialogWindow<T>(string, Func<T, bool>)
Performs an anction on spesific control in the opened DialogWindow.
Declaration
public bool PerformActionOnTheOpenedDialogWindow<T>(string controlAutomationId, Func<T, bool> applyAction) where T : IFrameworkElementParameters
controlAutomationId
The automation id of the control to perform action on. All automation id of the existing items can be found in the SchedulerWindowElementIds class.
applyAction
The action to be performed.
Returns
Implements
VerifyPropertyInTheOpenedDialogWindow<T>(string, Action<T>)
Verifies property of spesific control in the opened DialogWindow
Declaration
public void VerifyPropertyInTheOpenedDialogWindow<T>(string controlAutomationId, Action<T> verifyProperty) where T : IFrameworkElementParameters
controlAutomationId
The automation id of the control to perform action on. All automation id of the existing items can be found in the SchedulerWindowElementIds class.
verifyProperty
Action<T>
The action that verifies the property.
Implements
VerticalScrollToVisible(FrameworkElement)
Performs scrolling until item is in the view port. Return true if the item is visible in the view port after the scrolling is performed.
Declaration
public bool VerticalScrollToVisible(FrameworkElement item)Parameters
item
Item to scroll to.
Returns
Implements