Gantt popup menu

TreeGrid documentation

new 7.1 upd 11.0 <C> <cell> string[*]

GanttMenu

[...]
Defines all items in right click popup menu in the Gantt column for given cell or whole column
It can be first character separated array of menu item names. The items can contain any HTML code. Separator can be shown as item named '-'
Or it can be in standard TreeGrid menu format as complex menu with sub levels, sub menus, columns and so on.
See also API ShowMenu function to show custom menu from JavaScript.

It is possible to change the order or remove some items.
You can also add new custom items and define OnGanttMenuClick API event to be called on click to the custom item.

The predefined menu item texts are defined in Text.xml, in <Lang><Gantt></Lang>.
Default Gantt menu is defined in Defaults.xml, in <D Name="Gantt" ... /> and contains all these items in this order:

Item name used in GanttMenu Text defined in Text.xmlWhen shown and notes
DelGanttConstraint Delete %d constraint Shown on constraint and constraints are editable
SplitGanttConstraint Split the %d constraint Shown on mandatory constraint and constraints are editable
ChangeGanttConstraint Set the constraint as %d Shows up to four items to change to all possible constraints. Shown on constraint and constraints are editable
 
DelGanttFlag Delete the flag Shown on flag and flags are editable
EditGanttFlag Enter the flag text Shown on flag and flags are editable and the GanttFlagTexts column is defined
ChooseGanttFlagIcon Select the flag icon Shown on flag and flags are editable and the GanttFlagIcons column is defined
 
DelGanttPoint Delete the point Shown on point and points are editable
 
DelGanttFlowPart Delete the real flow bar Shown on flow bar and the flow is editable (deleted 10.0)
Delete milestone Shown on flow milestone and the flow is editable (deleted 10.0)
SplitGanttFlow Split the real flow bar Shown on flow and the flow is editable (deleted 10.0)
SetGanttFlowPercent Update completed status here Shown on flow and the flow is editable and the GanttFlowComplete is defined (deleted 10.0)
EditGanttFlowPercent Enter completed status Shown on flow and the flow is editable and the GanttFlowComplete is defined (deleted 10.0)
EditGanttFlowText Enter the real flow information Shown on flow and the flow is editable and the GanttFlowText column is defined (deleted 10.0)
 
DelGanttMilestone Delete milestone Shown on milestone, the main bar is editable and GanttSummary is not set
SetGanttMilestone Set the milestone complete Shown on incomplete milestone, the main bar is editable, GanttSummary is not 1 and GanttComplete column is defined
Set the milestone incomplete Shown on complete milestone, the main bar is editable, GanttSummary is not 1 and GanttComplete column is defined
DelGanttMainPart Delete the bar (new 10.0) Shown on main bar, the main bar is editable and GanttSummary is not set and there are more main bar parts
DelGanttMain Delete the task Shown on main bar, the main bar is editable and GanttSummary is not set
DisableGanttMain Disable the task (new 10.0) Shown on main bar, the main bar is editable
Enable the task
LockGanttMain Lock the task (new 10.0) Shown on main bar, the main bar is editable
Unlock the task
SplitGanttMain Split the bar (new 10.0) Shown on main bar, the main bar is editable, GanttSummary is not set and the GanttParts is defined
SetGanttPercent Update completed status here Shown on main bar, the main bar is editable, GanttSummary is not set and GanttComplete column is defined
EditGanttPercent Enter completed status Shown on main bar, the main bar is editable, GanttSummary is not set and GanttComplete column is defined
EditGanttText Enter the main bar information Shown on main bar or milestone, the main bar is editable and GanttText column is defined
 
