TimelineState class

Office 2013 and later

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

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

C#
VB
C++
Copy
No code example is currently available or this language may not be supported.

2.6.116 CT_TimelineState

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

Referenced by: CT_TimelineCacheDefinition

The CT_TimelineState complex type specifies the Timeline state (section 2.3.5.1.4) of the Timeline cache (section 2.3.5.1).<92>

Child Elements:

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

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 values ([XMLSCHEMA2] section 3.2.7).

movingPeriodState: A CT_MovingPeriodState element (section 2.6.140) that specifies the current state of the moving period associated with the Timeline state of the Timeline cache specified by this element.

This element MUST exist only if the singleRangeFilterState attribute of this element is TRUE. It MUST exist only if the CT_TimelineRange element exists within the parent element of this type.

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

Attributes:

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

minimalRefreshVersion: An unsignedInt attribute ([XMLSCHEMA2] section 3.3.22) 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. This element MUST be equal to the pivotCacheId attribute of an existing CT_PivotCacheDefiniton element (section 2.6.33).

filterType: An ST_PivotFilterType attribute ([ISO/IEC-29500-1] section 18.18.59) 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="movingPeriodState" type="CT_MovingPeriodState" minOccurs="0" 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).

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