Class ScheduleToolBarDateRange

Represents a toolbar tool for selecting a date range in the SfSchedule<TValue> component.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
ScheduleToolBarDateRange
Implements
Inherited Members
Namespace: Syncfusion.Blazor.Schedule
Assembly: Syncfusion.Blazor.dll
Syntax
public class ScheduleToolBarDateRange : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Remarks

This component renders a date range picker that allows users to update the SelectedDate property of the scheduler based on the selected start date.

The date range picker supports internationalization for date formats, ensuring compatibility with locale-specific date representations as configured in the SfSchedule<TValue> component.

The component requires a reference to the parent ScheduleToolBar and its associated SfSchedule<TValue> component to function correctly.

For optimal performance, avoid frequent updates to the date range in scenarios with large datasets, as this may trigger scheduler refreshes that impact rendering performance.

This component must be placed within a ScheduleToolBar component, which in turn must be within a SfSchedule<TValue> component.

Examples

Demonstrates how to configure the ScheduleToolBarDateRange to enable date range selection in the scheduler.

<SfSchedule TValue="AppointmentData" @bind-SelectedDate="@SelectedDate">
    <ScheduleToolBar>
        <ScheduleToolBarDateRange />
    </ScheduleToolBar>
</SfSchedule>
@code {
    public class AppointmentData
    {
        public string Subject { get; set; }
        public DateTime StartTime { get; set; }
        public DateTime EndTime { get; set; }
    }
    private DateTime SelectedDate { get; set; } = DateTime.Today;
}

Constructors

ScheduleToolBarDateRange()

Declaration
public ScheduleToolBarDateRange()

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

Dispose(bool)

Dispose unmanaged resources in the Syncfusion Blazor component.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

Boolean value to dispose the object.
Overrides

OnInitializedAsync()

Initializes the ScheduleToolBarDateRange component during the component initialization phase.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

A task representing the asynchronous operation.
Overrides
Remarks

This method performs the following initialization tasks:

  • Calls the base OnInitializedAsync method
  • Validates that the component is used within a ScheduleToolBar component and throws an InvalidOperationException if not
  • Registers this date range toolbar item with the parent ScheduleToolBar
Exceptions
Type Condition
InvalidOperationException

Thrown when ScheduleToolBarDateRange is not used within a ScheduleToolBar component.

Implements