Office VBA Reference

https://learn.microsoft.com/en-us/office/vba/
Admin
Comprehensive documentation and reference guide for Microsoft Office Visual Basic for Applications...
Tokens:12,237,678
Snippets:116,902
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### PickerResult object example

Source: https://learn.microsoft.com/en-us/office/vba/api/office.pickerresult

Example showing how to configure PickerDialog properties and display the dialog to get results.

```APIDOC
## PickerResult object (Office)

### Description
Represents a resolved or selected item of data.

### Example

The following code sets the **PickerDialog** properties and then displays the **PickerDialog**.

```vb
Dim objPickerDialog As PickerDialog 
Dim objPickerProperties As PickerProperties 
Dim objPickerProperty As PickerProperty 
Dim objPickerExistingResults As PickerResults 
Dim objPickerExistingResult As PickerResult 
Dim objPickerResults As PickerResults 


' Configure the Picker Dialog properties. 
Set objPickerDialog = Application.PickerDialog 
objPickerDialog.DataHandlerId = "{000CDF0A-0000-0000-C000-000000000046}" 
objPickerDialog.Title = "Sample Picker Dialog" 
Set objPickerProperties = objPickerDialog.Properties 
Set objPickerProperty = objPickerProperties.Add("SiteUrl", "https://my", msoPickerFieldtypeText) 
Set objPickerExistingResults = objPickerDialog.CreatePickerResults 
Set objPickerExistingResult = objPickerExistingResults.Add("johndoe@contoso.com", "John Doe", "User") 

' Show the Picker Dialog and get the results. 
Set objPickerResults = objPickerDialog.Show(True, objPickerExistingResult)
```

### See also
- PickerResult object members
- Object Model Reference
```

--------------------------------

### VBA example: Start synchronization for selected Send/Receive groups

Source: https://learn.microsoft.com/en-us/office/vba/api/outlook.syncobject.start

This example displays all Send/Receive groups set up for the user and starts synchronization for each group the user confirms with a Yes response. It uses the Outlook NameSpace, SyncObjects, and SyncObject objects.

```VB
Public Sub Sync() 
 Dim nsp As Outlook.NameSpace 
 Dim sycs As Outlook.SyncObjects 
 Dim syc As Outlook.SyncObject 
 Dim i As Integer 
 Dim strPrompt As Integer 
 Set nsp = Application.GetNamespace("MAPI") 
 Set sycs = nsp.SyncObjects 
 For i = 1 To sycs.Count 
Set syc = sycs.Item(i) 
strPrompt = MsgBox( _ 
 "Do you wish to synchronize " & syc.Name &"?", vbYesNo) 
If strPrompt = vbYes Then 
 syc.Start 
End If 
 Next 
End Sub
```

--------------------------------

### Project.ProjectStart property

Source: https://learn.microsoft.com/en-us/office/vba/api/project.project.projectstart

Gets or sets the start date for a project. Read/write Variant. Setting this property also causes the project to be scheduled from its start date.

```APIDOC
## Project.ProjectStart property

### Description
Gets or sets the start date for a project. Read/write **Variant**.

### Syntax
_expression_.`ProjectStart`

_expression_ A variable that represents a **Project** object.

### Remarks
Setting **ProjectStart** value also causes the project to be scheduled from its start date. This has the same effect as setting the **ScheduleFromStart** property to **True**.

### Property Value
Variant
```

--------------------------------

### Window.ShowGuides property

Source: https://learn.microsoft.com/en-us/office/vba/api/visio.window.showguides

Gets or sets whether guides are shown in a window. Read/write.

```APIDOC
## Window.ShowGuides property

### Description
Determines whether guides are shown in a window. Read/write.

### Syntax
_expression_.`ShowGuides`

_expression_ A variable that represents a **Window** object.

### Return value
Integer

### Remarks
Setting the **ShowGuides** property is equivalent to selecting **Guides** in the **Show/Hide** group on the **View** tab.
```

--------------------------------

### UserForm_Initialize - Set up text boxes and toggle button

Source: https://learn.microsoft.com/en-us/office/vba/language/reference/user-interface-help/zorder-method-textbox-control-example

Initializes the form by setting the text, size, and position of the three TextBox controls so they overlap, and configures the ToggleButton's initial state, caption, and position. This setup is required for the z-order example to work correctly.

```VB
Private Sub UserForm_Initialize() 
'Set up text boxes to show z-order in the form 
TextBox1.Text = "TextBox 1" 
TextBox2.Text = "TextBox 2" 
TextBox3.Text = "TextBox 3" 
 
TextBox1.Height = 40 
TextBox2.Height = 40 
TextBox3.Height = 40 
 
TextBox1.Width = 60 
TextBox2.Width = 60 
TextBox3.Width = 60 
 
TextBox1.Left = 10 
TextBox1.Top = 10 
 
TextBox2.Left = 25 'Overlap TextBox2 on TextBox1 
TextBox2.Top = 25 
 
TextBox3.Left = 40 'Overlap TextBox3 on TextBox2, TextBox1 
TextBox3.Top = 40 
 
ToggleButton1.Value = False 
ToggleButton1.Caption = "Bring TextBox2 to Front" 
ToggleButton1.Left = 10 
ToggleButton1.Top = 90 
ToggleButton1.Width = 50 
ToggleButton1.Height = 50 
 
End Sub

```

--------------------------------

### Application.HelpLaunch method

Source: https://learn.microsoft.com/en-us/office/vba/api/project.application.helplaunch

Starts a Help file. This method is part of the Application object in the Project object model.

