SignDoc SDK (.NET without exceptions)  5.0.0
SignDocFindTextOccurrence Class Reference

Position of a hit returned by SignDocDocument.findText(). More...

Public Member Functions

 ~SignDocFindTextOccurrence ()
 Destructor. More...
 
 !SignDocFindTextOccurrence ()
 Finalizer. More...
 
 SignDocFindTextOccurrence ()
 Constructor. More...
 
 SignDocFindTextOccurrence (SignDocFindTextOccurrence aSource)
 Copy constructor. More...
 
int getNumberOfClusters ()
 Get the number of clusters making up the hit. More...
 
SignDocTextCluster getCluster (int aIndex)
 Get a cluster. More...
 
int getPage ()
 Get the page on which the glyphs of this object appear. More...
 
int[] getPages ()
 Get the pages on which the glyphs of this object appear. More...
 
int getUnicodeDirection ()
 Get the direction implied by the Unicode code points. More...
 
Rect[] getBoundingBoxes (int aPage, GetBoundingBoxesFlags aFlags)
 Get bounding boxes for the glyphs of this object. More...
 

Detailed Description

Position of a hit returned by SignDocDocument.findText().

Constructor & Destructor Documentation

Destructor.

Finalizer.

Constructor.

Copy constructor.

Parameters
[in]aSourceThe object to be copied.
Returns
The new object.

Member Function Documentation

Rect [] getBoundingBoxes ( int  aPage,
GetBoundingBoxesFlags  aFlags 
)

Get bounding boxes for the glyphs of this object.

Parameters
[in]aPageThe 1-based page number.
[in]aFlagsFlags controlling the behavior of this function, see GetBoundingBoxesFlags.Single, GetBoundingBoxesFlags.Individual, GetBoundingBoxesFlags.Logical. Exactly one of these flags must be set.
Returns
The bounding boxes.
See also
getPages(), getUnicodeDirection(), SignDocTextCluster.getGlyphBoundingBox()
SignDocTextCluster getCluster ( int  aIndex)

Get a cluster.

Parameters
[in]aIndexThe 0-based index of the cluster (logical order).
Returns
The cluster if successful, null if aIndex is out of range.
See also
getNumberOfClusters()
int getNumberOfClusters ( )

Get the number of clusters making up the hit.

Returns
The number of clusters.
int getPage ( )

Get the page on which the glyphs of this object appear.

The glyphs of a SignDocFindTextOccurrence object can appear on different pages, even on pages outside the range of pages passed to SignDocDocument.findText() or SignDocDocument.createTextIterator().

Returns
The 1-based page number of the page on which the glyphs appear or 0 if the glyphs appear on two or more different pages.
See also
getPages(), SignDocTextCluster.getGlyphPage(), SignDocTextCluster.getPage()
int [] getPages ( )

Get the pages on which the glyphs of this object appear.

The glyphs of a SignDocFindTextOccurrence object can appear on different pages, even on pages outside the range of pages passed to SignDocDocument.findText() or SignDocDocument.createTextIterator().

Returns
The 1-based page numbers of the pages on which the glyphs appear.
Note
The WinRT component returns null instead of an empty array.
See also
getPage(), SignDocTextCluster.getGlyphPage(), SignDocTextCluster.getPages()
int getUnicodeDirection ( )

Get the direction implied by the Unicode code points.

A lot of characters (such as punctuation characters) do not imply a direction. Unless there is at least one character that defines a direction, 0 will be returned. 0 is also returned if there are conflicting directions.

Returns
-1 for RTL, 1 for LTR, 0 if the direction cannot be determined unambiguously.

The documentation for this class was generated from the following file: