[This is preliminary documentation and is subject to change.]

When overriden in derived class, called when the user clicks on the sorting header above the columns.

Namespace: Tools.TotalCommanderT
Assembly: Tools.TotalCommander (in Tools.TotalCommander.dll) Version: 1.5.3.38916 (1.5.3.38916)

Syntax

C#
[MethodNotSupportedAttribute]
public virtual SortOrder GetDefaultSortOrder(
	int FieldIndex
)
Visual Basic
<MethodNotSupportedAttribute> _
Public Overridable Function GetDefaultSortOrder ( _
	FieldIndex As Integer _
) As SortOrder
Visual C++
[MethodNotSupportedAttribute]
public:
virtual SortOrder GetDefaultSortOrder(
	int FieldIndex
)
F#
[<MethodNotSupportedAttribute>]
abstract GetDefaultSortOrder : 
        FieldIndex:int -> SortOrder 
[<MethodNotSupportedAttribute>]
override GetDefaultSortOrder : 
        FieldIndex:int -> SortOrder
JScript
public function GetDefaultSortOrder(
	FieldIndex : int
) : SortOrder

Parameters

FieldIndex
Type: System..::..Int32
The index of the field for which the sort order should be returne

Return Value

One of the SortOrder values. [F:Tools::TotalCommanderT::SortOrder::unknown] has same meaning as [F:Tools::TotalCommanderT::SortOrder::Ascending].

Remarks

You may implement this function if there are fields which are usually sorted in descending order, like the size field (largest file first) or the date/time fields (newest first). If the function isn't implemented, ascending will be the default.

When most derived implementation of the function is marked with MethodNotSupportedAttribute, it means that the most derived plugin implementation does not support operation provided by the function.

Note
Do not throw any other exceptions. Such exception will be passed to Total Commander which cannot handle it.

Exceptions

ExceptionCondition
System..::..NotSupportedExceptionThe actual implementation is marked with MethodNotSupportedAttribute.
System..::..ArgumentOutOfRangeExceptionFieldIndex is out of range of field indexes as returned by SupportedFields. Throwing this exception has same effect as returning [F:Tools::TotalCommanderT::SortOrder::unknown].

See Also

Collapse/expand Version History

1.5.3

  • This function is new in version 1.5.3