Scheduler for ASP.NET AJAX - ComponentOne

89 Pages·2011·1.41 MB·English

ComponentOne
Scheduler for ASP.NET
AJAX
Copyright  2011 ComponentOne LLC. All rights reserved.

Corporate Headquarters
ComponentOne LLC
201 South Highland Avenue
3rd Floor
Pittsburgh, PA 15206 ∙ USA
Internet: [email protected]
Web site: http://www.componentone.com
Sales
E-mail: [email protected]
Telephone: [phone] or 1.412.681.4343 (Pittsburgh, PA USA Office)

Trademarks
The ComponentOne product name is a trademark and ComponentOne is a registered trademark of ComponentOne LLC. All
other trademarks used herein are the properties of their respective owners.

Warranty
ComponentOne warrants that the original CD (or diskettes) are free from defects in material and workmanship, assuming
normal use, for a period of 90 days from the date of purchase. If a defect occurs during this time, you may return the defective
CD (or disk) to ComponentOne, along with a dated proof of purchase, and ComponentOne will replace it at no charge. After
90 days, you can obtain a replacement for a defective CD (or disk) by sending it and a check for $25 (to cover postage and
handling) to ComponentOne.
Except for the express warranty of the original CD (or disks) set forth here, ComponentOne makes no other warranties, express
or implied. Every attempt has been made to ensure that the information contained in this manual is correct as of the time it was
written. We are not responsible for any errors or omissions. ComponentOne’s liability is limited to the amount you paid for the
product. ComponentOne is not liable for any special, consequential, or other damages for any reason.

Copying and Distribution
While you are welcome to make backup copies of the software for your own use and protection, you are not permitted to make
copies for the use of anyone else. We put a lot of time and effort into creating this product, and we appreciate your support in
seeing that it is used by licensed users only.

This manual was produced using ComponentOne Doc-To-Help™.
Table of Contents
ComponentOne Scheduler for ASP.NET AJAX Overview ..............................................................................1
What's New in Scheduler for ASP.NET AJAX ............................................................................................. 1
Revision History............................................................................................................................................. 1
What's New in 2011 v1..................................................................................................................... 1
What's New in 2010 v3..................................................................................................................... 2
What's New in 2010 v2..................................................................................................................... 3
Installing Scheduler for ASP.NET AJAX...................................................................................................... 4
Scheduler for ASP.NET AJAX Setup Files ..................................................................................... 4
System Requirements ....................................................................................................................... 5
Installing Demonstration Versions ................................................................................................... 5
Uninstalling Scheduler for ASP.NET AJAX ................................................................................... 6
Deploying your Application in a Medium Trust Environment ....................................................... 6
End-User License Agreement ........................................................................................................................ 9
Licensing FAQs ............................................................................................................................................. 9
What is Licensing?............................................................................................................................ 9
How does Licensing Work?.............................................................................................................. 9
Common Scenarios ........................................................................................................................ 10
Troubleshooting.............................................................................................................................. 12
Technical Support ........................................................................................................................................ 14
Redistributable Files ..................................................................................................................................... 14
About this Documentation........................................................................................................................... 15
Namespaces.................................................................................................................................................. 15
Creating an AJAX-Enabled ASP.NET Project............................................................................................ 16
Adding the C1Schedule Component to a Project ........................................................................................ 18
Scheduler for ASP.NET AJAX Key Features ............................................................................................... 21
Scheduler for ASP.NET AJAX Quick Start .................................................................................................. 23
Step 1 of 3: Adding C1Schedule to the Project ............................................................................................ 23
Step 2 of 3: Customizing the Schedule ......................................................................................................... 24
Step 3 of 3: Adding an Appointment at Run Time ...................................................................................... 25
Design-Time Support in Scheduler for ASP.NET AJAX ............................................................................... 29
iii
C1Schedule Smart Tag ................................................................................................................................. 29
C1Schedule Context Menu .......................................................................................................................... 31
C1Schedule Properties Window .................................................................................................................. 32
Scheduler for ASP.NET AJAX Top Tips ..................................................................................................... 33
Working with Scheduler for ASP.NET AJAX .............................................................................................. 34
Data and Databinding .................................................................................................................................. 34
Data Mappings ............................................................................................................................... 35
Binding C1Schedule to a Data Source ........................................................................................... 37
Using the Built-in Data Storage ...................................................................................................... 38
Appointments ............................................................................................................................................... 39
Recurrence ...................................................................................................................................... 40
Labels.............................................................................................................................................. 43
Availability Status .......................................................................................................................... 44
Reminders ....................................................................................................................................... 45
Contacts .......................................................................................................................................... 46
Categories ....................................................................................................................................... 50
Resources ........................................................................................................................................ 55
Data Views ................................................................................................................................................... 60
Changing the Data View ................................................................................................................ 64
Visual Styles ................................................................................................................................................. 65
Changing the Visual Style .............................................................................................................. 67
Customizing the Control's Appearance .......................................................................................... 68
Client-Side Functionality in Scheduler for ASP.NET AJAX .......................................................................... 68
Client-Side Properties ................................................................................................................................... 69
Client-Side Events ........................................................................................................................................ 69
Scheduler for ASP.NET AJAX Samples ...................................................................................................... 71
Scheduler for ASP.NET AJAX Task-Based Help .......................................................................................... 71
Customizing C1Schedule's Appearance ....................................................................................................... 71
Changing the Start Date of the Schedule in DayView ................................................................... 71
Changing the Culture of a Schedule ............................................................................................... 72
Hiding the Navigation Bar ............................................................................................................. 73
Hiding the Status Bar...................................................................................................................... 74
Hiding the View Selection Bar ....................................................................................................... 74
Working with Appointments at Run Time .................................................................................................. 75
Adding an Appointment ................................................................................................................. 75
iv
Deleting an Appointment ............................................................................................................... 75
Creating a Recurring Appointment ................................................................................................ 76
Printing an Appointment ................................................................................................................ 76
Changing the Time within the Appointment Dialog Box .............................................................. 76
Adding Keyboard Support ........................................................................................................................... 77
Disabling the Reminder Form ..................................................................................................................... 77
Importing and Exporting Schedule Data ..................................................................................................... 78
Using C1Schedule with C1Calendar............................................................................................................ 80
Client-Side Tasks .......................................................................................................................................... 81
Getting and Setting the Display Date in Day View ....................................................................... 81
Adding Previous and Next Navigation .......................................................................................... 82

