SortCondition Class

Defines the SortCondition Class.When the object is serialized out as xml, its qualified name is x:sortCondition.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Spreadsheet.SortCondition

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

Syntax

'Declaration
Public Class SortCondition _
    Inherits OpenXmlLeafElement
'Usage
Dim instance As SortCondition
public class SortCondition : OpenXmlLeafElement

Remarks

[ISO/IEC 29500-1 1st Edition]

18.3.1.91 sortCondition (Sort Condition)

Sort condition. When more than one sortCondition is specified, the first condition is applied first, then the second condition is applied, and so on.

Parent Elements

sortState (§18.3.1.92)

Attributes

Description

customList (Custom List)

Sort by a custom list.

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

descending (Descending)

Sort descending.

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

dxfId (Format Id)

Format Id when sortBy=cellColor or fontColor

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

iconId (Icon Id)

Zero-based index of an icon in an icon set. The absence of this attribute means "no icon"

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

iconSet (Icon Set)

Icon set index when sortBy=icon.

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

ref (Reference)

Column/Row that this sort condition applies to. This shall be contained within the ref in CT_SortState.

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

sortBy (Sort By)

Type of sort.

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

[Note: The W3C XML Schema definition of this element’s content model (CT_SortCondition) 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

SortCondition Members

DocumentFormat.OpenXml.Spreadsheet Namespace