TTMSFNCCustomPlanner Class
Core planner component providing a date/time scheduling grid with items, resources, groups, full-day events, and a configurable timeline.
API unit family: TMSFNCPlanner
Inherits from: TTMSFNCPlannerData
Implements: ITMSFNCBitmapContainer, ITMSFNCAppearanceGlobalFont
Syntax
TTMSFNCCustomPlanner = class(TTMSFNCPlannerData, ITMSFNCBitmapContainer, ITMSFNCAppearanceGlobalFont)
Properties
| Name | Description |
|---|---|
| PopupPlannerItem | Returns the item associated with the current popup menu operation. |
| ViewCol | Gets or sets the first visible column in the planner view. |
| ViewRow | Gets or sets the first visible row in the planner view. |
Methods
| Name | Description |
|---|---|
| AddItem | Adds a new planner item for the specified time range. |
| AddItemAtSelection | Adds a new item using the current selected time range. |
| AddOrUpdateItem | Adds a new item or updates an existing item in the current resource. |
| CancelEditing | Cancels the active item editing operation. |
| CellToDateTime | Converts a planner cell to its representative date and time. |
| CellToEndDateTime | Converts a planner cell to the end date and time of its interval. |
| CellToStartDatetime | Converts a planner cell to the start date and time of its interval. |
| ClearSelection | Clears the current planner selection. |
| CloseEditingDialog | Closes the active editing dialog. |
| CloseEditingDialogAndRemoveItem | Closes the active editing dialog and removes the item being inserted. |
| DateTimeToCell | Converts a date and time to a planner cell. |
| DateTimeToPosition | Converts a date and time to a visible planner position. |
| DateTimeToValue | Converts a date and time to the planner's internal numeric value. |
| DisplayEndDateTime | Returns the last date and time currently displayed by the planner. |
| DisplayStartDateTime | Returns the first date and time currently displayed by the planner. |
| Draw | Draws the planner in the specified rectangle. |
| EditItem | Starts editing the specified planner item. |
| FindFirstItem | Finds the first item in the specified time range and position. |
| FindItemLinkedTo | Finds an item linked to the specified planner item. |
| FindItemWithDBKey | Finds an item by its database key. |
| FindNextItem | Finds the next item in the specified time range and position. |
| GetContentClipRect | Returns the clipped content rectangle used for planner rendering. |
| GetContentRect | Returns the planner content rectangle. |
| GetDeleteHandler | Returns the delete-area interaction handler. |
| GetEditingDialog | Returns the editing dialog for inserting or updating an item. |
| GetEndTimeSizeHandler | Returns the end-time sizing handler. |
| GetHintPopup | Returns the popup used to display planner hints. |
| GetInplaceEditor | Returns the active inplace editor control. |
| GetStartTimeSizeHandler | Returns the start-time sizing handler. |
| HasFullDayItemPosition | Returns whether a full-day layout position contains the specified item. |
| HasItem | Returns whether an item exists in the specified time range and position. |
| InitSample | Populates the planner with sample data for design-time or demo use. |
| IsCellDisabled | Returns whether the specified cell is disabled for interaction. |
| IsCellInActive | Returns whether the specified cell is inactive. |
| IsDateTimeDisabled | Returns whether a date and time is disabled for interaction. |
| IsDateTimeInActive | Returns whether a date and time is inactive. |
| IsEditing | Returns whether an item editor is currently active. |
| IsFullDayAutoSize | Returns whether full-day item rows are automatically sized. |
| IsFullDayItem | Returns whether the specified item is a full-day item. |
| IsValidItem | Returns whether the specified item belongs to this planner and can be used safely. |
| ItemToEndCell | Returns the cell containing the end of an item. |
| ItemToStartCell | Returns the cell containing the start of an item. |
| LinkItems | Links a group of items so they can be treated as related planner entries. |
| Navigate | Scrolls the planner so the specified cell becomes visible. |
| NavigateToNextDateTime | Navigates to the next visible date and time interval. |
| NavigateToPreviousDateTime | Navigates to the previous visible date and time interval. |
| OpenEditingDialog | Opens the built-in editing dialog for inserting or updating an item. |
| PositionToDateTime | Converts a visible planner position to a date and time. |
| PositionToResource | Converts a visible planner position to a resource index. |
| ResourceToPosition | Converts a resource index to a visible planner position. |
| SelectCells | Selects the rectangular cell range between two planner cells. |
| SelectItem | Selects an item by index. |
| SelectItems | Selects multiple planner items. |
| SelectLinkedItems | Selects the items linked to the specified planner item. |
| SelectNextItem | Selects the next item relative to the active item. |
| SelectPreviousItem | Selects the previous item relative to the active item. |
| SelectedEndDateTime | Returns the end date and time of the current selection. |
| SelectedResource | Returns the resource index associated with the current selection. |
| SelectedStartDateTime | Returns the start date and time of the current selection. |
| StopEditing | Stops the active item editing operation and applies pending changes. |
| UnlinkItems | Removes links from the specified items. |
| UnselectAllItems | Clears the selected state from all planner items. |
| UnselectItem | Removes the selected state from the specified item. |
| UpdateConflicts | Recalculates normal item conflicts. |
| UpdateFullDayConflicts | Recalculates conflicts between full-day items. |
| UpdateItemsCache | Refreshes the cached item layout information. |
| UpdatePlannerCache | Refreshes the planner layout cache. |
| ValueToDateTime | Converts an internal numeric value to a date and time. |
| XYToCacheItem | Returns the cache item at the specified control coordinates. |
| XYToCell | Returns the planner cell at the specified control coordinates. |
| XYToFullDay | Returns the full-day cache item at the specified coordinate. |
| XYToFullDayItem | Returns the full-day item at the specified control coordinates. |
| XYToGroup | Returns the group cache item at the specified coordinate. |
| XYToGroupAnchor | Returns the group anchor at the specified coordinate. |
| XYToItem | Returns the item at the specified control coordinates. |
| XYToItemAnchor | Returns the item anchor at the specified coordinate. |
| XYToItemTitleAnchor | Returns the item title anchor at the specified coordinate. |
| XYToPosition | Returns the position cache item at the specified coordinate. |
| XYToPositionAnchor | Returns the position anchor at the specified coordinate. |
| XYToTime | Returns the planner time slot at the specified control coordinates. |
| XYToTimeLine | Returns the timeline cache item at the specified coordinate. |