SchedulerViewBase Class
A base class for RadzenScheduler<T> views.
Inheritance
Implements
Inherited Members
ComponentBase.BuildRenderTree
ComponentBase.OnInitialized
ComponentBase.OnInitializedAsync
ComponentBase.OnParametersSet
ComponentBase.OnParametersSetAsync
ComponentBase.StateHasChanged
ComponentBase.ShouldRender
ComponentBase.OnAfterRender
ComponentBase.OnAfterRenderAsync
ComponentBase.InvokeAsync
ComponentBase.DispatchExceptionAsync
ComponentBase.RendererInfo
ComponentBase.Assets
ComponentBase.AssignedRenderMode
Namespace: Radzen.Blazor
Assembly: Radzen.Blazor.dll
Syntax
public abstract class SchedulerViewBase : ComponentBase, IComponent, IHandleEvent, IHandleAfterRender, ISchedulerViewConstructors
SchedulerViewBaselinkLink to this section
A base class for RadzenScheduler<T> views.
Declaration
protected SchedulerViewBase()Properties
EndDatelinkLink to this section
Gets the end date.
Declaration
public DateTime EndDate { get; }Property Value
| Type | Description |
|---|---|
| DateTime | Gets the end date. |
IconlinkLink to this section
Gets the icon of the view. It is displayed in the view switching UI.
Declaration
public string Icon { get; }Property Value
| Type | Description |
|---|---|
| string | Gets the icon of the view. It is displayed in the view switching UI. |
SchedulerlinkLink to this section
Gets or sets the scheduler instance.
Declaration
public IScheduler Scheduler { get; set; }Property Value
| Type | Description |
|---|---|
| IScheduler | Gets or sets the scheduler instance. |
StartDatelinkLink to this section
Gets the start date.
Declaration
public DateTime StartDate { get; }Property Value
| Type | Description |
|---|---|
| DateTime | Gets the start date. |
TextlinkLink to this section
Gets the text of the view. It is displayed in the view switching UI.
Declaration
public string Text { get; set; }Property Value
| Type | Description |
|---|---|
| string | Gets the text of the view. It is displayed in the view switching UI. |
TitlelinkLink to this section
Gets the title of the view. It is displayed in the RadzenScheduler title area.
Declaration
public string Title { get; }Property Value
| Type | Description |
|---|---|
| string | Gets the title of the view. It is displayed in the RadzenScheduler title area. |
TitleFormatlinkLink to this section
Gets or sets a composite format string used to format the view title. Argument {0} is the first date and argument {1} is the last date displayed by the view. The dates are formatted using the scheduler culture. For example TitleFormat="{0:MMMM yyyy}" displays the month and year of the first date. TitleFormatter takes precedence when both are set.
Declaration
public string TitleFormat { get; set; }Property Value
| Type | Description |
|---|---|
| string | Gets or sets a composite format string used to format the view title. Argument {0} is the first date and argument {1} is the last date displayed by the view. The dates are formatted using the scheduler culture. For example TitleFormat="{0:MMMM yyyy}" displays the month and year of the first date. TitleFormatter takes precedence when both are set. |
TitleFormatterlinkLink to this section
Gets or sets a function which returns the view title. It is invoked with the first and the last date displayed by the view. Takes precedence over TitleFormat.
Declaration
public Func<DateTime, DateTime, string> TitleFormatter { get; set; }Property Value
| Type | Description |
|---|---|
| Func<DateTime, DateTime, string> | Gets or sets a function which returns the view title. It is invoked with the first and the last date displayed by the view. Takes precedence over TitleFormat. |
Methods
FormatTitlelinkLink to this section
Formats the view title using TitleFormatter or TitleFormat when set, otherwise returns the default title.
Declaration
protected string FormatTitle(DateTime start, DateTime end, string title)Parameters
| Type | Name | Description |
|---|---|---|
| DateTime | start | The first date displayed by the view. |
| DateTime | end | The last date displayed by the view. |
| string | title | The default title. |
Returns
| Type | Description |
|---|---|
| string | The formatted title. |
LocalizelinkLink to this section
Gets a localized string for the specified resource key.
Declaration
public string Localize(string key)Parameters
| Type | Name | Description |
|---|---|---|
| string | key |
Returns
| Type | Description |
|---|---|
| string |
NextlinkLink to this section
Returns a new date when the user clicks the next button of RadzenScheduler.
Declaration
public abstract DateTime Next()Returns
| Type | Description |
|---|---|
| DateTime | The next date. For example a day view will return the next day, a week view will return the next week. |
OnAppointmentMovelinkLink to this section
Handles appointent move event.
Declaration
public Task OnAppointmentMove(SchedulerAppointmentMoveEventArgs data)Parameters
| Type | Name | Description |
|---|---|---|
| SchedulerAppointmentMoveEventArgs | data |
Returns
| Type | Description |
|---|---|
| Task |
PrevlinkLink to this section
Returns a new date when the user clicks the previous button of RadzenScheduler.
Declaration
public abstract DateTime Prev()Returns
| Type | Description |
|---|---|
| DateTime | The previous date. For example a day view will return the previous day, a week view will return the previous week. |
RenderlinkLink to this section
Renders this instance.
Declaration
public abstract RenderFragment Render()Returns
| Type | Description |
|---|---|
| RenderFragment |
SetParametersAsynclinkLink to this section
Called by the Blazor runtime when parameters are set.
Declaration
public override Task SetParametersAsync(ParameterView parameters)Parameters
| Type | Name | Description |
|---|---|---|
| ParameterView | parameters | The parameters. |
Returns
| Type | Description |
|---|---|
| Task |