Class ScheduleEventSettings

Inheritance

System.Object

Syncfusion.EJ2.EJTagHelper

ScheduleEventSettings

Namespace: Syncfusion.EJ2.Schedule

Assembly: Syncfusion.EJ2.dll

Syntax

public class ScheduleEventSettings : EJTagHelper

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	The default value is true

AllowDeleting

When set to false the delete action will be restricted.

Declaration

public bool AllowDeleting { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

AllowEditing

When set to false the edit action will be restricted.

Declaration

public bool AllowEditing { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

ContentTemplate

To get or set value for ContentTemplate.

Declaration

public MvcTemplate<object> ContentTemplate { get; set; }

Property Value

Type
Syncfusion.EJ2.MvcTemplate<System.Object>

DataSource

With this property, the event data will be bound to Schedule. The event data can be passed either as an array of JavaScript objects, or else can create an instance of DataManager in case of processing remote data and can be assigned to the dataSource property. With the remote data assigned to dataSource, check the available adaptors to customize the data processing.

Declaration

public object DataSource { get; set; }

Property Value

Type	Description
System.Object	The default value is null

EditFollowingEvents

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

Declaration

public bool EditFollowingEvents { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

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	The default value is false

EnableMaxHeight

It enables the event to occupy the full height in timeline views and full width in vertical views, excluding the header of the cell.

Declaration

public bool EnableMaxHeight { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

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	The default value is false

Fields

Defines the collection of default event fields to be bind to the Schedule.

Declaration

public ScheduleField Fields { get; set; }

Property Value

Type	Description
ScheduleField	The default value is null

IgnoreWhitespace

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

Declaration

public bool IgnoreWhitespace { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

IncludeFiltersInQuery

Gets or sets a value that determines whether the start date and end date filter conditions should be included in the query itself when requesting data from the server, or passed as query parameters in the API call. When set to the filter conditions will be part of the query itself, potentially reducing the size of the request and minimizing the time needed to parse the response. However, it can also lead to longer query strings, which could result in issues with maximum URL length or server limitations on query string length.

Declaration

public bool IncludeFiltersInQuery { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

MinimumEventDuration

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. It accepts duration value in minutes. This property is only applicable when the event duration is lesser than this property duration.

Declaration

public double MinimumEventDuration { get; set; }

Property Value

Type	Description
System.Double	The default value is 1

Query

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

Declaration

public string Query { get; set; }

Property Value

Type	Description
System.String	The default value is null

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	The default value is null

SortComparer

Defines the custom sort comparer function. The sort comparer function has the same functionality like Array.sort sort comparer.

Declaration

public object SortComparer { get; set; }

Property Value

Type	Description
System.Object	The default value is null

SpannedEventPlacement

Defines the option to render the spanned events (more than 24 hours) in either AllDayRow or TimeSlot. By default it renders in AllDayRow. This property is applicable for Day, Week and WorkWeek views only. The possible values for this property as follows AllDayRow: Denotes the rendering of spanned events in an all-day row. TimeSlot: Denotes the rendering of spanned events in an time slot row.

Declaration

public SpannedEventPlacement SpannedEventPlacement { get; set; }

Property Value

Type	Description
SpannedEventPlacement	The default value is SpannedEventPlacement.AllDayRow

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 Schedule from dataSource can be accessed within this template code.

Declaration

public string Template { get; set; }

Property Value

Type	Description
System.String	The default value is null

TooltipTemplate

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

Declaration

public string TooltipTemplate { get; set; }

Property Value

Type	Description
System.String	The default value is null