Edit

Share via


NavigationModule Interface

Definition

Represents a navigation module in the Navigation Pane of an explorer.

public interface class NavigationModule : Microsoft::Office::Interop::Outlook::_NavigationModule
[System.Runtime.InteropServices.Guid("000630E8-0000-0000-C000-000000000046")]
public interface NavigationModule : Microsoft.Office.Interop.Outlook._NavigationModule
Public Interface NavigationModule
Implements _NavigationModule
Derived
Attributes
Implements

Remarks

This is a .NET interface derived from a COM coclass that is required by managed code for interoperability with the corresponding COM object. Use this derived interface to access all method, property, and event members of the COM object. However, if a method or event you want to use shares the same name under the same COM object, cast to the corresponding primary interface to call the method, and cast to the latest events interface to connect to the event. Refer to this topic for information about the COM object. For information about the method and property members of the COM object, see _NavigationModule.

The NavigationModule object provides access to the various navigation modules displayed in the Microsoft Outlook Navigation Pane. The following objects are derived from the NavigationModule object:

Use the GetNavigationModule(OlNavigationModuleType) method or the Item[Object] property (this in C#) of the NavigationModules collection for the parent NavigationPane object to retrieve a NavigationModule object, then use the NavigationModuleType property of the NavigationModule object to retrieve the module type. Depending on the value of the NavigationModuleType property, you can then cast the NavigationModule object reference as one of the objects listed above to access the NavigationGroups property for that object, such as a CalendarModule object.

The Shortcuts and Folder List navigation modules do not have a corresponding object, such as MailModule, because they do not support programmatic access to navigation groups or navigation folders. You can use the NavigationModule object to access the properties of the Shortcuts and Folder List modules.

You can use the Visible property to determine if the navigation module is visible and the Position property to return or set the display position of the navigation module within the Navigation Pane. You can also use the Name property to return the display name of the navigation module within the Navigation Pane.

Properties

Application

Returns an Application object that represents the parent Outlook application for the object. Read-only.

(Inherited from _NavigationModule)
Class

Returns an OlObjectClass constant indicating the object's class. Read-only.

(Inherited from _NavigationModule)
Name

Returns a String (string in C#) value that represents the localized display name for the NavigationModule object. Read-only.

(Inherited from _NavigationModule)
NavigationModuleType

Returns an OlNavigationModuleType constant that represents the navigation module type for the object. Read-only.

(Inherited from _NavigationModule)
Parent

Returns the parent Object of the specified object. Read-only.

(Inherited from _NavigationModule)
Position

Returns or sets an Integer (int in C#) value that represents the ordinal position of the NavigationModule object when displayed in the Navigation Pane. Read/write.

(Inherited from _NavigationModule)
Session

Returns the NameSpace object for the current session. Read-only.

(Inherited from _NavigationModule)
Visible

Returns or sets a Boolean value (bool in C#) that determines whether the NavigationModule object is displayed in the Navigation Pane. Read/write.

(Inherited from _NavigationModule)

Applies to