SortCondition Class

Definition

Namespace:

DocumentFormat.OpenXml.Office2010.Excel

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Defines the SortCondition Class.

This class is available in Office 2010 and above.

When the object is serialized out as xml, it's qualified name is x14:sortCondition.

public class SortCondition : DocumentFormat.OpenXml.OpenXmlLeafElement

type SortCondition = class
    inherit OpenXmlLeafElement

Public Class SortCondition
Inherits OpenXmlLeafElement

Inheritance

Object

OpenXmlElement

OpenXmlLeafElement

SortCondition

Remarks

2.4.32 sortCondition

Target namespace: http://schemas.microsoft.com/office/spreadsheetml/2009/9/main

A sortCondition element is a CT_SortCondition type element, as specified in section 2.6.61, that specifies a sort condition to apply to a range. See section 2.2.4.4, section 2.2.4.6, section 2.2.4.9, and section 2.2.4.11 for how this element integrates with the Office Open XML file formats specified in [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.4 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

2.6.61 CT_SortCondition

Target namespace: http://schemas.microsoft.com/office/spreadsheetml/2009/9/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 (2) or column (2) 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", this value specifies the column (2) to which this sort condition applies and there MUST be only a single column (2) specified by ref. If the sortState.columnSort attribute that precedes this element is "true", this value specifies the row (2) to which this sort condition applies and there MUST be only a single row (2) 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 (2). The order of strings in the list specifies the sort order (2). 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 identifier 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 three icons, this value MUST be less than or equal to 2. If the icon set specified by iconSet has four icons, this value MUST be less than or equal to 3. If the icon set specified by iconSet has five 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.4 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

Constructors

SortCondition()

Initializes a new instance of the SortCondition class.

Properties

ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
CustomList	customList, this property is only available in Office 2010 and later. Represents the following attribute in the schema: customList
Descending	descending, this property is only available in Office 2010 and later. Represents the following attribute in the schema: descending
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
Features	Gets a IFeatureCollection for the current element. This feature collection will be read-only, but will inherit features from its parent part and package if available. (Inherited from OpenXmlElement)
FirstChild	Gets the first child of the OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlElement)
FormatId	dxfId, this property is only available in Office 2010 and later. Represents the following attribute in the schema: dxfId
HasAttributes	Gets a value indicating whether the current element has any attributes. (Inherited from OpenXmlElement)
HasChildren	Gets a value that indicates whether the current element has any child elements. (Inherited from OpenXmlLeafElement)
IconId	iconId, this property is only available in Office 2010 and later. Represents the following attribute in the schema: iconId
IconSet	iconSet, this property is only available in Office 2010 and later. Represents the following attribute in the schema: iconSet
InnerText	Gets or sets the concatenated values of the node and all of its children. (Inherited from OpenXmlElement)
InnerXml	Gets or sets the markup that only represents child elements of the current element. (Inherited from OpenXmlLeafElement)
LastChild	Gets the last child of the OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlElement)
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
NamespaceDeclarations	Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration. (Inherited from OpenXmlElement)
NamespaceUri	Gets the namespace URI of the current element. (Inherited from OpenXmlElement)
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
OuterXml	Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement)
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
Reference	ref, this property is only available in Office 2010 and later. Represents the following attribute in the schema: ref
SortBy	sortBy, this property is only available in Office 2010 and later. Represents the following attribute in the schema: sortBy
XmlQualifiedName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
XName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)

Methods

AddAnnotation(Object)	Adds an object to the current OpenXmlElement element's list of annotations. (Inherited from OpenXmlElement)
AddNamespaceDeclaration(String, String)	Adds a namespace declaration to the current node. (Inherited from OpenXmlElement)
Ancestors()	Enumerates all of the current element's ancestors. (Inherited from OpenXmlElement)
Ancestors<T>()	Enumerates only the current element's ancestors that have the specified type. (Inherited from OpenXmlElement)
Annotation(Type)	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotation<T>()	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations(Type)	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations<T>()	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Appends each element from a list of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
Append(OpenXmlElement[])	Appends each element from an array of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
AppendChild<T>(T)	Appends the specified element to the end of the current element's list of child nodes. (Inherited from OpenXmlElement)
ClearAllAttributes()	Clears all of the attributes, including both known attributes and extended attributes. (Inherited from OpenXmlElement)
Clone()	Creates a duplicate of the current node. (Inherited from OpenXmlElement)
CloneNode(Boolean)	Creates a duplicate of this node.
Descendants()	Enumerates all of the current element's descendants. (Inherited from OpenXmlElement)
Descendants<T>()	Enumerate all of the current element's descendants of type T. (Inherited from OpenXmlElement)
Elements()	Enumerates all of the current element's children. (Inherited from OpenXmlElement)
Elements<T>()	Enumerates only the current element's children that have the specified type. (Inherited from OpenXmlElement)
ElementsAfter()	Enumerates all of the sibling elements that follow the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
ElementsBefore()	Enumerates all of the sibling elements that precede the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
GetAttribute(String, String)	Gets an Open XML attribute with the specified tag name and namespace URI. (Inherited from OpenXmlElement)
GetAttributes()	Gets a list that contains a copy of all the attributes. (Inherited from OpenXmlElement)
GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)
GetFirstChild<T>()	Finds the first child element in type T. (Inherited from OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlElement)
InsertAfterSelf<T>(T)	Inserts the specified element immediately after the current element. (Inherited from OpenXmlElement)
InsertAt<T>(T, Int32)	Inserts the specified element at the specified index in the current element's list of child elements. (Inherited from OpenXmlElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlElement)
InsertBeforeSelf<T>(T)	Inserts the specified element immediately before the current element. (Inherited from OpenXmlElement)
IsAfter(OpenXmlElement)	Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement)
IsBefore(OpenXmlElement)	Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement)
LookupNamespace(String)	Resolves the namespace prefix in the context of the current node. (Inherited from OpenXmlElement)
LookupPrefix(String)	Finds the corresponding prefix for a namespace uri in the current element scope. (Inherited from OpenXmlElement)
NextSibling()	Gets the OpenXmlElement element that immediately follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement element. (Inherited from OpenXmlElement)
NextSibling<T>()	Gets the OpenXmlElement element with the specified type that follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement. (Inherited from OpenXmlElement)
PrependChild<T>(T)	Inserts the specified element at the beginning of the current element's list of child elements. (Inherited from OpenXmlElement)
PreviousSibling()	Gets the OpenXmlElement element that immediately precedes the current OpenXmlElement element. Returns null (Nothing in Visual Basic ) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
PreviousSibling<T>()	Gets the OpenXmlElement element with the specified type that precedes the current OpenXmlElement. Returns null (Nothing in Visual Basic) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
Remove()	Removes the current element from its parent. (Inherited from OpenXmlElement)
RemoveAllChildren()	Removes all child elements of the current element. (Inherited from OpenXmlLeafElement)
RemoveAllChildren<T>()	Remove all of the current element's child elements that are of type T. (Inherited from OpenXmlElement)
RemoveAnnotations(Type)	Removes the annotations of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAnnotations<T>()	Removes the annotations with the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAttribute(String, String)	Removes the attribute from the current element. (Inherited from OpenXmlElement)
RemoveChild<T>(T)	Removes the specified child element from the current element's list of child elements. (Inherited from OpenXmlElement)
RemoveNamespaceDeclaration(String)	Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. (Inherited from OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Replaces a child element with another child element in the current element's list of child elements. (Inherited from OpenXmlElement)
SetAttribute(OpenXmlAttribute)	Sets an attribute to the specified element. If the attribute is a known attribute, the value of the attribute is set. If the attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Sets a number of attributes to the element. If an attribute is a known attribute, the value of the attribute is set. If an attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
WriteTo(XmlWriter)	Saves the current node to the specified XmlWriter. (Inherited from OpenXmlElement)

Explicit Interface Implementations

IEnumerable.GetEnumerator()	(Inherited from OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)