API referenceCore SDK

pdfCreateJSAction

Create a JavaScript action object that runs Script when

Exported namespdfCreateJSActionA, pdfCreateJSActionW

Purpose — Create a JavaScript action object that runs Script when triggered.

Description — Registers action kind 1 with Script in Text. This is distinct from the document-level named-script registry used by pdfChangeJavaScript (see that entry) — a JS *action* is an object you attach to a trigger (annotation, field, bookmark, page open/close, catalog open-action); it is not the same store as document /Names/JavaScript entries.

Declarations

C
int32_t __stdcall pdfCreateJSActionA(PPDF IPDF, const char* Script);
int32_t __stdcall pdfCreateJSActionW(PPDF IPDF, const wchar_t* Script);
Delphi
function pdfCreateJSActionA(const IPDF: PPDF; const Script: PAnsiChar): Integer; stdcall; external 'LumasPdf.dll';
function pdfCreateJSActionW(const IPDF: PPDF; const Script: PWideChar): Integer; stdcall; external 'LumasPdf.dll';

Parameters

ParameterTypeDescription
IPDFPPDFInstance handle.
ScriptstringJavaScript source. W encodes via the engine's PDF-text conversion (PWideToPdfText), not a raw ANSI narrow.

Return value — 1-based action handle (> 0), or 0 on an invalid handle.

See alsopdfChangeJavaScriptAction, pdfChangeJavaScript

C# (P/Invoke)

wrappers/dotnet/LumasPdf.cs
public static extern int pdfCreateJSActionA(IntPtr IPDF, [MarshalAs(UnmanagedType.LPStr)] string Script);
public static extern int pdfCreateJSActionW(IntPtr IPDF, [MarshalAs(UnmanagedType.LPWStr)] string Script);
Area
Core SDK
Category

Object Creation

Exported names

pdfCreateJSActionA pdfCreateJSActionW

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.