November Happy Hour will be moved to Thursday December 5th.

AI OnAI Off

Class SearchSort

Inheritance
System.Object
SearchSort
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Mediachase.Search
Assembly: Mediachase.Search.dll
Version: 13.30.0
Syntax
public class SearchSort

Constructors

SearchSort(SearchSortField)

Initializes a new instance of the SearchSort class.

Declaration
public SearchSort(SearchSortField field)
Parameters
Type Name Description
SearchSortField field

The field.

SearchSort(SearchSortField[])

Initializes a new instance of the SearchSort class.

Declaration
public SearchSort(SearchSortField[] fields)
Parameters
Type Name Description
SearchSortField[] fields

The fields.

SearchSort(String)

Initializes a new instance of the SearchSort class.

Declaration
public SearchSort(string fieldName)
Parameters
Type Name Description
System.String fieldName

Name of the field.

SearchSort(String, Boolean)

Initializes a new instance of the SearchSort class.

Declaration
public SearchSort(string fieldName, bool isDescending)
Parameters
Type Name Description
System.String fieldName

Name of the field.
System.Boolean isDescending

if set to true [is descending].

SearchSort(String[])

Initializes a new instance of the SearchSort class.

Declaration
public SearchSort(string[] fieldNames)
Parameters
Type Name Description
System.String[] fieldNames

The field names.

Methods

GetSort()

Representation of the sort criteria.

Declaration
public virtual SearchSortField[] GetSort()
Returns
Type Description
SearchSortField[]

Array of SortField objects used in this sort criteria

SetSort(SearchSortField)

Sets the sort to the given criteria.

Declaration
public virtual void SetSort(SearchSortField field)
Parameters
Type Name Description
SearchSortField field

The field.

SetSort(SearchSortField[])

Sets the sort.

Declaration
public virtual void SetSort(SearchSortField[] fields)
Parameters
Type Name Description
SearchSortField[] fields

The fields.

SetSort(String)

Sets the sort to the terms in 

field
then by index order (document number).

Declaration
public void SetSort(string field)
Parameters
Type Name Description
System.String field

The field.

SetSort(String, Boolean)

Sets the sort.

Declaration
public virtual void SetSort(string field, bool isDescending)
Parameters
Type Name Description
System.String field

The field.
System.Boolean isDescending

if set to true [is descending].

SetSort(String[])

Sets the sort to the terms in each field in succession.

Declaration
public virtual void SetSort(string[] fieldnames)
Parameters
Type Name Description
System.String[] fieldnames

The fieldnames.

ToString()

Returns a System.String that represents this instance.

Declaration
public override string ToString()
Returns
Type Description
System.String

A System.String that represents this instance.
Overrides
System.Object.ToString()