Public Member Functions | |
| Builder (TAbstractCalendarView component) | |
| virtual TBuilder | StartDay (int startDay) |
| The 0-based index for the day on which the calendar week begins (0=Sunday, which is the default) More... | |
| virtual TBuilder | DDCreateEventText (string dDCreateEventText) |
| The text to display inside the drag proxy while dragging over the calendar to create a new event (defaults to 'Create event for {0}' where {0} is a date range supplied by the view) More... | |
| virtual TBuilder | DDMoveEventText (string dDMoveEventText) |
| The text to display inside the drag proxy while dragging an event to reposition it (defaults to 'Move event to {0}' where {0} is the updated event start date/time supplied by the view) More... | |
| virtual TBuilder | DDResizeEventText (string dDResizeEventText) |
| The string displayed to the user in the drag proxy while dragging the resize handle of an event (defaults to 'Update event to {0}' where {0} is the updated event start-end range supplied by the view). Note that this text is only used in views that allow resizing of events. More... | |
| virtual TBuilder | EnableAddFx (bool enableAddFx) |
| True to enable a visual effect on adding a new event (the default), false to disable it. Note that if enableFx is false it will override this value. The specific effect that runs is defined in the doAddFx method. More... | |
| virtual TBuilder | EnableDD (bool enableDD) |
| True to enable drag and drop in the calendar view (the default), false to disable it More... | |
| virtual TBuilder | EnableFx (bool enableFx) |
| True to enable a visual effect on adding a new event (the default), false to disable it. Note that if enableFx is false it will override this value. The specific effect that runs is defined in the doAddFx method. More... | |
| virtual TBuilder | EnableRemoveFx (bool enableRemoveFx) |
| True to enable a visual effect on removing an event (the default), false to disable it. Note that if enableFx is false it will override this value. The specific effect that runs is defined in the doRemoveFx method. More... | |
| virtual TBuilder | EnableUpdateFx (bool enableUpdateFx) |
| True to enable a visual effect on updating an event, false to disable it (the default). Note that if enableFx is false it will override this value. The specific effect that runs is defined in the doUpdateFx method. More... | |
| virtual TBuilder | MonitorResize (bool monitorResize) |
| True to monitor the browser's resize event (the default), false to ignore it. If the calendar view is rendered into a fixed-size container this can be set to false. However, if the view can change dimensions (e.g., it's in fit layout in a viewport or some other resizable container) it is very important that this config is true so that any resize event propagates properly to all subcomponents and layouts get recalculated properly. More... | |
| virtual TBuilder | SpansHavePriority (bool spansHavePriority) |
| Allows switching between two different modes of rendering events that span multiple days. When true, span events are always sorted first, possibly at the expense of start dates being out of order (e.g., a span event that starts at 11am one day and spans into the next day would display before a non-spanning event that starts at 10am, even though they would not be in date order). This can lead to more compact layouts when there are many overlapping events. If false (the default), events will always sort by start date first which can result in a less compact, but chronologically consistent layout. More... | |
| virtual TBuilder | TrackMouseOver (bool trackMouseOver) |
| Whether or not the view tracks and responds to the browser mouseover event on contained elements (defaults to true). If you don't need mouseover event highlighting you can disable this. More... | |
Detailed Description
- Type Constraints
-
TAbstractCalendarView : AbstractCalendarView TBuilder : Builder TBuilder : TAbstractCalendarView TBuilder : TBuilder
Constructor & Destructor Documentation
◆ Builder()
|
inline |
Member Function Documentation
◆ DDCreateEventText()
|
inlinevirtual |
The text to display inside the drag proxy while dragging over the calendar to create a new event (defaults to 'Create event for {0}' where {0} is a date range supplied by the view)
◆ DDMoveEventText()
|
inlinevirtual |
The text to display inside the drag proxy while dragging an event to reposition it (defaults to 'Move event to {0}' where {0} is the updated event start date/time supplied by the view)
◆ DDResizeEventText()
|
inlinevirtual |
The string displayed to the user in the drag proxy while dragging the resize handle of an event (defaults to 'Update event to {0}' where {0} is the updated event start-end range supplied by the view). Note that this text is only used in views that allow resizing of events.
◆ EnableAddFx()
|
inlinevirtual |
True to enable a visual effect on adding a new event (the default), false to disable it. Note that if enableFx is false it will override this value. The specific effect that runs is defined in the doAddFx method.
◆ EnableDD()
|
inlinevirtual |
True to enable drag and drop in the calendar view (the default), false to disable it
◆ EnableFx()
|
inlinevirtual |
True to enable a visual effect on adding a new event (the default), false to disable it. Note that if enableFx is false it will override this value. The specific effect that runs is defined in the doAddFx method.
◆ EnableRemoveFx()
|
inlinevirtual |
True to enable a visual effect on removing an event (the default), false to disable it. Note that if enableFx is false it will override this value. The specific effect that runs is defined in the doRemoveFx method.
◆ EnableUpdateFx()
|
inlinevirtual |
True to enable a visual effect on updating an event, false to disable it (the default). Note that if enableFx is false it will override this value. The specific effect that runs is defined in the doUpdateFx method.
◆ MonitorResize()
|
inlinevirtual |
True to monitor the browser's resize event (the default), false to ignore it. If the calendar view is rendered into a fixed-size container this can be set to false. However, if the view can change dimensions (e.g., it's in fit layout in a viewport or some other resizable container) it is very important that this config is true so that any resize event propagates properly to all subcomponents and layouts get recalculated properly.
◆ SpansHavePriority()
|
inlinevirtual |
Allows switching between two different modes of rendering events that span multiple days. When true, span events are always sorted first, possibly at the expense of start dates being out of order (e.g., a span event that starts at 11am one day and spans into the next day would display before a non-spanning event that starts at 10am, even though they would not be in date order). This can lead to more compact layouts when there are many overlapping events. If false (the default), events will always sort by start date first which can result in a less compact, but chronologically consistent layout.
◆ StartDay()
|
inlinevirtual |
The 0-based index for the day on which the calendar week begins (0=Sunday, which is the default)
◆ TrackMouseOver()
|
inlinevirtual |
Whether or not the view tracks and responds to the browser mouseover event on contained elements (defaults to true). If you don't need mouseover event highlighting you can disable this.
The documentation for this class was generated from the following file:
- AbstractCalendarViewBuilder.cs
