Class SchedulerAgendaViewElement

Represents the main visual element for the agenda view in RadScheduler, providing a list-based display of appointments using a RadGridView control for efficient appointment management and navigation.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
SchedulerVisualElement
SchedulerViewElement
SchedulerAgendaViewElement
Inherited Members
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 SchedulerAgendaViewElement : SchedulerViewElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider

Constructors

SchedulerAgendaViewElement(RadScheduler, SchedulerView)

Initializes a new instance of the SchedulerAgendaViewElement class with the specified scheduler control and view configuration, setting up the grid-based agenda interface.

Declaration
public SchedulerAgendaViewElement(RadScheduler scheduler, SchedulerView view)
Parameters
RadScheduler scheduler

The RadScheduler control that owns this view element.
SchedulerView view

The SchedulerView that this element represents.

Properties

AppointmentMargin

This property is not relevant for this class as the agenda view uses a grid-based layout without traditional appointment margins.

Declaration
public override Padding AppointmentMargin { get; set; }
Property Value
System.Windows.Forms.Padding

Overrides

Grid

Gets the RadGridView instance used to display appointments in a tabular list format within this agenda view.

Declaration
public RadGridView Grid { get; }
Property Value
RadGridView

ResourceHeaderHeight

Gets or sets the height in pixels of the resource header rows displayed in the agenda view grid when resources are grouped.

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

Methods

ArrangeOverride(SizeF)

Arranges the child elements within the available space, positioning the navigation elements on the sides of the agenda view grid.

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

The final area within the parent that this element should use to arrange itself and its children.
Returns
System.Drawing.SizeF

The actual size used by the element.
Overrides

CreateGrid()

Creates and returns a new RadGridView instance for displaying appointment data in the agenda view with default configuration.

Declaration
protected virtual RadGridView CreateGrid()
Returns
RadGridView

A configured RadGridView control ready for appointment display.

CustomizeColumns()

Customizes the grid column widths, visibility, and formatting settings to optimize the display of appointment information in the agenda view.

Declaration
protected virtual void CustomizeColumns()

GetCellAtPosition(Int32, Int32)

Gets the cell element at the specified grid position, which is not applicable for the agenda view as it uses a different layout structure.

Declaration
public override SchedulerCellElement GetCellAtPosition(int row, int column)
Parameters
System.Int32 row

The row index in the layout grid.
System.Int32 column

The column index in the layout grid.
Returns
SchedulerCellElement

Always returns null as the agenda view does not use a traditional cell-based layout.
Overrides

GetCellCoordinates(SchedulerCellElement)

Gets the table layout coordinates for the specified cell element, which is not applicable for the agenda view as it uses a grid-based layout.

Declaration
public override TableLayoutPanelCellPosition GetCellCoordinates(SchedulerCellElement cell)
Parameters
SchedulerCellElement cell

The SchedulerCellElement to get coordinates for.
Returns
System.Windows.Forms.TableLayoutPanelCellPosition

An empty System.Windows.Forms.TableLayoutPanelCellPosition as the agenda view does not use a traditional cell coordinate system.
Overrides

HandleGrouping()

Configures grouping descriptors for the grid based on the current grouping settings, handling resource grouping and date grouping scenarios.

Declaration
protected virtual void HandleGrouping()

InitializeChildren()

Initializes the child elements including the grid control and sets up the complete agenda view interface with navigation elements.

Declaration
protected virtual void InitializeChildren()

LocalizeGridColumns()

Localizes the grid column headers and configures the column display properties, setting up the agenda view for the first time or after data changes.

Declaration
protected virtual void LocalizeGridColumns()

LocalizeGridColumnsCore()

Applies localized text to all grid column headers using the current localization provider for scheduler-specific strings.

Declaration
protected virtual void LocalizeGridColumnsCore()

OnLoaded()

Called when the element is loaded and applies theme settings to child elements including the grid and navigation components.

Declaration
protected override void OnLoaded()
Overrides

OnViewPropertyChanged(Object, PropertyChangedEventArgs)

Handles view property changes, updating the grid data source and grouping configuration based on specific property modifications.

Declaration
protected override void OnViewPropertyChanged(object sender, PropertyChangedEventArgs e)
Parameters
System.Object sender

The source of the event.
System.ComponentModel.PropertyChangedEventArgs e

The System.ComponentModel.PropertyChangedEventArgs instance containing the event data.
Overrides

ProcessContextMenu(Appointment, Point)

Processes and displays the context menu for the specified appointment at the given screen location, handling menu item visibility and appointment selection.

Declaration
protected virtual bool ProcessContextMenu(Appointment appointment, Point location)
Parameters
Appointment appointment

The Appointment to display the context menu for.
System.Drawing.Point location

The screen location where the context menu should be displayed.
Returns
System.Boolean

True if the context menu was successfully displayed, false otherwise.

SetupGrid()

Configures the RadGridView control used to display appointments in list format, including data binding, event handling, visual appearance settings, and grouping configuration.

Declaration
protected virtual void SetupGrid()

SetupNavigators()

Configures the forward and backward navigation elements for moving between appointments in the agenda view, setting up their text and visual orientation.

Declaration
protected virtual void SetupNavigators()

WireEvents()

Subscribes to the necessary grid events for handling appointment interaction, display customization, and user input processing.

Declaration
protected virtual void WireEvents()

Extension Methods