SelectGanttRunPart Select the box (new 10.0) Shown on run bar that is not selected
Unselect the box (new 10.0) Shown on selected run bar
DisableGanttRun Disable the task / Disable the box (new 10.0) Shown on run bar, the run bar is editable
Enable the task / Enable the box
LockGanttRun Lock the task / Lock the box (new 10.0) Shown on run bar, the run bar is editable
Unlock the task / Unlock the box
LockGanttRunContainer Lock all %d boxes in container (new 13.0) Shown on run container, the run container is editable
DisableGanttRunContainer Disable all %d boxes in container (new 13.0) Shown on run container, the run container is editable
EnableGanttRunContainer Enable all %d boxes in container (new 13.0) Shown on run container, the run container is editable
SplitGanttRun Split the bar / Split the box (new 10.0) Shown on run bar except End/Bound and the run is editable and GanttRunError contains 'Merge'
EditGanttRun Change the box text Shown on run bar except End/Bound and the run is editable
EditGanttRunTip Change the box information Shown on run bar except End/Bound and the run is editable
ChooseGanttRunType Change the box Shown on run bar except End/Bound and the run is editable
ChooseGanttRunContainer Change the container (new 13.0) Shown on run container, the run container is editable
AddGanttRunContainer Add new container for the box (new 13.0) Shown on run bar except End/Bound and the run is editable
-
DelGanttRunPart Delete the box Shown on run bar except End/Bound and the run is editable
DelGanttRunContainerOnly Delete the container (new 13.0) Shown on run container, the run container is editable
-
SelectGanttRun Select all boxes (new 10.0) Shown if there is no selected box in the row / grid
UnselectGanttRun Unselect all boxes (new 10.0) Shown if there are some selected boxes in row / grid
JoinGanttRunSelected Join selected boxes (new 11.0) Shown when there are available selected bars that can be joined by Nbsp
SplitGanttRunJoined Split joined boxes (new 11.0) Shown on joined run bar
JoinGanttRunAdjacent Join adjacent boxes (new 11.0) Shown on adjacent run bar that can be directly joined
SplitGanttRunAdjacent Split joined adjacent boxes (new 11.0) Shown on directly joined run bar
ChooseGanttRunSelectedType Change selected %d boxes (new 10.0) Shown if there are some selected boxes in the row / grid
ChooseGanttRunGroupType Change %d boxes in row group Shown on run bar except End/Bound and the run is editable. Only if there are more boxes with the same Group attribute as this box in the same row
ChooseGanttRunGroupAllType Change %d boxes in group Shown on run bar except End/Bound and the run is editable. Only if there is a box with the same Group attribute as this box in another row
ChooseGanttRunRowType Change all %d boxes in row (new 11.0) Shown on run bar except End/Bound and the run is editable. Only if there is a box with the same Group attribute as this box in another row
ChooseGanttRunContainerType Change all %d boxes in container (new 13.0) Shown on run container, the run container is editable
-
DelGanttRunSelected Delete selected boxes (%d boxes) (new 11.0) Shown if there are some selected boxes in the row / grid
DelGanttRunGroup Delete row group (%d boxes) Shown on run bar except End/Bound and the run is editable. Only if there are more boxes with the same Group attribute as this box in the same row
DelGanttRunGroupAll Delete group (%d boxes) Shown on run bar except End/Bound and the run is editable. Only if there is a box with the same Group attribute as this box in another row
-
SetGanttRunMilestone Set the milestone complete Shown on incomplete run Milestone or Stop, the run is editable, GanttRunComplete column is defined. Only if the run contains only the box.
Set the milestone incomplete Shown on complete run Milestone or Stop, the run bar is editable, GanttRunComplete column is defined. Only if the run contains only the box.
SetGanttRunPercent Update completed status here Shown on run bar, the run is editable, GanttRunComplete column is defined. Except the run contains the only milestone.
EditGanttRunPercent Enter completed status Shown on run bar, the run is editable, GanttRunComplete column is defined. Except the run contains the only milestone.
EditGanttRunText Enter the task information Shown on run bar, the run is editable, GanttRunText column is defined.
-
EditGanttResource Change resources Shown if resources are editable and GanttResources column is defined
GanttDepLagChange Change the dependency lag (chg 10.0) Show on dependency line and the dependencies and lags are editable
-
DelGanttDep Delete the dependency (chg 10.0) Show on dependency line and the dependencies are editable
DelAllGanttDep Disconnect all dependencies Shown if there is some incoming/outgoing dependency in any GanttTask in the cell
DelGanttMainDep Delete main bar and dependencies Shown if there is some incoming/outgoing dependency and the GanttTask bar (main or flow or run) that is editable (deleted 10.0)
Delete milestone and dependenciesShown if there is some incoming/outgoing dependency and milestone and the main bar is in the GanttTask and the main bar is editable (deleted 10.0)
DelGanttMainBar Delete the task Shown on main bar and the main bar is editable
DelGanttMainAll Delete all tasks (new 10.0) Shown if there is main bar and the main bar is editable
DelGanttFlow Delete real flow Shown if there is flow bar and the flow is editable and GanttFlowComplete column is not defined (deleted 10.0)
Delete main bar Shown if there is flow bar and the flow is editable and GanttFlowComplete column is defined (deleted 10.0)
DelGanttRun Delete all boxes Shown if there is run bar and the run is editable
DelGanttRunContainer Delete all %d boxes in container (new 13.0) Shown on run container, the run container is editable
DelGanttFlags Delete all flags Shown if there is some flag and the flags are editable
DelGanttPoints DelGanttPoints Shown if there is some editable point
DelGanttConstraints Delete all constraints Shown if there is some constraint and the constraints are editable
DelGanttAll Clear the gantt cell Shown if there is any object in the cell that can be deleted
-
NewGanttFlag Add new flag to selected point Shown if there is no flag under mouse, the flags are editable, GanttFlags column is defined and the adding does not violate constraints
NewGanttPoint Add new point to selected point Shown if it is possible to add new point here
NewGanttConstraint Add %d constraint here Shows up to six items for every constraint that can be added to this place
NewGanttMilestone Add new milestone here Shown if there is neither main bar nor milestone, the main bar is editable, GanttStart column is defined and the adding does not violate constraints
NewGanttEndMilestone Add new ending milestone here Shown if there is neither main bar nor milestone, the main bar is editable, GanttEnd column is defined and the adding does not violate constraints
NewGanttFlowMilestone Add new milestone here Shown if there is no flow bar under mouse, the flow is editable, GanttFlowComplete is defined and the adding does not violate constraints (deleted 10.0)
NewGanttFlowEndMilestone Add new ending milestone here Shown if there is no flow bar under mouse, the flow is editable, GanttFlowComplete is defined and the adding does not violate constraints (deleted 10.0)
NewGanttRunMilestone Add new milestone here Shown if there is no run bar under mouse, the run is editable, GanttRun column is defined, GanttRunMilestones=1 and the adding does not violate constraints
NewGanttRunStop Add new stop here Shown if there is no run bar under mouse, the run is editable, GanttRun column is defined, GanttRunMilestones=1 and the adding does not violate constraints
-
SetGanttBase Set project start here Shown on computed start line (if GanttBase is empty) and GanttBaseCanEdit is set
DelGanttBase Delete project start Shown on start line (if GanttBase is not empty) and GanttBaseCanEdit is set
SetGanttFinish Set project finish here Shown on computed finish line (if GanttFinish is empty) and GanttFinishCanEdit is set
DelGanttFinish Delete project finish Shown on finish line (if GanttFinish is not empty) and GanttFinishCanEdit is set
CorrectRelatedDependencies Correct related dependencies Shown on Gantt task if there is some dependency error in the group related to this task
CorrectAllDependencies Correct all dependencies in chart Shown if there is some dependency error in chart
-
ZoomBar Zoom to bar (new 10.0) Shown on bar (main or run) and GanttSmoothZoom>=1
ZoomAll Zoom to all objects (new 10.0) Shown if the cell contains some object (Main, Run, Flags, Points) and GanttSmoothZoom>=1
ZoomHeader Zoom to %d %d - %d (new 10.0) Shows more menu items, one per Gantt header row with different units
ZoomUndo Zoom back to %d (new 10.0) Shown to undo last zoom change
ZoomIn Zoom in to %d (new 10.0) Shown if it is possible to increase zoom level
ZoomOut Zoom out to %d (new 10.0) Shown if it is possible to decrease zoom level
ZoomFit Zoom fit to actual space (new 10.0) Shown always

