PdfCaretAnnotation Class

Represents a caret annotation

Inheritance Hierarchy

SystemObject
  Patagames.Pdf.Net.WrappersPdfWrapper
    Patagames.Pdf.Net.AnnotationsPdfAnnotation
      Patagames.Pdf.Net.AnnotationsPdfMarkupAnnotation
        Patagames.Pdf.Net.AnnotationsPdfCaretAnnotation

Namespace: Patagames.Pdf.Net.Annotations
Assembly: Patagames.Pdf (in Patagames.Pdf.dll) Version: 4.111.2704

Syntax

C++

JavaScript

Copy

public class PdfCaretAnnotation : PdfMarkupAnnotation

Public Class PdfCaretAnnotation
	Inherits PdfMarkupAnnotation

public ref class PdfCaretAnnotation : public PdfMarkupAnnotation

type PdfCaretAnnotation = 
    class
        inherit PdfMarkupAnnotation
    end

public class PdfCaretAnnotation extends PdfMarkupAnnotation

Patagames.Pdf.Net.Annotations.PdfCaretAnnotation = function();

Type.createClass(
	'Patagames.Pdf.Net.Annotations.PdfCaretAnnotation',
	Patagames.Pdf.Net.Annotations.PdfMarkupAnnotation);

The PdfCaretAnnotation type exposes the following members.

Constructors

	Name	Description
	PdfCaretAnnotation(PdfPage)	Creates a new PdfCaretAnnotation.
	PdfCaretAnnotation(PdfPage, PdfTypeBase)	Initializes a new instance of the PdfCaretAnnotation class based on the specified dictionary.
	PdfCaretAnnotation(PdfPage, FS_RECTF, FS_COLOR, Boolean)	Creates a new PdfCaretAnnotation with parameters as specified.

Top

Properties

	Name	Description
	InnerRectangle	Gets or sets an inner rectangle of the annotation.
	IsSymbol	Gets or sets a value indicating whether a new paragraph symbol (¶) is associated with the caret.

Top

Methods

	Name	Description
	RegenerateAppearances	Re-creates the appearance of the annotation based on its properties (Overrides PdfMarkupAnnotationRegenerateAppearances)

Top

Remarks

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

Reference

Patagames.Pdf.Net.Annotations Namespace