Application.GanttBarFormat Method
Project Developer Reference |
Formats Gantt bars.
Syntax
expression.GanttBarFormat(TaskID, GanttStyle, StartShape, StartType, StartColor, MiddleShape, MiddlePattern, MiddleColor, EndShape, EndType, EndColor, LeftText, RightText, TopText, BottomText, InsideText, Reset, ProjectName)
expression A variable that represents an Application object.
Parameters
Name | Required/Optional | Data Type | Description |
---|---|---|---|
TaskID | Optional | Long | The identification number of the task represented by the Gantt bar to be changed. The default is to change the Gantt bars of the selected tasks. |
GanttStyle | Optional | Integer | The style applied to the Gantt bar to be formatted. The value for GanttStyle is based on the position of the bar style in the list. For example, the value 3 returns the third bar style in the list. |
StartShape | Optional | Long | The start shape of the Gantt bar. Can be one of the PjBarEndShape constants. |
StartType | Optional | Long | The start type of the Gantt bar. Can be one of the PjBarType constants. |
StartColor | Optional | Long | The start color of the Gantt bar. Can be one of the PjColor constants. |
MiddleShape | Optional | Long | The middle shape of the Gantt bar. Can be one of the PjBarShape constants. |
MiddlePattern | Optional | Long | The middle pattern of the Gantt bar. Can be one of the PjFillPattern constants. |
MiddleColor | Optional | Long | The middle color of the Gantt bar. Can be one of the PjColor constants. |
EndShape | Optional | Long | The end shape of the Gantt bar. Can be one of the PjBarEndShape constants. |
EndType | Optional | Long | The end type of the Gantt bar. Can be one of the following PjBarType constants: pjDashed, pjFramed, or pjSolid. |
EndColor | Optional | Long | The end color of the Gantt bar. Can be one of the PjColor constants. |
LeftText | Optional | String | The task field to display to the left of the Gantt bar. |
RightText | Optional | String | The task field to display to the right of the Gantt bar. |
TopText | Optional | String | The task field to display above the Gantt bar. |
BottomText | Optional | String | The task field to display below the Gantt bar. |
InsideText | Optional | String | The task field to display inside the Gantt bar. |
Reset | Optional | Boolean | True if the bar formatting is reset to the default formatting of the style in the Bar Styles dialog box. |
ProjectName | Optional | String | The name of the project containing TaskID if consolidation is involved. The default value is the name of the active project. |
Return Value
Boolean
Remarks
Using the GanttBarFormat method without specifying any arguments displays the Bar Styles dialog box.
Use the GanttBarFormat method to change the formatting of Gantt bars from their default styles. To define the default styles, use the GanttBarStyleEdit method.
Example
The following example will display red diamond shape for the start of the task with the Task ID of 3.
Visual Basic for Applications |
---|
|
See Also