SortCondition Class
Defines the SortCondition Class.This class is only available in Office2010.When the object is serialized out as xml, its qualified name is x14:sortCondition.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlLeafElement
DocumentFormat.OpenXml.Office2010.Excel.SortCondition
Namespace: DocumentFormat.OpenXml.Office2010.Excel
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
<OfficeAvailabilityAttribute(FileFormatVersions.Office2010)> _
Public Class SortCondition _
Inherits OpenXmlLeafElement
'Usage
Dim instance As SortCondition
[OfficeAvailabilityAttribute(FileFormatVersions.Office2010)]
public class SortCondition : OpenXmlLeafElement
Remarks
2.4.28 sortCondition
Target namespace: https://schemas.microsoft.com/office/spreadsheetml/2010/main
A CT_SortCondition element that specifies a sort condition to apply to a range. See Pivot Table, Query Table, Table Definition, and Worksheet under Extensions by Part for how this element integrates with [ISO/IEC-29500-1].
The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this element.
<xsd:element name="sortCondition" type="CT_SortCondition"/>
See section 5.3 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).
2.6.58 CT_SortCondition
Target namespace: https://schemas.microsoft.com/office/spreadsheetml/2010/main
Referenced by: sortCondition
A complex type that specifies a sort condition to apply to a range.
Attributes:
descending : A boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies the direction of the sort.
Value |
Meaning |
FALSE |
If sortBy is “value”, sort in ascending order. If sortBy is “cellColor” or “fontColor”, cells in which the cell color or cell font color specified by dxfId occurs are ordered at the top of the range. If sortBy is “icon”, cells in which the icon specified by iconSet and iconId occurs are ordered at the top of the range. |
TRUE |
If sortBy is “value”, sort in descending order. If sortBy is “cellColor” or “fontColor”, cells in which the cell color or cell font color specified by dxfId occurs are ordered at the bottom of the range. If sortBy is “icon”, cells in which the icon specified by iconSet and iconId occurs are ordered at the bottom of the range. |
sortBy : An ST_SortBy ([ISO/IEC-29500-1] section 18.18.72) attribute that specifies how the cells in a range are sorted.
ref : An ST_Ref ([ISO/IEC-29500-1] section 18.18.62) attribute that specifies the row or column to which this sort condition applies. This value MUST be contained within the ref in the sortState element that precedes this element. If the sortState.columnSort attribute that precedes this element is “FALSE”, then this value specifies the column to which this sort condition applies and there MUST be only a single column specified by ref. If the sortState.columnSort attribute that precedes this element is “TRUE”, then this value specifies the row to which this sort condition applies and there MUST be only a single row specified by ref.
customList : An ST_Xstring ([ISO/IEC-29500-1] section 22.9.2.19) attribute that specifies a comma-delimited list of strings that specifies a custom sort order. The order of strings in the list specifies the sort order. When a cell value matches a string in the list, it is sorted ahead of the cell values that match a later string in the list, and so on for each cell in the range. MUST be ignored if sortBy is not equal to “value”.
dxfId : An ST_DxfId ([ISO/IEC-29500-1] section 18.18.25) attribute that specifies the format id when sortBy equals “cellColor” or sortBy equals “fontColor”. MUST NOT be present if sortBy equals “icon” or “value”.
iconSet : An ST_IconSetType attribute that specifies the icon set when sortBy equals “icon”. The absence of this attribute means no icon. MUST NOT be present if sortBy is not equal to “icon”.
iconId : An unsignedInt ([XMLSCHEMA2] section 3.3.22) attribute that specifies the zero-based index of an icon in an icon set. If the icon set specified by iconSet has 3 icons, this value MUST be less than or equal to 2. If the icon set specified by iconSet has 4 icons, this value MUST be less than or equal to 3. If the icon set specified by iconSet has 5 icons, this value MUST be less than or equal to 4. The absence of this attribute means no icon*.* MUST NOT be present if sortBy is not equal to “icon”.
The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this complex type.
<xsd:complexType name="CT_SortCondition">
<xsd:attribute name="descending" type="xsd:boolean" use="optional" default="false"/>
<xsd:attribute name="sortBy" type="x:ST_SortBy" use="optional" default="value"/>
<xsd:attribute name="ref" type="x:ST_Ref" use="required"/>
<xsd:attribute name="customList" type="x:ST_Xstring" use="optional"/>
<xsd:attribute name="dxfId" type="x:ST_DxfId" use="optional"/>
<xsd:attribute name="iconSet" type="ST_IconSetType" use="optional" default="3Arrows"/>
<xsd:attribute name="iconId" type="xsd:unsignedInt" 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.