ig.scheduler.AppointmentPropertyMapping

Encapsulates a property mapping for an ScheduleListDataSource.appointmentPropertyMappings.

Remarks

The ScheduleListDataSource class provides the ability to specify an item source from which data objects which represent appointments can be obtained.

In cases where the name or data type of the data object property does not match the name or data type of the corresponding appointment property, a mapping can be used to resolve the name and/or type.

In cases where the name or data type of the data object property does not match the name or data type of the corresponding appointment property, a mapping can be used to resolve the name and/or type.

For example, assume there exists a data object property named 'StartDate', which is the property from which the appointment's Start property value is obtained.

To create a mapping between these two properties, a new AppointmentPropertyMapping object is created with a Property value of Start, and a DataObjectPropertyName of 'StartDate', i.e., the actual name of the data object property.

This AppointmentPropertyMapping object is then added to the ScheduleListDataSource's AppointmentPropertyMappings collection; this signifies to the data source that the value the Appointment's Start property is to be obtained/assigned from/to a property named 'StartDate' on the data object.

A property mapping can also be used to perform bi-directional conversions between an appointment property and the corresponding data object property using the ConvertCallback AND ConvertBackCallback properties. These properties accept a delegate which is invoked whenever data is transferred between the appointment and it's underlying data object, providing the ability to change the value.

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.AppointmentPropertyMapping
    Constructor

    new $.ig.scheduler.AppointmentPropertyMapping( );

    Creates a new instance.

  • convertBackCallback
    Inherited

    .convertBackCallback( );

    Reference to a delegate which is invoked before the value of a schedule object property is assigned 'back' to the underlying data object's corresponding property, providing an opportunity to convert the value to the type expected by that property.

    Remarks

    To bypass conversion, return the same value that was passed into this method. If null is returned, a value of null will be assigned to the underlying data object property, which will cause an exception to be thrown if null is not a valid value for that property.

  • convertBackCallback
    Inherited

    .convertBackCallback( value:function );

    Reference to a delegate which is invoked before the value of a schedule object property is assigned 'back' to the underlying data object's corresponding property, providing an opportunity to convert the value to the type expected by that property.

    • value
    • Type:function

    Remarks

    To bypass conversion, return the same value that was passed into this method. If null is returned, a value of null will be assigned to the underlying data object property, which will cause an exception to be thrown if null is not a valid value for that property.

  • convertCallback
    Inherited

    .convertCallback( );

    Reference to a delegate which is invoked before a value is assigned to a schedule object property, providing an opportunity to convert the value.

    Remarks

    To bypass conversion, return the same value that was passed into this method. If null is returned, a value of null will be assigned to the schedule object property, which will cause an exception to be thrown if null is not a valid value for that property.

  • convertCallback
    Inherited

    .convertCallback( value:function );

    Reference to a delegate which is invoked before a value is assigned to a schedule object property, providing an opportunity to convert the value.

    • value
    • Type:function

    Remarks

    To bypass conversion, return the same value that was passed into this method. If null is returned, a value of null will be assigned to the schedule object property, which will cause an exception to be thrown if null is not a valid value for that property.

  • dataObjectPropertyName
    Inherited

    .dataObjectPropertyName( );

    Gets the name of the property of the underlying data object with which this instance is associated.

  • dataObjectPropertyName
    Inherited

    .dataObjectPropertyName( value:string );

    Sets the name of the property of the underlying data object with which this instance is associated.

    • value
    • Type:string
  • onPropertyChanged
    Inherited

    .onPropertyChanged( propertyName:string );

    Raises the PropertyChanged event.

    • propertyName
    • Type:string
  • property

    .property( );
    Return Type:
    ig.scheduler.AppointmentProperty
    Return Type Description:
    Returns a AppointmentProperty.

    Identifies the property on the Appointment object.

  • property

    .property( value:ig.scheduler.AppointmentProperty );
    Return Type:
    ig.scheduler.AppointmentProperty
    Return Type Description:
    Returns a AppointmentProperty.

    Identifies the property on the Appointment object.

    • value
    • Type:ig.scheduler.AppointmentProperty
  • toString
    Inherited

    .toString( );

    Returns the string representation of this object.

  • verifyProperty

    .verifyProperty( propertyValue:number );

    Throws an exception if a mapping is created for the RecurrenceRoot or Resource properties.

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