Timeline class

Defines the Timeline Class.This class is only available in O15. When the object is serialized out as xml, its qualified name is x15:timeline.

Inheritance hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Office15.Excel.Timeline

Namespace:  DocumentFormat.OpenXml.Office15.Excel
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(ExtensionList), FileFormatVersions.Office15)> _
<OfficeAvailabilityAttribute(FileFormatVersions.Office15)> _
Public Class Timeline _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As Timeline

[ChildElementInfoAttribute(typeof(ExtensionList), FileFormatVersions.Office15)]
[OfficeAvailabilityAttribute(FileFormatVersions.Office15)]
public class Timeline : OpenXmlCompositeElement

Remarks

2.6.125 CT_Timeline

Target namespace: https://schemas.microsoft.com/office/spreadsheetml/2010/11/main

Referenced by: CT_Timelines

A complex type that specifies a Timeline view (section 2.3.5.2) in this worksheet.

Child Elements:

extLst: A CT_ExtensionList element, as specified in [ISO/IEC-29500-4] section A.2 that specifies future extensibility for this element.

Attributes:

name: An ST_Xstring attribute, as specified in [ISO/IEC-29500-1] section 22.9.2.19, that specifies the name of the Timeline view. MUST be a unique case-insensitive name within the scope of this workbook. The length of this attribute MUST be greater than or equal to 1 character and MUST be less than or equal to 32767 characters.

cache: An ST_Xstring attribute that specifies the name of the Timeline cache, as specified in section 2.3.5.1, that this Timeline view is associated with. There MUST be a CT_TimelineCacheDefinition element, as specified in section 2.6.126, within this workbook with the name attribute equal to the value of this attribute.

caption: An ST_Xstring attribute that specifies the caption of the Timeline view. If this string exists, the length MUST be greater than or equal to 1 character.

showHeader: A Boolean attribute, as specified in [XMLSCHEMA2] section 3.2.2, that specifies whether the header is displayed.

showSelectionLabel: A Boolean attribute that specifies whether the selection label is displayed.

showTimeLevel: A Boolean attribute that specifies whether the time level is displayed.

showHorizontalScrollbar: A Boolean attribute that specifies whether the horizontal scrollbar is displayed.

level: An unsignedInt attribute, as specified in [XMLSCHEMA2] section 3.3.22, that specifies the current time level of the Timeline. MUST be greater than or equal to 0 and MUST be less than or equal to 3.

selectionLevel: An unsignedInt attribute that specifies the time level at which the current selection was made for the Timeline. MUST be greater than or equal to 0 and MUST be less than or equal to 3.

scrollPosition: A dateTime ([XMLSCHEMA2] section 3.2.7) attribute that specifies the start date of the timespan scrolling position of the Timeline.

style: An ST_Xstring ([ISO/IEC-29500-1] section 22.9.2.19) attribute that specifies the Timeline style of the Timeline view. If this field (1) exists, this string MUST match the name attribute of a CT_TimelineStyle element within this workbook or MUST be equal to one of the built-in Timeline style names:

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this complex type.

<xsd:complexType name="CT_Timeline">

<xsd:sequence>

<xsd:element name="extLst" type="x:CT_ExtensionList" minOccurs="0" maxOccurs="1"/>

</xsd:sequence>

<xsd:attribute name="name" type="x:ST_Xstring" use="required"/>

<xsd:attribute name="cache" type="x:ST_Xstring" use="required"/>

<xsd:attribute name="caption" type="x:ST_Xstring" use="optional"/>

<xsd:attribute name="showHeader" type="xsd:boolean" use="optional" default="true"/>

<xsd:attribute name="showSelectionLabel" type="xsd:boolean" use="optional" default="true"/>

<xsd:attribute name="showTimeLevel" type="xsd:boolean" use="optional" default="true"/>

<xsd:attribute name="showHorizontalScrollbar" type="xsd:boolean" use="optional" default="true"/>

<xsd:attribute name="level" type="xsd:unsignedInt" use="required"/>

<xsd:attribute name="selectionLevel" type="xsd:unsignedInt" use="required"/>

<xsd:attribute name="scrollPosition" type="xsd:dateTime" use="optional"/>

<xsd:attribute name="style" type="x:ST_Xstring" use="optional"/>

</xsd:complexType>

See section 5.3 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

Thread safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See also

Reference

Timeline members

DocumentFormat.OpenXml.Office15.Excel namespace