```APIDOC
## Application.HelpLaunch method

### Description
Starts a Help file.

### Syntax
_expression_.`HelpLaunch`( `_FileName_`, `_ContextNumber_`, `_Search_`, `_SearchKey_` )

_expression_ A variable that represents an **Application** object.

### Parameters

#### Parameters
- **FileName** (String) - Optional - The file name (with either .hlp or .chm extension) of the Help file to start. If FileName is not specified and Search is **False**, the Project **Help** window appears with the navigation pane expanded.
- **ContextNumber** (Long) - Optional - The context number of a topic to display.
- **Search** (Boolean) - Optional - **True** if the **Help** window appears with the navigation pane expanded (CHM). If Search is **True**, ContextNumber is ignored. The default value is **False**.
- **SearchKey** (String) - Optional - Due to changes in the Project object model, this argument is no longer supported.

### Return value
**Boolean**
```

--------------------------------

### Display the Access GUID using ProductCode

Source: https://learn.microsoft.com/en-us/office/vba/api/access.application.productcode

This example uses the ProductCode property to retrieve and display the GUID for the Microsoft Access installation in a message box.

```vb
MsgBox "The GUID for Microsoft Access on this computer is " & Application.ProductCode & "."
```

--------------------------------

### SwitchDocsInsideUndo Example

Source: https://learn.microsoft.com/en-us/office/vba/word/concepts/working-with-word/working-with-the-undorecord-object

Example showing the behavior when switching documents inside a custom undo record.

```APIDOC
## SwitchDocsInsideUndo Example

### Description
Demonstrates that switching documents inside a custom undo record terminates the record when writing to the second document. Only the first document will have the custom undo record.

### Code

```vb
Dim objUndo As UndoRecord 

Sub SwitchDocsInsideUndo() 
  Set objUndo = Application.UndoRecord 
  objUndo.StartCustomRecord ("New Paragraph") 
  
  'Insert some text into the first document 
  Documents(1).Content.InsertAfter "A new paragraph in doc1." 
  
  'Switch documents to the second document 
  'The custom undo record will terminate here 
  Documents(2).Content.InsertAfter "A new paragraph in doc2." 
  
  objUndo.EndCustomRecord 
End Sub
```
```

--------------------------------

### Application.FilePageSetup method

Source: https://learn.microsoft.com/en-us/office/vba/api/project.application.filepagesetup

Displays the Page Setup dialog box for the specified view. Equivalent to clicking Page Setup on the File menu.

```APIDOC
## Application.FilePageSetup method (Project)

### Description
Displays the **Page Setup** dialog box. Equivalent to clicking **Page Setup** on the **File** menu.

### Syntax
_expression_. `FilePageSetup`( `_Name_` )

_expression_ A variable that represents an **Application** object.

### Parameters
| Name | Required/Optional | Data type | Description |
|------|-------------------|-----------|-------------|
| _Name_ | Optional | **Variant** | The name of the view for which to set up pages for printing. The default value is the name of the active view. |

### Return value
**Boolean**
```

--------------------------------

### Get the starting position of a phonetic text string

Source: https://learn.microsoft.com/en-us/office/vba/api/excel.phonetics.start

This example sets phonetic text for a cell and then retrieves the starting position of the second phonetic entry.

```vba
ActiveCell.FormulaR1C1 = "東京都渋谷区代々木" 
ActiveCell.Phonetics.Add Start:=1, Length:=3, Text:="トウキョウト" 
ActiveCell.Phonetics.Add Start:=4, Length:=3, Text:="シブヤク" 
MsgBox ActiveCell.Phonetics(2).Start
```

--------------------------------

### Apply administrative permission policy example

Source: https://learn.microsoft.com/en-us/office/vba/visio/how-to/use-information-rights-management-for-visio

This example checks whether the active document is protected and, if not, protects it and applies an administrative permission policy.

```APIDOC
## Apply administrative permission policy example

### Description
This example checks whether the active document is protected and, if it is not, protects the document and applies an administrative permission policy.

### Code (VBA)
```vb
Dim irmPermission As Office.Permission 
Set irmPermission = ActiveDocument.Permission 
Dim strIRMInfo As String 
Select Case irmPermission.Enabled 
Case True 
strIRMInfo = "Permissions are already restricted on this document." 
Case False 
With irmPermission 
.Enabled = True 
.ApplyPolicy ("\\server\share\permissionpolicy.xml") 
End With 
strIRMInfo = "Permissions are now restricted on this document " & _ 
vbCrLf & _ 
" and the permission policy has been applied." 
End Select 
MsgBox strIRMInfo, vbInformation + vbOKOnly, "IRM Information" 
Set irmPermission = Nothing
```
```

--------------------------------

### Split function example: split string by delimiter and retrieve substrings

Source: https://learn.microsoft.com/en-us/office/vba/language/reference/user-interface-help/split-function

Shows how to use the Split function to break a string into an array using different delimiters, and how to retrieve a specific element by index or by searching with InStr. The delimiter determines whether spaces are preserved in the returned substrings. The example also demonstrates calling Split directly with an index to get a single value without storing the whole array.

```vb
Dim strFull As String
Dim arrSplitStrings1() As String
Dim arrSplitStrings2() As String
Dim strSingleString1 As String
Dim strSingleString2 As String
Dim strSingleString3 As String
Dim i As Long

strFull = "Dow - Fonseca - Graham - Kopke - Noval - Offley - Sandeman - Taylor - Warre"    ' String that will be used. 

arrSplitStrings1 = Split(strFull, "-")      ' arrSplitStrings1 will be an array from 0 To 8. 
                                            ' arrSplitStrings1(0) = "Dow " and arrSplitStrings1(1) = " Fonesca ". 
                                            ' The delimiter did not include spaces, so the spaces in strFull will be included in the returned array values. 

arrSplitStrings2 = Split(strFull, " - ")    ' arrSplitStrings2 will be an array from 0 To 8. 
                                            ' arrSplitStrings2(0) = "Dow" and arrSplitStrings2(1) = "Fonesca". 
                                            ' The delimiter includes the spaces, so the spaces will not be included in the returned array values. 

'Multiple examples of how to return the value "Kopke" (array position 3). 

strSingleString1 = arrSplitStrings2(3)      ' strSingleString1 = "Kopke". 

strSingleString2 = Split(strFull, " - ")(3) ' strSingleString2 = "Kopke".
                                            ' This syntax can be used if the entire array is not needed, and the position in the returned array for the desired value is known. 

For i = LBound(arrSplitStrings2, 1) To UBound(arrSplitStrings2, 1)
    If InStr(1, arrSplitStrings2(i), "Kopke", vbTextCompare) > 0 Then
        strSingleString3 = arrSplitStrings2(i)
        Exit For
    End If 
Next i


```

