ExtractJavaScript(string,string) Method

Summary

Extracts the list of JavaScript actions from a PDF document file.

Syntax

C++/CLI

Java

Python

public static IList<PDFJavaScript> ExtractJavaScript( 
   string fileName, 
   string password 
)

public static IList<PDFJavaScript>^ ExtractJavaScript( 
   string^ fileName, 
   string^ password 
)

public static java.util.List<PDFJavaScript> extractJavaScript( 
   java.lang.String fileName,  
   java.lang.String password 
);

def ExtractJavaScript(self,fileName,password):

Parameters

fileName

Name of the owner PDF document file.

password

The password to use when loading this PDF file (if the file is encrypted); otherwise, use null.

Remarks

This method is used to extract the JavaScript actions contained in a PDF file.

This method extracts all the global JavaScript actions contained in a PDF file as a list of PDFJavaScript objects. Each object contains properties indicating the name and the code.

The method returns an empty list of the source file does not contain JavaScript.

You can use PDFFile.WriteJavaScript to write JavaScript actions to a PDF file.

The JavaScript actions are global for the document and are not attached to a particular page. But pages or other PDF objects can reference these JavaScript actions.

The JavaScript actions are sorted and executed in ascending order based on the PDFJavaScript.Name property value.

Example

using Leadtools.WinForms; 
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Controls; 
using Leadtools.Drawing; 
using Leadtools.ImageProcessing; 
using Leadtools.Pdf; 
using Leadtools.Svg; 
 
 
public void TestExtractJavaScript_string_string() 
{ 
   string fileName = Path.Combine(LEAD_VARS.ImagesDir, "leadtools.pdf"); 
   IList<PDFJavaScript> list = PDFFile.ExtractJavaScript(fileName, null); 
 
   if (list == null || list.Count == 0) 
      Console.WriteLine("The source files does not have any javaScript"); 
   else 
   { 
      Console.WriteLine($"The source files has {list.Count} javascript actions"); 
      for (int i = 0; i < list.Count; i++) 
      { 
         Console.WriteLine($"  [{i}] Name = {list[i].Name}"); 
         Console.WriteLine($"  [{i}] Code = {list[i].Code}\n"); 
      } 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS22\Resources\Images"; 
}

Requirements

Target Platforms

Reference

PDFFile Class

PDFFile.ExtractJavaScript(stream,string)

PDFFile.WriteJavaScript

PDFFile Members

Leadtools.Pdf Namespace

Download our FREE evaluation

Help Version 22.0.2023.7.10