Table of Contents

TTMSFNCPlannerItem Class

Represents a single appointment or event in the planner, storing its time range, resource assignment, display text, title, colours, font settings, link to another item, recurring rule, and mark decoration.

API unit family: TMSFNCPlannerData Inherits from: TCollectionItem

Syntax

TTMSFNCPlannerItem = class(TCollectionItem)

Properties

Name Description
ActiveColor Background fill colour of the item block in its active (hover/focus) state.
ActiveFontColor Text colour of the body content in the active state.
ActiveFontName Font family name applied to the body text in the active state.
ActiveFontSize Font size in points applied to the body text in the active state.
ActiveFontStyle Font style applied to the body text in the active state.
ActiveStrokeColor Border stroke colour of the item block in its active state.
ActiveTitleColor Background fill colour of the title band in the active state; use gcNull to inherit ActiveColor.
ActiveTitleFontColor Text colour of the title in the active state.
ActiveTitleFontName Font family name applied to the title text in the active state.
ActiveTitleFontSize Font size in points applied to the title text in the active state.
ActiveTitleFontStyle Font style applied to the title text in the active state; defaults to bold.
ActiveTitleStrokeColor Border stroke colour of the title band in the active state.
Background When True, the item is rendered as a background decoration behind other items rather than as a foreground appointment.
Color Background fill colour of the item block in its normal (unselected, enabled) state.
DBKey Database key string used by database adapters to correlate this item with a record in an external data source.
DataBoolean Arbitrary Boolean value for associating application-defined state with this item; True has only the meaning assigned by the application.
DataInteger Arbitrary integer for associating application-defined numeric data with this item.
DataObject Arbitrary object reference for associating application-defined data with this item.
DataPointer Arbitrary pointer for associating application-defined data with this item.
DataString Arbitrary string for associating application-defined text data with this item.
Deletable When True, the item can be deleted by the user via keyboard or context menu.
DisabledColor Background fill colour of the item block when it is disabled.
DisabledFontColor Text colour of the body content when the item is disabled.
DisabledFontName Font family name applied to the body text when the item is disabled.
DisabledFontSize Font size in points applied to the body text when the item is disabled.
DisabledFontStyle Font style applied to the body text when the item is disabled.
DisabledStrokeColor Border stroke colour of the item block when it is disabled.
DisabledTitleColor Background fill colour of the title band when the item is disabled; use gcNull to inherit DisabledColor.
DisabledTitleFontColor Text colour of the title when the item is disabled.
DisabledTitleFontName Font family name applied to the title text when the item is disabled.
DisabledTitleFontSize Font size in points applied to the title text when the item is disabled.
DisabledTitleFontStyle Font style applied to the title text when the item is disabled; defaults to bold.
DisabledTitleStrokeColor Border stroke colour of the title band when the item is disabled.
Editable When True, the item can be opened for inline or dialog editing by the user.
Enabled When True, the item responds to user interaction; set to False to display it in its disabled state.
EndTime Date and time at which the appointment ends; determines the trailing edge of the item block.
FixedResource When True, the item cannot be dragged to a different resource; it stays in its assigned resource row/column.
FontColor Text colour of the body content in the normal state.
FontName Font family name applied to the body text in the normal state; empty inherits the planner default font.
FontSize Font size in points applied to the body text in the normal state.
FontStyle Font style applied to the body text in the normal state.
FullDay When True, the item spans the full day and is displayed in the full-day band rather than at a specific time position.
FullDayLayout Controls which full-day bands (pfdlTop, pfdlBottom, or both) the item is displayed in when FullDay is True.
Hint Tooltip text shown when the user hovers over this item.
LinkArrow Arrowhead style drawn on the link line connector; default is ilaNone (no arrowheads).
LinkColor Colour of the link line drawn between this item and its LinkedItem in the normal state.
LinkType Determines which endpoints of the two linked items are connected by the link line; default is iltNone (no connector).
LinkedItem Another planner item visually connected to this item by a link line drawn according to LinkType and LinkArrow.
Margins Inner spacing between the item border and its text content.
MarkColor Default colour of all mark strips; individual edges can be overridden with MarkColorLeft, MarkColorTop, MarkColorRight, MarkColorBottom.
MarkColorBottom Colour of the mark strip on the bottom edge; use gcNull to fall back to MarkColor.
MarkColorLeft Colour of the mark strip on the left edge; use gcNull to fall back to MarkColor.
MarkColorRight Colour of the mark strip on the right edge; use gcNull to fall back to MarkColor.
MarkColorTop Colour of the mark strip on the top edge; use gcNull to fall back to MarkColor.
MarkCorners Set of corners that are rounded on the mark strip rectangles.
MarkRounding Corner rounding radius applied to the mark strip rectangles; default is 0 (square corners).
MarkSizeBottom Height in pixels of the bottom mark strip.
MarkSizeLeft Width in pixels of the left mark strip; inherits MarkColor width when not stored.
MarkSizeRight Width in pixels of the right mark strip.
MarkSizeTop Height in pixels of the top mark strip.
MarkType Set of edges on which a coloured mark strip is drawn; combine imtLeft, imtTop, imtRight, imtBottom.
MasterEndDateTime End date/time of the master recurring item from which this occurrence was generated.
MasterStartDateTime Start date/time of the master recurring item from which this occurrence was generated.
Movable When True, the item can be dragged to a new time position or resource by the user.
OldEndTime End time of the item before the most recent drag or resize operation, used to restore the original position on cancel.
OldStartTime Start time of the item before the most recent drag or resize operation, used to restore the original position on cancel.
Overlappable When True, this item may overlap other items visually; set to False to force side-by-side layout when times conflict.
Recurrency iCalendar RRULE string defining the recurrence pattern for this item; used together with Recurrent.
Recurrent When True, this item is a generated occurrence of a recurring appointment defined by Recurrency.
Resource Zero-based index of the resource (row or column) to which this item belongs.
Rounding Corner rounding radius of the item block border rectangle; default is 0 (square corners).
RoundingCorners Set of corners that are rounded on the item block border rectangle.
Selectable When True, the item can be clicked to become the selected item.
SelectedColor Background fill colour of the item block when it is selected.
SelectedFontColor Text colour of the body content when the item is selected.
SelectedFontName Font family name applied to the body text when the item is selected.
SelectedFontSize Font size in points applied to the body text when the item is selected.
SelectedFontStyle Font style applied to the body text when the item is selected.
SelectedLinkColor Colour of the link line drawn between this item and its LinkedItem when the item is selected.
SelectedStrokeColor Border stroke colour of the item block when it is selected.
SelectedTitleColor Background fill colour of the title band when the item is selected; use gcNull to inherit SelectedColor.
SelectedTitleFontColor Text colour of the title when the item is selected.
SelectedTitleFontName Font family name applied to the title text when the item is selected.
SelectedTitleFontSize Font size in points applied to the title text when the item is selected.
SelectedTitleFontStyle Font style applied to the title text when the item is selected; defaults to bold.
SelectedTitleStrokeColor Border stroke colour of the title band when the item is selected.
ShowTitle When True, the title band is rendered above the body text inside the item block.
Sizeable When True, the item edges can be dragged to resize the appointment's start or end time.
StartTime Date and time at which the appointment starts; determines its initial position in the planner grid.
StrokeColor Border stroke colour of the item block in its normal state.
Tag Integer tag for associating application-defined numeric data with this item.
Text Body text displayed inside the item block; supports HTML markup when HTML rendering is active.
TextHorizontalTextAlign Horizontal text alignment of the body text within the item block.
TextVerticalTextAlign Vertical text alignment of the body text within the item block.
Title Title text displayed at the top of the item block; supports HTML markup when HTML rendering is active.
TitleColor Background fill colour of the title band in the normal state; use gcNull to inherit Color.
TitleFontColor Text colour of the title in the normal state.
TitleFontName Font family name applied to the title text in the normal state.
TitleFontSize Font size in points applied to the title text in the normal state.
TitleFontStyle Font style applied to the title text in the normal state; defaults to bold.
TitleHorizontalTextAlign Horizontal text alignment of the title text within the title band.
TitleStrokeColor Border stroke colour of the title band in the normal state.
TitleVerticalTextAlign Vertical text alignment of the title text within the title band.
UseDefaultAppearance When True, all colour and font settings are inherited from the global ItemsAppearance instead of per-item overrides.
Visible When True, the item is rendered in the planner; set to False to hide it without removing it from the collection.

Methods

Name Description
BeginUpdate Suspends visual updates so multiple property changes can be applied without intermediate repaints.
ConflictsForPosition Returns the number of overlapping items (conflicts) that this item has at the given resource position.
ConflictsPosForPosition Returns the conflict offset index of this item at the given resource position, used to determine its horizontal placement within a set of overlapping items.
DirtyItem Marks this item as requiring a repaint without scheduling a full planner update.
EndUpdate Resumes visual updates after a BeginUpdate call and optionally repaints or marks the item dirty.
GetFirstRect Returns the bounding rectangle of the first tile occupied by this item in the planner canvas.
GetLastRect Returns the bounding rectangle of the last tile occupied by this item in the planner canvas.
GetRect Returns the bounding rectangle of the item tile at the specified render index, or the first tile when AIndex is -1.
Planner Returns the planner data instance that owns this item.
RectCount Returns the number of tile rectangles occupied by this item across wrapped rows or spanned positions.
UpdateItem Schedules a full visual update for the item, optionally triggering a conflict recalculation and marking the item as dirty.

Used by