isInOrder Method

Summary

A helper function for loosely determining if two DocumentViewerTextPosition objects are in order.

Syntax

JavaScript Syntax

isInOrder = function( 
   minPosition, 
   maxPosition 
)

TypeScript Syntax

static isInOrder( 
   minPosition: DocumentViewerTextPosition, 
   maxPosition: DocumentViewerTextPosition 
): boolean;

Parameters

minPosition

The DocumentViewerTextPosition that should be a lower page number and/or character index than maxPosition.

maxPosition

The DocumentViewerTextPosition that should be a higher page number and/or character index than minPosition.

Return Value

true if the minPosition has an explicitly lower page number and/or character index than maxPosition; otherwise false.

Remarks

IsInOrder indicates whether the two provided DocumentViewerTextPosition are in order from "lowest" to "highest" by PageNumber and then by CharacterIndex. If both page numbers are the same and if maxPosition has a CharacterIndex of -1 (indicating the end of a page), IsInOrder will return true; IsInOrder does not check against the actual last character in any document.

Pseudo-code:

if (minPosition.PageNumber < maxPosition.PageNumber) 
   return true; 
else if (minPosition.PageNumber == maxPosition.PageNumber) 
   return (maxPosition.CharacterIndex == -1) || (minPosition.CharacterIndex != -1 && minPosition.CharacterIndex < maxPosition.CharacterIndex); 
return false;

History

19.0.0.49: Added

Requirements

Target Platforms

Reference

DocumentViewerTextPosition Class

DocumentViewerTextPosition Members

Leadtools.Documents.UI Namespace

Help Version 19.0.2017.10.27