Show / Hide Table of Contents

# Class Caret

A Caret annotation (PDF 1.5) is a visual symbol that indicates the presence of text edits.

##### Inheritance

object
Annot
Markup
Caret

##### Implements

IDisposable

##### Inherited Members

Markup.GetTitle()
Markup.SetTitle(string)
Markup.GetPopup()
Markup.SetPopup(Popup)
Markup.GetOpacity()
Markup.SetOpacity(double)
Markup.GetSubject()
Markup.SetSubject(string)
Markup.GetCreationDates()
Markup.SetCreationDates(Date)
Markup.GetBorderEffect()
Markup.SetBorderEffect(Markup.BorderEffect)
Markup.GetBorderEffectIntensity()
Markup.SetBorderEffectIntensity(double)
Markup.GetInteriorColor()
Markup.GetInteriorColorCompNum()
Markup.SetInteriorColor(ColorPt, int)
Markup.GetContentRect()
Markup.SetContentRect(Rect)
Markup.GetPadding()
Markup.SetPadding(Rect)
Markup.RotateAppearance(double)
Annot.Dispose()
Annot.Dispose(bool)
Annot.GetHandleInternal()
Annot.GetRefHandleInternal()
Annot.CreateInternal(IntPtr, object)
Annot.Create(SDFDoc, Annot.Type, Rect)
Annot.op_Assign(Annot)
Annot.Equals(object)
Annot.IsValid()
Annot.GetSDFObj()
Annot.GetType()
Annot.IsMarkup()
Annot.GetRect()
Annot.GetVisibleContentBox()
Annot.SetRect(Rect)
Annot.GetContents()
Annot.SetContents(string)
Annot.GetPage()
Annot.SetPage(Page)
Annot.GetUniqueID()
Annot.SetUniqueID(string)
Annot.GetDate()
Annot.SetDate(Date)
Annot.GetFlag(Annot.Flag)
Annot.SetFlag(Annot.Flag, bool)
Annot.GetBorderStyle()
Annot.SetBorderStyle(Annot.BorderStyle)
Annot.GetAppearance()
Annot.GetAppearance(Annot.AnnotationState)
Annot.GetAppearance(Annot.AnnotationState, string)
Annot.SetAppearance(Obj)
Annot.SetAppearance(Obj, Annot.AnnotationState)
Annot.SetAppearance(Obj, Annot.AnnotationState, string)
Annot.RemoveAppearance()
Annot.RemoveAppearance(Annot.AnnotationState)
Annot.RemoveAppearance(Annot.AnnotationState, string)
Annot.Flatten(Page)
Annot.GetActiveAppearanceState()
Annot.SetActiveAppearanceState(string)
Annot.GetColorAsRGB()
Annot.GetColorAsCMYK()
Annot.GetColorAsGray()
Annot.GetColorCompNum()
Annot.SetColor(ColorPt, int)
Annot.SetColor(ColorPt)
Annot.GetStructParent()
Annot.SetStructParent(int)
Annot.GetOptionalContent()
Annot.SetOptionalContent(Obj)
Annot.Resize(Rect)
Annot.GetRotation()
Annot.SetRotation(int)
Annot.RefreshAppearance()
Annot.GetCustomData(string)
Annot.SetCustomData(string, string)
Annot.DeleteCustomData(string)
object.Equals(object, object)
object.GetHashCode()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()

###### Namespace: pdftron.PDF.Annots

###### Assembly: PDFTronDotNet.dll

##### Syntax

    public class Caret : Markup, IDisposable

### Constructors

#### 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

### Implements

IDisposable