TocEntry.CompareTo Method

TocEntryCompareTo Method

Compares this instance to another instance and returns an indication of their relative values.

Namespace: SandcastleBuilder.Utils.ConceptualContent
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

C++

Copy

public int CompareTo(
	TocEntry other
)

Public Function CompareTo ( 
	other As TocEntry
) As Integer

public:
virtual int CompareTo(
	TocEntry^ other
) sealed

abstract CompareTo : 
        other : TocEntry -> int 
override CompareTo : 
        other : TocEntry -> int

Parameters

other: Type: SandcastleBuilder.Utils.ConceptualContentTocEntry
A TocEntry object to compare

Return Value

Type: Int32
Returns -1 if this instance is less than the value, 0 if they are equal, or 1 if this instance is greater than the value or the value is null.

Implements

IComparableTCompareTo(T)

Remarks

The SortOrder property is compared first. If equal, the Title property is used.

Reference

TocEntry Class

SandcastleBuilder.Utils.ConceptualContent Namespace