Class Caret
A Caret annotation (PDF 1.5) is a visual symbol that indicates the presence of text edits.
Implements
Inherited Members
Namespace: pdftron.PDF.Annots
Assembly: PDFTronDotNet.dll
Syntax
public class Caret : Markup, IDisposableConstructors
Caret(Annot)
Creates an Caret annotation and initialize it using given annotation object.
Declaration
public Caret(Annot ann)Parameters
| Type | Name | Description |
|---|---|---|
| Annot | ann | the annot |
Remarks
The constructor does not copy any data, but is instead the logical equivalent of a type cast.
Exceptions
| Type | Condition |
|---|---|
| PDFNetException | PDFNetException the PDFNet exception |
Caret(Obj)
Creates an Caret annotation and initialize it using given Cos/SDF object.
Declaration
public Caret(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
Create(SDFDoc, Rect)
Creates an Caret annotation and initialize it using given annotation object.
Declaration
public static Caret Create(SDFDoc doc, Rect pos)Parameters
| Type | Name | Description |
|---|---|---|
| SDFDoc | doc | SDFDoc to create Caret in |
| Rect | pos | position of the caret |
Returns
| Type | Description |
|---|---|
| Caret | newly created Caret |
Exceptions
| Type | Condition |
|---|---|
| PDFNetException | PDFNetException the PDFNet exception |
Create(SDFDoc, Rect, Rect)
Declaration
public static Caret Create(SDFDoc doc, Rect pos, Rect padding)Parameters
| Type | Name | Description |
|---|---|---|
| SDFDoc | doc | |
| Rect | pos | |
| Rect | padding |
Returns
| Type | Description |
|---|---|
| Caret |
~Caret()
Releases all resources used by the Caret
Declaration
protected ~Caret()GetSymbol()
Gets the paragraph symbol displayed along with the Caret.
Declaration
public string GetSymbol()Returns
| Type | Description |
|---|---|
| string | A pointer to an array of charactors that specifies the Caret content. |
Remarks
the content of the Caret Annotation is a name specifying a symbol that shall be associated with the Caret: P - A new paragraph symbol (¶) should be associated with the Caret. None - No symbol should be associated with the Caret. Default value: None.
Exceptions
| Type | Condition |
|---|---|
| PDFNetException | PDFNetException the PDFNet exception |
SetSymbol(string)
Sets the paragraph symbol displayed along with the Caret. (Optional)
Declaration
public void SetSymbol(string contt)Parameters
| Type | Name | Description |
|---|---|---|
| string | contt | A pointer to an array of charactors that specifies the Caret content. specifies the Caret content. |
Remarks
the content of the Caret Annotation is a name specifying a symbol that shall be associated with the Caret: P - A new paragraph symbol (¶) should be associated with the Caret. None - No symbol should be associated with the Caret. Default value: None.
Exceptions
| Type | Condition |
|---|---|
| PDFNetException | PDFNetException the PDFNet exception |