Any other item name is custom name and its click must be handled by OnGanttMenuClick API event.
new 7.1 API event string

OnGetGanttMenu

(TGrid grid, TRow row, string col, string menu, object GanttXY)
Called to get the popup GanttMenu attribute dynamically by JavaScript.
menu is the original menu for the cell with all default and custom values. It should return new menu string.
GanttXY is object returned by GetGanttXY method and contains information about the Gantt bar(s) under mouse cursor.
new 6.1 API event bool

OnGanttMenu

(TGrid grid, TRow row, string col, TMenu Menu, object GanttXY)
Called before the Gantt popup menu is displayed for the appropriate cell.
Menu is TreeGrid JavaScript TMenu object, here can be changed, items modified, added or deleted and so on.
GanttXY is object returned by GetGanttXY method and contains information about the Gantt bar(s) under mouse cursor.
Return true to cancel showing menu.
new 7.1 chg 10.0 API event bool

OnGanttMenuClick

(TGrid grid, TRow row, string col, string name, TMenuItem Item, object GanttXY)
Called when a user clicks to an item in GanttMenu. Since 10.0 it is called for all GanttMenu items, not only for custom ones.
name is clicked custom item Name or standard item Text, Item is the whole clicked item object.
GanttXY is object returned by GetGanttXY method and contains information about the Gantt bar(s) under mouse cursor in time of the menu display.
Return true to suppress default behavior.
<Actions>

GanttMenu

Attached to OnRightClickGantt event
Shows popup menu with available actions for given clicked point in the Gantt cell.
chg 6.0 <C> <cell> string[*]

Menu

[...]
For compatibility with 6.x and 7.0 version only. In 7.1+ version use GanttMenu attribute instead.
Context (popup) menu for the Gantt cell to add custom items to the default Gantt menu.
chg 6.0 API event bool

OnContextMenu

(TGrid grid, TRow row, string col, string result)
Called when user clicks to context menu set by Menu attribute.
result is Value or Name of the clicked item or all value.
Return true to not close the menu.