--------------------------------

### Apply a user's permission example

Source: https://learn.microsoft.com/en-us/office/vba/visio/how-to/use-information-rights-management-for-visio

This example demonstrates how to add a user with Read and Edit permissions to the active document and set an expiration date for those permissions.

```APIDOC
## Apply a user's permission example

### Description
This example gives a user a combination of Read and Edit permissions on the active document and sets an expiration date for these permissions.

### Code (VBA)
```vb
Dim objPermission As Office.Permission
Dim objUserPerm As Office.UserPermission

Set objPermission = ActiveDocument.Permission
Set objUserPerm = objPermission.Add( _
"<user>@<domain>.com", _
msoPermissionRead + msoPermissionEdit, #12/31/2016#)
MsgBox "Permissions added for " & _
objUserPerm.UserId, _
vbInformation + vbOKOnly, _
"Permissions Added"
Set objUserPerm = Nothing
```
```

--------------------------------

### List permitted users example

Source: https://learn.microsoft.com/en-us/office/vba/visio/how-to/use-information-rights-management-for-visio

This example checks whether the active document is protected and, if it is, lists users and their assigned permissions.

```APIDOC
## List permitted users example

### Description
This example checks whether the active document is protected and, if it is, lists users and their assigned permissions.

### Code (VBA)
```vb
Dim irmPermission As Office.Permission 
Dim irmUserPerm As Office.UserPermission 
Dim strIRMInfo As String 
Set irmPermission = ActiveDocument.Permission 
If irmPermission.Enabled Then 
For Each irmUserPerm In irmPermission 
strIRMInfo = strIRMInfo & irmUserPerm.UserId & vbCrLf & _ 
" - Permissions: " & irmUserPerm.Permission & vbCrLf & _ 
" - Expiration Date: " & irmUserPerm.ExpirationDate & vbCrLf 
Next 
MsgBox strIRMInfo, _ 
vbInformation + vbOKOnly, "IRM Information" 
Else 
MsgBox "This document is not restricted.", _ 
vbInformation + vbOKOnly, "IRM Information" 
End If 
Set irmUserPerm = Nothing 
Set irmPermission = Nothing
```
```

--------------------------------

### VBA function to get task ID by GUID

Source: https://learn.microsoft.com/en-us/office/vba/api/project.project.gettaskindexbyguid

Returns the local task ID for a task with the specified GUID. The example assumes the task ID is 6 and uses ActiveProject.GetTaskIndexByGuid with a hardcoded GUID.

```VB
Function TestTaskId() As Long 
 TestTaskId = ActiveProject.GetTaskIndexByGuid("341A479D-73A5-4209-9366-8EA2B836255B") 
End Function

```

--------------------------------

### InitializeMAPI example

Source: https://learn.microsoft.com/en-us/office/vba/api/outlook.namespace.logon

A code example demonstrating how to start Outlook with the default profile without using the Logon method, by instantiating the Outlook Application object and referencing a default folder.

```APIDOC
## InitializeMAPI example

### Description
This example shows how to start Outlook with the default profile without using the Logon method. It instantiates the Outlook Application object and references a default folder to initialize MAPI.

### Code
```vb
Sub InitializeMAPI ()

    ' Start Outlook.
    Dim olApp As Outlook.Application
    Set olApp = CreateObject("Outlook.Application")
    
    ' Get a session object. 
    Dim olNs As Outlook.NameSpace
    Set olNs = olApp.GetNamespace("MAPI")
    
    ' Create an instance of the Inbox folder. 
    ' If Outlook is not already running, this has the side
    ' effect of initializing MAPI.
    Dim mailFolder As Outlook.Folder
    Set mailFolder = olNs.GetDefaultFolder(olFolderInbox)

    ' Continue to use the object model to automate Outlook.
End Sub
```
```

--------------------------------

### AddIn.Installed property (Word)

Source: https://learn.microsoft.com/en-us/office/vba/api/word.addin.installed

Documentation for the Installed property of the AddIn object in Word VBA. It describes how to get or set whether an add-in is loaded, with syntax, remarks, and code examples.

```APIDOC
## [Property] Installed

### Description
Gets or sets a Boolean value that indicates whether the specified add-in is installed (loaded). Add-ins that are loaded are selected in the Templates and Add-ins dialog box. Read/write Boolean.

### Syntax
_expression_.`Installed`

_expression_ An expression that returns an 'AddIn' object.

### Property Value
Boolean

### Remarks
Uninstalled add-ins are included in the AddIns collection. To remove a template or WLL from the AddIns collection, apply the Delete method to the AddIn object (the add-in name is removed from the Templates and Add-ins dialog box). To unload all templates and WLLs, apply the Unload method to the AddIns collection.

### Examples

#### Example 1: Unload a global template
```vb
Addins("Gallery.dot").Installed = False
```

#### Example 2: Load a WLL
```vb
Addins("C:\Templates\FindAll.wll").Installed = True
```

#### Example 3: Load a custom template
```vb
AddIns("C:\Program Files\Microsoft Office\" _ 
 & "Templates\Custom.dot").Installed = True
```

#### Example 4: Check if a template is loaded
```vb
If AddIns("Dot1.dot").Installed = True Then _ 
 StatusBar = "Dot1.dot is loaded"
```
```

--------------------------------

### InitSettings method example (VBA)

Source: https://learn.microsoft.com/en-us/office/vba/api/visio.viswebpagesettings.initsettings

Shows how to use the InitSettings method to reinitialize webpage settings to those saved in an earlier instance of Visio. Before running, replace `path\filename` with a valid path and file name for the webpage project file.

```VBA
Public Sub InitSettings_Example() 
 Dim vsoSaveAsWeb As VisSaveAsWeb 
 Dim vsoWebSettings As VisWebPageSettings 

 Set vsoSaveAsWeb = Visio.Application.SaveAsWebObject 
 Set vsoWebSettings = vsoSaveAsWeb.WebPageSettings 

 With vsoWebSettings 
 .InitSettings 
 .TargetPath = "path\filename" 
 End With 

 vsoSaveAsWeb.CreatePages 
End Sub

```

--------------------------------

### Get start and end positions of first bookmark in active document (VBA)

Source: https://learn.microsoft.com/en-us/office/vba/api/word.document.bookmarks

Uses ActiveDocument.Bookmarks(1) to access the first bookmark and retrieves its .Start and .End character positions. The example assumes a bookmark exists in the active document.

```VB
With ActiveDocument.Bookmarks(1) 
 BookStart = .Start 
 BookEnd = .End 
End With

```

--------------------------------

### Application.DisplayProjectGuide property

Source: https://learn.microsoft.com/en-us/office/vba/api/project.application.displayprojectguide

Gets a Boolean value indicating whether the Project Guide is shown by default on startup for all new projects. This property is read-only.

```APIDOC
## Application.DisplayProjectGuide property

### Description
Gets a Boolean value indicating whether the Project Guide is shown by default on startup for all new projects. This property is read-only.

### Syntax
_expression_.`DisplayProjectGuide`

_expression_ A variable that represents an **Application** object.

### Property Value
Read-only **Boolean**.

### Remarks
None.

### Example
No example is provided in the source documentation.

```

--------------------------------

### UndoInUndoRecord Example

Source: https://learn.microsoft.com/en-us/office/vba/word/concepts/working-with-word/working-with-the-undorecord-object

Example showing how to call the Undo method from within a custom undo record.

```APIDOC
## UndoInUndoRecord Example

### Description
Demonstrates calling the Undo method from inside a custom undo record. Each action prior to the Undo method call is undone, while actions after the call are placed on the undo stack.

### Code

```vb
Sub UndoInUndoRecord() 
   
  Set objUndo = Application.UndoRecord 
  
  objUndo.StartCustomRecord ("New Paragraph") 
  
  ActiveDocument.Content.InsertAfter Text:=" The end." 
  ActiveDocument.Undo 
  ActiveDocument.Content.InsertAfter Text:=" The end, again." 
  ActiveDocument.Content.InsertAfter Text:=" The last end." 
 
  objUndo.EndCustomRecord 
 
End Sub
```
```

--------------------------------

### Example: Display start of selected task with DateFormat

Source: https://learn.microsoft.com/en-us/office/vba/api/project.application.dateformat

This example uses the DateFormat method to display the start of the selected task in the format "1/31/02 12:33 PM." It passes the task's start date and the pjDate_mm_dd_yy_hh_mmAM constant to the MsgBox function.

```VB
Sub OutputDate() 
 MsgBox DateFormat(ActiveCell.Task.Start, pjDate_mm_dd_yy_hh_mmAM) 
End Sub

```

--------------------------------

### Display Page Setup dialog using Dialogs.Item

Source: https://learn.microsoft.com/en-us/office/vba/api/word.dialogs.item

This VBA example displays the Page Setup dialog by calling the Item method of the Dialogs collection with the wdDialogFileDocumentLayout constant, then calls Display on the returned Dialog object.

```VBA
Sub DialogItem() 
 Application.Dialogs.Item(wdDialogFileDocumentLayout).Display 
End Sub

```

--------------------------------

### ScopeFolder object usage examples

Source: https://learn.microsoft.com/en-us/office/vba/api/office.scopefolder

Examples demonstrating how to retrieve a root ScopeFolder object and a subfolder, and how to display the root paths of directories in My Computer.

```APIDOC
## ScopeFolder object (Office)

### Description
Corresponds to a searchable folder. **ScopeFolder** objects are intended for use with the **SearchFolders** collection.

### Remarks
When you want to search specific folders, you can use the methods and properties of the **SearchScope** object and **ScopeFolders** collection to retrieve **ScopeFolder** objects and add them to the **SearchFolders** collection.

In each **ScopeFolder** object, there is a **ScopeFolders** collection that contains the subfolders of the parent **ScopeFolder** object. You can traverse the entire folder structure of a search scope (for example, all local drives) by looping through these **ScopeFolders** collections and returning all of the lower-level **ScopeFolder** objects. A **ScopeFolder** object with no subfolders contains an empty **ScopeFolders** collection.

Use the **Add** method of the **SearchFolders** collection to add a **ScopeFolder** object to the **SearchFolders** collection; however, it is usually simpler to use the **AddToSearchFolders** method of the **ScopeFolder** that you want to add because there is only one **SearchFolders** collection for all searches.

### Example
Use the **ScopeFolder** property of the **SearchScope** object to return the root **ScopeFolder** object of a search scope; for example:

```vb
Set sf = SearchScopes.Item(1).ScopeFolder
```

Use the **Item** property of the **ScopeFolders** collection to return a subfolder of a root **ScopeFolder** object; for example:

```vb
Set sf = SearchScopes.Item(1).ScopeFolder.ScopeFolders.Item(1)
```

The following example displays the root path of each directory in My Computer. To retrieve this information, the example first gets the **ScopeFolder** object at the root of My Computer. The path of this **ScopeFolder** object will always be "*". As with all **ScopeFolder** objects, the root object contains a **ScopeFolders** collection. This example loops through this **ScopeFolders** collection and displays the path of each **ScopeFolder** object in it. The paths of these **ScopeFolder** objects will be `A:\`, `C:\`, etc.

```vb
Sub DisplayRootScopeFolders() 

 'Declare variables that reference a 
 'SearchScope and a ScopeFolder object. 
 Dim ss As SearchScope 
 Dim sf As ScopeFolder 

 'Loop through the SearchScopes collection 
 'and display all of the root ScopeFolders collections in 
 'the My Computer scope. 
 For Each ss In SearchScopes 
 Select Case ss.Type 
 Case msoSearchInMyComputer 

 'Loop through each ScopeFolder object in 
 'the ScopeFolders collection of the 
 'SearchScope object and display the path. 
 For Each sf In ss.ScopeFolder.ScopeFolders 
 MsgBox "ScopeFolder object's path: " & sf.Path 
 Next sf 

 Case Else 
 End Select 
 Next 

End Sub
```

### See also
- ScopeFolder object members
- Object Model Reference
```

--------------------------------

### Assignment.StartVariance property

Source: https://learn.microsoft.com/en-us/office/vba/api/project.assignment.startvariance

Gets the variance (in minutes) between the baseline start date and the start date of the assignment. Read-only Variant.

```APIDOC
## Assignment.StartVariance property

### Description
Gets the variance (in minutes) between the baseline start date and the start date of the assignment. Read-only **Variant**.

### Syntax
_expression_. `StartVariance`

_expression_ A variable that represents an **Assignment** object.

### Example
The following example displays the number of tasks in the active project that have started late.

```vb
Sub CountLateAssignments() 

 Dim a As Assignment 
 Dim t As Task 
 Dim numLateAssignments As Long 
 Dim lateAssignments As String 
 Dim daysLate As Single 

 numLateAssignments = 0 

 ' Look for late tasks in the active project. 
 For Each t In ActiveProject.Tasks 
 For Each a In t.Assignments 
 If a.BaselineStart < ActiveProject.CurrentDate And a.StartVariance > 0 Then 
 numLateAssignments = numLateAssignments + 1 
 daysLate = Round(a.StartVariance / 1440, 1) 
 lateAssignments = lateAssignments & vbCrLf & vbTab & t.Name _ 
 & ": resource " & a.Resource.Name & ": " & daysLate & " days" 
 End If 
 Next a 
 Next t 

 MsgBox "There are " & numLateAssignments & " late assignments in this project: " & lateAssignments 

End Sub
```
```

--------------------------------

### PickerResults Object Usage Example

Source: https://learn.microsoft.com/en-us/office/vba/api/office.pickerresults

Demonstrates how to configure a PickerDialog, create PickerResults, add a PickerResult, show the dialog, and enumerate the results.

```APIDOC
## PickerResults Object (Office)

### Description
A collection of **PickerResult** objects. Each **PickerResult** object represents a resolved or selected item data.

### Remarks
Each **PickerResult** object represents a resolved or selected item data.

### Example
The following code displays the **PickerDialog**, gets results, and then enumerates those results.

```vb
Dim objPickerDialog As PickerDialog 
Dim objPickerProperties As PickerProperties 
Dim objPickerProperty As PickerProperty 
Dim objPickerExistingResults As PickerResults 
Dim objPickerExistingResult As PickerResult 
Dim objPickerResults As PickerResults 

' Configure the Picker Dialog properties. 
Set objPickerDialog = Application.PickerDialog 
objPickerDialog.DataHandlerId = "{000CDF0A-0000-0000-C000-000000000046}" 
objPickerDialog.Title = "Sample Picker Dialog" 
Set objPickerProperties = objPickerDialog.Properties 
Set objPickerProperty = objPickerProperties.Add("SiteUrl", "https://my", msoPickerFieldtypeText) 
Set objPickerExistingResults = objPickerDialog.CreatePickerResults 
Set objPickerExistingResult = objPickerExistingResults.Add("johndoe@contoso.com", "John Doe", "User") 

' Show the Picker Dialog and get the results. 
Set objPickerResults = objPickerDialog.Show(True, objPickerExistingResult) 

' Enumerate the results. 
For index = 1 To objPickerResults.Count-1 
 Debug.Print objPickerResults.Item(index).Id 
 Debug.Print objPickerResults.Item(index).DisplayName 
 Debug.Print objPickerResults.Item(index).Type 
 Debug.Print objPickerResults.Item(index).SIPId 
Next 
```

### See Also
- PickerResults object members
- Object Model Reference
```

--------------------------------

### Sample XML file (C:\test.xml)

Source: https://learn.microsoft.com/en-us/office/vba/word/concepts/objects-properties-methods/capture-and-respond-to-events-in-the-data-store

Example XML file used in the sample scenario. It defines a root element with two child nodes, 'a' and 'b', and is used to demonstrate event handling.

```XML
<?xml version="1.0" standalone="no"?>  
<root xmlns="urn:test">  
  <a>NodeA</a>  
  <b>NodeB</b>  
</root>
```

--------------------------------

### Application.AltStartupPath property

Source: https://learn.microsoft.com/en-us/office/vba/api/excel.application.altstartuppath

Returns or sets the name of the alternate startup folder. Read/write String.

```APIDOC
## Application.AltStartupPath property

### Description
Returns or sets the name of the alternate startup folder. Read/write String.

### Syntax
_expression_.**AltStartupPath**

_expression_ A variable that represents an **Application** object.

### Property Value
String

### Example
This example sets the alternate startup folder.

```vb
Application.AltStartupPath = "C:\EXCEL\MACROS"
```
```

--------------------------------

### ActualStartDrivers.TotalDetectedCount property

Source: https://learn.microsoft.com/en-us/office/vba/api/project.actualstartdrivers.totaldetectedcount

Gets the total number of actual start drivers that affect the start date of a task. Read-only Long.

```APIDOC
## ActualStartDrivers.TotalDetectedCount property

### Description
Gets the total number of actual start drivers that affect the start date of a task. Read-only Long.

### Syntax
_expression_.TotalDetectedCount

_expression_ A variable that represents an 'ActualStartDrivers' object.

### Remarks
Actual start drivers are assignments that affect the start date of a task because they have actual work completed on the first day of the task.

### Example
The following example displays TotalDetectedCount for each task in the active project. The example assumes there are no more than five assignments whose start dates are the same as the task's start date.

```vb
Sub b() 

 Dim T As Task 

 Dim count As Integer 

 For Each T In ActiveProject.Tasks 

 If T.RecalcFlags = 1 Then 

 MsgBox (T.StartDriver.ActualStartDrivers.TotalDetectedCount) 

 End If 

 Next T 

End Sub
```
```

--------------------------------

### AppleScript handler example

Source: https://learn.microsoft.com/en-us/office/vba/office-mac/applescripttask

Example of an AppleScript handler that receives a parameter string and returns a response. The handler name must match the one passed to AppleScriptTask.

```AppleScript
    on myapplescripthandler(paramString) 

    #do something with paramString 
    return "You told me " & paramString 

    end myapplescripthandler

```

--------------------------------

### Get signature detail example

Source: https://learn.microsoft.com/en-us/office/vba/api/office.signatureinfo.getsignaturedetail

This example demonstrates how to retrieve information about the suggested signer of a document using the GetSignatureDetail method.

```VB
Sub GetSigDetails() 
Dim objSignatureInfo As SignatureInfo 
Dim varDetail As Variant 
 
strDetail = objSignatureInfo.GetSignatureDetail(sigdetDelSuggSigner) 
 
End Sub
```

--------------------------------

### Start or switch to Microsoft System Information

Source: https://learn.microsoft.com/en-us/office/vba/api/word.system.msinfo

Use this example to start the Microsoft System Information application or switch to it if it is already running. The code is a single line that calls the MSInfo method on the System object.

```VB
System.MSInfo
```

--------------------------------

### VBA example: ChangeLevelingDates

Source: https://learn.microsoft.com/en-us/office/vba/api/project.project.levelfromdate

This example lets the user change the date range where leveling occurs, if the current range starts on the project start date or finishes on the project finish date. It uses the LevelFromDate and LevelToDate properties of the ActiveProject object.

```VB
Sub ChangeLevelingDates() 
 Dim Response As Long 
 Dim NewFrom As Variant, NewTo As Variant 
 
 With ActiveProject 
 If Application.DateDifference(.ProjectSummaryTask.Start, .LevelFromDate) = 0 Then 
 Response = MsgBox("Overallocated resources are leveled from " & _ 
 "the project start date. Should that be changed?", vbYesNo) 
 If Response = vbYes Then 
 NewFrom = InputBox("Date to level from: ") 
 .LevelFromDate = NewFrom 
 Else 
 MsgBox "Resources remain leveled from the project start date." 
 End If 
 End If 
 
 If Application.DateDifference(.ProjectSummaryTask.Finish, .LevelToDate) = 0 Then 
 Response = MsgBox("Overallocated resources are leveled to " & _ 
 "the project finish date. Should that be changed?", vbYesNo) 
 If Response = vbYes Then 
 NewTo = InputBox("Date to level to: ") 
 .LevelToDate = NewTo 
 Else 
 MsgBox "Resources remain leveled to the project finish date." 
 End If 
 End If 
 End With 
 
End Sub

```

--------------------------------

### Application.FilePageSetupPage method

Source: https://learn.microsoft.com/en-us/office/vba/api/project.application.filepagesetuppage

Sets up pages for printing in Microsoft Project. This method can be called with optional parameters to configure page setup, or without arguments to display the Page Setup dialog box with the Page tab selected.

```APIDOC
## Application.FilePageSetupPage method

### Description
Sets up pages for printing in Microsoft Project.

### Syntax
_expression_.`FilePageSetupPage`(`_Name_`, `_Portrait_`, `_PercentScale_`, `_PagesTall_`, `_PagesWide_`, `_PaperSize_`, `_FirstPageNumber_`)

_expression_ A variable that represents an **Application** object.

### Parameters
| Name | Required/Optional | Data type | Description |
| --- | --- | --- | --- |
| _Name_ | Optional | **String** | The name of the view or report for which to set up pages for printing. |
| _Portrait_ | Optional | **Boolean** | **True** if the page orientation is portrait. **False** if the page orientation is landscape. |
| _PercentScale_ | Optional | **Integer** | The scaling factor, specified as a percentage of the original. Can be a number between 1 and 500. |
| _PagesTall_ | Optional | **Integer** | The height the printed project should be fit to, in pages. The **PagesTall** argument is ignored if **PercentScale** is specified. |
| _PagesWide_ | Optional | **Variant** | The width the printed project should be fit to, in pages. The **PagesWide** argument is ignored if **PercentScale** is specified. |
| _PaperSize_ | Optional | **Long** | The size of the paper to be used when printing. (Some printers may not support all of these paper sizes.) Can be one of the **PjPaperSize** constants. |
| _FirstPageNumber_ | Optional | **String** | Any valid integer to print on the first page or the string "Auto" to print the actual number of the first printed page. (For example, "3" if the first printed page is page 3.) Succeeding page numbers are incremented on this number. The default value is "Auto". |

### Return value
**Boolean**

### Remarks
Using the **FilePageSetupPage** method without specifying any arguments displays the **Page Setup** dialog box with the **Page** tab selected.

```

--------------------------------

### VBScript code example using Restrict method

Source: https://learn.microsoft.com/en-us/office/vba/outlook/how-to/using-visual-basic-to-customize-outlook-forms/referencing-existing-items-in-a-folder

VBScript version of the Restrict method example, using the numeric constant 10 for the contacts folder. Displays all contacts from ProseWare Corporation.

```VB
' VBScript code example. 
Set olns = Item.Application.GetNameSpace("MAPI") 
Set MyFolder = olns.GetDefaultFolder(10) 
Set myItems = myFolder.Items.Restrict("[MessageClass] = 'IPM.Contact'") 
MyClause = "[CompanyName] = ""ProseWare""" 
Set MyPWItems = MyItems.Restrict(MyClause) 
For Each MyItem in MyPWItems 
   MyItem.Display 
Next

```

--------------------------------

### Install a template add-in with AddIns.Add

Source: https://learn.microsoft.com/en-us/office/vba/api/word.addins.add

VBA example that installs a template named MyFax.dot and adds it to the list of add-ins in the Templates and Add-ins dialog box. The comment notes that the path must be correct and the file must exist for the example to work.

```VB
Sub AddTemplate() 
 ' For this example to work correctly, verify that the 
 ' path is correct and the file exists. 
 
 AddIns.Add FileName:="C:\Program Files\Microsoft Office" _ 
 & "\Templates\Letters & Faxes\MyFax.dot", Install:=True 
End Sub
```

--------------------------------

### Configure and display PickerDialog with PickerResults.Add

Source: https://learn.microsoft.com/en-us/office/vba/api/office.pickerresults.add

Sets up PickerDialog properties, creates a PickerResults collection, adds an existing result using the Add method, and then shows the dialog. The example uses the Add method with Id, DisplayName, and Type parameters.

```VB
Dim objPickerDialog As PickerDialog 
Dim objPickerProperties As PickerProperties 
Dim objPickerProperty As PickerProperty 
Dim objPickerExistingResults As PickerResults 
Dim objPickerExistingResults As PickerResult 
Dim objPickerResults As PickerResults 

' Configure the Picker Dialog properties. 
Set objPickerDialog = Application.PickerDialog 
objPickerDialog.DataHandlerId = "{000CDF0A-0000-0000-C000-000000000046}" 
objPickerDialog.Title = "Sample Picker Dialog" 
Set objPickerProperties = objPickerDialog.Properties 
Set objPickerProperty = objPickerProperties.Add("SiteUrl", "https://my", msoPickerFieldtypeText) 
Set objPickerExistingResults = objPickerDialog.CreatePickerResults 
Set objPickerExistingResult = objPickerExistingResults.Add("johndoe@contoso.com", "John Doe", "User") 

' Show the Picker Dialog and get the results. 
Set objPickerResults = objPickerDialog.Show(True, objPickerExistingResult)
```

--------------------------------

### Install an XML expansion pack using InstallManifest

Source: https://learn.microsoft.com/en-us/office/vba/api/excel.xmlnamespaces.installmanifest

This example installs the SimpleSample smart document solution for the current user. Note that unsigned manifests cannot be installed for security reasons.

```vba
Application.XMLNamespaces.InstallManifest _ 
 "https://smartdocuments/simplesample/manifest.xml"
```

--------------------------------

### AttachToVisioDoc_Example - Open and save a Visio document as a webpage

Source: https://learn.microsoft.com/en-us/office/vba/api/visio.vissaveasweb.attachtovisiodoc

This example shows how to open an existing Visio document and save it as a webpage using the Save as Web Page feature's default settings and the AttachToVisioDoc and CreatePages methods. Before running, replace path\filename with a valid path and file name for a Visio document to pass to the Open method, and replace targetpath\filename with a valid target path and file name for the webpage project files.

```VB
Public Sub AttachToVisioDoc_Example () 
    Dim vsoSaveAsWeb As VisSaveAsWeb 
    Dim vsoWebSettings As VisWebPageSettings 
    Dim vsoDocument As Visio.Document
 
    Set vsoDocument = Application.Documents.Open("<variable>path\filename</variable>") 
    Set vsoSaveAsWeb = Visio.Application.SaveAsWebObject
    Set vsoWebSettings = vsoSaveAsWeb.WebPageSettings
 
    vsoWebSettings.TargetPath = "<variable>targetpath\filename</variable>"

    With vsoSaveAsWeb
        .AttachToVisioDoc vsoDocument
        .CreatePages 
    End With
End Sub
```

--------------------------------

### Write # statement example

Source: https://learn.microsoft.com/en-us/office/vba/language/reference/user-interface-help/writestatement

This example uses the Write # statement to write raw data to a sequential file. It opens a file for output, writes comma-delimited data, writes a blank line, and then writes Boolean, Date, Null, and Error values. The comments explain the formatting of each data type.

```VB
Open "TESTFILE" For Output As #1    ' Open file for output. 
Write #1, "Hello World", 234    ' Write comma-delimited data. 
Write #1, ' Write blank line. 
 
Dim MyBool, MyDate, MyNull, MyError 
' Assign Boolean, Date, Null, and Error values. 
MyBool = False : MyDate = #February 12, 1969# : MyNull = Null 
MyError = CVErr(32767) 
' Boolean data is written as #TRUE# or #FALSE#. Date literals are  
' written in universal date format, for example, #1994-07-13#  
 'represents July 13, 1994. Null data is written as #NULL#.  
' Error data is written as #ERROR errorcode#. 
Write #1, MyBool ; " is a Boolean value" 
Write #1, MyDate ; " is a date" 
Write #1, MyNull ; " is a null value" 
Write #1, MyError ; " is an error value" 
Close #1    ' Close file. 

```

--------------------------------

### FollowHyperlink example: Open a URL in a new browser window

Source: https://learn.microsoft.com/en-us/office/vba/api/excel.workbook.followhyperlink

This example uses the FollowHyperlink method to load the document at example.microsoft.com in a new browser window and adds it to the History folder. The Address parameter is set to the target URL.

```VB
ActiveWorkbook.FollowHyperlink Address:="https://example.microsoft.com"

```

--------------------------------

### VBA example: Check if Access was started by the user

Source: https://learn.microsoft.com/en-us/office/vba/api/access.application.usercontrol

Displays a message box indicating whether Access was started by the user, using the Application.UserControl property. The property returns True if started by the user, False if started by Automation.

```VB
MsgBox "The user started Access:  " & Application.UserControl

```

--------------------------------

### VBA example: Using BeginUndoScope to start a transaction

Source: https://learn.microsoft.com/en-us/office/vba/api/visio.application.beginundoscope

This example shows how to use the BeginUndoScope method to start a transaction with a unique scope ID. It sets up event handlers for CellChanged, EnterScope, and ExitScope, and uses IsInScope to check if events occur within the scope. The example draws shapes, changes a cell, and ends the scope with EndUndoScope.

```VB
 
Private WithEvents vsoApplication As Visio.Application  
Private lngScopeID As Long 
 
Public Sub BeginUndoScope_Example()  
 
    Dim vsoShape As Visio.Shape  
 
    'Set the module-level application variable to  
    'trap application-level events.  
    Set vsoApplication = Application 
 
    'Begin a scope and set the module-level scope ID variable.  
    lngScopeID = Application.BeginUndoScope("Draw Shapes")  
 
    'Draw three shapes.  
    Set vsoShape = ActivePage.DrawRectangle(1, 2, 2, 1)  
    ActivePage.DrawOval 3, 4, 4, 3  
    ActivePage.DrawLine 4, 5, 5, 4 
 
    'Change a cell to trigger the CellChanged event.  
    vsoShape.Cells("Width").Formula = 5 
 
    'End and commit this scope.  
    Application.EndUndoScope lngScopeID, True 
 
 End Sub   
 
 Private Sub vsoApplication_CellChanged(ByVal Cell As IVCell)  
 
    'Check to see if this cell change is the result of something  
    'happening within the scope.  
    If vsoApplication.IsInScope(lngScopeID) Then  
        Debug.Print Cell.Name & " changed in scope "; lngScopeID  
    End If   
 
End Sub   
 
Private Sub vsoApplication_EnterScope(ByVal app As IVApplication, _  
    ByVal nScopeID As Long, _  
    ByVal bstrDescription As String)  
 
    If vsoApplication.CurrentScope = lngScopeID Then  
        Debug.Print "Entering my scope " & nScopeID  
    Else  
        Debug.Print "Enter Scope " & bstrDescription & "(" & nScopeID & ")"  
    End If  
 
End Sub   
 
Private Sub vsoApplication_ExitScope(ByVal app As IVApplication, _  
    ByVal nScopeID As Long, _  
    ByVal bstrDescription As String, _  
    ByVal bErrOrCancelled As Boolean)  
 
    If vsoApplication.CurrentScope = lngScopeID Then  
        Debug.Print "Exiting my scope " & nScopeID  
    Else  
        Debug.Print "Exit Scope " & bstrDescription & "(" & nScopeID & ")"  
    End If   
 
End Sub

```

--------------------------------

### BeginInitialize method usage in VBA

Source: https://learn.microsoft.com/en-us/office/vba/api/office.sensitivitylabelpolicy.begininitialize

This example demonstrates how to call the BeginInitialize method to retrieve the supported policy version string.

```VB
Dim supportedPolicyVersion As String

supportedPolicyVersion = Application.SensitivityLabelPolicy.BeginInitialize
```

--------------------------------

### VBA example: SaveSettings_Example

Source: https://learn.microsoft.com/en-us/office/vba/api/visio.viswebpagesettings.savesettings

Shows how to use the SaveSettings method to immediately change the default value for the PriFormat property. Before running, replace path\filename with a valid path and file name for the webpage project files.

```VB
Public Sub SaveSettings_Example() 
 Dim vsoSaveAsWeb As VisSaveAsWeb 
 Dim vsoWebSettings As VisWebPageSettings 
 
 Set vsoSaveAsWeb = Visio.Application.SaveAsWebObject 
 Set vsoWebSettings = vsoSaveAsWeb.WebPageSettings 
 
 With vsoWebSettings 
 'Set PriFormat to a non-default value. 
 .PriFormat = "JPG" 
 .SaveSettings 
 .TargetPath = "path\filename" 
 End With 
 
 vsoSaveAsWeb.CreatePages 
End Sub

```

--------------------------------

### RulerGuide.Position

Source: https://learn.microsoft.com/en-us/office/vba/api/publisher.rulerguide

Gets or sets the position of the ruler guide.

```APIDOC
## Position

### Description
Gets or sets the position of the ruler guide.

### Syntax
`expression.Position`

`expression` A variable that represents a **RulerGuide** object.

### Example
See the example in the RulerGuide object overview.

```

--------------------------------

### Property Get statement example: PenColor property

Source: https://learn.microsoft.com/en-us/office/vba/language/reference/user-interface-help/property-get-statement

Defines a Property Get procedure that returns the current pen color as a string based on the CurrentColor variable. The example also shows how to call the property procedure by assigning its return value to a variable.

```VB
Dim CurrentColor As Integer 
Const BLACK = 0, RED = 1, GREEN = 2, BLUE = 3 

' Returns the current color of the pen as a string. 
Property Get PenColor() As String 
 Select Case CurrentColor 
 Case RED 
 PenColor = "Red" 
 Case GREEN 
 PenColor = "Green" 
 Case BLUE 
 PenColor = "Blue" 
 End Select 
End Property 

' The following code gets the color of the pen 
' calling the Property Get procedure. 
ColorName = PenColor 

```

--------------------------------

### SetPageSetupOptions

Source: https://learn.microsoft.com/en-us/office/vba/api/publisher.pagesetup

Example demonstrating how to set the page height and width of the active publication using the PageSetup object.

```APIDOC
## SetPageSetupOptions

### Description
Sets all pages in the active publication to be 8.5 inches wide and 11 inches high.

### Method
N/A (VBA Sub procedure)

### Endpoint
N/A (VBA code example)

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
N/A

#### Response Example
N/A
```
Tokens:
Raw