API Reference

Class

PdfDocumentJavaScript

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Modifiers sealed

Explicit active-content operations for named document-level JavaScript.

Inheritance

  • Object
  • PdfDocumentJavaScript

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Methods

public PdfJavaScriptEditResult AddOrReplace(String name, String script) #
Returns: PdfJavaScriptEditResult

Adds a named script or replaces the source of an existing script with the same name.

Parameters

name System.String requiredposition: 0
script System.String requiredposition: 1
public PdfJavaScriptEditResult Clear() #
Returns: PdfJavaScriptEditResult

Removes every named document-level script.

public PdfJavaScriptEditResult Edit(Action<PdfJavaScriptEditSession> edit) #
Returns: PdfJavaScriptEditResult

Applies a transactional named-script collection edit. JavaScript is active content and may execute in capable PDF viewers. The default sanitization policy removes authored scripts unless JavaScript is explicitly allowed.

Parameters

edit System.Action{OfficeIMO.Pdf.PdfJavaScriptEditSession} requiredposition: 0
public IReadOnlyList<PdfJavaScript> List() #
Returns: IReadOnlyList<PdfJavaScript>

Lists named document-level scripts and their exact source text.

public PdfJavaScriptEditResult Remove(String name) #
Returns: PdfJavaScriptEditResult

Removes a named script when it exists.

Parameters

name System.String requiredposition: 0