Class ScheduleFieldBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
ScheduleFieldBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class ScheduleFieldBuilder : ControlBuilder
Constructors
ScheduleFieldBuilder()
Declaration
public ScheduleFieldBuilder()
ScheduleFieldBuilder(ScheduleField)
Declaration
public ScheduleFieldBuilder(ScheduleField model)
Parameters
Methods
Description(ScheduleFieldOptions)
It maps the description field from the dataSource and denotes the event description which is optional.
Declaration
public ScheduleFieldBuilder Description(ScheduleFieldOptions value)
Parameters
Returns
Description(Action<ScheduleFieldOptionsBuilder>)
Declaration
public ScheduleFieldBuilder Description(Action<ScheduleFieldOptionsBuilder> description)
Parameters
Returns
EndTime(ScheduleFieldOptions)
The endTime field defines the end time of an event and it is mandatory to provide the end time for any of the valid event objects.
Declaration
public ScheduleFieldBuilder EndTime(ScheduleFieldOptions value)
Parameters
Returns
EndTime(Action<ScheduleFieldOptionsBuilder>)
Declaration
public ScheduleFieldBuilder EndTime(Action<ScheduleFieldOptionsBuilder> endTime)
Parameters
Returns
EndTimezone(ScheduleFieldOptions)
It maps the endTimezone field from the dataSource and usually accepts the valid
IANA timezone names.
It is assumed that the value provided for this field is taken into consideration while processing the endTime field.
When this field is not mapped with any timezone names, then the events will be processed based on the timezone assigned
to the Schedule.
Declaration
public ScheduleFieldBuilder EndTimezone(ScheduleFieldOptions value)
Parameters
Returns
EndTimezone(Action<ScheduleFieldOptionsBuilder>)
Declaration
public ScheduleFieldBuilder EndTimezone(Action<ScheduleFieldOptionsBuilder> endTimezone)
Parameters
Returns
FollowingID(String)
The followingID field is mapped from dataSource and usually holds the ID value of the main parent event.
Declaration
public ScheduleFieldBuilder FollowingID(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Id(String)
The id field needs to be defined as mandatory, when the Schedule is bound to remote data and
it is optional, if the same is bound with JSON data. This field usually assigns ID value to each of the events.
Declaration
public ScheduleFieldBuilder Id(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
IsAllDay(ScheduleFieldOptions)
The isAllDay field is mapped from the dataSource and is used to denote whether an event is created
for an entire day or for specific time alone.
Declaration
public ScheduleFieldBuilder IsAllDay(ScheduleFieldOptions value)
Parameters
Returns
IsAllDay(Action<ScheduleFieldOptionsBuilder>)
Declaration
public ScheduleFieldBuilder IsAllDay(Action<ScheduleFieldOptionsBuilder> isAllDay)
Parameters
Returns
IsBlock(String)
The isBlock field allows you to block certain time interval on the Scheduler.
It is a boolean type property accepting either true or false values.
When set to true, creates a block range for the specified time interval and disables the event scheduling actions on that time range.
Declaration
public ScheduleFieldBuilder IsBlock(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
IsReadonly(String)
The isReadonly field is mapped from the dataSource and is used to prevent the CRUD actions on specific events.
Declaration
public ScheduleFieldBuilder IsReadonly(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Location(ScheduleFieldOptions)
It maps the location field from the dataSource and the location field value will be displayed over
events, while given it for an event object.
Declaration
public ScheduleFieldBuilder Location(ScheduleFieldOptions value)
Parameters
Returns
Location(Action<ScheduleFieldOptionsBuilder>)
Declaration
public ScheduleFieldBuilder Location(Action<ScheduleFieldOptionsBuilder> location)
Parameters
Returns
RecurrenceException(ScheduleFieldOptions)
It maps the recurrenceException field from dataSource and is used to hold the exception dates
which needs to be excluded from recurring type.
Declaration
public ScheduleFieldBuilder RecurrenceException(ScheduleFieldOptions value)
Parameters
Returns
RecurrenceException(Action<ScheduleFieldOptionsBuilder>)
Declaration
public ScheduleFieldBuilder RecurrenceException(Action<ScheduleFieldOptionsBuilder> recurrenceException)
Parameters
Returns
RecurrenceID(ScheduleFieldOptions)
It maps the recurrenceID field from dataSource and usually holds the ID value of the parent
recurrence event. It is applicable only for the edited occurrence events.
Declaration
public ScheduleFieldBuilder RecurrenceID(ScheduleFieldOptions value)
Parameters
Returns
RecurrenceID(Action<ScheduleFieldOptionsBuilder>)
Declaration
public ScheduleFieldBuilder RecurrenceID(Action<ScheduleFieldOptionsBuilder> recurrenceID)
Parameters
Returns
RecurrenceRule(ScheduleFieldOptions)
It maps the recurrenceRule field from dataSource and is used to uniquely identify whether the
event belongs to a recurring event type or normal ones.
Declaration
public ScheduleFieldBuilder RecurrenceRule(ScheduleFieldOptions value)
Parameters
Returns
RecurrenceRule(Action<ScheduleFieldOptionsBuilder>)
Declaration
public ScheduleFieldBuilder RecurrenceRule(Action<ScheduleFieldOptionsBuilder> recurrenceRule)
Parameters
Returns
StartTime(ScheduleFieldOptions)
The startTime field defines the start time of an event and it is mandatory to provide it for any of the valid event objects.
Declaration
public ScheduleFieldBuilder StartTime(ScheduleFieldOptions value)
Parameters
Returns
StartTime(Action<ScheduleFieldOptionsBuilder>)
Declaration
public ScheduleFieldBuilder StartTime(Action<ScheduleFieldOptionsBuilder> startTime)
Parameters
Returns
StartTimezone(ScheduleFieldOptions)
It maps the startTimezone field from the dataSource and usually accepts the valid
IANA timezone names.
It is assumed that the value provided for this field is taken into consideration while processing
the startTime field. When this field is not mapped with any timezone names,
then the events will be processed based on the timezone assigned to the Schedule.
Declaration
public ScheduleFieldBuilder StartTimezone(ScheduleFieldOptions value)
Parameters
Returns
StartTimezone(Action<ScheduleFieldOptionsBuilder>)
Declaration
public ScheduleFieldBuilder StartTimezone(Action<ScheduleFieldOptionsBuilder> startTimezone)
Parameters
Returns
Subject(ScheduleFieldOptions)
The subject field is optional, and usually assigns the subject text to each of the events.
Declaration
public ScheduleFieldBuilder Subject(ScheduleFieldOptions value)
Parameters
Returns
Subject(Action<ScheduleFieldOptionsBuilder>)
Declaration
public ScheduleFieldBuilder Subject(Action<ScheduleFieldOptionsBuilder> subject)
Parameters
Returns
