A navigation control for the RadScheduler component that provides view switching, date navigation, and other scheduler-related UI operations. This control allows users to switch between different scheduler views, navigate between time periods, and toggle weekend display.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.Scheduler.dll
Syntax:
[TelerikToolboxCategory("Scheduler")]
public class RadSchedulerNavigator : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider
Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadSchedulerNavigator...
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadSchedulerNavigator class. Creates a navigator control with default settings and enables auto-sizing.
public RadSchedulerNavigator()
Properties
Gets the AgendaViewButton element.
[Browsable(false)]
public RadButtonElement AgendaViewButton { get; }
Show/Hide Agenda View button.
[Browsable(false)]
public bool AgendaViewButtonVisible { get; set; }
true if Agenda View button is visible; otherwise, false.
the Agenda view button will not be hide when the scheduler is in timeline view
Gets or sets the RadScheduler control associated with this RadSchedulerNavigator.
[Browsable(true)]
public RadScheduler AssociatedScheduler { get; set; }
Gets or sets whether the navigator uses automatic navigation mode. When enabled, navigation will automatically adjust based on the active view type, ignoring the NavigationStep property.
[Browsable(true)]
public bool AutomaticNavigation { get; set; }
Gets or sets the format string used to display the date range in the navigator. The format follows the standard .NET date formatting patterns.
[Browsable(true)]
public string DateFormat { get; set; }
Gets the DateLabelElement
[Browsable(false)]
public RadLabelElement DateLabelElement { get; }
Gets the DateSelectorElement
[Browsable(false)]
public RadToggleButtonElement DateSelectorButton { get; }
Show/Hide the DateSelecotrButton.
[Browsable(true)]
public bool DateSelectorButtonVisible { get; set; }
true if the DateSelectorButton is visible; otherwise, false.
Gets the DayViewButton element.
[Browsable(false)]
public RadButtonElement DayViewButton { get; }
Show/Hide Day View button.
[Browsable(false)]
public bool DayViewButtonVisible { get; set; }
true if Day View button is visible; otherwise, false.
the day view button will not be hide when the scheduler is in day view
Gets the default size of the control.
protected override Size DefaultSize { get; }
A Size representing the default size of the control.
Overrides:
Gets the button element that allows users to switch to the Month view in the scheduler.
[Browsable(false)]
public RadButtonElement MonthViewButton { get; }
Show/Hide Month View button.
[Browsable(false)]
public bool MonthViewButtonVisible { get; set; }
true if Month View button is visible; otherwise, false.
the month view button will not be hide when the scheduler is in month view
Gets the NavigateBackwardsButton element.
[Browsable(false)]
public RadButtonElement NavigateBackwardsButton { get; }
Gets the NavigateForwardsButton element.
[Browsable(false)]
public RadButtonElement NavigateForwardsButton { get; }
Gets the button element that allows users to quickly navigate to today's date.
[Browsable(false)]
public RadButtonElement NavigateTodayButton { get; }
Gets or sets the number of units to move when navigating forward or backward. For example, if set to 2 and navigation type is days, clicking forward will advance by 2 days. The minimum value is 1.
[Browsable(true)]
public int NavigationStep { get; set; }
Gets or sets the unit type used for navigation steps (Day, Week, Month, etc.). This determines how the NavigationStep value is interpreted when navigating. Note: When in WeekView or MonthView with Day as the step type, navigation only works if NavigationStep is 7 or greater.
[Browsable(true)]
public NavigationStepTypes NavigationStepType { get; set; }
Gets the root element that represents the visual structure of this navigator control.
[Browsable(false)]
public SchedulerNavigatorElement SchedulerNavigatorElement { get; }
Gets the ShowWeekendCheckBox element
[Browsable(false)]
public RadCheckBoxElement ShowWeekendCheckBox { get; }
Gets the TimelineViewButton element.
[Browsable(false)]
public RadButtonElement TimelineViewButton { get; }
Show/Hide Timeline View button.
[Browsable(false)]
public bool TimelineViewButtonVisible { get; set; }
true if Timeline View button is visible; otherwise, false.
the timeline view button will not be hide when the scheduler is in timeline view
Gets the WeekViewButton element.
[Browsable(false)]
public RadButtonElement WeekViewButton { get; }
Show/Hide Week View button.
[Browsable(false)]
public bool WeekViewButtonVisible { get; set; }
true if button Week View is visible; otherwise, false.
the week view button will not be hide when the scheduler is in week view
Methods
Determines whether this control defines the theme for the specified element.
public override bool ControlDefinesThemeForElement(RadElement element)
The element to check.
Returns:True if this control defines the theme for the element; otherwise, false.
Overrides:
Creates the child elements that make up the control.
protected override void CreateChildItems(RadElement parent)
The parent element to which child elements will be added.
Overrides:
Called when the control is being loaded.
protected override void OnLoad(Size desiredSize)
The desired size of the control.
Overrides:
Processes changes to the AutoSize property.
protected override void ProcessAutoSizeChanged(bool value)
The new AutoSize value.
Overrides:
Events
Fires when the user clicks on the Agenda View button.
public event EventHandler AgendaViewClick
Fires when the user clicks on the Day View button.
public event EventHandler DayViewClick
Fires when the user clicks on the Month View button.
public event EventHandler MonthViewClick
Fires when the user clicks on the Navigate Backwards button.
public event EventHandler NavigateBackwardsClick
Fires when the user clicks on the Navigate Forwards button.
public event EventHandler NavigateForwardsClick
Fires when the user perform search from search textbox
public event EventHandler SearchCompleted
Fires when the user changes the state of the ShowWeekend checkbox.
public event StateChangedEventHandler ShowWeekendStateChanged
Fires when the user clicks on the Timeline View button.
public event EventHandler TimelineViewClick
Fires when the user clicks of the Week View button.
public event EventHandler WeekViewClick