v

ComponentOne Scheduler for
ASP.NET AJAX Overview
ComponentOne Scheduler for ASP.NET provides full Getting Started
scheduling functionality with the familiar look of Microsoft
OutlookTM. Display shared or private appointment calendars in Get started with the
following topics:
day, week, work week, or monthly views, complete with
appointment pop-up reminders, labels, and availability status. - Key Features (page
C1Schedule also manages contacts, categories, and resources to 21)
help you stay organized. With C1Schedule's built-in data layer,
- Quick Start (page 23)
easily save and load data, either from a bound or built-in data
source. - Samples (page 71)
Offering ASP.NET AJAX (1.0 and later) compatibility and a
rich client-side object model, C1Schedule allows you to deliver
a responsive UI, optimizing performance in your Web
applications for a smooth user experience.
What's New in Scheduler for ASP.NET AJAX
The following new features were added to ComponentOne Scheduler for ASP.NET AJAX in the 2011 v2 release:
 Time Ruler Format
Specify the format of the time ruler for the Day or HorizontalWeek view with the new TimeRulerFormat
property.
 Time Interval
Specify the time interval for displaying the time slots in the DayView mode with the new TimeInterval
property. Built-in intervals range from five minutes to one hour.
 Highlighted Date
Now when you set an appointment in a C1Schedule control the date in a linked C1Calendar control will
be highlighted.
Tip: A version history containing a list of new features, improvements, fixes, and changes for each product
is available on HelpCentral at http://helpcentral.componentone.com/VersionHistory.aspx.
Revision History
The revision history details recent enhancements to Scheduler for ASP.NET AJAX.
What's New in 2011 v1
No new features were added or enhancements made to ComponentOne Scheduler for ASP.NET AJAX in the
2011 v1 release.
1
What's New in 2010 v3
New features and class members were added to ComponentOne Scheduler for ASP.NET AJAX in the 2010 v3
release.
 Spanish Translation
The distribution now includes Spanish translation.
 Extended EventArgs
The CancelableAppointmentEventArgs was extended to include appointment data that was populated in
the browser. This property returns null in the BeforeAppointmentDelete event.
 New Members
Several new members were added to the CancelableAppointmentEventArgs and ClientAppointmentData
classes.
New Members
The following new properties were added to ComponentOne Scheduler for ASP.NET AJAX in the 2010 v3
release:

Class Property Description
CancelableAppointmentEventAr Appointment The Appointment object to be updated.
gs
CancelEvent Set this property to True if you want to cancel the
action that called this event.
ClientData The appointment information that was received
from client. Note, this property returns null for the
BeforeAppointmentDelete event.
ClientAppointmentData AllDayEvent Is an all-day event appointment. Used by
SaveAppointmentCommand.
Body Gets the String value representing the body of the
Appointment object.
BusyStatus Gets or sets the Status object indicating the busy
status of the user for the appointment.
Categories Gets the Category List which holds the set of
categories assigned to the appointment. Categories
may be associated with an appointment to
effectively group appointments. An appointment
may be associated with multiple categories.
Duration Duration in minutes. Used by
UpdateAppointmentLocationCommand /
SaveAppointmentCommand.
HasAllDayEvent The AllDayEvent value specified by client.
HasBody The Body value specified.
HasBusyStatus The BusyStatus value specified by client.
HasCategories The Categories value specified by client.
HasDuration The Duration value specified.
2
HasLabel The Label value specified by client.
HasLinks The Links value specified by client.
HasLocation The Location value specified.
HasPrivate The Private value specified.
HasSnoozeTime The SnoozeTime value specified.
HasSubject The Subject value specified.
HasRecurrenceSta The RecurrenceState value specified.
te
HasReminderTime The ReminderTimeBeforeStart value specified.
BeforeStart
HasReminderSet The ReminderSet value specified.
HasResources The Resources value specified by client.
HasStartDate The StartDate value specified.
Label Gets the Label object associated with the
appointment.
Links Gets the Contact List which holds the set of
Contact objects for this appointment. An
appointment may be associated with multiple
contacts.
Location Gets the Location value of the appointment.
Private Gets the Boolean value determining whether the
calendar owner intends to keep the Appointment
object private.
RecurrenceState Gets the RecurrenceStateEnum value indicating
the recurrence state of the appointment.
ReminderSet Gets the Boolean value indicating whether a
reminder is associated with the appointment.
Resources Gets the Resource List which holds the set of
Resource objects for this appointment. An
appointment may be associated with multiple
resources.
ReminderTimeBef Gets the TimeSpan value indicating the interval of
oreStart time the reminder should occur prior to the start of
the appointment.
StartDate Gets the DateTime value determining the start
date and time of the appointment.
Subject Gets the Subject value of the appointment.
What's New in 2010 v2
New features and class members supporting dialog box customization were added to ComponentOne Scheduler
for ASP.NET AJAX in the 2010 v2 release.
3
 New Members
The C1ScheduleDialogEventArgs class was extended with the Appointment, DialogType, and Window
properties. The DialogType enumeration was added to indicate the dialog box type.
 New Sample
The C1Schedule OnClientBeforeDialogOpen sample was added to the Scheduler for ASP.NET AJAX
installation in the 2010 v2 release. This sample demonstrates how to replace the built-in EditAppointment
dialog box with a custom dialog box using the OnClientBeforeDialogOpen event.
New Members
The following new class was added to ComponentOne Scheduler for ASP.NET AJAX in the 2010 v2 release:

Class Description
DialogType Represents the dialog box type. Options include: AddNewAppointment =
1, EditAppointment = 2, Contacts = 3, Categories = 4, EditResources =
5, EditCategories = 6, EditContacts = 7, Reminder = 8, Resources = 9,
Recurrence = 10.

The following new properties were added to ComponentOne Scheduler for ASP.NET AJAX in the 2010 v2
release:

Class Property Description
C1ScheduleDialogEventArgs Appointment Gets the appointment object, instance of the
C1Appointment client class.
DialogType Gets the type of the dialog box.
Window Gets the dialog window.
Installing Scheduler for ASP.NET AJAX
The following sections provide helpful information on installing ComponentOne Scheduler for ASP.NET AJAX.
Scheduler for ASP.NET AJAX Setup Files
The ComponentOne Studio for ASP.NET AJAX installation program will create the following directory:
C:\Program Files\ComponentOne\Studio for ASP.NET. This directory contains the following subdirectories:
Bin Contains copies of all binaries (DLLs, Exes) in the
ComponentOne Visual Studio ASP.NET package.
C1WebUi Contains files (at least a readme.txt) related to the product.
C1WebUi\VisualStyles Contains all external file themes.
The ComponentOne Studio for ASP.NET AJAX Help Setup program installs integrated Microsoft Help 2.0 and
Microsoft Help Viewer help to the C:\Program Files\ComponentOne\Studio for ASP.NET directory in the
following folders:

H2Help Contains Microsoft Help 2.0 integrated documentation for all Studio
components.
4