API referenceAnnotations

pdfCaretAnnot

Create a Caret annotation (the text-insertion "^" marker).

C
int32_t __stdcall pdfCaretAnnotA(PPDF IPDF, double PosX, double PosY, double Width, double Height, uint32_t Color, TPDFColorSpace CS, const char* Author, const char* Subject, const char* Content);
int32_t __stdcall pdfCaretAnnotW(PPDF IPDF, double PosX, double PosY, double Width, double Height, uint32_t Color, TPDFColorSpace CS, const wchar_t* Author, const wchar_t* Subject, const wchar_t* Content);
Delphi
function pdfCaretAnnotA(const IPDF: PPDF; PosX, PosY, Width, Height: Double; Color: Cardinal; CS: TPDFColorSpace; const Author, Subject, Content: PAnsiChar): Integer; stdcall;
function pdfCaretAnnotW(const IPDF: PPDF; PosX, PosY, Width, Height: Double; Color: Cardinal; CS: TPDFColorSpace; const Author, Subject, Content: PWideChar): Integer; stdcall;

Purpose. Create a Caret annotation (the text-insertion "^" marker).

Parameters.

ParameterDescription
IPDFDocument handle.
PosX, PosY, Width, HeightBounding box.
ColorPacked color — see the chapter note (CS is dropped, always RGB).
CSAccepted but dropped.
Author, Subject, Content/T, /Subj, /Contents.

Return value. The new annotation's handle; 0 on failure.

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs
public static extern int pdfCaretAnnotA(IntPtr IPDF, double PosX, double PosY, double Width, double Height, uint Color, TPDFColorSpace CS, [MarshalAs(UnmanagedType.LPStr)] string Author, [MarshalAs(UnmanagedType.LPStr)] string Subject, [MarshalAs(UnmanagedType.LPStr)] string Content);
public static extern int pdfCaretAnnotW(IntPtr IPDF, double PosX, double PosY, double Width, double Height, uint Color, TPDFColorSpace CS, [MarshalAs(UnmanagedType.LPWStr)] string Author, [MarshalAs(UnmanagedType.LPWStr)] string Subject, [MarshalAs(UnmanagedType.LPWStr)] string Content);
Area
Annotations
Category

Core

Exported names

pdfCaretAnnotA pdfCaretAnnotW

String variants

The …A form takes UTF-8, …W takes UTF-16; a bare name aliases the ANSI form.

See working code

Worked examples — complete programs in ten languages.