TcxSchedulerControlEvent Members
A temporary in-memory user event object in the scheduler control.Constructors
| Name | Description |
|---|---|
| Create(TcxCustomSchedulerStorage,Boolean) | Initializes a new instance of the TcxSchedulerControlEvent class with specified settings. |
| Create(TcxCustomSchedulerStorage,Pointer) | Initializes a new instance of the TcxSchedulerEvent class with specified settings. Inherited from TcxSchedulerEvent. |
| Create(TcxSchedulerEvent,TcxSchedulerEvent) | Initializes a new instance of the TcxSchedulerControlEvent class with specified settings. |
| Create(TcxSchedulerEvent,TDateTime,TDateTime) | Initializes a new instance of the TcxSchedulerControlEvent class with specified settings. |
| Create(TcxSchedulerEvent) | Initializes a new instance of the TcxSchedulerControlEvent class with specified settings. |
Properties
| Name | Description |
|---|---|
| ActualFinish | Gets the user event’s end date or the end date of its last occurrence if the user event is recurring. Inherited from TcxSchedulerEvent. |
| ActualLabelColor | Inherited from TcxSchedulerEvent. |
| ActualStart | Gets the user event’s start date or the start date of its first occurrence if the user event is recurring. Inherited from TcxSchedulerEvent. |
| AllDayEvent | Specifies whether the user event is an all-day event (an event that lasts at least 24 hours or longer). Inherited from TcxSchedulerEvent. |
| Caption | Specifies the caption of the user event. Inherited from TcxSchedulerEvent. |
| Data | Inherited from TcxSchedulerEvent. |
| Duration | Specifies the user event’s duration. Inherited from TcxSchedulerEvent. |
| EditingRecordHandle | Inherited from TcxSchedulerEvent. |
| EditValues | Provides indexed access to the user event object’s properties in edit mode. Inherited from TcxSchedulerEvent. |
| Enabled | This property is used as a custom property. Inherited from TcxSchedulerEvent. |
| EventType | Specifies the status of the user event’s reoccurrences. Inherited from TcxSchedulerEvent. |
| Finish | Specifies the user event’s end time, for the primary time zone. Inherited from TcxSchedulerEvent. |
| GroupID | Determines the task group’s identifier. Inherited from TcxSchedulerEvent. |
| GroupItems | Inherited from TcxSchedulerEvent. |
| ID | Gets the unique identifier of the user event. Inherited from TcxSchedulerEvent. |
| Index | Inherited from TcxSchedulerEvent. |
| IsClone | Specifies whether the current object is a clone of another TcxSchedulerControlEvent object. |
| IsDataValid | Inherited from TcxSchedulerEvent. |
| IsEditing | |
| IsGroup | Specifies the task as a task group in the Gantt View. Inherited from TcxSchedulerEvent. |
| IsSource | |
| LabelColor | Specifies the user event’s color. Inherited from TcxSchedulerEvent. |
| Location | Specifies the text that represents the location at which the user event is being held. Inherited from TcxSchedulerEvent. |
| Message | Specifies the text for the end-user’s description of the user event. Inherited from TcxSchedulerEvent. |
| NonExceptionLinkCount | |
| ParentGroup | Specifies the task’s group in the Gantt View. Inherited from TcxSchedulerEvent. |
| ParentID | Specifies the unique identifier of the user event. Inherited from TcxSchedulerEvent. |
| Pattern | |
| ReadOnly | Gets the user event’s read-only status. Inherited from TcxSchedulerEvent. |
| RecordHandle | Inherited from TcxSchedulerEvent. |
| RecurrenceIndex | Specifies which one of the user event’s reoccurrences this is. Inherited from TcxSchedulerEvent. |
| RecurrenceInfo | Provides access to the user event’s recurrence data. Inherited from TcxSchedulerEvent. |
| Reminder | Specifies whether the reminder is on or off. Inherited from TcxSchedulerEvent. |
| ReminderDate | Specifies the date and time of the user event’s reminder. Inherited from TcxSchedulerEvent. |
| ReminderMinutesBeforeStart | Specifies the time-out in minutes for the reminder of the user event. Inherited from TcxSchedulerEvent. |
| ResourceID | Specifies the resource’s unique identifier for the user event. Inherited from TcxSchedulerEvent. |
| ResourceIDCount | Returns the number of resources that reference the user event. Inherited from TcxSchedulerEvent. |
| ResourceIDs | Provides indexed access to unique identifiers of resources that reference the user event. Inherited from TcxSchedulerEvent. |
| Selected | Specifies whether the user event is selected. |
| Shared | Gets whether the user event is shared between different resources. Inherited from TcxSchedulerEvent. |
| SkipExceptions | Inherited from TcxSchedulerEvent. |
| Source | Represents the TcxSchedulerEvent or TcxSchedulerControlEvent object (if the current object is the TcxSchedulerControlEvent‘s clone). |
| Start | Specifies the user event’s start time, for the primary time zone. Inherited from TcxSchedulerEvent. |
| State | Specifies the availability status of the user event. Inherited from TcxSchedulerEvent. |
| Storage | Represents the persistence manager component. Inherited from TcxSchedulerEvent. |
| TaskComplete | Specifies the task completion, as a percentage. Inherited from TcxSchedulerEvent. |
| TaskIndex | Specifies the row in which the current task resides. Inherited from TcxSchedulerEvent. |
| TaskLinkOwners | References a collection that stores predecessor tasks to which the current task is linked. Inherited from TcxSchedulerEvent. |
| TaskLinks | Represents task links that belong to the TcxSchedulerEvent instance. Inherited from TcxSchedulerEvent. |
| TaskStatus | Specifies the task status. Inherited from TcxSchedulerEvent. |
| UTCFinish | Specifies the user event’s end time, for the UTC time zone. Inherited from TcxSchedulerEvent. |
| UTCStart | Specifies the user event’s start time, for the UTC time zone. Inherited from TcxSchedulerEvent. |
| ValueCount | Gets the number of the storage fields that store the TcxSchedulerEvent property values. Inherited from TcxSchedulerEvent. |
| Values | Provides indexed access to the storage fields that store the current TcxSchedulerEvent object’s properties values. Inherited from TcxSchedulerEvent. |
Methods
| Name | Description |
|---|---|
| AllowLink(TcxSchedulerEvent) | Inherited from TcxSchedulerEvent. |
| Assign(TPersistent) | Inherited from TPersistent. |
| AssignAttributes(TcxSchedulerEvent,Boolean) | Copies the contents of the ASource user event. Inherited from TcxSchedulerEvent. |
| AssignDefaultValues | Inherited from TcxSchedulerEvent. |
| AssignTo(TPersistent) | Inherited from TPersistent. |
| BeginEditing | Loads the current object properties’ values for editing and activates edit mode for the user event. Inherited from TcxSchedulerEvent. |
| Cancel | Deactivates edit mode and prevents the user event from being updated in storage. Inherited from TcxSchedulerEvent. |
| CanLink(TcxSchedulerEvent) | Checks whether an event can be linked to the current task when scheduling in the Gantt View. Inherited from TcxSchedulerEvent. |
| Conflicts(Boolean) | Determines whether other user events overlap with the scheduled time of the user event. Inherited from TcxSchedulerEvent. |
| CreateConflictsInfo(Boolean) | Instantiates a TcxSchedulerEventConflictsInfo object which contains information on any user events that overlap with the user event. Inherited from TcxSchedulerEvent. |
| Delete | Removes the user event from storage and memory and updates the scheduler to reflect the changes. Inherited from TcxSchedulerEvent. |
| DeleteExceptions | Deletes all the custom occurrences and exceptions if the user event is the pattern. Inherited from TcxSchedulerEvent. |
| EndEditing | Flushes the updated user event to storage and deactivates edit mode for it. Inherited from TcxSchedulerEvent. |
| Equals(TObject) | Inherited from TObject. |
| GetCustomFieldValue(TcxCustomSchedulerStorageField) | Returns the user-defined attribute’s value of the user event from the ACustomField in the TcxSchedulerStorageFields collection. Inherited from TcxSchedulerEvent. |
| GetCustomFieldValueByIndex(Integer) | Returns the user-defined attribute’s value of the user event from the TcxSchedulerStorageFields collection at the position specified by the AIndex parameter. Inherited from TcxSchedulerEvent. |
| GetCustomFieldValueByName(string) | Returns the user-defined attribute’s value of the user event from the AName custom field, located in the TcxSchedulerStorageFields collection. Inherited from TcxSchedulerEvent. |
| GetHashCode | Inherited from TObject. |
| GetNamePath | Inherited from TPersistent. |
| GetOccurrence(TDateTime) | Returns the recurring user event’s occurrence by the ADate. Inherited from TcxSchedulerEvent. |
| GetOriginalDate | Returns the start date and time of the user event. Inherited from TcxSchedulerEvent. |
| GetOwner | Inherited from TPersistent. |
| GetRecurrenceChain | Loads all the TcxSchedulerEvent objects that represent exceptions or custom occurrences of the user event, from storage and puts them in the TcxSchedulerEventList collection, if the flag etPattern on the user event’s EventType property is active. Inherited from TcxSchedulerEvent. |
| GetResourceItem |
Returns the TcxSchedulerStorageResourceItem object, which represents the schedule resource. This method is deprecated. Inherited from TcxSchedulerEvent. |
| GetTaskLinkOwnerRelation(TcxSchedulerEvent,TcxSchedulerEventRelation) | Checks whether the current task (the successor) and a specified task (the predecessor) are linked, and obtains the link type. Inherited from TcxSchedulerEvent. |
| GetValidTaskTimeRange(TDateTime,TDateTime) | Validates the current task’s time start and end time. Inherited from TcxSchedulerEvent. |
| GetValidTaskTimeRangeByRelation(TcxSchedulerEventRelation,TcxSchedulerEvent,TDateTime,TDateTime) | Validates the current task’s time bounds. Inherited from TcxSchedulerEvent. |
| HasAsParentGroup(TcxSchedulerEvent) | Determines whether AEvent is the task’s group parent. Inherited from TcxSchedulerEvent. |
| HasChildren | Determines whether the task owns the group children. Inherited from TcxSchedulerEvent. |
| HasExceptions | Specifies whether the user event has custom occurrences or exceptions in the chain of reoccurrences if this user event is the parent of this chain. Inherited from TcxSchedulerEvent. |
| HasReminderForResourceID(Variant) | Inherited from TcxSchedulerEvent. |
| InitFromSource(TcxSchedulerEvent) | |
| IsAllDayOrLonger | Inherited from TcxSchedulerEvent. |
| IsDayEvent(Integer) | Inherited from TcxSchedulerEvent. |
| IsDayEvent(TDateTime) | Checks whether the ADate date contains the user event. Inherited from TcxSchedulerEvent. |
| IsEventLinked(TcxSchedulerEvent) | Inherited from TcxSchedulerEvent. |
| IsOrigin(TcxSchedulerEvent) | |
| IsRecurring | Checks whether the user event is recurring. Inherited from TcxSchedulerEvent. |
| IsResourceEvent(TcxSchedulerStorageResourceItem,Boolean) | Checks whether the user event belongs to the AResource resource. Inherited from TcxSchedulerEvent. |
| IsSharedWithResource(TcxSchedulerStorageResourceItem) | Inherited from TcxSchedulerEvent. |
| IsSharedWithResource(Variant) | Checks whether the user event belongs to the AResourceItem resource. Inherited from TcxSchedulerEvent. |
| lockResource(Variant) | |
| MoveTo(TDateTime) | Changes the user event’s start time to the start time specified by the AStartTime parameter. Inherited from TcxSchedulerEvent. |
| OpenedInEditor | |
| Post | Submits the user event to storage and updates the scheduler to reflect the changes. Inherited from TcxSchedulerEvent. |
| RemoveRecurrence | Changes the state of the user event from recurring to regular. Inherited from TcxSchedulerEvent. |
| ReplaceResourceID(Variant) | Replaces an associated resource with a new one or adds a new resource if the user event is shared between resources. Inherited from TcxSchedulerEvent. |
| SetCustomFieldValue(TcxCustomSchedulerStorageField,Variant) | Writes the AValue user-defined attribute’s value of the user event to the ACustomField in the TcxSchedulerStorageFields collection. Inherited from TcxSchedulerEvent. |
| SetCustomFieldValueByIndex(Integer,Variant) | Writes the AValue user-defined attribute’s value of the user event to the custom field located at the AIndex position in the TcxSchedulerStorageFields collection. Inherited from TcxSchedulerEvent. |
| SetCustomFieldValueByName(string,Variant) | Writes the AValue user-defined attribute’s value of the user event to the custom field identified by the AName in the TcxSchedulerStorageFields collection. Inherited from TcxSchedulerEvent. |
| ShareWithResource(TcxSchedulerStorageResourceItem) | Inherited from TcxSchedulerEvent. |
| ShareWithResource(Variant) | Assigns the user event to the resource specified by the AResourceItem or AResourceID parameter. Inherited from TcxSchedulerEvent. |
| StorageTimeBias | |
| TimeBias | Returns the system time offset from UTC. Inherited from TcxSchedulerEvent. |
| ToString | Inherited from TObject. |
| unlockResource | |
| UnshareWithResource(TcxSchedulerStorageResourceItem) | Inherited from TcxSchedulerEvent. |
| UnshareWithResource(Variant) | Disassociates the user event from the AResourceItem resource. Inherited from TcxSchedulerEvent. |
| ValidateOccurrenceTimeBounds(TcxSchedulerEvent,TDateTime,TDateTime) | Inherited from TcxSchedulerEvent. |
See Also