API referenceAnnotations

pdfSetAnnotBorderWidth

Set an annotation's /BE border-effect (beSolid,

C
BOOL32 __stdcall pdfSetAnnotBorderEffect(PPDF IPDF, uint32_t Handle, TBorderEffect Value);
BOOL32 __stdcall pdfSetAnnotBorderStyle(PPDF IPDF, uint32_t Handle, TBorderStyle Style);
BOOL32 __stdcall pdfSetAnnotBorderWidth(PPDF IPDF, uint32_t Handle, double LineWidth);
Delphi
function pdfSetAnnotBorderEffect(const IPDF: PPDF; Handle: Cardinal; Value: TBorderEffect): LongBool; stdcall;
function pdfSetAnnotBorderStyle(const IPDF: PPDF; Handle: Cardinal; Style: TBorderStyle): LongBool; stdcall;
function pdfSetAnnotBorderWidth(const IPDF: PPDF; Handle: Cardinal; LineWidth: Double): LongBool; stdcall;

Purpose. Set an annotation's /BE border-effect (beSolid, beCloudy1, beCloudy2), /BS /S border style (Solid/Bevelled/Inset/ Underline/Dashed/UserDefined), and /BS /W border line width, respectively.

Parameters.

ParameterDescription
IPDFDocument handle.
HandleDocument-wide annotation handle.
Value/Style/LineWidthThe property to set.

Return value. True if Handle resolves; False otherwise.

See also. pdfSetAnnotLineDashPattern (dashed border-style detail).

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs
[return: MarshalAs(UnmanagedType.Bool)]
Area
Annotations
Category

Annotations

Exported names

pdfSetAnnotBorderWidth

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.