SortProperties Property

For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.

Gets or sets the name of the property to sort on.

Namespace:  Microsoft.CommerceServer
Assembly:  Microsoft.CommerceServer.CrossTierTypes (in Microsoft.CommerceServer.CrossTierTypes.dll)

Syntax

'Declaration
Public Property SortProperties As String
'Usage
Dim instance As SearchOptions
Dim value As String

value = instance.SortProperties

instance.SortProperties = value
public string SortProperties { get; set; }
public:
property String^ SortProperties {
    String^ get ();
    void set (String^ value);
}
public function get SortProperties () : String
public function set SortProperties (value : String)

Property Value

Type: System..::.String
The name of the property to sort on.

Remarks

Sorting is allowed only on a single property and properties with IsMultivalued set to true cannot be specified as a sort property. Sorting can also be done on the client, which may reduce the load on the server, however, this does not work when server-side paging is employed. The value in this property must be a valid property name or an exception will be raised by the server when the search is executed. The sort property specified must be in the subset of values in the PropertiesToReturn list or an exception will be raised when the search is executed.

SortProperties cannot contain CatalogDataType.Text properties. This is a limitation of SQL Server.

Permissions

See Also

Reference

SearchOptions Class

SearchOptions Members

Microsoft.CommerceServer Namespace