Class TextMarkup
Text markup annotations shall appear as highlights, underlines, strikeouts (all PDF 1.3), or jagged ('squiggly') underlines (PDF 1.4) in the text of a document. When opened, they shall display a pop-up window containing the text of the associated note.
Implements
Inherited Members
Namespace: pdftron.PDF.Annots
Assembly: PDFNet.dll
Syntax
public class TextMarkup : Markup, IDisposableConstructors
TextMarkup(Obj)
Creates a TextMarkup annotation and initialize it using given Cos/SDF object.
Declaration
public TextMarkup(Obj d)Parameters
| Type | Name | Description |
|---|---|---|
| Obj | d | the d |
Remarks
The constructor does not copy any data, but is instead the logical equivalent of a type cast.
Methods
Dispose(bool)
Declaration
[HandleProcessCorruptedStateExceptions]
protected override void Dispose(bool A_0)Parameters
| Type | Name | Description |
|---|---|---|
| bool | A_0 |
Overrides
~TextMarkup()
Declaration
protected ~TextMarkup()GetQuadPoint(int)
Gets the QuadPoint located at a certain index of the QuadPoint array of the TextMarkup annotation.
Declaration
public QuadPoint GetQuadPoint(int idx)Parameters
| Type | Name | Description |
|---|---|---|
| int | idx | The index where the QuadPoint is to be located (the index is counted from 0, and continue on assendingly). |
Returns
| Type | Description |
|---|---|
| QuadPoint | The QuadPoint located at a certain index of the QuadPoint array of the TextMarkup annotation. |
Remarks
An array of n QuadPoints specifying the coordinates of nquadrilaterals in default user space. Each quadrilateral shall encompasses a word or group of contiguous words in the text underlying the annotation. The coordinates for each quadrilateral shall be given in the order p1, p2, p3, p4 specifying the quadrilateral's four vertices in counterclockwise order. The text shall be oriented with respect to the edge connecting points (p1) and (p2). The annotation dictionary's Appearance(AP) entry, if present, shall take precedence over QuadPoints.
Exceptions
| Type | Condition |
|---|---|
| PDFNetException | PDFNetException the PDFNet exception |
GetQuadPointCount()
Gets the number of QuadPoints in the QuadPoints array of the TextMarkup annotation.
Declaration
public int GetQuadPointCount()Returns
| Type | Description |
|---|---|
| int | The number of QuadPoints. |
Remarks
An array of n QuadPoints specifying the coordinates of nquadrilaterals in default user space. Each quadrilateral shall encompasses a word or group of contiguous words in the text underlying the annotation. The coordinates for each quadrilateral shall be given in the order p1, p2, p3, p4 specifying the quadrilateral's four vertices in counterclockwise order. The text shall be oriented with respect to the edge connecting points (p1) and (p2). The annotation dictionary's Appearance(AP) entry, if present, shall take precedence over QuadPoints.
Exceptions
| Type | Condition |
|---|---|
| PDFNetException | PDFNetException the PDFNet exception |
SetQuadPoint(int, QuadPoint)
Sets the QuadPoint to be located at a certain index of the QuadPoint array of the TextMarkup annotation. (Optional; PDF'1.6 )
Declaration
public void SetQuadPoint(int idx, QuadPoint qp)Parameters
| Type | Name | Description |
|---|---|---|
| int | idx | The index where the QuadPoint is to be located (the index is counted from 0, and continue on assendingly). |
| QuadPoint | qp | The QuadPoint to be located at a certain index of the QuadPoint array of the TextMarkup annotation. |
Remarks
To make this QuadPoint compatible with Adobe Acrobat|Reader, you can use either clockwise or counterclockwise order, but the points p3 and p4 must be swapped. This is because those readers do not follow the PDF specification for TextMarkup QuadPoints.
Exceptions
| Type | Condition |
|---|---|
| PDFNetException | PDFNetException the PDFNet exception |