Class TextExtractor.Line
TextExtractor.Line object represents a line of text on a PDF page. Each line consists of a sequence of words, and each words in one or more styles.
Inheritance
Namespace: pdftron.PDF
Assembly: PDFNetAndroid.dll
Syntax
public class Line : IDisposableConstructors
Line()
Declaration
public Line()Methods
Dispose()
Declaration
public void Dispose()Dispose(Boolean)
Declaration
protected virtual void Dispose(bool disposing)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | disposing |
EndsWithHyphen()
Ends with hyphen.
Declaration
public Boolean EndsWithHyphen()Returns
| Type | Description |
|---|---|
| Boolean | true, if successful |
Equals(Object)
Determines if equals to the specified object
Declaration
public override bool Equals(object o)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | o | specified object |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if both objects are equal. false, otherwise |
Finalize()
Releases all resources used by the Line
Declaration
protected void Finalize()GetBBox()
Gets the b box.
Declaration
public Rect GetBBox()Returns
| Type | Description |
|---|---|
| Rect | The bounding box for this line (in unrotated page coordinates). |
Remarks
To account for the effect of page '/Rotate' attribute, transform all points using page.GetDefaultMatrix().
GetCurrentNum()
Gets the current num.
Declaration
public Int32 GetCurrentNum()Returns
| Type | Description |
|---|---|
| Int32 | the index of this line of the current page. |
GetFirstWord()
Gets the first word.
Declaration
public TextExtractor.Word GetFirstWord()Returns
| Type | Description |
|---|---|
| TextExtractor.Word | the first word in the line. |
Remarks
To traverse the list of all words on this line use word.GetNextWord().
GetFlowID()
Gets the flow id.
Declaration
public Int32 GetFlowID()Returns
| Type | Description |
|---|---|
| Int32 | The unique identifier for a paragraph or column that this line belongs to. This information can be used to identify which lines/paragraphs belong to which flows. |
GetNextLine()
Gets the next line.
Declaration
public TextExtractor.Line GetNextLine()Returns
| Type | Description |
|---|---|
| TextExtractor.Line | the next line on the page. |
GetNumWords()
Gets the num words.
Declaration
public Int32 GetNumWords()Returns
| Type | Description |
|---|---|
| Int32 | The number of words in this line. |
GetParagraphID()
Gets the paragraph id.
Declaration
public Int32 GetParagraphID()Returns
| Type | Description |
|---|---|
| Int32 | The unique identifier for a paragraph or column that this line belongs to. This information can be used to identify which lines belong to which paragraphs. |
GetQuad()
Gets the quad.
Declaration
public double[] GetQuad()Returns
| Type | Description |
|---|---|
| System.Double[] | out_quad The quadrilateral representing a tight bounding box for this line (in unrotated page coordinates). |
GetStyle()
Gets the style.
Declaration
public TextExtractor.Style GetStyle()Returns
| Type | Description |
|---|---|
| TextExtractor.Style | predominant style for this line. |
GetWord(Int32)
Gets the first word.
Declaration
public TextExtractor.Word GetWord(Int32 word_idx)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | word_idx | index of the word |
Returns
| Type | Description |
|---|---|
| TextExtractor.Word | word with specified index |
IsSimpleLine()
Checks if is simple line.
Declaration
public Boolean IsSimpleLine()Returns
| Type | Description |
|---|---|
| Boolean | true is this line is not rotated (i.e. if the quadrilaterals returned by GetBBox() and GetQuad() coincide). |
IsValid()
Checks if line is valid
Declaration
public bool IsValid()Returns
| Type | Description |
|---|---|
| System.Boolean | true if line is valid, false otherwise. |
op_Assign(TextExtractor.Line)
Assignment operator
Declaration
public TextExtractor.Line op_Assign(TextExtractor.Line l)Parameters
| Type | Name | Description |
|---|---|---|
| TextExtractor.Line | l | another |
Returns
| Type | Description |
|---|---|
| TextExtractor.Line | a |
Set(TextExtractor.Line)
Sets value to the specified Line object
Declaration
public void Set(TextExtractor.Line r)Parameters
| Type | Name | Description |
|---|---|---|
| TextExtractor.Line | r | another |
Operators
Equality(TextExtractor.Line, TextExtractor.Line)
Equality operator checks whether two Line objects are the same.
Declaration
public static Boolean operator ==(TextExtractor.Line l, TextExtractor.Line r)Parameters
| Type | Name | Description |
|---|---|---|
| TextExtractor.Line | l |
|
| TextExtractor.Line | r |
|
Returns
| Type | Description |
|---|---|
| Boolean | true if both objects are equal |
Inequality(TextExtractor.Line, TextExtractor.Line)
Inequality operator checks whether two Line objects are different.
Declaration
public static Boolean operator !=(TextExtractor.Line l, TextExtractor.Line r)Parameters
| Type | Name | Description |
|---|---|---|
| TextExtractor.Line | l |
|
| TextExtractor.Line | r |
|
Returns
| Type | Description |
|---|---|
| Boolean | true if both objects are equal |