A newer version of this page is available. Switch to the current version.

SchedulerListEditor Members

Represents the Scheduling List Editor used in the XAF Windows Forms applications.

Constructors

Name Description
SchedulerListEditor(IModelListView) Creates and initializes an instance of the SchedulerListEditor class.

Fields

Name Description
DailyPrintStyleCalendarHeaderVisible static Specifies whether or not the calendar header must be visible when printing the SchedulerListEditor.SchedulerControl in a Day view, via the Printing System.
SchedulerViewTypeAttribute static Holds the SchedulerViewType property’s name of the Application Model‘s Views | <ListView> node. Inherited from SchedulerListEditorBase.

Properties

Name Description
AllowEdit Indicates whether the data bound to the current List Editor can be edited via the List Editor’s control. Inherited from ListEditor.
Appointments
AppointmentsCustomFieldMappings Provides access to the collection of objects specifying mappings of the appointments’ custom properties to appropriate data fields.
AppointmentsMappings Provides access to an object that allows the persistent properties of the appointments maintained by the current storage to be bound to appropriate fields in the data source.
BorderStyle Gets or sets the border style for the target Scheduler.
ContextMenuTemplate Returns a null reference.
Control Provides access to the control that is used by the current List Editor to represent a List View in a UI. Inherited from ListEditor.
DataSource Specifies a List Editor‘s data source. Inherited from ListEditor.
DateNavigator Provides access to the SchedulerListEditor‘s Date Navigator.
ErrorMessages Provides access to the current ListEditor‘s error message collection, populated when Validation Rules are broken. Inherited from ListEditor.
EventAssigner Intended for internal use. Inherited from SchedulerListEditorBase.
FocusedObject Gets or sets the focused object in the SchedulerListEditorBase. Inherited from SchedulerListEditorBase.
IsChangedOccurrenceFocused Indicates whether a recurring Event’s occurrence, which was changed and now does not satisfy the recurrency pattern, is focused in the Scheduler. Inherited from SchedulerListEditorBase.
IsDisposed Indicates whether a List Editor has been disposed of. Inherited from ListEditor.
IsOccurrenceFocused Indicates whether a non-recurring Event is focused in the Scheduler. Inherited from SchedulerListEditorBase.
IsPatternFocused Indicates whether an Event which serves as the pattern for other recurring Events is focused in the Scheduler. Inherited from SchedulerListEditorBase.
IsSchedulerControlLoaded Indicates whether the Scheduler control has been loaded. Inherited from SchedulerListEditorBase.
List This property is intended for internal use. Inherited from ListEditor.
Model Provides access to the Application Model node that defines the List View represented by the current List Editors. Inherited from ListEditor.
Name Specifies a List Editor‘s name. Inherited from ListEditor.
OptionsCustomization Provides access to the scheduler’s customization options.
Printable Specifies the control to be exported via the ExportController.ExportAction.
ProtectedContentText Specifies the text that is used by a List Editor to display a property which is prohibited for viewing by the current user. Inherited from ListEditor.
RequiredProperties Returns an array of descriptors for the properties considered bindable by the SchedulerListEditorBase‘s Collection Source. Inherited from SchedulerListEditorBase.
Resources
ResourcesDataSource Provides access to the object that stores resources.
ResourcesMappings Provides access to an object that allows the persistent properties of the resources maintained by the current storage to be bound to appropriate fields in the data source.
SchedulerControl Provides access to the SchedulerListEditor‘s control.
SchedulerDeleteHelper Intended for internal use. Inherited from SchedulerListEditorBase.
SelectedAppointments Provides access to the collection of selected appointments.
SelectedInterval Specifies the time interval currently selected in the scheduler’s active view by an end-user.
SelectedResource
SelectionType Returns the selection type supported by the SchedulerListEditorBase. Inherited from SchedulerListEditorBase.
SourceObjectHelper Intended for internal use. Inherited from SchedulerListEditorBase.
Start Specifies the start date of the scheduler.
StorageBase
SupportedExportFormats Provides access to the list of export formats supported by the current Scheduler List Editor.

Methods

