Back to Devexpress

TcxCustomScheduler Members

vcl-cxschedulercustomcontrols-dot-tcxcustomscheduler-dot-underscore-members.md

latest82.7 KB
Original Source

TcxCustomScheduler Members

The base class for classes that implement the scheduler control.

Constructors

NameDescription
Create(TComponent)Inherited from TComponent.
CreateParented(HWND)Inherited from TWinControl.

Properties

NameDescription
ActionInherited from TControl.
ActiveCanvasProvides access to the control’s GDI-based canvas. Inherited from TcxControl.
ActiveHitTestRepresents the currently active TcxSchedulerSubControlHitTest‘s subclass.
AlignInherited from TControl.
AlignDisabledInherited from TWinControl.
AlignWithMarginsInherited from TControl.
AnchorsInherited from TControl.
AutoSizeInherited from TControl.
BevelEdgesInherited from TWinControl.
BevelInnerInherited from TWinControl.
BevelKindInherited from TWinControl.
BevelOuterInherited from TWinControl.
BevelWidthInherited from TWinControl.
BiDiModeInherited from TControl.
BorderSize protectedInherited from TcxControl.
BorderStyle protected
BorderWidthInherited from TWinControl.
BoundsReturns the control’s boundaries. Inherited from TcxControl.
BoundsRectInherited from TControl.
BrushInherited from TWinControl.
CanvasProvides access to the control’s GDI-based canvas. Inherited from TcxControl.
CaptionInherited from TControl.
ClientBoundsReturns the control’s client area. Inherited from TcxControl.
ClientHeightInherited from TControl.
ClientOriginInherited from TControl.
ClientRectInherited from TControl.
ClientWidthInherited from TControl.
ColorInherited from TControl.
ComObjectInherited from TComponent.
ComponentCountInherited from TComponent.
ComponentIndexInherited from TComponent.
ComponentsInherited from TComponent.
ComponentStateInherited from TComponent.
ComponentStyleInherited from TComponent.
ConstraintsInherited from TControl.
ContentPopupMenuRepresents the pop-up menu that can be invoked for the time blocks in the currently active time View.
ControlBoxRepresents the Control Box.
ControlCountInherited from TWinControl.
ControlsInherited from TWinControl.
ControlStateInherited from TControl.
ControlStyleInherited from TControl.
Ctl3DInherited from TWinControl.
CurrentPPIInherited from TControl.
CurrentViewSpecifies the currently active time View in the scheduling area.
CursorInherited from TControl.
CustomHintInherited from TControl.
DateNavigator
DateTimeHelperRepresents the date/time utility.
DesignInfoInherited from TComponent.
DialogsLookAndFeelRepresents look and feel settings for the built-in dialogs.
DialogsStyle protectedSpecifies the Event dialog’s paint style.
DockClientCountInherited from TWinControl.
DockClientsInherited from TWinControl.
DockManagerInherited from TWinControl.
DockOrientationInherited from TControl.
DockSiteInherited from TWinControl.
DoubleBufferedInherited from TWinControl.
DragAndDropObjectInherited from TcxControl.
DragAndDropObjectClassInherited from TcxControl.
DragAndDropStateInherited from TcxControl.
DragCursorInherited from TControl.
DragKindInherited from TControl.
DragMode protected
EnabledInherited from TControl.
EventDaysRepresents a collection of dates containing user events.
EventImagesRepresents the user-defined collection of user event icons.
EventOperationsSpecifies the operations an end-user can perform on user events.
EventPopupMenuRepresents the pop-up menu that can be invoked for any user event available in the scheduling area.
ExplicitHeightInherited from TControl.
ExplicitLeftInherited from TControl.
ExplicitTopInherited from TControl.
ExplicitWidthInherited from TControl.
FirstVisibleResourceIndexSpecifies the zero-based index of the leftmost visible resource in the scheduling area.
FloatingInherited from TControl.
FloatingDockSiteClassInherited from TControl.
FocusOnClick protectedSpecifies if clicking the control focuses it. Inherited from TcxControl.
FontInherited from TControl.
HandleInherited from TWinControl.
HeightInherited from TControl.
HelpContextInherited from TControl.
HelpKeywordInherited from TControl.
HelpTypeInherited from TControl.
HintSpecifies a hint message for the control. Inherited from TcxControl.
HolidayDays
HostDockSiteInherited from TControl.
HScrollBar protectedInherited from TcxControl.
HScrollBarVisible protectedInherited from TcxControl.
ImeModeInherited from TWinControl.
ImeNameInherited from TWinControl.
IsDesigningIdentifies if the control is being modified by the form designer. Inherited from TcxControl.
IsDestroyingIdentifies if the control is about to be destroyed. Inherited from TcxCustomControl.
IsDrawingLockedInherited from TWinControl.
IsFocusedIdentifies if the control has focus. Inherited from TcxControl.
IsLoadingIdentifies if the control is being loaded. Inherited from TcxControl.
Keys protectedInherited from TcxControl.
LeftInherited from TControl.
LookAndFeel protectedProvides access to the control’s look & feel settings. Inherited from TcxControl.
LookAndFeelPainter protectedInherited from TcxControl.
LRDockWidthInherited from TControl.
MarginsInherited from TControl.
MouseCaptureInherited from TControl.
MouseCaptureObjectProvides access to the dragged object during a drag-and-drop operation. Inherited from TcxControl.
MouseDownPosSpecifies the mouse pointer position when an OnMouseDown event occurs. Inherited from TcxControl.
MouseInClientInherited from TWinControl.
NameInherited from TComponent.
ObserversInherited from TComponent.
OptionsBehaviorReferences settings that specify the scheduler’s response to end-user actions.
OptionsCustomizeRepresents settings that define the behavior of the scheduler’s components.
OptionsViewRepresents settings that define the scheduler control’s appearance.
OwnerInherited from TComponent.
PaddingInherited from TWinControl.
ParentInherited from TControl.
ParentBackground protectedInherited from TcxControl.
ParentBiDiModeInherited from TControl.
ParentColorInherited from TControl.
ParentCtl3DInherited from TWinControl.
ParentCustomHintInherited from TControl.
ParentDoubleBufferedInherited from TWinControl.
ParentFont protected
ParentShowHintInherited from TControl.
ParentWindowInherited from TWinControl.
PixelsPerInchInherited from TWinControl.
PopupMenu protectedSpecifies the popup menu associated with the control. Inherited from TcxControl.
RaiseOnNonMainThreadUsageInherited from TControl.
RedrawDisabledInherited from TWinControl.
ResourceNavigatorRepresents the resource navigator.
ScaleFactorInherited from TControl.
ScrollBars protectedInherited from TcxControl.
SelectedDaysRepresents the collection of dates displayed in the scheduling area.
SelectedEventCountGets the number of TcxSchedulerControlEvent objects in the SelectedEvents collection.
SelectedEventsProvides indexed access to user events that are currently selected in the scheduling area.
SelFinishGets the currently selected end time in the scheduling area.
SelResourceSpecifies the currently selected resource in the scheduling area.
SelStartGets the currently selected start time in the scheduling area.
ShowHintInherited from TControl.
ShowingInherited from TWinControl.
StorageSpecifies the event data source for the scheduler control.
StoringNameSpecifies the name under which the scheduler control’s layout is stored (also called stored name).
StyleElementsInherited from TControl.
StyleNameInherited from TControl.
StylesRepresents style settings for the scheduler control’s elements.
TabOrderInherited from TWinControl.
TabStopInherited from TcxControl.
TagInherited from TComponent.
TBDockHeightInherited from TControl.
TextInherited from TControl.
TipModeInherited from TWinControl.
TopInherited from TControl.
TouchInherited from TControl.
Transparent protectedSpecifies if the control is transparent in GDI render mode. Inherited from TcxControl.
UndockHeightInherited from TControl.
UndockWidthInherited from TControl.
UseDockManagerInherited from TWinControl.
VCLComObjectInherited from TComponent.
VisibleInherited from TControl.
VisibleDockClientCountInherited from TWinControl.
VisibleEventCountGets the number of TcxSchedulerControlEvent objects in the collection represented by the VisibleEvents property.
VisibleEventsProvides indexed access to the TcxSchedulerControlEvent user events contained in the dates currently available in the Date Navigator.
VScrollBar protectedInherited from TcxControl.
VScrollBarVisible protectedInherited from TcxControl.
WidthInherited from TControl.
WindowProcInherited from TControl.

