TimelineView Interface

Definition

Namespace:

Microsoft.Office.Interop.Outlook

Assembly:

Microsoft.Office.Interop.Outlook.dll

Represents a view that displays Outlook items in a timeline.

public interface class TimelineView : Microsoft::Office::Interop::Outlook::_TimelineView

[System.Runtime.InteropServices.Guid("0006309C-0000-0000-C000-000000000046")]
public interface TimelineView : Microsoft.Office.Interop.Outlook._TimelineView

Public Interface TimelineView
Implements _TimelineView

Derived

Microsoft.Office.Interop.Outlook.TimelineViewClass

Attributes

GuidAttribute

Implements

_TimelineView

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 _TimelineView.

The TimelineView object, derived from the View object, allows you to create customizable views that allow you to display Outlook items within a timeline.

Outlook provides several built-in TimelineView objects, and you can also create custom TimelineView objects. Use the Add(String, OlViewType, OlViewSaveOption) method of the Views collection to add a new TimelineView to a Folder object. Use the Standard property to determine if an existing TimelineView object is built-in or custom.

The TimelineView object supports several different view modes, depending on the desired layout and time period in which to display Outlook items. Use the TimelineViewMode property to set the view mode, the StartField property to specify the Outlook item property that contains the start date, and the EndField property to specify the Outlook item property that contains the end date for Outlook items to be displayed.

You can configure the appearance of the TimelineView, depending on the view mode. Use the ShowWeekNumbers property to indicate whether week numbers are displayed in the time scale for the view. Use the UpperScaleFont and LowerScaleFont properties to specify the font used when displaying, respectively, the upper and lower portions of the time scale for the view.

You can also configure how Outlook items appear within the TimelineView object. Use the ItemFont property to specify the font used to display Outlook item labels and the MaxLabelWidth property to specify the length of labels for Outlook items in the view. Use the DefaultExpandCollapseSetting property to determine if Outlook items are expanded by default in the view. Use the Filter property to determine which Outlook items to display in the view and the GroupByFields collection to specify the Outlook item properties by which Outlook items are grouped in the view. If you set the TimelineViewMode to olTimelineViewMonth, you can use the ShowLabelWhenViewingByMonth property to determine if labels for Outlook items are displayed in the view.

The definition for each TimelineView object is stored in Extensible Markup Language (XML) format. Use the XML property to work with the XML definition for the TimelineView object.

Use the Apply() method to apply any changes made to the TimelineView object to the current view. Use the Save() method to persist any changes made to the TimelineView object. Use the LockUserChanges property to allow or prevent changes to the user interface for the view.

You can change built-in TimelineView objects, but you cannot delete them. Use the Delete() method to delete a custom TimelineView object. Use the Reset() method to reset the properties of a built-in TimelineView object to their default values.

Properties

Application	Returns an Application object that represents the parent Outlook application for the object. Read-only. (Inherited from _TimelineView)
Class	Returns an OlObjectClass constant indicating the object's class. Read-only. (Inherited from _TimelineView)
DefaultExpandCollapseSetting	Returns or sets an OlDefaultExpandCollapseSetting constant that determines the default expansion setting for groups in the TimelineView object. Read/write. (Inherited from _TimelineView)
EndField	Returns or sets a String (string in C#) value that represents the name of the property that ends the time duration for Outlook items displayed in the TimelineView object. Read/write. (Inherited from _TimelineView)
Filter	Returns or sets a String (string in C#) value that represents the filter for a view. Read/write. (Inherited from _TimelineView)
GroupByFields	Returns an OrderFields object that represents the set of fields by which the items displayed in the TimelineView object are grouped. Read-only. (Inherited from _TimelineView)
ItemFont	Returns a ViewFont object that represents the font used when displaying Outlook items in the TimelineView object. Read-only. (Inherited from _TimelineView)
Language	Returns or sets a String (string in C#) value that represents the language setting for the view. Read/write. (Inherited from _TimelineView)
LockUserChanges	Returns or sets a Boolean (bool in C#) value that indicates whether a user can modify the settings of the view. Read/write. (Inherited from _TimelineView)
LowerScaleFont	Returns a ViewFont object that represents the font used to display the lower portion of the timeline scale for a TimelineView object. Read-only. (Inherited from _TimelineView)
MaxLabelWidth	Returns or sets an Integer (int in C#) value that represents the maximum length (in characters) for the label of an Outlook item in the TimelineView object. Read/write. (Inherited from _TimelineView)
Name	Returns or sets a String (string in C#) value that represents the display name for the object. Read/write. (Inherited from _TimelineView)
Parent	Returns the parent Object of the specified object. Read-only. (Inherited from _TimelineView)
SaveOption	Returns an OlViewSaveOption constant that specifies the folders in which the specified view is available and the read permissions attached to the view. Read-only. (Inherited from _TimelineView)
Session	Returns the NameSpace object for the current session. Read-only. (Inherited from _TimelineView)
ShowLabelWhenViewingByMonth	Returns or sets a Boolean (bool in C#) value that determines if labels for Outlook items are displayed when viewing by month in the TimelineView object. Read/write. (Inherited from _TimelineView)
ShowWeekNumbers	Returns or sets a Boolean (bool in C#) value that indicates whether week number labels are displayed in the timeline scale for the TimelineView object. Read/write. (Inherited from _TimelineView)
Standard	Returns a Boolean (bool in C#) value that indicates whether the TimelineView object is a built-in Outlook view. Read-only. (Inherited from _TimelineView)
StartField	Returns or sets a String (string in C#) value that represents the name of the property that starts the time duration for Outlook items displayed in the TimelineView object. Read/write. (Inherited from _TimelineView)
TimelineViewMode	Returns or sets an OlTimelineViewMode constant that indicates the view mode for the TimelineView object. Read/write. (Inherited from _TimelineView)
UpperScaleFont	Returns a ViewFont object that represents the font used to display the upper portion of the timeline scale for a TimelineView object. Read-only. (Inherited from _TimelineView)
ViewType	Returns an OlViewType constant that indicates the view type of the view. Read-only. (Inherited from _TimelineView)
XML	Returns or sets a String (string in C#) value that specifies the XML definition of the view. Read/write. (Inherited from _TimelineView)

Methods

Apply()	Applies the TimelineView object to the current view. (Inherited from _TimelineView)
Copy(String, OlViewSaveOption)	Creates a new View object based on the existing TimelineView object. (Inherited from _TimelineView)
Delete()	Deletes an object from a collection. (Inherited from _TimelineView)
GoToDate(DateTime)	Changes the date used by the current view to display information. (Inherited from _TimelineView)
Reset()	Resets a built-in Microsoft Outlook view to its original settings. (Inherited from _TimelineView)
Save()	Saves the view, or saves the changes to a view. (Inherited from _TimelineView)