Class ScheduleField
Inherited Members
Namespace: Syncfusion.EJ2.Schedule
Assembly: Syncfusion.EJ2.dll
Syntax
public class ScheduleField : EJTagHelper
Constructors
ScheduleField()
Declaration
public ScheduleField()
Properties
ContentTemplate
To get or set value for ContentTemplate.
Declaration
public MvcTemplate<object> ContentTemplate { get; set; }
Property Value
Type | Description |
---|---|
MvcTemplate<System.Object> |
Description
It maps the description
field from the dataSource and denotes the event description which is optional.
Declaration
[HtmlAttributeName("description")]
public ScheduleFieldOptions Description { get; set; }
Property Value
Type | Description |
---|---|
ScheduleFieldOptions | The default value is null |
EndTime
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
[HtmlAttributeName("endTime")]
public ScheduleFieldOptions EndTime { get; set; }
Property Value
Type | Description |
---|---|
ScheduleFieldOptions | The default value is null |
EndTimezone
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
[HtmlAttributeName("endTimezone")]
public ScheduleFieldOptions EndTimezone { get; set; }
Property Value
Type | Description |
---|---|
ScheduleFieldOptions | The default value is null |
FollowingID
The followingID
field is mapped from dataSource and usually holds the ID value of the main parent event.
Declaration
[HtmlAttributeName("followingID")]
public string FollowingID { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Id
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
[HtmlAttributeName("id")]
public override string Id { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Overrides
IsAllDay
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
[HtmlAttributeName("isAllDay")]
public ScheduleFieldOptions IsAllDay { get; set; }
Property Value
Type | Description |
---|---|
ScheduleFieldOptions | The default value is null |
IsBlock
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
[HtmlAttributeName("isBlock")]
public string IsBlock { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
IsReadonly
The isReadonly
field is mapped from the dataSource and is used to prevent the CRUD actions on specific events.
Declaration
[HtmlAttributeName("isReadonly")]
public string IsReadonly { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Location
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
[HtmlAttributeName("location")]
public ScheduleFieldOptions Location { get; set; }
Property Value
Type | Description |
---|---|
ScheduleFieldOptions | The default value is null |
RecurrenceException
It maps the recurrenceException
field from dataSource and is used to hold the exception dates
which needs to be excluded from recurring type.
Declaration
[HtmlAttributeName("recurrenceException")]
public ScheduleFieldOptions RecurrenceException { get; set; }
Property Value
Type | Description |
---|---|
ScheduleFieldOptions | The default value is null |
RecurrenceID
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
[HtmlAttributeName("recurrenceID")]
public ScheduleFieldOptions RecurrenceID { get; set; }
Property Value
Type | Description |
---|---|
ScheduleFieldOptions | The default value is null |
RecurrenceRule
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
[HtmlAttributeName("recurrenceRule")]
public ScheduleFieldOptions RecurrenceRule { get; set; }
Property Value
Type | Description |
---|---|
ScheduleFieldOptions | The default value is null |
StartTime
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
[HtmlAttributeName("startTime")]
public ScheduleFieldOptions StartTime { get; set; }
Property Value
Type | Description |
---|---|
ScheduleFieldOptions | The default value is null |
StartTimezone
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
[HtmlAttributeName("startTimezone")]
public ScheduleFieldOptions StartTimezone { get; set; }
Property Value
Type | Description |
---|---|
ScheduleFieldOptions | The default value is null |
Subject
The subject
field is optional, and usually assigns the subject text to each of the events.
Declaration
[HtmlAttributeName("subject")]
public ScheduleFieldOptions Subject { get; set; }
Property Value
Type | Description |
---|---|
ScheduleFieldOptions | The default value is null |