[This is preliminary documentation and is subject to change.]
Called when the user clicks on the sorting header above the columns.
Namespace: Tools.TotalCommanderTAssembly: Tools.TotalCommander (in Tools.TotalCommander.dll) Version: 1.5.3.38916 (1.5.3.38916)
Syntax
| C# |
|---|
[CLSCompliantAttribute(false)] [EditorBrowsableAttribute(EditorBrowsableState.Never)] public int ContentGetDefaultSortOrder( int FieldIndex ) |
| Visual Basic |
|---|
<CLSCompliantAttribute(False)> _ <EditorBrowsableAttribute(EditorBrowsableState.Never)> _ Public Function ContentGetDefaultSortOrder ( _ FieldIndex As Integer _ ) As Integer |
| Visual C++ |
|---|
[CLSCompliantAttribute(false)] [EditorBrowsableAttribute(EditorBrowsableState::Never)] public: int ContentGetDefaultSortOrder( int FieldIndex ) |
| F# |
|---|
[<CLSCompliantAttribute(false)>] [<EditorBrowsableAttribute(EditorBrowsableState.Never)>] member ContentGetDefaultSortOrder : FieldIndex:int -> int |
| JScript |
|---|
public function ContentGetDefaultSortOrder( FieldIndex : int ) : int |
Parameters
- FieldIndex
- Type: System..::..Int32
The index of the field for which the sort order should be returne
Return Value
Return 1 for ascending (a..z, 1..9), or -1 for descending (z..a, 9..0).
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.
This function is called by Total Commander and is not intended for direct use.
See Also
Version History
1.5.3
- This function is new in version 1.5.3