Methods

NameDescription
AcceptMousePosForClick(Integer,Integer)Inherited from TcxControl.
AddFontListener(IcxFontListener)Inherited from TcxControl.
Assign(TPersistent)Inherited from TPersistent.
AssignTo(TPersistent)Inherited from TPersistent.
BeginDrag(Boolean,Integer)Inherited from TControl.
BeginDragAndDropInherited from TcxControl.
BeginInvoke(TAsyncConstArrayFunctionEvent,Untyped[],TObject)Inherited from TComponent.
BeginInvoke(TAsyncConstArrayProc,Untyped[],TObject)Inherited from TComponent.
BeginInvoke(TAsyncConstArrayProcedureEvent,Untyped[],TObject)Inherited from TComponent.
BeginInvoke(TAsyncFunctionEvent,TObject)Inherited from TComponent.
BeginInvoke(TAsyncProcedureEvent,TObject)Inherited from TComponent.
BeginInvoke(TProc,TObject)Inherited from TComponent.
BeginInvoke<TResult>(TAsyncConstArrayFunc<TResult>,Untyped[],TObject)Inherited from TComponent.
BeginInvoke<TResult>(TFunc<TResult>,TObject)Inherited from TComponent.
BeginUpdatePrevents the scheduler control from flickering during bulk updates.
BringToFrontInherited from TControl.
Broadcast(Untyped)Inherited from TWinControl.
CanFocusInherited from TWinControl.
CanFocusExInherited from TcxControl.
ChangeScale(Integer,Integer)Inherited from TControl.
CheckNonMainThreadUsageInherited from TControl.
ClickInherited from TControl.
ClientToParent(TPoint,TWinControl)Inherited from TControl.
ClientToScreen(TPoint)Inherited from TControl.
ClientToScreen(TRect)Inherited from TControl.
ConstrainedResize(Integer,Integer,Integer,Integer)Inherited from TControl.
ContainsControl(TControl)Inherited from TWinControl.
ControlAtPos(TPoint,Boolean,Boolean,Boolean)Inherited from TWinControl.
CopyToClipboardCopies the selected user event(s) into the scheduler’s clipboard.
CreateEventUsingDialog(Boolean,Boolean)Invokes the Event dialog used to create new user events.
CreateEventUsingInplaceEditInvokes the in-place editor used to create new user events.
CreateParentedControl(HWND)Inherited from TWinControl.
CutToClipboardMoves the selected user event(s) into the scheduler’s clipboard.
DeleteEvent(TcxSchedulerControlEvent)Removes the AEvent user event.
DeleteSelectedEvents(Boolean)Removes selected user events.
DestroyComponentsInherited from TComponent.
DestroyingInherited from TComponent.
DisableAlignInherited from TWinControl.
Dock(TWinControl,TRect)Inherited from TControl.
DockDrop(TDragDockObject,Integer,Integer)Inherited from TWinControl.
DragDrop(TObject,Integer,Integer)Inherited from TControl.
DraggingInherited from TControl.
DrawTextBiDiModeFlags(Longint)Inherited from TControl.
DrawTextBiDiModeFlagsReadingOnlyInherited from TControl.
EditEventUsingDialog(TcxSchedulerControlEvent,Boolean,Boolean)Invokes the Event dialog for the target user event.
EditEventUsingInplaceEdit(TcxSchedulerControlEvent)Activates the in-place editor used to edit the AEvent user event‘s subject.
EnableAlignInherited from TWinControl.
EndDrag(Boolean)Inherited from TControl.
EndFunctionInvoke(IAsyncResult)Inherited from TComponent.
EndInvoke(IAsyncResult)Inherited from TComponent.
EndInvoke<TResult>(IAsyncResult)Inherited from TComponent.
EndUpdateReleases a lock acquired by the BeginUpdate method.
Equals(TObject)Inherited from TObject.
ExecuteAction(TBasicAction)Inherited from TComponent.
FindChildControl(String)Inherited from TWinControl.
FindComponent(String)Inherited from TComponent.
FinishDragAndDrop(Boolean)Inherited from TcxControl.
FlipChildren(Boolean)Inherited from TWinControl.
FocusedInherited from TWinControl.
FreeNotification(TComponent)Inherited from TComponent.
FreeOnReleaseInherited from TComponent.
FullRefreshUpdates a collection of TcxSchedulerControlEvent objects and forces the scheduler control to redraw itself.
GetChildren(TGetChildProc,TComponent)Inherited from TComponent.
GetControlsAlignmentInherited from TControl.
GetDragImagesInherited from TControl.
GetHashCodeInherited from TObject.
GetNamePathInherited from TPersistent.
GetOwnerInherited from TPersistent.
GetParentComponentInherited from TComponent.
GetStyleNameInherited from TControl.
GetSystemMetrics(Integer)Inherited from TControl.
GetTabControlList(TList)Inherited from TWinControl.
GetTabOrderList(TList)Inherited from TWinControl.
GetTextBuf(PChar,Integer)Inherited from TControl.
GetTextLenInherited from TControl.
GoToDate(TDateTime,TcxSchedulerViewMode)
GoToDate(TDateTime)
HandleAllocatedInherited from TWinControl.
HandleNeededInherited from TWinControl.
HasParentInherited from TComponent.
HideInherited from TControl.
InitiateActionInherited from TControl.
InsertComponent(TComponent)Inherited from TComponent.
InsertControl(TControl)Inherited from TWinControl.
InvalidateInherited from TControl.
InvalidateRect(TRect,Boolean)Adds a specified portion of the control’s client area to the window update region. Inherited from TcxControl.
InvalidateRgn(TcxRegion,Boolean)Inherited from TcxControl.
InvalidateWithChildrenInherited from TcxControl.
IsCustomStyleActiveInherited from TControl.
IsImplementorOf(IInterface)Inherited from TComponent.
IsLightStyleColor(TColor)Inherited from TControl.
IsMouseInPressedArea(Integer,Integer)Inherited from TcxControl.
IsRightToLeftInherited from TControl.
LayoutChangedForces the scheduler control to update itself.
LoadedInherited from TComponent.
LockDrawingInherited from TWinControl.
LockScrollBarsInherited from TcxControl.
MakeEventVisible(TcxSchedulerControlEvent,TDateTime,TcxSchedulerStorageResourceItem)Scrolls the scheduling area‘s content to bring a user event into the Time View.
MakeResourceVisible(TcxSchedulerStorageResourceItem)Scrolls the scheduling area‘s content to bring the AResource resource into view.
ManualDock(TWinControl,TControl,TAlign)Inherited from TControl.
ManualFloat(TRect)Inherited from TControl.
MouseDown(TMouseButton,TShiftState,Integer,Integer)Inherited from TControl.
MouseMove(TShiftState,Integer,Integer)Inherited from TControl.
MouseUp(TMouseButton,TShiftState,Integer,Integer)Inherited from TControl.
MouseWheelHandler(TMessage)Inherited from TControl.
Notification(TComponent,TOperation)Inherited from TComponent.
PaintTo(HDC,Integer,Integer)Inherited from TWinControl.
PaintTo(TCanvas,Integer,Integer)Inherited from TWinControl.
ParentToClient(TPoint,TWinControl)Inherited from TControl.
PasteFromClipboardInserts the user event(s) from the scheduler’s clipboard into the selected time block(s).
Perform(Cardinal,WPARAM,LPARAM)Inherited from TControl.
Perform(Cardinal,WPARAM,PChar)Inherited from TControl.
Perform(Cardinal,WPARAM,TRect)Inherited from TControl.
PostMouseMoveInherited from TcxControl.
PostMouseMove(TPoint)Inherited from TcxControl.
PreProcessMessage(TMsg)Inherited from TWinControl.
RealignInherited from TWinControl.
ReferenceInterface(IInterface,TOperation)Inherited from TComponent.
RefreshInherited from TControl.
RemoveComponent(TComponent)Inherited from TComponent.
RemoveControl(TControl)Inherited from TWinControl.
RemoveFontListener(IcxFontListener)Inherited from TcxControl.
RemoveFreeNotification(TComponent)Inherited from TComponent.
RepaintInherited from TControl.
ReplaceDockedControl(TControl,TWinControl,TControl,TAlign)Inherited from TControl.
RestoreFromIniFile(string,Boolean)Restores the scheduler control’s layout from an INI file.
RestoreFromRegistry(string,Boolean)Restores the scheduler control’s layout from the system registry.
RestoreFromStream(TStream,Boolean)Restores the scheduler control’s layout from an AStream stream.
ScaleBy(Integer,Integer)Inherited from TWinControl.
ScaleForPPI(Integer)Inherited from TControl.
ScaleRectSize(TRect)Inherited from TControl.
ScaleValue(Double)Inherited from TControl.
ScaleValue(Integer)Inherited from TControl.
ScaleValue(TPoint)Inherited from TControl.
ScaleValue(TRect)Inherited from TControl.
ScaleValue(TSize)Inherited from TControl.
ScreenToClient(TPoint)Inherited from TControl.
ScreenToClient(TRect)Inherited from TControl.
ScrollBy(Integer,Integer)Inherited from TWinControl.
ScrollContent(TcxDirection)Inherited from TcxControl.
ScrollWindow(Integer,Integer,TRect)Inherited from TcxControl.
SelectEvent(TcxSchedulerControlEvent,TShiftState)Emulates the AEvent user event being selected by an end-user.
SelectTime(TDateTime,TDateTime,TcxSchedulerStorageResourceItem)Selects the time blocks from the ASelStart time block through to the ASelFinish time block, inclusive, in the AResource resource.
SendToBackInherited from TControl.
SetBounds(Integer,Integer,Integer,Integer)Inherited from TControl.
SetDesignVisible(Boolean)Inherited from TControl.
SetFocusInherited from TWinControl.
SetParentComponent(TComponent)Inherited from TComponent.
SetScrollBarInfo(TScrollBarKind,Integer,Integer,Integer,Integer,Integer,Boolean,Boolean)Inherited from TcxControl.
SetSubComponent(Boolean)Inherited from TComponent.
SetTextBuf(PChar)Inherited from TControl.
ShowInherited from TControl.
StartDrag(TDragObject)Inherited from TcxControl.
StoreToIniFile(string,Boolean,Boolean)Saves the scheduler control’s layout scheme in an INI file.
StoreToRegistry(string,Boolean,Boolean)Saves the scheduler control’s layout scheme in the system registry.
StoreToStream(TStream,Boolean)Saves the scheduler control’s layout scheme in the AStream stream.
SupportsUIAutomation protectedInherited from TcxCustomControl.
SystemInfoChanged(Cardinal)Inherited from TcxControl.
ToStringInherited from TObject.
TranslationChangedInherited from TcxControl.
UnlockDrawingInherited from TWinControl.
UnlockScrollBarsInherited from TcxControl.
UnselectEventsCauses to undo the current selection of user events.
UpdateInherited from TControl.
UpdateAction(TBasicAction)Inherited from TComponent.
UpdateControlStateInherited from TWinControl.
UpdateWithChildrenInherited from TcxControl.
UseRightToLeftAlignmentInherited from TControl.
UseRightToLeftReadingInherited from TControl.
UseRightToLeftScrollBarInherited from TControl.
ValidateFirstVisibleResourceIndex
WndProc(TMessage)Inherited from TControl.

