TupleSet Class

OLAP Set.When the object is serialized out as xml, its qualified name is x:set.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Spreadsheet.TupleSet

Namespace:  DocumentFormat.OpenXml.Spreadsheet
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(SortByTuple))> _
<ChildElementInfoAttribute(GetType(Tuples))> _
Public Class TupleSet _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As TupleSet
[ChildElementInfoAttribute(typeof(SortByTuple))]
[ChildElementInfoAttribute(typeof(Tuples))]
public class TupleSet : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

  • Tuples <x:tpls>

  • SortByTuple <x:sortByTuple>

[ISO/IEC 29500-1 1st Edition]

18.10.1.88 set (OLAP Set)

Represents an OLAP sheet data set or tuple set. The set is defined by a Multidimensional Expressions (MDX) query that specifies criteria for the dimension members that belong to the set.

[Example: the following MDX expression defines the set for the 10 salespersons with the lowest sales:

BottomCount([Salesperson].[Salesperson Name].Members,10,[Measures].[Sales])

end example]

The MDX expression is specified in the setDefinition attribute.

Parent Elements

sets (§18.10.1.89)

Child Elements

Subclause

sortByTuple (Sort By Tuple)

§18.10.1.91

tpls (Tuples)

§18.10.1.93

Attributes

Description

count (Number of Tuples)

Specifies the number of tuples in the set.

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

maxRank (Maximum Rank Requested)

Specifies the largest rank entry the user has requested.

The possible values for this attribute are defined by the W3C XML Schema int datatype.

queryFailed (Query Failed)

Specifies a boolean value that indicates whether querying on this set failed.

A value of 1 or true indicates a query against this set failed.

A value of 0 or false indicates a query against this set succeeded.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

setDefinition (MDX Set Definition)

Specifies the Multidimensional Expressions (MDX) set definition.

[Note: Data connectivity can use a number of different technologies. One example of potential values stored in this attribute can be found at: https://msdn2.microsoft.com/en-us/library/ms145595.aspx end note]

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

sortType (Set Sort Order)

Specifies the sort order of the set.

The possible values for this attribute are defined by the ST_SortType simple type (§18.18.74).

[Note: The W3C XML Schema definition of this element’s content model (CT_Set) is located in §A.2. end note]

© ISO/IEC29500: 2008.

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

TupleSet Members

DocumentFormat.OpenXml.Spreadsheet Namespace