Indicates one of the bounds of the Find Text operation.
Object.defineProperty(DocumentViewerFindText.prototype, 'endPosition',
get: function(),
set: function(value)
)
endPosition: DocumentViewerTextPosition;
A DocumentViewerTextPosition object indicating the page number and index of the bottom of the text search. The default value is null, which indicates the bottom of the last page of the document.
EndPosition allows DocumentViewerText.Find to have an ending bound. Its specification with BeginPosition also decides the direction of the search.
If EndPosition is found to be "greater than" BeginPosition - meaning a higher page number or character index - the search will be conducted in the "forward" direction, incrementing through the character indices and pages from BeginPosition to EndPosition. Otherwise, the search will be conducted in a "backward" direction, decrementing through the pages and character indices, but still from the BeginPosition to the EndPosition. Thus, to change direction between calls to DocumentViewerText.Find, swap the two properties.
Since a page's text may not yet be parsed when the search bounds are being chosen, both BeginPosition and EndPosition can take -1
as the value for DocumentViewerTextPosition.CharacterIndex. This value will be internally resolved to the index of the final character of the page if and when the page's text is retrieved. If DocumentViewerText.AutoGetText is false, the -1
will not resolve to a real index and the search will return no results for that page.
See Start as a way to change the starting point of the search from BeginPosition while maintaining BeginPosition as a bound. If FindAll or Loop are true, this could internally create two searches:
Search from the starting point to EndPosition.
If the starting point from (1) was not BeginPosition, and FindAll or Loop is true, search from BeginPosition to start – 1.
The default value is null, meaning the bottom of the final page.
For more information, refer to DocumentViewerText.Find.
History
Help Collections
Raster .NET | C API | C++ Class Library | HTML5 JavaScript
Document .NET | C API | C++ Class Library | HTML5 JavaScript
Medical .NET | C API | C++ Class Library | HTML5 JavaScript
Medical Web Viewer .NET
Multimedia
Direct Show .NET | C API | Filters
Media Foundation .NET | C API | Transforms
Supported Platforms
.NET, Java, Android, and iOS/macOS Assemblies
Imaging, Medical, and Document
C API/C++ Class Libraries
Imaging, Medical, and Document
HTML5 JavaScript Libraries
Imaging, Medical, and Document
Your email has been sent to support! Someone should be in touch! If your matter is urgent please come back into chat.
Chat Hours:
Monday - Friday, 8:30am to 6pm ET
Thank you for your feedback!
Please fill out the form again to start a new chat.
All agents are currently offline.
Chat Hours:
Monday - Friday
8:30AM - 6PM EST
To contact us please fill out this form and we will contact you via email.