SortEntryVector Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides access to the sorting criteria of the query results as a collection of SortEntry objects.
public ref class SortEntryVector sealed : IIterable<SortEntry>, IVector<SortEntry>/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
class SortEntryVector final : IIterable<SortEntry>, IVector<SortEntry>[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public sealed class SortEntryVector : IEnumerable<SortEntry>, IList<SortEntry>Public NotInheritable Class SortEntryVector
Implements IEnumerable(Of SortEntry), IList(Of SortEntry)- Inheritance
- Attributes
- Implements
Windows requirements
| Device family |
Windows 10 (introduced in 10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v1.0)
|
Remarks
Note
Although it's not attributed with marshalling_behavior(agile), this class can be treated as agile. For more info, see Threading and Marshaling (C++/CX).
You can retrieve this object using QueryOptions.SortOrder.
Collection member lists
For JavaScript, SortEntryVector has the members shown in the member lists. In addition, SortEntryVector supports a length property, members of Array.prototype, and using an index to access items.
Enumerating the collection in C# or Microsoft Visual Basic
A SortEntryVector is enumerable, so you can use language-specific syntax such as foreach in C# to enumerate the items in the collection. The compiler does the type-casting for you and you won't need to cast to IEnumerable<SortEntry> explicitly. If you do need to cast explicitly, for example if you want to call GetEnumerator, cast to IEnumerable<T> with a SortEntry constraint.
Properties
| Size |
Gets the number of sort entries in the collection. |
Methods
| Append(SortEntry) |
Appends a sort entry to the end of the collection. |
| Clear() |
Removes all sort entries from the collection. |
| First() |
Retrieves an iterator that iterates through the sort entries in the collection. |
| GetAt(UInt32) |
Retrieves the sort entry at the specified index in the collection. |
| GetMany(UInt32, SortEntry[]) |
Retrieves the sort entries that start at the specified index in the collection. |
| GetView() |
Retrieves an immutable view of the collection of sort entries. |
| IndexOf(SortEntry, UInt32) |
Retrieves the index of a specified sort entry in the collection. |
| InsertAt(UInt32, SortEntry) |
Inserts a sort entry into the collection at a specified index. |
| RemoveAt(UInt32) |
Removes the sort entry at the specified index in the collection. |
| RemoveAtEnd() |
Removes the last sort entry from the collection. |
| ReplaceAll(SortEntry[]) |
Replaces all sort entries in the collection with the specified sort entries. |
| SetAt(UInt32, SortEntry) |
Sets the sort entry at the specified index of the collection. |