ig.scheduler.Appointment

Encapsulates the properties of an appointment.

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.ext_web.js
infragistics.dv_core.js
infragistics.dv_jquerydom.js
infragistics.dv_interactivity.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.
  • ig.scheduler.Appointment
    Constructor

    new $.ig.scheduler.Appointment( );

    Creates a new instance with default values.

  • dataObject
    Inherited

    .dataObject( );

    Returns the data object from which this activity or resource was created, or null if it has no associated data object.

  • description
    Inherited

    .description( );

    Gets the description of the activity.

  • description
    Inherited

    .description( value:string );

    Sets the description of the activity.

    • value
    • Type:string
  • destroy

    .destroy( );

    Releases any memory previously used by this object.

  • end
    Inherited

    .end( );

    Gets the date and time before which the activity ends.

    Remarks

    The value of the End property is considered to be exclusive for the purposes of activity queries.

    For example, consider an activity whose ActivityBase.start property is set to 9AM, and whose End is set to 10AM. An activity query with a range that begins at 10AM will not include this activity, because the activity's end is compared using a "less than but not equal to" condition.

  • end
    Inherited

    .end( value:ig.Date );

    Sets the date and time before which the activity ends.

    • value
    • Type:ig.Date

    Remarks

    The value of the End property is considered to be exclusive for the purposes of activity queries.

    For example, consider an activity whose ActivityBase.start property is set to 9AM, and whose End is set to 10AM. An activity query with a range that begins at 10AM will not include this activity, because the activity's end is compared using a "less than but not equal to" condition.

  • id
    Inherited

    .id( );

    Gets the unique identifier for this activity.

    Remarks

    When activities are deserialized from an external items source such as the ScheduleListDataSource.appointmentItemsSource, the value of some other instance's ActivityBase.recurrenceId property is checked against the value of this property to determine whether that instance is a member of this activity's recurrence.

    When no value is explicitly assigned, a GUID is generated and the string representation thereof is used as the activity's identifier.

  • id
    Inherited

    .id( value:string );

    Sets the unique identifier for this activity.

    • value
    • Type:string

    Remarks

    When activities are deserialized from an external items source such as the ScheduleListDataSource.appointmentItemsSource, the value of some other instance's ActivityBase.recurrenceId property is checked against the value of this property to determine whether that instance is a member of this activity's recurrence.

    When no value is explicitly assigned, a GUID is generated and the string representation thereof is used as the activity's identifier.

  • isAllDay
    Inherited

    .isAllDay( );

    Returns a boolean value indicating whether this ActivityBase effectively spans the entire day.

    Remarks

    When this property is set to true, the time component of the ActivityBase.start and ActivityBase.end properties are not used when the activity times are evaluated during range queries.

    The effective start time for the activity is adjusted to midnight of the day which contains the actual value of the ActivityBase.start property.

    The effective end time for the activity is adjusted to midnight of the day following the date containing the actual value of the ActivityBase.end property.

  • isAllDay
    Inherited

    .isAllDay( value:boolean );

    Returns a boolean value indicating whether this ActivityBase effectively spans the entire day.

    • value
    • Type:boolean

    Remarks

    When this property is set to true, the time component of the ActivityBase.start and ActivityBase.end properties are not used when the activity times are evaluated during range queries.

    The effective start time for the activity is adjusted to midnight of the day which contains the actual value of the ActivityBase.start property.

    The effective end time for the activity is adjusted to midnight of the day following the date containing the actual value of the ActivityBase.end property.

  • isRecurrenceRoot
    Inherited

    .isRecurrenceRoot( );

    Returns a boolean value indicating whether this activity defines a recurrence pattern.

  • isRemoved
    Inherited

    .isRemoved( );

    Returns a boolean value indicating whether this ActivityBase has been effectively removed. Applicable only for recurring activities.

    Remarks

    When this property is set to true, this activity does not appear in activity queries or in the user interface.

    The IsRemoved property is used to indicate that a specific occurrence of a recurrence has been removed. The associated activity essentially becomes a placeholder, signifying that a "gap" exists in the recurrence pattern, resulting in no activity appearing for that slot.

  • isSameAs

    .isSameAs( appointment:ig.scheduler.Appointment );
    Return Type:
    boolean
    Return Type Description:
    True if the appointments are the same.

    Returns a boolean value indicating whether the specified appointment is the same as this one.

    • appointment
    • Type:ig.scheduler.Appointment
    • The appointment to be compared to this one.
  • location

    .location( );

    Gets the location of the appointment.

  • location

    .location( value:string );

    Sets the location of the appointment.

    • value
    • Type:string
  • onPropertyChanged

    .onPropertyChanged( propertyName:string );

    Raises the PropertyChanged event.

    • propertyName
    • Type:string
  • originalStart
    Inherited

    .originalStart( );

    Returns the date and time which marks this activity's placement in a recurrence.

  • recurrence
    Inherited

    .recurrence( );

    Returns a string which describes the recurrence pattern for this activity, or null if this activity is not a root activity.

    Remarks

    Assigning a value to this property causes the activity to assume the role of a template, i.e., it is used to define the properties of individual occurrences. This activity instance no longer appears in activity queries such as ScheduleDataSource.getAppointmentsInRange, but rather the occurrences it generates are displayed instead.

    To make an activity a recurrence root, create an instance of the DateRecurrence class, set property values to customize the recurrence pattern, and call the DateRecurrence.toICalendarString method to serialize the recurrence information to a string. The resulting string can then be directly assigned to this property.

  • recurrence
    Inherited

    .recurrence( value:string );

    Sets a string which describes the recurrence pattern for this activity, or null if this activity is not a root activity.

    • value
    • Type:string

    Remarks

    Assigning a value to this property causes the activity to assume the role of a template, i.e., it is used to define the properties of individual occurrences. This activity instance no longer appears in activity queries such as ScheduleDataSource.getAppointmentsInRange, but rather the occurrences it generates are displayed instead.

    To make an activity a recurrence root, create an instance of the DateRecurrence class, set property values to customize the recurrence pattern, and call the DateRecurrence.toICalendarString method to serialize the recurrence information to a string. The resulting string can then be directly assigned to this property.

  • recurrenceId
    Inherited

    .recurrenceId( );

    Returns the identifier for the associated ActivityBase.recurrenceRoot, or null if this activity is not associated with a DateRecurrence.

    Remarks

    The RecurrenceId property is used during the deserialization process to identify an activity as a member of a recurrence.

    When activities are deserialized from an external items source such as the ScheduleListDataSource.appointmentItemsSource, the value of this property is used to match modified occurrences of a recurrence with their respective root activity.

    This match is made by comparing the value of this property to the value of the ActivityBase.id property of another activity. If the values are equal, this activity is assumed to be a member of the other activity's recurrence.

  • recurrenceRoot
    Inherited

    .recurrenceRoot( );
    Return Type:
    ig.scheduler.ActivityBase
    Return Type Description:
    Returns a ActivityBase.

    Returns the ActivityBase which defines the recurrence pattern from which this activity was created, or null if this activity is not associated with a recurrence.

    Remarks

    An activity whose ActivityBase.recurrence property is set is considered to be a root activity; these activities do not appear in activity queries, but rather serve as a template from which individual occurrences are generated.

  • resource
    Inherited

    .resource( );
    Return Type:
    ig.scheduler.ScheduleResource
    Return Type Description:
    Returns a ScheduleResource.

    Returns the resource associated with this activity.

    Remarks

    To assign a resource to an activity, use the ActivityBase.resourceId property.

  • resourceId
    Inherited

    .resourceId( );

    Returns the identifier for the associated resource, or null if this activity is not associated with any particular resource.

    Remarks

    The value assigned to the property is not validated, i.e., no exception is thrown if the value does not match the id of any currently defined resource.

    When a resource with the specified Id becomes available through the data source, a reference to that resource is returned via the ActivityBase.resource property.

    Note that a ScheduleResource is only available to an activity if it is associated with the same ScheduleDataSource.

    For a ScheduleListDataSource, for example, resources are associated with the data source via the ScheduleListDataSource.resourceItemsSource property. Assign an IEnumerable implementation which contains either ScheduleResource instances, or custom data objects which represent resources to the ResourceItemsSource property, and the resource whose ScheduleResource.id property matches the value of this activity's ResourceId property will then own this activity.

  • resourceId
    Inherited

    .resourceId( value:string );

    Sets the identifier for the associated resource, or null if this activity is not associated with any particular resource.

    • value
    • Type:string

    Remarks

    The value assigned to the property is not validated, i.e., no exception is thrown if the value does not match the id of any currently defined resource.

    When a resource with the specified Id becomes available through the data source, a reference to that resource is returned via the ActivityBase.resource property.

    Note that a ScheduleResource is only available to an activity if it is associated with the same ScheduleDataSource.

    For a ScheduleListDataSource, for example, resources are associated with the data source via the ScheduleListDataSource.resourceItemsSource property. Assign an IEnumerable implementation which contains either ScheduleResource instances, or custom data objects which represent resources to the ResourceItemsSource property, and the resource whose ScheduleResource.id property matches the value of this activity's ResourceId property will then own this activity.

  • start
    Inherited

    .start( );

    Gets the date and time at which the activity begins.

  • start
    Inherited

    .start( value:ig.Date );

    Sets the date and time at which the activity begins.

    • value
    • Type:ig.Date
  • subject
    Inherited

    .subject( );

    Gets the subject of the activity.

  • subject
    Inherited

    .subject( value:string );

    Sets the subject of the activity.

    • value
    • Type:string
  • toString

    .toString( );
    Return Type:
    string
    Return Type Description:
    A string representation of the object.

    Returns a string representation of the object.

Copyright © 1996 - 2019 Infragistics, Inc. All rights reserved.