CompareTo Method

Compares this tool to another.

Syntax

Visual Basic

'Declaration
 
Protected Overridable Function CompareTo( _
   ByVal tool As ToolBase _
) As Integer

C#

protected virtual int CompareTo( 
   ToolBase tool
)

Parameters

tool

The ToolBase derived object to compare

Return Value

Returns 1 if the passed in tool has a lower Priority, 0 if the tool is the same tool or -1 if the passed in tool has a higher Priority.

If the tools have the same Priority then tools with higher indexes will be given lower priorities. This means that by default tools will be hidden from right to left as the toolbar is shortened.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2