TimelineState class

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

Inheritance hierarchy

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

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

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(MovingPeriodState), FileFormatVersions.Office15)> _
<ChildElementInfoAttribute(GetType(BoundsTimelineRange), FileFormatVersions.Office15)> _
<ChildElementInfoAttribute(GetType(ExtensionList), FileFormatVersions.Office15)> _
<OfficeAvailabilityAttribute(FileFormatVersions.Office15)> _
<ChildElementInfoAttribute(GetType(SelectionTimelineRange), FileFormatVersions.Office15)> _
Public Class TimelineState _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As TimelineState
[ChildElementInfoAttribute(typeof(MovingPeriodState), FileFormatVersions.Office15)]
[ChildElementInfoAttribute(typeof(BoundsTimelineRange), FileFormatVersions.Office15)]
[ChildElementInfoAttribute(typeof(ExtensionList), FileFormatVersions.Office15)]
[OfficeAvailabilityAttribute(FileFormatVersions.Office15)]
[ChildElementInfoAttribute(typeof(SelectionTimelineRange), FileFormatVersions.Office15)]
public class TimelineState : OpenXmlCompositeElement

Remarks

2.6.130 CT_TimelineState

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

Referenced by: CT_TimelineCacheDefinition

A complex type that specifies the state of the Timeline cache.

Child Elements:

selection: A CT_TimelineRange element that specifies the start and end dates that are selected in the Timeline view. The start and end dates in the selection element MUST be interpreted as dateTime ([XMLSCHEMA2] section 3.2.7) values.

bounds: A CT_TimelineRange element that specifies the minimum and maximum dates available for display in the Timeline view. The minimum and maximum dates in the bounds element MUST be interpreted as dateTime ([XMLSCHEMA2] section 3.2.7) values.

extLst: A CT_ExtensionList ([ISO/IEC-29500-4] section A.2) element that specifies future extensibility for this element.

Attributes:

singleRangeFilterState: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the filtering state of the Timeline is a contiguous date range.

minimalRefreshVersion: An unsignedInt ([XMLSCHEMA2] section 3.3.22) attribute that specifies the minimum application version required to refresh the Timeline cache*.*

lastRefreshVersion: An unsignedInt attribute that specifies the application version that last refreshed the Timeline cache*.*

pivotCacheId: An unsignedInt attribute that specifies the associated OLAP PivotTable ([ISO/IEC-29500-1] section 18.10) PivotCache. MUST be equal to the pivotCacheId attribute of an existing CT_PivotCacheDefinition element.

filterType: An ST_PivotFilterType ([ISO/IEC-29500-1] section 18.18.59) attribute that specifies type of the filter ([ISO/IEC-29500-1] section 18.10.1.33) used in the Timeline*.*

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

<xsd:complexType name="CT_TimelineState">

<xsd:sequence>

<xsd:element name="selection" type="CT_TimelineRange" minOccurs="0" maxOccurs="1"/>

<xsd:element name="bounds" type="CT_TimelineRange" minOccurs="1" maxOccurs="1"/>

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

</xsd:sequence>

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

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

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

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

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

</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

TimelineState members

DocumentFormat.OpenXml.Office15.Excel namespace