Syncfusion.Schedule.Base
The Syncfusion namespace contains classes that defines the value and reference data types, events and event handlers, interfaces, attributes and processing the exceptions.
This class holds the name of the Syncfusion.Grid.Windows assembly and provides a helper
routine that helps with resolving types when loading a serialization stream and when
the framework probes for assemblies by reflection.
The full name of this assembly without version information: "Syncfusion.Schedule.Base"
A reference to the for the Schedule assembly.
The root namespace of this assembly. Used internally for locating resources within the assembly.
This delegate helps with resolving types and can be used as a eventhandler
for a event.
The source of the event.
The event data with information about the type.
A reference to the assembly where the type is located.
Use this handler when reading back types from a serialization stread
saved with an earlier version of this assembly.
Defines items that can be included in a .
Choice lists within the ScheduleControl are used to provide possible
schedule item information like location or a reminder. ILookUpObject
allows such list items to have a ValueMember/DisplayMember associated with
the choices as well as a color that will be used in dropdowns showing these
lists. Value members are normally the values serialized to data stores.
Gets or sets a color associated with this item.
Gets or sets the display member associated with this item.
Gets or sets a value member associated with this item.
An Interface that defines Collection of items.
Indexer that returns a .
Gets i-th Object
Provides the functionality for individual schedule items.
IScheduleAppointments must implement IComparable and ICloneable. IComparable is used to order
the incidents in sorts so the items can be properly arranged in the schedule. ICloneable is
also required to handle support for drag and drop in the ScheduleControl.
Provides the functionality for individual schedule items.
IScheduleAppointments must implement IComparable and ICloneable. IComparable is used to order
the incidents in sorts so the items can be properly arranged in the schedule. ICloneable is
also required to handle support for drag and drop in the ScheduleControl.
Determine whether item has conflict with other item.
A IScheduleAppointment
True if the item is in conflict.
Determine whether item has conflict with other item.
start time
end time
True if the item is in conflict.
Gets or sets a value indicating whether all day appointment or not.
Gets or sets a value indicating whether or not blocked appointment is allowed to click.
Gets or sets a value indicating whether or not an appointment is allowed to drag.
Gets or sets a value indicating whether or not an appointment is allowed to resize and modify its duration.
Gets or sets the appointment html element background color.
Gets or sets fore color of the appointment panel.
Gets or sets a text displayed as the main content of this schedule item.
Gets or sets associates ToolTip text with the appointment.
Gets or sets a value indicating whether or not this items has been modified.
Gets or sets end time for this item.
Gets or sets a value indicating whether or not changes to this item should be ignored.
Gets or sets a categorizer value for this item.
Gets or sets some item dependent string-like the location of a meeting.
Gets or sets some item dependent string-like the location of a meeting.
Gets or sets categorizer value for this item.
Gets or sets owner of this schedule item.
Gets or sets a value indicating whether or not some reminder action should be taken as this item becomes current.
Gets or sets a remind value of this item.
Gets or sets a remind text of this item.
Gets or sets a start time of this item.
Gets or sets the subject or topic title for this schedule item.
Gets or sets an arbitrary object associated with this item.
Gets or sets a color of appointment time span element.
Gets or sets ToolTip text with the appointment.
Gets or sets a unique identifier for this schedule item.
A read-only property that gets a version associated with the data schema for this item.
Gets or sets the recurrenceList holding the dates associated with this recurring appointment.
Gets or sets the RecurrenceRule including both start and end dates.
Gets or sets the unique identifier assigned to this recurrence appointment.
Implement this interface to support recurring appointment in your IScheduleDataProvider.
Initially adds recurring appointments to the data provider.
The recurring appointment definition.
The minimal date up to which all recurring appointments should be added.
Use this method on the initial load to handle adding recurring appointments.
Used after the initial load to add additional recurring appointments to the data provider.
The date to which recurring appointments need to be extended.
True if dates were added.
Dynamically provide appointments on demand as new dates are exposed.
Returns a unique integer that serves to identify a recurring family of appointments.
A unique integer.
Removes all occurrences the given appointment.
Recurring appointment form.
True if the operation succeeds.
Makes changes to appointments in a recurring sequence of appointments.
The edited appointment.
The un-edited appointment.
The requested edit action.
Gets a list of recurring appointments.
Defines the collection of schedule items.
Adds an IScheduleAppointment at the end of this collection.
An IScheduleAppointment item.
Finds an IScheduleAppointment in the collection using its IScheduleAppointment.UniqueID.
The IScheduleAppointment.UniqueID of the IScheduleAppointment being searched for.
The IScheduleAppointment whose IScheduleAppointment.UniqueID is the given uniqueID.
Locates the index of a particular IScheduleAppointment in this collection.
The item to be located.
The index of the given item.
Inserts the given IScheduleAppointment at a particular position in this collection.
Where the item should be inserted.
The item to be inserted.
Returns an instance of a new schedule item.
A new schedule item that can be added to this list.
Removes a given IScheduleAppointment from this collection.
The item to be removed.
Removes an IScheduleAppointment at the given index from this collection.
The index of the IScheduleAppointment to be removed.
Arranges the IScheduleAppointments in this list according to IScheduleAppointment.StartTime.
Gets number of IScheduleAppointments in this list.
An IScheduleAppointment referenced through an indexer.
Get the ScheduleAppointment based on index
Defines the framework for providing schedule item data to the ScheduleControl.
Adds a schedule item to this list.
The schedule item to be added.
Saves modifications to the schedule items back to the data store.
Gets a list holding the possible values for the property.
A list of possible values.
Gets a list holding the possible values for the property.
A list of possible values.
Gets a list holding the possible values for the property.
A list of possible values.
Gets a list holding the possible values for the property.
Resources collection
Gets a list holding the possible values for the property.
A list of possible values.
Gets a list of schedule items for a range of dates.
The start date of the requested range.
The end date of the requested range.
IScheduleAppointmentList object that holds the list of schedule items.
Gets a list of schedule items for a range of dates and a specified owner.
The start date of the requested range.
The end date of the requested range.
The requested owner.
IScheduleAppointmentList object that holds the list of schedule items.
Gets a list of schedule items for a particular day.
The requested date.
IScheduleAppointmentList object that holds the list of schedule items.
Gets a list of schedule items for a particular day and owner.
The requested date.
The requested owner.
IScheduleAppointmentList object that holds the list of schedule items.
Initializes the contents of the ILookUpObjectList lists obtained from
these methods: , , , ,
Gets an instance of a new schedule item.
A new schedule item that can be added to this list.
Gets an instance of a new schedule items collection.
A new schedule items collection.
Gets an instance of a new schedule resource.
A new schedule resource.
Gets an instance of a new schedule resources collection.
A new schedule resources collection.
Removes a schedule item from this list.
The schedule item to be removed.
Makes changes to appointments.
The edited appointment.
The original appointment.
Gets or sets a value indicating whether data source is modified or not.
Gets or sets the SaveOnCloseBehavioourAction which determines whether CommitChanges is called when the toplevel Form holding the ScheduleControl is closed.
Provides the functionality for individual schedule resources.
Gets or sets the name of the resource.
Gets or sets a unique integer associated with this resource.
Defines the collection of schedule resources.
Appends the IScheduleResource to the end of the IScheduleResourceCollection.
The IScheduleResource to add to the IScheduleResourceCollection.
Index at which the item is added.
Determines whether the collection contains the specified resource.
A IScheduleResource to search for in the collection.
true if the collection contains the specified item; otherwise, false.
Finds resource by UniqueID.
resource UniqueID
A IScheduleResource
Determines the index value that represents the position of the IScheduleResource in the ScheduleResourceCollection.
The IScheduleResource to locate in the IScheduleResourceCollection.
The index position of the specified IScheduleResource in the collection.
Inserts a IScheduleResource in the IScheduleResourceCollection at the specified index location.
The location in the collection to insert the ScheduleResource.
A IScheduleResource to add to the collection.
Gets an instance of a new schedule resource.
A new schedule resource that can be added to this list.
Removes the specified ScheduleResource from the ScheduleResourceCollection.
The IScheduleResource to remove from the collection.
Indexer that returns a .
Get the ScheduleResource based on index
Represents a method that handles an event with arguments
which is raised when any has changed.
The source of the event.
The that contains the event data.
Represents a method that handles an event with arguments
which is raised when any has changed.
The source of the event.
The that contains the event data.
Provides data for the ItemChanging event.
Initializes a new instance of the class.
The event arguments for a cancellable event raised prior to changes in an IScheduleAppointment object.
Current value of the IScheduleAppointment object.
Modified value of the IScheduleAppointment object.
An value that indicates the type of the change.
Initializes a new instance of the class.
The event arguments for a cancellable event raised prior to changes in an IScheduleAppointment object.
Current value of the IScheduleAppointment object.
Modified value of the IScheduleAppointment object.
An value that indicates the type of the change.
An value that indicates the drag hit context.
An Overridden method that returns the string representation of ScheduleAppointmentCancelEventArgs object.
A string holding the event args object.
Gets or sets type of action that is being taken such as a Drag or an Edit.
Gets or sets drag hit context in a Month or Week View
Gets or sets IScheduleAppointment prior to the change.
Gets or sets IScheduleAppointment after the change.
Provides data for the ItemChanged event.
Initializes a new instance of the class.
Current value of the IScheduleAppointment object.
An value that indicates the type of the change.
An Overridden method that returns the string representation of ScheduleAppointmentEventArgs object.
A string holding the Event Args object.
Gets or sets type of action that is being taken such as a Drag or an Edit.
Gets or sets IScheduleAppointment after the change.
Defines the constants that specify how the fixed panel holding the navigation calendars is displayed.
No navigation calendars are visible.
Navigation calendars are positioned to the left of Schedule display.
Navigation calendars are positioned to the right of Schedule display.
Defines the constants that specify the type of change an IScheduleAppointment is undergoing due to a user action.
A new IScheduleAppointment is being added.
A default IScheduleAppointment is being requested.
An IScheduleAppointment is being deleted.
An existing IScheduleAppointment is being edited.
A IScheduleAppointment is being moved with a Mouse Drag.
The bottom or top border of a IScheduleAppointment is being dragged.
Defines the constants that specify the type of information under a Point.
There is a AllDay IScheduleAppointment item under the Point.
The Point is in a header line within a cell in a Week or Month Schedule view.
The Point is in a column header of a Day or WorkWeek Schedule view.
An IScheduleAppointment item under the Point.
The Point is in the rectangle occupied by the MoreItemsBitmap.
There is no IScheduleAppointment item under the Point.
Defines the constants that specify the possible edit actions on recurring appointments.
Cancel the edit action.
Modify all appointments in this recurrence definition.
Modify this and all future appointments.
Modify a single appointment.
Defines the constants that specify the SaveOnClose behavior on how IScheduleDataProvider.Commit will be called when the toplevel Form holding the ScheduleControl is closed.
Do not call Commit.
Propmt before calling Commit.
Call Commit without a prompt.
Defines the constants that specify the details of a that get displayed in a ToolTip.
Retreives all the details of any appointment
When the is set to custom you can define your own custom tooltip
Retreives the of a appointment
Retreives the of a appointment
Retreives the ResourceName of Appointment"/> of a appointment
Retreives the and of a appointment
Retreives the of a appointment
Retreives the of a appointment
Defines the constants that specify where the mouse is during a appointment drag in a Week or Month view.
Mouse is over the schedule control.
Mouse is over the calendar.
Exposes methods that allow you find dates that satisfy
some rule that designate when recurring appointments happen. The rule may be something as
simple as 'every month on 13' to indicate that the appointment should occur on the 13th
day of each month. Other rules might be 'every year on Jan 13', or
'every year on weekday after Apr 15'. A recurrence rule may be defined either as a string
(as with the three examples so far), or as an . More samples
of each use case follows.
A recurrence rule has three main pieces; an Every clause, an On clause and an BeforeAfter
clause. Each of the three main pieces also has an integer count property associated with
it; EveryCount, OnCount and BeforeAfterCount. The RecurrenceRule class has public
properties that reflect these values; Every, EveryCount, On, OnCount, BeforeAfter, and
BeforeAfterCount. You may create a RecurrenceRule either by passing the constructor a
well formaed string holding the rule, or you can use the default constructor and explicitly
set the six properties mentioned above to define the RecurrenceRule.
Initializes a new instance of the class.
Gets the first day of specified month.
The date value to find.
The first day.
Gets the first day of quarter month.
The date value to find.
The first day.
Gets the first day of year.
The date value to find.
The first day.
Gets an integer starting at location in parsedRule.
Index of the rule.
Rule string.
Count.
Gets the first date that satisfies the given recurrence definition that follows the
given date.
The date where the search begins, returns as the newly located date.
The RecurrenceRule that defines the recurrence.
True if a date was located and dt holds the next occurrence.
The usage is to call GetFirstDate to begin accumulating the dates that satisfiy the recurrence
definition. After returning the first date, then use the GetNextDate method to find each addition date.
Notice that GetFirstDate may find the passed in value (dt) satisfies the recurrence definition, but
GetNextDate does not consider the passed in date when it does it search.
Gets the first date that satisfies the given recurrence definition that follows the
given date.
The date where the search begins and returns as the newly found date.
A string holding the recurrence definition.
The Recurrence object defines the recurrence.
True if a new recurrence date is located.
If rule is passed in as null, then parsedExpression must hold the
recurrence definition. If parsedExpression is passed in as empty, then rule must hold the
recurrence definition.
The usage is to call GetFirstDate to begin accumulating the dates that satisfy the recurrence
definition. After returning the first date, then use the GetNextDate method to find each addition date.
Notice that GetFirstDate may find the passed in value (dt) satisfies the recurrence definition, but
GetNextDate does not consider the passed in date when it does it search.
The typical use case will not require the use of this method. Usually,
you would define a object, and work with that object and its
IsValidRecurrence method to get recurrent dates.
Get the next date that satisfies the recurrence definition.
The date after which the search begins. The newly found date
is returned through this parameter.
A parsed expression that defines the recurrence defintion.
The recurrence definition.
True if a new date is located that satisfies the recurrence.
Get the next date that satisfies the recurrence definition.
The date after which the search begins. The newly found date
is returned through this parameter.
The recurrence definition.
True if a new date is located that satisfies the recurrence.
The typical use case will not require the use of this method. Usually,
you would define a object, and work with that object and its
IsValidRecurrence method to get recurrent dates.
Gets a represented by the input text.
A string holding a valid recurrence definition.
A RecurrenceRule.
If the input text holds multiple recurrence definitions (separated
by semicolons), then the first definition is used to define the single RecurrenceRule
that is returned.
Returns a string holding the recurrenced defined by the given RecurrenceRule.
The RecurrenceRule.
The string representing the recurrence definition.
Handles the recurrence rule before and after.
The date value to handle.
The recurrence rule.
Handles the On clause
The date value to handle.
Recurrence rule.
Determines if the passed AppointmentItem is a Span Item or not.
Schedule Appointment.
True if the Schedule Appointment is Span Item, false otherwise.
Checks whether the provided string holds a valid recurrence defintion.
A string containingth eproposed rule.
True if the rule is valid.
Checks whether the provided string holds a valid recurrence defintion.
A string containingth eproposed rule.
Returns an error message if teh rule is not valid.
True if the rule is valid.
Gets a tokenized version of the recurrence definition represented by text.
The text of the definition. eg. Every month On Wed After 15
A tokenized string.
Accepts a tokenized string representing a recurrence definition and returns a non-tokenized version.
Tokenized string
Non tokenized string.
Accepts a tokenized string representing a recurrence definition and returns a non-tokenized version.
Token string.
Non tokenized string.
Gets or sets the character that is used to indicate a count parameter
(an integer) is applied to the preceding value. Default value is colon (:).
Use this character to delimit an object from a count. For example,
if you want to specify the second Wednesday of every month, then the recurrence
definition could be represented as 'Every month On Wed:2'. The idea is that
Wed:2 represents the second Wednesday.
Gets the token of week days.
Gets an ArrayList of strings that can be used to compose a text version of
a recurrence definition.
This list is exposed in case you want to localize the strings
used to define a recurrence definition in text. Note each string
should be padded with a single space at each end. The strings are
defined by the code below. When you replace them, the replacements must
be in the same order.
gridTableControl.UpdateWithCustomPaint(bounds, new PaintEventHandler(TableControl_CustomPaint));
void TableControl_CustomPaint(object sender, PaintEventArgs e)
{
Rectangle clipBounds = Rectangle.Truncate(e.Graphics.ClipBounds);
gridTableControl.DrawClippedGrid(e.Graphics, clipBounds, false);
}
public ArrayList ParseableStrings
{
get
{
if (parseableStrings == null)
{
parseableStrings = new ArrayList(new string[]{
" EVERY ",
" ON ",
" AFTER ",
" DAY ",
" WEEK ",
" MONTH ",
" QUARTER ",
" YEAR ",
" WEEKDAY ",
" WEEKEND ",
" MON ",
" TUE ",
" WED ",
" THU ",
" FRI ",
" SAT ",
" SUN ",
" JAN ",
" FEB ",
" MAR ",
" APR ",
" MAY ",
" JUN ",
" JUL ",
" AUG ",
" SEP ",
" OCT ",
" NOV ",
" DEC "
});
}
return parseableStrings;
}
}
Gets or sets the character that indicates a recurrence definition
string has been parsed. Parsed strings begin with this character.
Default is tilde (~).
Gets or sets the character used to delimit multiple recurrence definitions
in a single string. Default is semicolon (;).
Gets or sets the character used to delimit multiple recurrence definitions
in a single string. Default is semicolon (;).
Gets the support class for recurrence support.
Gets or sets an array list that holds the days of the weeks that are considered the weekend.
It defaults to two days: DayOfWeek.Saturday, DayOfWeek.Sunday.
If you modify this list, you must make sure you only add DayOfWeek
enumerations to this list. The implementation expects this class to hold DayOfWeek values.
Defines the constants that specify the various pieces that go into making a valid rule that defines a set of recurring dates.
Indicates the beginning of an Every clause.
Indicates the beginning of an On clause.
Indicates the beginning of an BeforeAfter clause.
Indicates the beginning of an BeforeAfter clause. Not currently used.
Indicates the beginning of an In clause. Not currently used.
Represents a Day.
Represents a Week.
Represents a Month.
Represents a Quarter.
Represents a Year.
Represents a Week Day.
Represents a Week End.
Represents a Monday.
Represents a Tuesday.
Represents a Wednesday.
Represents a Thursday.
Represents a Friday.
Represents a Saturday.
Represents a Sunday.
Represents January.
Represents February.
Represents March.
Represents April.
Represents May.
Represents June.
Represents July.
Represents August.
Represents September.
Represents October.
Represents November.
Represents December.
Represents no entry.
Represents seconds.
Represents minutes.
Represents hours
Encapsulates the idea of a recurrence defintion. Its purpose is to accept a
recurrence definition (either as a string or as RecurrenceRules) and allow you to easily
decide whether particular date satisfies the defineition of recurrence. The class derives from
ArrayList. The ArayList may (depending upon ) hold a list
of known valid recurrent dates. This list is dynamic, and will grow as you use the method
to determine whether a date satisfies the definition of
recurrence.
Initializes a new instance of the class.
Initializes a new instance of the class. Accepts a string rule and a base date to define the recurrence.
The string rule.
The base date.
Defines the appointment associated with this recurrence.
Initializes a new instance of the class. Uses a RecurenceRule and BaseDate to define the recurrence.
The recurrence rule.
The basedate.
Defines the appointment associated with this recurrence.
Initializes a new instance of the class. Accepts a fixed list of dates.
An Array of DateTime values.
Defines the appointment associated with this recurrence.
This constructor allows you to specify a recurrence as a fix set of dates. So,
if you want to set up a series of 5 meetings on 5 different dates, then
you can use this constructor to do so as a recurring appointment.
Determines whether the given date satisfies the recurrence definition.
The date to be tested.
True is the date satisfies the recurrence definition.
If is true, then this routine first
does a binary search on the dates that are cached in the underlying ArrayList.
If the date is not found and exceeds the last cached date, then
Syncfusion.Schedule.RecurrenceSupport.GetFirstDate is called with a base date of the
last known cached recurrence date. Then GetNextDate is continually called until
either the given date is found to satisfy the recurrence, or the given date has
been exceeded. As the dates are generated, they are inserted into the underlying
ArrayList, extending the known date cache. Care is taken to insert the new dates
properly so the underlying date cache is always sorted, and BinarySearch is valid.
If EnableDateCache is false, then no searching is attempted in the cache which is
always empty. Instead, GetFirstDate is always called with the BaseDate, and the
GetNextDate is called until the given date is found or exceeded. There is no
cacheing involved and all checks require starting at the beginning and computing
all the dates from scratch everytime.
Gets or sets appointment information for this recurring event.
When a Calendar is displaying a date that holds a recurring
appointment, the information provided through this property will
be used to create a placeholder appointment for this recurring event.
Gets or sets the start date for this recurrence.
This value should be the earliest possible date that you want to be considered
for this set of recurrences.
Gets or sets a value indicating whether this RecurrencList maintains a list of dates that satisfies
the recurrence definition.
If this property is true, the ReccurenceList is an ArrayList object hodling a sorted
list of the known occurrences to date. The list is fully populated in the sense that
all dates between the first date in that list and the last date in the list which
satisfy the recurrence definintion are also in the list. This list is used in the
method to check for occurences. This method first
checks whether the requested date is in the list which means the method returns true.
If not, it checks to see if the requested date is less than teh last date in the list,
and if so, returns false. Finally, if the requested date is beyond the dates in the list,
the method computes new dates that satisfy the rule and adds them to the list until
ether the requested date is found, or exceeded. This means that the list dynamically
grows as you request further and further dates into the future.
This dynamic list technique makes validating dates to be very efficient at the expense
of the memory load of maintaining the date list.
Gets or sets an array of s that defines this recurrence collection.
Gets or sets a string that defines this recurrence collection.
The string may be a simple rule that qualifies (
for sample rules). It also can be several simple rules appended together with
semicolons. This RuleString is equivalent to the collection of
in that both RuleString and Rules define exactly the same set of recurrent dates.
Gets or sets the last date associated with this recurrence definition.
Gets of sets the ith date in this RecurrentList.
The requested index.
A date satisfying this recurrence.
Implements the definition of a simple recurrence. There are two representations
available for the recurrence definition. One is a simple text string that hold words defining the
recurrence. The property Text holds this text string. The other representation is based on the
enumerations along with some supporting integer properties. The enumerations
are Every, On, and BeforeAfter. The supporting properties are EveryCount, OnCount and BeforeAfterCount.
It is important to understand that there are two ways to define a set of recurrences
in a RecurrenceRule object. One is through the Text property. The other is through the ParseToken
enumeration properties and their associated integer properties. The Text definition is easier to
serialize and present to the user. The enumeration properties allow for straight-forward calculation
support.
Initializes a new instance of the RecurrenceRule class. Accepts a string used in the recurrence defintion.
The string that defines this recurrence.
Initializes a new instance of the class.
Handles the null tokens.
Token.
Token string.
An Overridden method that returns a string holding the RecurrenceRule object.
String representation of this object.
Gets or sets after clause for this rule.
The valid values for this property are:
MON
TUE
WED
THU
FRI
SAT
SUN
JAN
FEB
MAR
APR
MAY
JUN
JUL
AUG
SEP
OCT
NOV
DEC
NULL
If BeforeAfter has a value of ParseToken.NULL, then BeforeAfterCount should be positive and
represent a date. For example, the string "Every month on Wed After 15" would pick out the
first Wed of every month on or after the 15th of the month. In this case, the enumeration
representation of this recurrence definition would have BeforeAfter = ParseToken.NULL and
BeforeAfterCount = 15.
Also, this is a required entry when specifying a recurrence definition.
Gets or sets an integer value used in conjunction with the BeforeAfter property to determine the After clause of the
definition of this recurrence. So, if Text = "Every month After Wed:2", then this would tranlate into
the BeforeAfter = ParseToken.WED and BeforeAfterCount = 2.
Gets or sets the BeforeAfterType which is not currently being used.
For the current implementation, this property should always have the value of
ParseTokens.After.
Gets or sets Every clause for this rule.
The valid values for this property are:
DAY
WEEK
MONTH
QUARTER
YEAR
WEEKDAY
WEEKEND
MON
TUE
WED
THU
FRI
SAT
SUN
JAN
FEB
MAR
APR
MAY
JUN
JUL
AUG
SEP
OCT
NOV
DEC
NULL
If Every = ParseTokens.NULL, then EveryCount must be positive. In this case, the EveryCount represents a
date. So, the string Text = "Every 21" would result in Every = ParseTokens.NULL and EveryCount = 21. The
recurrence definition would represent the 21st of every month.
Please note that the month entries, normally have a non-zero value set for EveryCount.
Also, this is a required entry when specifying a recurrence definition.
Gets or sets an integer value used in conjunction with the Every property to determine the Every clause of the
definition of this recurrence. So, if Text = "Every Jan 20", then this would translate into
the Every = ParseToken.JAN and EveryCount = 20.
Gets or sets on clause for this rule.
The valid values for this property are:
WEEKDAY
WEEKEND
MON
TUE
WED
THU
FRI
SAT
SUN
JAN
FEB
MAR
APR
MAY
JUN
JUL
AUG
SEP
OCT
NOV
DEC
Gets or sets an integer value used in conjunction with the On property to determine the On clause of the
definition of this recurrence. So, if Text = "Every month On Wed:2", then this would tranlate into
the On = ParseToken.WED and OnCount = 2.
Gets a string representation of a recurrence definition.
Here are some examples:
1) Every Month On 13
2) Every Month On Wed:2
3) Every Year On Apr 15
4) Every Apr 15
5) Every Year On weekday After Apr 15
6) Every Year On Tue After Apr 15
7) Every Week on Thu
8) Every Week:2 On Wed
9) Every Week On Thu
10) Every Month On 13
Many of the example strings are self explanatory. In the second example, the Wed:2 indicates
the second Wed. In the 8th example, Week:2 indicates every 2 weeks. Examples 3 and 4 define
exactly the same recurrence. Examples 5 and 6 have After clauses in addition to Every and On
clauses.
From the examples, you can see that a Text rule that defines a recurrence can contain an
Every clause, an On clause and an After clause. The only piece that is required is the
Every clause (as seen in example 4). The order and case of these clause does not matter. So,
On 'Apr 15 Every Year' is valid and the same as 'EVERY year ON apr 15'. See the indivdual
ParseToken properties (Every, On and BeforeAfter) for a discussion of the valid forms of these
clauses.
The words used in a Text definition of a recurrence rule can be localized through the
property.
Implements the list choices that can have a valueMember, displayMember and colorMember associated with them.
Initializes a new instance of the class.
The valueMember that is stored in the data objects.
The displayMember that is used for display.
A color that is associated with this valueMember.
An Overridden method to return DisplayMember.
The DisplayMember.
Gets or sets color associated with this object.
Gets or sets string that is used when this object is displayed.
Gets or sets an integer that is stored in the data objects to represent this object.
A strongly typed Array list class that maintain list option values.
Gets ListObject property descriptors collection.
An array of PropertyDescriptor objects to find in the collection as bindable. This can be a null reference.
The property descriptors for each property in ListObject.
Gets the name of the list, i.e. "ListObject".
An array of PropertyDescriptor objects to find in
the collection as bindable. This can be a null reference.
The list name.
Gets or sets the i-th item in the list.
The key to identify the desired item.
Implements the objects that represent appointments in the Schedule Control.
This class implements IScheduleAppointment to provide an object to hold the concrete data associated
with appointments.
You can either derive this class or implement IScheduleAppointment yourself to extend or modify the information
managed by the ScheduleAppointment class.
Holds the default fore color of appointment panel.
Initializes a new instance of the class.
Creates a copy of this item; using MemberwiseClone.
A new instance of this item.
Implemented to check UniqueID property for equality.
The object to compare this instance to.
Zero if the objects have the same UniqueID. Nonzero otherwise.
Determines whether the item has conflict with other item.
A IScheduleAppointment
True, it the item is in conflict; Fasle, otherwise.
Determines whether the item has conflict with other item.
Item start time.
Item end time.
True, if the item is in conflict; False, otherwise.
Gets the maximum date between specified dates.
The date value to compare.
The date value to compare.
The maximum date.
Gets the minimum date between specified dates.
The date value to compare.
The date value to compare.
The minimum date.
An Overridden method that returns a text representation of the appointment.
A string holding the schedule appointment data.
Gets or sets fore color of the appointment panel.
The default value of ForeColor property is Color.Black.
Gets or sets a value indicating whether this appointment is an all-day appointment.
Gets or sets a value indicating whether or not blocked appointment is allowed to click.
Gets or sets a value indicating whether or not an appointment is allowed to be dragged.The total hours doesn't gets changed by dragging an appointment.
Default is true.
Setting this property to true enables moving an appointment by clicking on a appointment and moving it to a new place.
The total duration of an Appointment is not altered by dragging.
Gets or sets a value indicating whether or not an appointment is allowed to resize and modify its duration.
Gets or sets back color of the appointment panel
Gets or sets a value indicating whether the block appointment is blocked.
Gets or sets the custom tooltip text to be displayed for the item.
Gets or sets a text string holding the details or comments for this appointment item.
Gets or sets a value indicating whether this item has been modified.
Gets or sets the end time for this item.
Gets or sets a value indicating whether changes to this item affect the Dirty property.
Gets or sets a integer categorizer value for this item.
Gets or sets a string associated with this item.
Gets or sets a integer categorizer value for this item.
Gets or sets a value indicating whether the block appointment is notify on overide.
Gets or sets a value indicating whether the block appointment is notify on overide.
Gets or sets an integer that can be used to identify the owner (if any) of this item.
Gets or sets priority of the block appointment.
Gets or sets a value indicating whether you want a reminder event raised when the StartTime of this item gets close.
Gets or sets the type of reminder event raised when the StartTime of this item gets close.
Gets or sets the type of reminder event raised when the StartTime of this item gets close.
Gets or sets the start time for this item.
Gets or sets a text string identifying the topic of this item.
Gets or sets an arbitrary object associated with this item.
Gets or sets color of appointment time span element.
Gets or sets the tooltip text to be displayed for the item.
Gets or sets a unique integer associated with this item.
Gets an integer format version number.
If you modify this class in a manner that changes its serialization, you should change
the version number so there is a unique number that can be used to identify the serialization
format.
Maintains collection of IScheduleAppointments that serves as the data for the Schedule Control.
This class is a wrapper class for an ArrayList and implements IComparer which orders the
list by the item's StartTime. If two items start at the same time, then the
EndTime is used as well to determine the order.
Initializes a new instance of the class.
Adds an IScheduleAppointment to this list.
The IScheduleAppointment to be added.
Determines whether the collection contains the specified item.
A IScheduleAppointment to search for in the collection.
true if the collection contains the specified item; otherwise, false.
Finds the item of the key passed in. Not implemented.
The unique search key.
The found item.
Gets the enumerator of the list.
The iterator.
Copies the list to array collection.
The destination array.
The starting index for copying from list.
Adds the value to the list.
The schedule appointment item.
Index of the item.
Clears the collection.
Returns a value indicating whether collection contains the specified item.
Object of the schedule appointment item.
True if collection has item otherwise false.
Returns the Zero-based index of the first occurrence of the specified item.
Object of the schedule appointment item.
Index of the item.
Inserts the value to the list at specified position.
The schedule appointment item.
Index value to insert item.
Removes the value to the list.
The schedule appointment item.
Removes the value to the list at specified position.
Index value of remove item.
Returns the position of the specified item within this list.
The search item.
The index in the list of the search item.
Inserts an IScheduleAppointment into this list.
The position in the list where the item is to be inserted.
The IScheduleAppointment to be inserted.
Determines if any items overlap the schedule area.
Start date
Time interval
True, if items overlap schedule area; False otherwise.
Determine if any items of this collection overlap the schedule area.
The start date
The end date
True, if items overlap schedule area; False otherwise.
Determines whether item has conflict with items of this collection.
A IScheduleAppointment
True, if the item is in conflict; False, otherwise.
Returns a default ScheduleAppointment.
New ScheduleAppointment.
Returns the next available slot after date.
Start date
Time interval
Next available slot.
Returns the next available slot after date.
Start date
Time interval
Time step in minutes
Next available slot.
Returns the next available slot after date.
Start date
Time interval
Time step in minutes
Schedule min date
Schedule max date
Next available slot.
Returns the next available slot after date.
Start date
Time interval
Time step in minutes
Schedule min date
Schedule max date
Schedule day start hour
Schedule day end hour
Next available slot.
Removes an IScheduleAppointment from this list.
The IScheduleAppointment to be removed.
Removes an IScheduleAppointment from this list.
The position of the item to be removed.
Sorts this list on the IScheduleAppointment.StartTime property.
Gets the number of IScheduleAppointments in this list.
Gets the number of appointments.
Gets a value indicating whether collection is synchronized.
Gets an object that can be used to synchronize access to collection.
Gets a value indicating whether collection has fixed size.
Gets a value indicating whether collection is read only.
Gets or sets list can be serialized in derived classes.
Gets the appointment from list.
Index of the appointment item.
The .
Gets or sets the i-th IScheduleAppointment in this list.
The index to identify the desired ScheduleAppointment.
IComparer implementation that uses the StartTime/EndTime in its comparison.
Compares two ScheduleAppointment objects and returns a value indicating whether one is
less than, equal to, or greater than the other.
First item.
Second item
1 if x > y, -1 if x < y and zero otherwise.
Provides an empty implementation of IScheduleDataProvider. The implementation is done
through virtual methods. You can then derive this class and through its overrides, set up an
IScheduleDataProvider. See the ArrayListDataProvider class in the ScheduleSample sample.
Initializes a new instance of the class.
Adds IScheduleAppointment passed in. No implementation.
The IScheduleAppointment to be added.
Commits the changes made in item. No implementation.
Gets the list for the LabelValue options.
LabelValue list.
Gets the list for the LocationValue options.
LocationValue list.
Gets the list for the MarkerValue options.
MarkerValue list.
Gets resources collection.
The resources collection.
Gets the list for the ReminderValue options.
ReminderValue list.
Gets the schedule added in dates passed in. No implementation.
The first date.
The second date.
An IScheduleAppointmentList holding the schedule items between the given dates.
Gets the schedule added in dates passed in for the respective owner. No implementation.
The first date.
The second date.
The owner.
An IScheduleAppointmentList holding the schedule items for a particular owner between the given dates.
Gets the schedule for the day passed in. No implementation.
The DateTime
An IScheduleAppointmentList holding the schedule items for the given date.
Gets the schedule for the day passed in for the respective owner. No implementation.
The given date.
The owner.
An IScheduleAppointmentList holding the schedule items for a particular owner on the given date.
Initiates the default drop lists for entering IScheduleAppointment data.
You can override this method to provide customized droplists.
Returns a default ScheduleAppointment.
New ScheduleAppointment.
Returns a default ScheduleAppointmentList.
New ScheduleAppointmentList.
Returns a default ScheduleResource.
New ScheduleResource.
Returns a default ScheduleAppointmentList.
New ScheduleAppointment.
Removes an item. No implementation.
The IScheduleAppointment to be removed.
Saves the modified item. No implementation.
The modified IScheduleAppointment.
The original IScheduleAppointment.
Gets or sets a value indicating whether data source is modified or not.
Gets or sets the list for the LabelValue options.
Gets or sets the list for the LocationValue options.
Gets or sets the list for the MarkerValue options.
Gets or sets resources collection.
Gets or sets the list for the ReminderValue options.
Gets or sets whether CommitChanges is called when the ScheduleControl is disposed.
Represents a single schedule resource.
Initializes a new instance of the class.
Initializes a new instance of the class using the specified resource UniqueID.
Resource unique id.
Initializes a new instance of the class using the specified resource UniqueID and name.
Resource unique id.
Resource name.
An Overridden method that returns the string representation of ScheduleResource object.
A string holding the ScheudleResource object.
Gets or sets text to be displayed for the resources in Schedule.
Gets or sets a unique integer associated with this resource.
A Collection of IScheduleResources to be displayed in Schedule's resource row.
Collection contains objects displayed in a Schedule as additional columns/rows of a Schedule.
Resource objects allow for displaying schedules for different resources or schedules along each other.
This allows for easy analysis and comparing two or more schedules linked to Resource objects.
If there is no objects in a collection then the Schedule displays one schedule
Initializes a new instance of the class.
Appends the IScheduleResource to the end of the ScheduleResourceCollection.
The IScheduleResource to add to the ScheduleResourceCollection.
The position into which the new element was inserted.
Determines whether the collection contains the specified resource.
A IScheduleResource to search for in the collection.
true if the collection contains the specified item; otherwise, false.
Finds resource by UniqueID.
resource UniqueID
A IScheduleResource
Determines the index value that represents the position of the IScheduleResource in the ScheduleResourceCollection.
The IScheduleResource to locate in the ScheduleResourceCollection.
The index position of the specified IScheduleResource in the collection.
Inserts a IScheduleResource in the ScheduleResourceCollection at the specified index location.
The location in the collection to insert the IScheduleResource.
A IScheduleResource to add to the collection.
Returns a default ScheduleResource.
New ScheduleResource.
Removes the specified IScheduleResource from the ScheduleResourceCollection.
The IScheduleResource to remove from the collection.
Gets or sets the schedule resource.
The zero-based index at which value should be returned.
A IScheduleResource
The Syncfusion.Schedule namespace contains fundamental classes and base classes that define commonly used interfaces and data provider for Essential ScheduleControl.
Derives to implement IScheduleAppointment.
Initializes a new instance of the class.
Initializes a new instance of the class to handle serialization.
The SerialazationInfo.
The StreamingContext.
Gets the serialization object data.
The SerialazationInfo.
The StreamingContext.
Initiates the span date list.
Added to provide dynamic initialization for DateList in span rules.
Gets or sets the list of dates defined for this recurrence definition.
Gets or sets the string that defines this recurrence.
Gets or sets a Unique identifier to this recurrence appointment.
This value is zero for all non-recurring appointments. For a recurring appointment,
this value is the same for all appointments in the same recurrence definition.
Derives to implement IScheduleAppointmentList.
Initializes a new instance of the class.
Initializes a new instance of the class to handle serialization.
The SerializationInfo.
The StreamingContext.
Gets the underlying ArrayList that holds these objects.
The underlying ArrayList.
Overridden to control serialization.
The SerializationInfo.
The StreamingContext.
Gets the serialization object data.
The SerializationInfo.
The StreamingContext.
Overridden to return a .
An ArrayListAppointment.
Derives and implements .
This implementation of IRecurringScheduleDataProvider uses two collection of
objects to hold the items displayed in the schedule. These collections is serialized to disk as a
binary file. The ArrayListDataProvider.MasterList holds the appointment items that appear
in the schedule. The ArrayListDataProvider.RecurList holds any non-terminiating
appoint definitions.
Initializes a new instance of the class.
Adds the appointment form for specified item and date.
The item to add appointment.
The date value of appointment.
Overridden to add the item to the MasterList.
IScheduleAppointment item to be added.
Determines whether seconds rule is recurring appointment.
Seconds rule string.
The interval time of recurrence.
True if it recurrence appointment otherwise false.
Adds recurring appointments.
The recurring appointment definition.
A date limit at which the recurring appointments end.
The date limit may be dateTime.MaxValue which indicates no limit.
Used after the initial load to add additional recurring appointments to the data provider.
The recurring appointment definition.
True if dates were added.
Dynamically provide appointments on demand as new dates are exposed.
Saves this ArrayListDataProvider object as a disk file.
If the ends with ".XML", then
the data object is saved to disk as an XML file. If the
FileName ends with something else, then the object is saved
as a binary file.
Creates the date list from specified item.
The appointment item.
USed to check the item list for debugging purpose.
Title of the debugging.
Appointment list.
Returns a the subset of MasterList between the 2 dates.
Starting date limit for the returned items.
Ending date limit for the returned items.
Returns a the subset of MasterList.
Returns a the subset of MasterList for a given date.
Date for the returned items.
Returns a the subset of MasterList.
Returns a unique integer that serves to identify a recurring family of appointments.
A unique integer.
Provides random data, not really a part of the implementations.
A ArrayListAppointmentList object holding sample data.
Provides random data, not really a part of the implementations.
A ScheduleAppointmentList
A ArrayListAppointmentList object holding sample data.
Loads a binary file whose name is given by
into this class instance.
Creates an instance of and loads
a previously serialized ArrayListDataProvider into the instance.
The serialized filename.
A ArrayListDataProvider.
This method depends upon System.AppDomain.CurrentDomain.AssemblyResolve to
avoid versioning issues with the binary serialization of the MasterList.
Creates an instance of and loads
a previously serialized ArrayListDataProvider into the instance from an XML file.
The serialized filename.
A ArrayListDataProvider.
An Overridden method to return a .
New ArrayListAppointment.
An Overridden method to return a .
New ArrayListAppointmentList.
Strips out any unnecessary recurring appointments (already added appointments up thru time limit)
An Overridden method to remove the item from the MasterList.
IScheduleAppointment item to be removed.
Removes all occurrences the given appointment.
The recurring appointment to be removed.
True, if the appointment is removed; False otherwise.
Resets the base date for schedule appointment item.
The schedule appointment item to reset.
Saves the object to a stream in binary format.
The Stream object.
Saves the current object in binary format to a file with the specified filename.
The file name.
Overridden to make changes to appointments.
The edited appointment.
The original appointment.
Makes changes to appointments in a recurring sequence of appointments.
The edited appointment.
The original appointment.
The requested edit action.
Saves this object in an XML file with the specified filename.
The file name.
Sets the start and end date.
The destination item to set.
The source item.
The modified schedule appointment.
Gets or sets the file name used to store the serialized data.
Gets or sets whether the MasterList has been modified.
Gets or sets an IScheduleAppointmentList collection that holds the IRecurringScheduleAppointments.
Gets or sets the MasterListArrray for XML serialization.
Gets or sets the largest ID value used so far in this ScheduleDataProvider.
Gets a ArrayListAppointmentList collection that holds ScheduleRecurringAppointments.
Gets or sets RecurringListArray which is used internally for XML serialization.
Gets or sets the recurrence support.