Application.GanttBarFormatEx method (Project)

Article
01/19/2022

Changes the formatting of Gantt bars from their default styles, where colors can be hexadecimal RGB values.

Syntax

expression. GanttBarFormatEx( _TaskID_, _GanttStyle_, _StartShape_, _StartType_, _StartColor_, _MiddleShape_, _MiddlePattern_, _MiddleColor_, _EndShape_, _EndType_, _EndColor_, _LeftText_, _RightText_, _TopText_, _BottomText_, _InsideText_, _Reset_, _ProjectName_ )

expression An expression that returns an Application object.

Parameters

Name	Required/Optional	Data type	Description
TaskID	Optional	Long	The identification number of the task to be changed on the Gantt chart. 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 Bar Styles dialog box. For example, the value 3 returns the third bar style in the list.
StartShape	Optional	Integer	The start shape of the Gantt bar. Can be one of the PjBarEndShape constants.
StartType	Optional	Integer	The start type of the Gantt bar. Can be one of the PjBarType constants.
StartColor	Optional	Long	The color of the start shape of the Gantt bar. Can be a hexadecimal RGB value, where red is the last byte. For example, &H00FFFF is yellow.
MiddleShape	Optional	Integer	The middle shape of the Gantt bar. Can be one of the PjBarShape constants.
MiddlePattern	Optional	Integer	The middle pattern of the Gantt bar. Can be one of the PjFillPattern constants.
MiddleColor	Optional	Long	The color of the middle section Gantt bar. Can be a hexadecimal RGB value, where red is the last byte. For example, &HFF00FF is purple.
EndShape	Optional	Integer	The end shape of the Gantt bar. Can be one of the PjBarEndShape constants.
EndType	Optional	Integer	The end type of the Gantt bar. Can be one of the following PjBarType constants: pjDashed, pjFramed, or pjSolid.
EndColor	Optional	Long	The color of the end shape of the Gantt bar. Can be a hexadecimal RGB value, where red is the last byte. For example, &HFFFF00 is blue-green.
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; otherwise, False.
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 GanttBarFormatEx method without specifying any arguments displays the Format Bar dialog box.

To define the default styles where colors can be hexadecimal RGB values, use the GanttBarEditEx method.

Example

The following example displays a medium red diamond shape for the start of the task with the Task ID of 3.

Sub GanttBar_Format() 
 
    'Activate Gantt Chart view 
    ViewApply Name:="&Gantt Chart" 
    GanttBarFormatEx TaskID:=3, StartShape:=pjDiamond, StartType:=pjSolid, StartColor:=&H8888FF
End Sub

Support and feedback

Have questions or feedback about Office VBA or this documentation? Please see Office VBA support and feedback for guidance about the ways you can receive support and provide feedback.

Share via