Class ScheduleEventSettings<TValue>

Complete set of settings related to Scheduler events to bind it to local or remote dataSource, map applicable database fields and other validation to be carried out on the available fields.

Inheritance
System.Object
SfBaseComponent
SfDataBoundComponent
ScheduleEventSettings<TValue>
Inherited Members
Namespace: Syncfusion.Blazor.Schedule
Assembly: Syncfusion.Blazor.dll
Syntax
public class ScheduleEventSettings<TValue> : SfDataBoundComponent, IScheduleEventSettings
Type Parameters
Name Description
TValue

A type which provides schema for the events.

Constructors

ScheduleEventSettings()

Declaration
public ScheduleEventSettings()

Properties

AllowAdding

When set to false the add action will be restricted.

Declaration
public bool AllowAdding { get; set; }
Property Value
Type Description
System.Boolean

AllowDeleting

When set to false the delete action will be restricted.

Declaration
public bool AllowDeleting { get; set; }
Property Value
Type Description
System.Boolean

AllowEditFollowingEvents

When set to true will edit the future events only instead of editing entire series.

Declaration
public bool AllowEditFollowingEvents { get; set; }
Property Value
Type Description
System.Boolean

AllowEditing

When set to false the edit action will be restricted.

Declaration
public bool AllowEditing { get; set; }
Property Value
Type Description
System.Boolean

ChildContent

Child Content for schedule event settings.

Declaration
public RenderFragment ChildContent { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment

DataSource

With this property, the event data will be bound to Scheduler.

Declaration
public IEnumerable<TValue> DataSource { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<TValue>

EnableIndicator

This property enables the event to occupy the full height that remaining from the header and more indicator. More than one appointment are available on the cell the more indicator is created.

Declaration
public bool EnableIndicator { get; set; }
Property Value
Type Description
System.Boolean

EnableMaxHeight

It enables the event to occupy the full height of the cell without the header of the cell.

Declaration
public bool EnableMaxHeight { get; set; }
Property Value
Type Description
System.Boolean

EnableTooltip

When set to true will display the normal tooltip over the events with its subject, location, start and end time.

Declaration
public bool EnableTooltip { get; set; }
Property Value
Type Description
System.Boolean

IgnoreWhitespace

This property ignores or include the Events element bottom white space.

Declaration
public bool IgnoreWhitespace { get; set; }
Property Value
Type Description
System.Boolean

MinimumEventDuration

Get or sets a minimum duration for an event where the events are rendered for this minimum duration when the duration of the event is lesser than this value.

Declaration
public int MinimumEventDuration { get; set; }
Property Value
Type Description
System.Int32

Accepts a MinimumEventDuration duration value in minutes. The default value is 1 minute.
Remarks

The events are rendered using MinimumEventDuration property when the event duration is lesser than MinimumEventDuration.

Query

Defines the external Query. that will be executed along with the data processing.

Declaration
public Query Query { get; set; }
Property Value
Type Description
Query

ResourceColorField

Defines the resource name, to decides the color of which particular resource level is to be applied on appointments, when grouping is enabled on scheduler.

Declaration
public string ResourceColorField { get; set; }
Property Value
Type Description
System.String

SortBy

This property will sort the events based on the scheduler's event filed.

Declaration
public string SortBy { get; set; }
Property Value
Type Description
System.String

SpannedEventPlacement

Get or sets the rendering of spanned events (duration is more than 24 hours) in an all-day row or time slot (work area).

Declaration
public SpannedEventPlacement SpannedEventPlacement { get; set; }
Property Value
Type Description
SpannedEventPlacement

Accepts a SpannedEventPlacement enum value. The default value is SpannedEventPlacement.AllDayRow.
Remarks

Spanned events are rendered in allday row or within timeslot based on this property applicable for day, week and workweek views only.

Template

It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto the event background. All the event fields mapped to Scheduler from dataSource can be accessed within this template code.

Declaration
public RenderFragment<object> Template { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment<System.Object>

TooltipTemplate

All the event fields mapped with Scheduler dataSource can be accessed within this template.

Declaration
public RenderFragment<object> TooltipTemplate { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment<System.Object>

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
System.Threading.Tasks.Task
Overrides

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
System.Threading.Tasks.Task
Overrides

Implements