Using Scripts to Manage Project's Calendar Options

  • Article

Sample VBScript scripts that demonstrate how you can both retrieve and configure the Microsoft Project 2003 Calendar options.

Mapping the Dialog Box to the Project Object Model

The options referenced in the following scripts correspond to the options found on the Calendar tab of the Options dialog box. To access these options in Microsoft Project 2003, click Tools, click Options, and then click the Calendar tab. A mapping between the options available in this dialog box and the Microsoft Project object model is shown below.

calendar

Note that the item shown in orange does not have a corresponding property in the Project object model. The current value for Use starting year for FY numbering cannot be returned using the script for retrieving property values; however, the value for this item can be configured using the OptionsCalendar method. A sample script using OptionsCalendar is included on this page.

The scripts shown on this page were tested using Microsoft Project 2003. At least some of the functionality is likely to work on any version of Microsoft Project that supports Visual Basic for Applications (VBA); however, the scripts have not been tested using any of these other versions.

Sample Code for Retrieving Values

Sample script that retrieves the configuration information found on the Calendar tab in the Options dialog box in Microsoft Project 2003.

Set objProject = CreateObject("MSProject.Application")
objProject.Visible = TRUE
Set colProjects = objProject.Projects
Set objDoc = colProjects.Add()

Wscript.Echo "Week starts on: " & objProject.StartWeekOn
Wscript.Echo "Fiscal year starts in: " & objProject.StartYearIn
Wscript.Echo "Default start time: " & objDoc.DefaultStartTime
Wscript.Echo "Default end time: " & objDoc.DefaultFinishTime
Wscript.Echo "Hours per day: " & objDoc.HoursPerDay
Wscript.Echo "Hours per week: " & objDoc.HoursPerWeek
Wscript.Echo "Days per month: " & objDoc.DaysPerMonth

objProject.Quit

Sample Code for Modifying Values

Sample script that sets the starting day for the week to Monday.

Const pjDoNotSave = 0

Set objProject = CreateObject("MSProject.Application")

Set colProjects = objProject.Projects
Set objDoc = colProjects.Add()

objDoc.StartWeekOn = 2

objProject.Quit(pjDoNotSave)

Sample Code for Modifying Values Without Corresponding Properties

Sample script that enables the Use starting year for FY numbering option. The commas preceding the value TRUE represent other values that can be configured using this method; the blank parameters instruct the method to leave existing values for these items as-is. Note that this parameter can be changed only if you specify a month other than January for the Fiscal year starts in option.

Const pjJune = 6

Set objProject = CreateObject("MSProject.Application")

Set colProjects = objProject.Projects
Set objDoc = colProjects.Add()

objProject.StartYearIn = pjJune
Wscript.Sleep 3000
errReturn = objProject.OptionsCalendar(,,,,,,,,TRUE) 

objProject.Quit(pjDoNotSave)

The sample scripts are not supported under any Microsoft standard support program or service. The sample scripts are provided AS IS without warranty of any kind. Microsoft further disclaims all implied warranties including, without limitation, any implied warranties of merchantability or of fitness for a particular purpose. The entire risk arising out of the use or performance of the sample scripts and documentation remains with you. In no event shall Microsoft, its authors, or anyone else involved in the creation, production, or delivery of the scripts be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of the use of or inability to use the sample scripts or documentation, even if Microsoft has been advised of the possibility of such damages.