Class ScheduleToolBarViews

Represents a toolbar tool for switching between views in the SfSchedule<TValue> component.

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

This component renders a toolbar tool that allows users to switch between the available views defined in the Syncfusion.Blazor.Schedule.SfSchedule<TValue>.ScheduleViews property, such as Day, Week, or Month.

The views displayed by this tool must correspond to the views configured in the Syncfusion.Blazor.Schedule.SfSchedule<TValue>.ScheduleViews collection to ensure consistent behavior.

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 ScheduleToolBarViews to enable view switching in the scheduler.

<SfSchedule TValue="AppointmentData">
    <ScheduleToolBar>
        <ScheduleToolBarViews />
    </ScheduleToolBar>
</SfSchedule>
@code {
    public class AppointmentData
    {
        public string Subject { get; set; }
        public DateTime StartTime { get; set; }
        public DateTime EndTime { get; set; }
    }
}

Constructors

ScheduleToolBarViews()

Declaration
public ScheduleToolBarViews()

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 ScheduleToolBarViews 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 views toolbar item with the parent ScheduleToolBar
Exceptions
Type Condition
InvalidOperationException

Thrown when ScheduleToolBarViews is not used within a ScheduleToolBar component.

Implements