Name Description
ApplyModel() Updates the current List Editor’s state in accordance with the information stored in the Application Model.
AssignCustomProperties(Appointment) Inherited from SchedulerListEditorBase.
BeginUpdate() Prevents the SchedulerListEditor‘s control from being updated until the SchedulerListEditor.EndUpdate method is called.
BreakLinksToControls() Removes references to the SchedulerListEditor‘s control and its event handlers.
CreateControls() Creates the current List Editor‘s control that represents a List View in a UI. Inherited from ListEditor.
Dispose() Releases all resources used by the SchedulerListEditor.
EndUpdate() Unlocks the SchedulerListEditor‘s control after a call to the SchedulerListEditor.BeginUpdate method and causes an immediate update.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
GetAppointment(IEvent) Inherited from SchedulerListEditorBase.
GetAppointment(IEvent, IObjectSpace) Inherited from SchedulerListEditorBase.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetIndexByObject(Object) Returns the index of an object that represents the Scheduler‘s Event. Inherited from SchedulerListEditorBase.
GetObjectByIndex(Int32) Returns an object that represents the Scheduler‘s Event with the specified index. Inherited from SchedulerListEditorBase.
GetOrderedObjects() Returns an ordered list of objects that represent the Scheduler‘s Events. Inherited from SchedulerListEditorBase.
GetResourceType() Returns the type of the Resource objects used by the Scheduler. Inherited from SchedulerListEditorBase.
GetSelectedObjects() Returns a collection of objects that are currently selected in the SchedulerListEditorBase‘s control. Inherited from SchedulerListEditorBase.
GetType() Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
OnExporting() Performs the required pre-export actions under the SchedulerListEditor.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Refresh() Updates the SchedulerListEditor.SchedulerControl to reflect any changes made in the data sources which store the Events and Event resources.
SaveModel() Writes information on a List Editor‘s control to the Application Model.
Setup(CollectionSourceBase, XafApplication) Performs additional initialization of the SchedulerListEditorBase. Inherited from SchedulerListEditorBase.
StartIncrementalSearch(String) Starts an incremental search for the specified string. Inherited from ListEditor.
SupportsDataAccessMode(CollectionSourceDataAccessMode) Determines whether or not the given data access mode is supported by the ListEditor. Inherited from ListEditor.
ToString() Returns a string that represents the current object. Inherited from Object.

Events

Name Description
AllowEditChanged Occurs after the ListEditor‘s ListEditor.AllowEdit property has changed. Inherited from ListEditor.
ControlsCreated Occurs after a ListEditor‘s control is created. Inherited from ListEditor.
CreateCustomModelSynchronizer Obsolete. Occurs when the Application Model‘s node specified by the ListEditor.Model property has been changed. Inherited from ListEditor.
CreateDeleteHelper Intended for internal use. Inherited from SchedulerListEditorBase.
DataSourceChanged Occurs after the ListEditor.DataSource property’s value has been changed. Inherited from ListEditor.
ExceptionEventCreated Occurs when an exceptional Event occurrence is created. Inherited from SchedulerListEditorBase.
FilterDataSource Intended for internal use. Inherited from SchedulerListEditorBase.
FocusedObjectChanged Occurs after the focused object has been changed in a List Editor‘s control. Inherited from ListEditor.
FocusedObjectChanging Occurs before the focused object is changed in a List Editor‘s control. Inherited from ListEditor.
ModelApplied Occurs after the customizations from the Application Model have been applied to the List Editor’s control. Inherited from ListEditor.
ModelApplying Occurs when customizations from the Application Model are applied to the List Editor’s control. Inherited from ListEditor.
ModelSaved Occurs after the List Editor’s control customizations have been saved to the Application Model. Inherited from ListEditor.
ModelSaving Occurs when the List Editor’s control customizations are saved to the Application Model. Inherited from ListEditor.
NewAction Intended for internal use. Inherited from SchedulerListEditorBase.
NewObjectAdding Occurs before a new object is created in a List Editor. Inherited from ListEditor.
NewObjectCanceled Occurs after creation of a new object is cancelled in a List Editor. Inherited from ListEditor.
NewObjectCreated Occurs after a new object has been created in a List Editor. Inherited from ListEditor.
ObjectChanged For internal use only. Inherited from ListEditor.
PrintableChanged Occurs when the IExportable.Printable control is created and disposed of.
ProcessSelectedItem Occurs after an object is selected in the List Editor‘s control and an end-user presses Enter or double-clicks the object. Inherited from ListEditor.
RequiredPropertiesChanged Inherited from ListEditor.
ResourceDataSourceCreated Occurs after the resources data source has been instantiated by the SchedulerListEditorBase‘s descendant. Inherited from SchedulerListEditorBase.
ResourceDataSourceCreating Occurs before the resources data source has been instantiated by the SchedulerListEditorBase‘s descendant. Inherited from SchedulerListEditorBase.
SelectionChanged Occurs after the selection has been changed in a List Editor‘s control. Inherited from ListEditor.
SelectionTypeChanged Occurs after a List Editor‘s supported selection type is changed. Inherited from ListEditor.
ValidateObject Occurs when the object represented by the ListEditor‘s focused row must be validated. Inherited from ListEditor.
See Also