Version

WebScheduleInfo Object

WebScheduleInfo

The WebScheduleInfo object provides access to the control-level features of the WebScheduleInfo control.

WebScheduleInfo Methods

addActivity

Adds an Activity.

Parameters

activity

The activity to be added. id

A string value that can be accessed in the Adding events on both the client and server.

Remarks

If called by a control, the control’s ClientId is used for the id.

deleteActivity

Deletes an Activity.

Parameters

activity

The activity to be deleted. id

A string value that can be accessed in the Deleting events on both the client and server.

Remarks

If called by a control, the control’s ClientId is used for the id.

fetchReminders

Performs a SmartCallback that goes to the server and checks to see if any reminders have come due.

getActiveDay

Returns a Date object that represents the ActiveDay.

getActiveDayClientSynchronization

Returns 0 if ActiveDayClientSynchronization is set to Always and 1 if its sent to Never.

getActiveResourceDataKey

Returns the ActiveResources Datakey.

getActiveResourceName

Returns the ActiveResource name.

getActivities

Returns an ig_ActivityCollection of all the Activites passed down to the client.

getAllowAllDayEvents

Returns "true" if All Day Events are allowed.

getAppointmentDialogID

Returns the ClientID of the Appointment Dialog.

getClientID

Returns the ClientID of the WebScheduleInfo.

getDefaultActivityDuration

Returns the default duration of an Activity in Minutes. The default value is 30\.

getDefaultReminderInterval

Returns the default interval for reminders in Ticks.

getDefaultSnoozeInterval

Returns the default interval for snoozing in Ticks.

getEnableProgressIndicator

Returns a boolean value that determines if a Progress Indicator will be displayed during a SmartCallback.

getEnableSmartCallbacks

Returns a boolean value that determines if SmartCallbacks are turned on.

getImageDirectory

Returns a string value of the image directory specified for WebScheduleInfo.

getProgressIndicator

Returns the Progress Indicator object that will be displayed during a SmartCallback.

getReminderDialogID

Returns the ClientID for the ReminderDialog.

getReminders

Returns an ig_ReminderCollection of all the Reminders passed passed down to the client.

getTimeDisplayFormat

Returns 0 if TimeDisplayFormat is set to 12Hours and 1 if its set to 24Hours.

getUniqueID

Returns the UniqueID of WebScheduleInfo.

getWorkDayEndTime

Returns a Date object for the WorkDayEndTime, or null if its not set.

getWorkDayStartTime

Returns a Date object for the WorkDayStartTime, or null if its not set.

navigate

Navigates the activeday the specified amount of time.

Parameters

years

The amount of years to navigate. months

The amount of months to navigate. days

The amount of days to navigate. id

A string value that can be accessed in the ActiveDayChanging/Navigation events on both the client and server.

Remarks

If called by a control, the control’s ClientId is used for the id.

setActiveDay

Sets the ActiveDay to the specified date.

Parameters

dateTime

The new date to set the ActiveDay. This parameter must be a date object. post

True if a postback should occur. id

A string value that can be accessed in the ActiveDayChanging events on both the client and server.

Remarks

If called by a control, the control’s ClientId is used for the id.

setDefaultActivityDuration

Sets the default duartion for an Activity.

Parameters

duration

The number of minutes the default duration for an activity should be.

Remarks

This method is client side only and must be reset for each post.

setFetchReminderInterval

Sets the interval on how often WebScheduleInfo should check for reminders when SmartCallbacks are turned on.

Parameters

interval

The interval to be set in miliseconds.

Remarks

The default value is 2 minutes. Automatic fetch reminders can be turned off by setting the interval to any number less than or equal to zero.

showAddAppointmentDialog

Opens the Appointment Dialog.

Parameters

appointment

The appointment to display in the Dialog. id

A string value that can be accessed in the Dialog events on the client.

Remarks

If called by a control, the control’s ClientId is used for the id.

showReminders

Opens the ReminderDialog.

showUpdateAppointmentDialog

Opens the Appointment Dialog.

Parameters

dataKey

The DataKey of the appointment to display in the appointment dialog. id

A string value that can be accessed in the Dialog events on the client.

Returns

False if no appointment is found with the passed datakey on the client.

Remarks

If called by a control, the control’s ClientId is used for the id.

updateActivity

Updates an Activity.

Parameters

activityUpdateProps

A dynamic object that contains the properties and their values that are to be updated. activity

The activity to be updated. id

A string value that can be accessed in the Updating events on both the client and server.

Remarks

Note: this is not an activity object. The activity object should not be modified. Any properties that should be updated should be placed in the activityUpdateProps object. If called by a control, the control’s ClientId is used for the id.