Class ScheduleEventSettingsBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
ScheduleEventSettingsBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class ScheduleEventSettingsBuilder : ControlBuilder
Constructors
ScheduleEventSettingsBuilder()
Declaration
public ScheduleEventSettingsBuilder()
ScheduleEventSettingsBuilder(ScheduleEventSettings)
Declaration
public ScheduleEventSettingsBuilder(ScheduleEventSettings model)
Parameters
Methods
AllowAdding(Boolean)
When set to false the add action will be restricted.
Declaration
public ScheduleEventSettingsBuilder AllowAdding(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
AllowDeleting(Boolean)
When set to false the delete action will be restricted.
Declaration
public ScheduleEventSettingsBuilder AllowDeleting(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
AllowEditing(Boolean)
When set to false the edit action will be restricted.
Declaration
public ScheduleEventSettingsBuilder AllowEditing(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
DataSource(Action<DataManagerBuilder>)
Declaration
public ScheduleEventSettingsBuilder DataSource(Action<DataManagerBuilder> dataSource)
Parameters
| Type |
Name |
Description |
| System.Action<Syncfusion.EJ2.DataManagerBuilder> |
dataSource |
|
Returns
DataSource(Object)
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 ScheduleEventSettingsBuilder DataSource(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
EditFollowingEvents(Boolean)
When set to true will edit the future events only instead of editing entire series.
Declaration
public ScheduleEventSettingsBuilder EditFollowingEvents(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
EnableIndicator(Boolean)
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 ScheduleEventSettingsBuilder EnableIndicator(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
EnableMaxHeight(Boolean)
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 ScheduleEventSettingsBuilder EnableMaxHeight(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
When set to true will display the normal tooltip over the events with its subject, location, start and end time.
Declaration
public ScheduleEventSettingsBuilder EnableTooltip(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Fields(ScheduleField)
Defines the collection of default event fields to be bind to the Schedule.
Declaration
public ScheduleEventSettingsBuilder Fields(ScheduleField value)
Parameters
Returns
Fields(Action<ScheduleFieldBuilder>)
Declaration
public ScheduleEventSettingsBuilder Fields(Action<ScheduleFieldBuilder> fields)
Parameters
Returns
IgnoreWhitespace(Boolean)
This property ignores or include the Events element bottom white space.
Declaration
public ScheduleEventSettingsBuilder IgnoreWhitespace(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
IncludeFiltersInQuery(Boolean)
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 ScheduleEventSettingsBuilder IncludeFiltersInQuery(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
MinimumEventDuration(Double)
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 ScheduleEventSettingsBuilder MinimumEventDuration(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Query(String)
Defines the external query
that will be executed along with the data processing.
Declaration
public ScheduleEventSettingsBuilder Query(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
ResourceColorField(String)
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.
{% codeBlock src="schedule/resource-color-field-api/index.ts" %}{% endcodeBlock %}
Declaration
public ScheduleEventSettingsBuilder ResourceColorField(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
SortComparer(Object)
Defines the custom sort comparer function.
The sort comparer function has the same functionality like
Array.sort sort comparer.
Declaration
public ScheduleEventSettingsBuilder SortComparer(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
SpannedEventPlacement(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.
{% codeBlock src='schedule/spannedEventPlacement/index.md' %}{% endcodeBlock %}
Declaration
public ScheduleEventSettingsBuilder SpannedEventPlacement(SpannedEventPlacement value)
Parameters
Returns
Template(String)
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.
{% codeBlock src="schedule/event-template-api/index.ts" %}{% endcodeBlock %}
Declaration
public ScheduleEventSettingsBuilder Template(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
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.
{% codeBlock src="schedule/tooltip-template-api/index.ts" %}{% endcodeBlock %}
Declaration
public ScheduleEventSettingsBuilder TooltipTemplate(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns