Table of Contents

TocEntry.CompareTo Method

Definition

Namespace
Sandcastle.Core.ConceptualContent
Assembly
Sandcastle.Core.dll

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

public int CompareTo(TocEntry other)

Parameters

other TocEntry

A TocEntry object to compare

Returns

int

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.

Remarks

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