Events

NameDescription
ContentPopupMenuEvents
EventPopupMenuEvents
OnAfterDragEvent protectedFires after an end-user has finished dragging the user event and released the mouse button.
OnAfterEditing protectedFires when the in-place editor or the Event dialog exits.
OnAfterSizingEvent protectedFires after an end-user has finished dragging the user event‘s time boundaries and released the mouse button.
OnAlignInsertBeforeInherited from TWinControl.
OnAlignPositionInherited from TWinControl.
OnBeforeDeleting protectedFires when AEvent is about to be deleted.
OnBeforeDragEvent protectedFires before an end-user starts dragging the user event in the scheduling area.
OnBeforeEditing protectedFires before the in-place editor or Event dialog editor is activated.
OnBeforeSizingEvent protectedFires before an end-user starts resizing the user event in the scheduling area.
OnCanResizeInherited from TControl.
OnCanShowView protectedFires before a time View shown in the scheduling area is changed for another.
OnClickInherited from TControl.
OnConstrainedResizeInherited from TControl.
OnContextPopupInherited from TControl.
OnDblClickInherited from TControl.
OnDockDropInherited from TWinControl.
OnDockOverInherited from TWinControl.
OnDragDropInherited from TControl.
OnDragOverInherited from TControl.
OnEndDockInherited from TControl.
OnEndDragInherited from TControl.
OnEnterInherited from TWinControl.
OnEventSelectionChanged protectedFires when the user event has been selected or unselected.
OnExitInherited from TWinControl.
OnFirstVisibleResourceChanged protectedFires when the leftmost resource in the scheduling area has been changed.
OnFocusChanged protectedInherited from TcxControl.
OnGestureInherited from TControl.
OnGetEventDisplayText protectedFires before the AEvent user event‘s subject is drawn in the scheduling area.
OnGetEventEditProperties protectedFires before the description is drawn in the AEvent user event‘s rectangle.
OnGetEventHintText protectedFires before the hint window is shown when an end-user positions the mouse pointer over the user event‘s rectangle.
OnGetEventModernStyleHintInfo protectedEnables you to show, hide, and customize the callout popup hint’s content for a user event when the Modern Style is active.
OnGetSiteInfoInherited from TWinControl.
OnInitEdit protectedFires when the user event‘s AEdit in-place editor gets activated.
OnIsWorkTime protectedFires before the time block is drawn in the scheduling area.
OnKeyDownInherited from TWinControl.
OnKeyPressInherited from TWinControl.
OnKeyUpInherited from TWinControl.
OnLayoutChanged protectedFires when the scheduler control’s layout has been changed.
OnMoreEventsButtonClick protectedFires when an end-user clicks the button which brings user events into view.
OnMouseActivateInherited from TControl.
OnMouseDownInherited from TControl.
OnMouseEnter protectedOccurs when the mouse pointer enters into the control. Inherited from TcxControl.
OnMouseLeave protectedOccurs when the mouse pointer leaves the control. Inherited from TcxControl.
OnMouseMoveInherited from TControl.
OnMouseUpInherited from TControl.
OnMouseWheelInherited from TControl.
OnMouseWheelDownInherited from TControl.
OnMouseWheelUpInherited from TControl.
OnNavigationButtonClick protectedAllows you to respond to the user event navigation button click.
OnResizeInherited from TControl.
OnScaleScroll protectedEnables you to synchronize scroll operations in the TimeGrid View with the Date Navigator.
OnSelectionChanged protectedFires after an end-user has selected the time block(s).
OnShowDateHint protectedAllows you to customize hint visibility and display text.
OnStartDockInherited from TControl.
OnStartDragInherited from TControl.
OnUnDockInherited from TWinControl.
OnViewTypeChanged protectedFires when the time View in the scheduling area is about to be changed.
ResourceNavigatorEvents
StylesEvents

See Also

TcxCustomScheduler Class

cxSchedulerCustomControls Unit