Share via

CalendarModule.Position Property

  • Article
Outlook Developer Reference

Returns or sets an Long value that represents the ordinal position of the CalendarModule object when displayed in the Navigation Pane. Read/write.

Version Information
 Version Added:  Outlook 2007

Syntax

expression.Position

expression   A variable that represents a CalendarModule object.

Remarks

This property can only be set to a value between 1 and 8. An error occurs if you attempt to set this property to a value outside that range.

Changing the value of this property for a CalendarModule object changes the Position values of other navigation modules contained by a NavigationModules collection, depending on the relative change between the new value and the original value of the Position property for that CalendarModule object:

  • If the new value is less than the original value, then the specified CalendarModule object moves up to the new position and pushes the other navigation modules already at or below that new position down.
  • If the new value is greater than the original value, then the specified CalendarModule object moves down to the new position and pushes the other navigation modules between the old position and the new position up, filling the old position.

Example

The following Visual Basic for Applications (VBA) sample attempts to retrieve the Calendar navigation module from the Navigation Pane. If successful, the sample then sets the Position property of the CalendarModule object to 1, moving it into the topmost position in the Navigation Pane. Finally, the sample sets the CurrentModule property of the NavigationPane object to the retrieved Calendar module, selecting it in the Navigation Pane.

Visual Basic for Applications 
  Sub MoveCalendarModuleFirst()
    Dim objPane As NavigationPane
    Dim objModule As CalendarModule
    
    On Error GoTo ErrRoutine
    
    ' Get the current NavigationPane object.
    Set objPane = Application.ActiveExplorer.NavigationPane
    
    ' Get the Calendar navigation module 
    ' from the Navigation Pane.
    Set objModule = objPane.Modules.GetNavigationModule( _
        olModuleCalendar)
    
    ' If a CalendarModule object is present,
    ' make it the first navigation module displayed in the
    ' Navigation Pane.
    If Not (objModule Is Nothing) Then
        objModule.Position = 1
    End If
    
    ' Select the Calendar navigation module in the
    ' Navigation Pane.
    Set objPane.CurrentModule = objModule

EndRoutine:
On Error GoTo 0
Set objModule = Nothing
Set objPane = Nothing
Exit Sub


ErrRoutine:
Debug.Print Err.Number & " (&H" & Hex(Err.Number) & ")"
Select Case Err.Number
Case -2147024809 '&H80070057
' Typically occurs if you set the Position
' property less than 1 or greater than 8.
MsgBox Err.Number & " - " & Err.Description, _
vbOKOnly Or vbCritical, _
"MoveCalendarModuleFirst"
End Select
GoTo EndRoutine
End Sub

See Also