Adobe Acrobat SDK

https://opensource.adobe.com/dc-acrobat-sdk-docs/
Admin
Adobe Acrobat SDK provides developer tools and APIs for building applications that interact with PDF...
Tokens:819,955
Snippets:7,878
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install Event Listeners for Media Events

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/JS_API_AcroJS.html

This example shows how to install 'onPlay' and 'afterPlay' event listeners for a media player using two different techniques. These listeners log messages to the console when executed. The 'on' methods are called immediately, while 'after' methods are called later during idle time.

```javascript
// Create a simple MediaEvents object
var events = new app.media.Events
({
    // Called immediately during a Play event:
    onPlay: function() { console.println( "onPlay" ); },

    // Called during idle time after the Play event:
    afterPlay: function() { console.println( "afterPlay" ); },
});
var player = app.media.createPlayer({events: events});
player.events.add({
    afterPlay: function( e ) {
        app.alert("Playback started, doc.URL = " + e.media.doc.URL );
    }
});
player.open();

```

--------------------------------

### DDE Message Setup Example

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/interapp/IAC_DevApp_DDE_Support.html

Defines the constants for DDE server name, topic name, and an example item name for executing a command. Ensure square brackets are used for commands and messages are case-sensitive.

```plaintext
DDE_SERVERNAME = "acroview";
DDE_TOPICNAME = "control";
DDE_ITEMNAME = "[AppHide()]";

```

--------------------------------

### Register Agent with Consultant

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/plugin/Plugins_ExtendedAPI.html

This example demonstrates how to create a consultant, register an agent with it, and start the traversal process. Ensure proper memory management by destroying the consultant and freeing memory when done.

```c
// Declare volatile consultant because it is inside a DURING bloc
 //   Consultant volatile hConsultant = (Consultant)NULL;

DURING
   AVDoc hAVDoc = AVAppGetActiveDoc();
   miAssert(hAVDoc != ( AVDoc )NULL );
   if( hAVDoc != ( AVDoc )NULL )
       {

 // Create a Consultant object
 //        hConsultant = ConsultantCreate(
       DumpAllObjectsAgentPercentDone );
       miAssert( hConsultant != ( Consultant )NULL );

       if( hConsultant != ( Consultant )NULL )
       {

 // Get the current document root
 //            PDDoc hPDDoc = AVDocGetPDDoc(hAVDoc);


 // Create an agent and register it
 //            gDumpAllObjectsAgent = new DumpAllObjectsAgent(hPDDoc);

           if((gDumpAllObjectsAgent == (DumpAllObjectsAgent*)NULL)
           || (gDumpAllObjectsAgent->IsValid() == false))
           {
           ASRaise(GenError(genErrNoMemory) );
           }
           else
           {
           ConsultantRegisterAgent(hConsultant,*gDumpAllObjectsAgent,
           REG_REVISITRECLASS_ALL );


 // Start the consultant
 //            ConsultantTraverseFrom(hConsultant,
           CosDocGetRoot(PDDocGetCosDoc(hPDDoc)),PT_CATALOG);
           }
       }
 }
 HANDLER
... Destroy Consultant...Free Memory...
 END_HANDLER

```

--------------------------------

### Basic Bookmark Examples

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/pdfmark/pdfmark_Basic.html

Examples demonstrating various bookmark configurations, including opening documents, navigating to specific pages and views, and setting zoom levels.

```postscript
[ /Count 2 /Page 1 /View [/XYZ 44 730 1.0] /Title (Open Actions) /OUT pdfmark

```

```postscript
[ /Action /Launch /File (test.doc) /Title (Open test.doc) /OUT pdfmark

```

```postscript
[ /Action /GoToR /File (test.pdf) /Page 2 /View [/FitR 30 648 209 761]
    /Title (Open test.pdf on page 2) /OUT pdfmark

```

```postscript
[ /Count 2 /Page 2 /View [/XYZ 44 730 1.0] /Title (Fixed Zoom) /OUT pdfmark

```

```postscript
[ /Page 2 /View [/XYZ 44 730 2.0] /Title (200% Magnification) /OUT pdfmark

```

```postscript
[ /Count 1 /Page 2 /View [/XYZ 44 730 4.0] /Title (400% Magnification)
    /OUT pdfmark

```

```postscript
[ /Page 2 /View [/XYZ 44 730 5.23] /Title (523% Magnification) /OUT pdfmark

```

```postscript
[ /Count 3 /Page 1 /View [/XYZ 44 730 1.0] /Title (Table of Contents #1)
    /OUT pdfmark

```

```postscript
[ /Page 1 /View [/XYZ 44 730 1.0] /Title (Page 1 - 100%) /OUT pdfmark

```

```postscript
[ /Page 2 /View [/XYZ 44 730 2.25] /Title (Page 2 - 225%) /OUT pdfmark

```

```postscript
[ /Page 3 /View [/Fit] /Title (Page 3 - Fit Page) /OUT pdfmark

```

```postscript
[ /Count -3 /Page 1 /View [/XYZ 44 730 1.0] /Title (Table of Contents #2)
    /OUT pdfmark

```

```postscript
[ /Page 1 /View [/XYZ null null 0] /Title (Page 1 - Inherit) /OUT pdfmark

```

```postscript
[ /Page 2 /View [/XYZ null null 0] /Title (Page 2 - Inherit) /OUT pdfmark

```

```postscript
[ /Page 3 /View [/XYZ null null 0] /Title (Page 3 - Inherit) /OUT pdfmark

```

```postscript
[ /Count 1 /Page 0 /Title (Articles) /OUT pdfmark

```

```postscript
[ /Action /Article /Dest (Now is the Time) /Title (Now is the Time) /OUT pdfmark

```

--------------------------------

### Full Plugin Initialization Example

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/plugin/Plugins_Toolbutton.html

This example demonstrates the complete process of creating a toolbar button, defining its callback, associating them, and attaching the button to the File toolbar within the PluginInit procedure. It also includes releasing the callback.

```c
//Define a toolbar button callback function
   ACCB1 void ACCB2 ShowButtonMessage (void* data)

   {
   AVAlertNote ("A button was clicked.");
   }
   ACCB1 ASBool ACCB2 PluginInit (void)

   {

//Declare an AVToolButton object
   AVToolButton MyButton = NULL;

//Create a AVIcon object
   AVIcon myIcon = (AVCursor)LoadBitmap(gHINSTANCE, MAKEINTRESOURCE(IDB_BITMAP1));

//Create a new button
   MyButton = AVToolButtonNew (ASAtomFromString("MyExtn:MyButton"), myIcon, FALSE, FALSE);

//Retrieve the File toolbar
   const char * toolbarName= "File" ;
   AVToolBar ToolBar = AVAppGetToolBarByName(toolbarName);

//Create toolbar button callback
   AVExecuteProc ExecProcPtr = ASCallbackCreateProto (AVExecuteProc, &ShowButtonMessage);
   AVToolButtonSetExecuteProc (MyButton, ExecProcPtr, NULL);

//Attach the button
   AVToolBarAddButton(ToolBar, MyButton, FALSE, NULL);

//Release the callback function
   ASCallbackDestroy(ExecProcPtr);

   return true;
   }
```

--------------------------------

### Parameter Help Output Example

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/index.html

Example output from using 'acrohelp' with the app.response method, showing the expected format for parameter information.

```text
HelpError: Help.
app.response:1:Console undefined:Exec
====> [cQuestion: string]
====> [cTitle: string]
====> [cDefault: string]
====> [bPassword: boolean]
====> [cLabel: string]

```

--------------------------------

### SpellCheckWord Example

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/plugin/Plugins_ExtendedAPI.html

Demonstrates calling SpellCheckWord to get spelling suggestions. It shows how to process the returned alternative words and convert them to a host-encoded string.

```c
char **altArray = NULL;
 ASInt32 altCount = 0;
 ASBool status = SpellCheckWord(acd, cWord, NULL, 0, &altArray, &altCount);
 if (altCount) {
     ASText ast = ASTextFromPDText(altArray[1]);
     char* altWord = ASTextGetEncodedCopy(ast, (ASHostEncoding)
     PDGetHostEncoding() );
 }
```

--------------------------------

### Get URL with Policy

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/JS_API_AcroJS.html

Demonstrates allowed and disallowed URL fetches after a policy file has been loaded. This code continues the previous example of loading a policy file.

```javascript
this.getURL("http://www.example.com/sub/dir/vars.txt", true) // allowed
this.getURL("http://www.example.com/sub/dir/deep/vars2.txt", true) // allowed
this.getURL("http://www.example.com/mydir/vars3.txt", true) // not allowed
```

--------------------------------

### Example DOCVIEW pdfmark for File Open Action

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/pdfmark/pdfmark_Basic.html

This example demonstrates setting the page mode to display outlines, opening to page 2 with a specific view, and executing the DOCVIEW pdfmark.

```postscript
[ /PageMode /UseOutlines
    /Page 2 /View [/XYZ null null null]
    /DOCVIEW pdfmark

```

--------------------------------

### Retrieve APS Security Policies with Login

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/JS_API_AcroJS.html

This example demonstrates forcing a login for APS policies and then retrieving a list of policies. It shows how to get a handler, log in, and filter policies by handler.

```javascript
var aps = security.getHandler( security.APSHandler, true );
aps.login();
var options = { cHandler: security.APSHandler };
var policyArray = security.getSecurityPolicies({
    bUI: true,
    oOptions: options });
for(var i = 0; i < policyArray.length; i++)
    console.println( policyArray[i].name );
```

--------------------------------

### Example DOCINFO pdfmark

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/pdfmark/pdfmark_Basic.html

An example of how to set various document information fields using the DOCINFO pdfmark operator, including custom keys.

```postscript
[ /Title (My Test Document)
    /Author (John Doe)
    /Subject (pdfmark 3.0)
    /Keywords (pdfmark, example, test)
    /Creator (Hand programmed)
    /ModificationDate (D:19940912205731)
    /ADBETest_MyKey (My private information)
    /DOCINFO pdfmark

```

--------------------------------

### Get and Post View State to Host Application

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/doc.html

This example retrieves the current view state of a PDF document and posts it to the host application. The host application can then store this state and use it to restore the document's view later. This code is typically executed by a button within the PDF.

```javascript
if(this.hostContainer)
{
    cVState = this.viewState.toSource();
    aMsg = new Array( "viewState", cVState );
    this.hostContainer.postMessage(aMsg);
}
```

--------------------------------

### Print Security Handler Name (Example)

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/doc.html

An example output showing the security handler name if the document is encrypted with the standard security handler.

```javascript
This document is encrypted with Standard security.

```

--------------------------------

### SOAP Request Example

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/JS_API_AcroJS.html

This example demonstrates a basic SOAP request using the SOAP.request method, including request headers.

```APIDOC
## SOAP Request with Headers

### Description
This example shows how to make a SOAP request including custom request and response headers.

### Method
SOAP.request()

### Parameters
- `cURL` (string): The URL for the SOAP service.
- `oRequest` (object): The SOAP request object.
- `cAction` (string): The SOAP action.
- `oReqHeader` (object): An object containing custom request headers.
- `oRespHeader` (object): An object to store the response headers.

### Request Example
```javascript
var cURL = "http://soapinterop.org/"
var NS = "http://soapinterop.org/";
var oHeader = {
    soapValue: "Header Test String"
};
var oResultHeader = {};
var oRequest = {};
oRequest[NS + "echoHeader"] = {};
var response = SOAP.request(
{
    cURL: cURL,
    oRequest: oRequest,
    cAction: "http://soapinterop.org/",
    oReqHeader: oHeader,
    oRespHeader: oResultHeader
});
```
```

--------------------------------

### Example: Page Label Settings

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/pdfmark/pdfmark_Basic.html

This example shows how to set a page label to 'Sec1:1' and plate color to 'Cyan' for one page, and a label 'iii' for another page.

```postscript
%%Page: Sec1:2 1
%%PlateColor: Cyan
[ /Label (Sec1:1) /PlateColor (Cyan) /PAGELABEL pdfmark

%%Page: iii 3
[ /Label (iii) /PAGELABEL pdfmark


```

--------------------------------

### Enumerate Installed Plug-ins

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/JS_API_AcroJS.html

Retrieves an array of `PlugIn` objects, counts them, and then iterates through the array to print the name of each installed plug-in.

```javascript
// Get array of PlugIn objects
var aPlugins = app.plugIns;
// Get number of plug-ins
var nPlugins = aPlugins.length;
// Enumerate names of all plug-ins
for ( var i = 0; i < nPlugins; i++)
    console.println("Plugin #"+i+" is " + aPlugins[i].name);

```

--------------------------------

### Get Name of Bookmark Example

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/interapp/IAC_API_AppleEvtObjects.html

Example of retrieving the name of the last bookmark.

```applescript
get the name of last bookmark
```

--------------------------------

### Stream Manipulation Example

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/pdfmark/pdfmark_Syntax.html

An example demonstrating the creation, population, and closing of a stream object named 'MoonNotes' using pdfmark, including adding dictionary entries and closing the stream.

```pdfmark
[   /_objdef {MoonNotes} /type /stream /OBJ pdfmark

```

```pdfmark
[   {MoonNotes} (Hipparchus around 129 BC calculated the distance to the Moon.n)
    /PUT pdfmark

```

```pdfmark
[   {MoonNotes} (The Moon was first touched by Armstrong on July 20, 1969.n)
    /PUT pdfmark

```

```pdfmark
[   {MoonNotes} << /Author (Steve Amerige) /Company (Adobe) >> /PUT pdfmark

```

```pdfmark
[   {Catalog} << /MoonNotes {MoonNotes} >> /PUT pdfmark

```

```pdfmark
[   {MoonNotes} /CLOSE pdfmark

```

--------------------------------

### Get SceneObject by GUID - JavaScript

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/js3dapi/JS_3D_API.html

Obtains a SceneObject from the list using its GUID. This method is deprecated.

```javascript
getByGUID(guid)
```

--------------------------------

### Initialize and Run an AVCommand Handler

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/plugin/Plugins_Handlers.html

This example demonstrates the complete process of creating an AVCommand handler, setting its inputs and parameters, and executing the command. It includes registering the handler and invoking the command.

```C
void InitializeCommandHandler()

{

//Declare local variables
static AVCommandHandlerRec gAVCmdHandler;
const char *kCmdName = "MinimalCommand";
ASAtom cmdName;
AVCommand cmd;
const char *docTitleValue = "Document Title";
const char *docSubjectValue = "Document Subject";


//Create a PDDoc object based on the current PDF document
AVDoc avDoc = AVAppGetActiveDoc();
AVPageView pageView = AVDocGetPageView(avDoc);
PDPageNumber pageNum = AVPageViewGetPageNum(pageView);
PDDoc pdDoc = AVDocGetPDDoc(avDoc);


//Create an AVCommandHandlerRec object
memset (&gAVCmdHandler, 0, sizeof(AVCommandHandlerRec));
gAVCmdHandler.size = sizeof(AVCommandHandlerRec);
gAVCmdHandler.Work = ASCallbackCreateProto (AVCommandWorkProc, DoWorkImpl);
AVAppRegisterCommandHandler (ASAtomFromString(kCmdName),&gAVCmdHandler);


//Invoke the AVCommand
cmdName = ASAtomFromString ("MinimalCommand");
cmd = AVCommandNew(cmdName);


//Set the input parameters
ASCab inputs = ASCabNew();
ASCabPutPointer (inputs, kAVCommandKeyPDDoc, PDDoc, pdDoc, NULL);


//Set the input parameters and destroy the container ASCab
if (kAVCommandReady != AVCommandSetInputs (cmd, inputs)) {
   // Handle error
}


//Create an ASCab object to hold command parameters
ASCab params = ASCabNew();
ASText text = ASTextNew();
ASTextSetEncoded(text, docTitleValue,(ASHostEncoding)PDGetHostEncoding());
ASCabPutText (params, docTitleValue, text);


//Clear the ASText object
text = ASTextNew();
ASTextSetEncoded(text, docSubjectValue,(ASHostEncoding)PDGetHostEncoding());
ASCabPutText(params, docSubjectValue, text);


//Invoke the command
AVCommandExecute(cmd);
}


static ACCB1 AVCommandStatus ACCB2 DoWorkImpl (AVCommand cmd)

{
AVAlertNote("The DoWorkImpl method was invoked");
return kAVCommandDone;
}
```

--------------------------------

### Get Index of Bookmark as String Example

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/interapp/IAC_API_AppleEvtObjects.html

Example of retrieving the index of the last bookmark, returned as a string.

```applescript
get the index of last bookmark as string
```

--------------------------------

### Get and Set Method Usage

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/plugin/index.html

Explains the purpose and usage of Get and Set methods for retrieving and modifying object attributes, with examples.

```APIDOC
Get and Set methods are used for getting and setting object attributes. Each object type has zero or more attributes. For example, an annotation object (`PDAnnot` ) contains attributes such as color and date. You can obtain and modify attribute values by using methods such as `PDAnnotGetColor` and `PDAnnotSetDate`.
```

--------------------------------

### Display Alert Box on Plugin Start

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/plugin/Plugins_CreatingSimplePlug.html

Add this line to the PluginInit method to display an alert box when Adobe Reader or Acrobat starts. This is a basic example of invoking application logic within your plugin.

```c
AVAlertNote("This is your first plugin");

```

--------------------------------

### Enumerate Directories and Connect

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/JS_API_AcroJS.html

This example demonstrates how to enumerate available directories using the security handler and establish a connection to the first directory in the list. The connect method can optionally take parameters for authentication.

```javascript
var sh = security.getHandler( "Adobe.PPKMS" );
var dirList = sh.directories;
for ( var i=0; i< dirList.length; i++)
    for ( var o in dirList[i].info )
        console.println( o + " = " + dirList[i].info[o]);
var dirConnection = dirList[0].connect();
```

--------------------------------

### Import and Play Sounds

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/doc.html

This example shows how to import two sounds, associate them with names, and then play them back using the getSound method. It covers both default and specified file paths.

```javascript
this.importSound("Moo");
this.getSound("Moo").play();
this.importSound("Moof", "./moof.wav");
this.getSound("Moof").play();
```

--------------------------------

### Cos Name Literal Example

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/plugin/Plugins_Cos.html

Illustrates the basic syntax for a Cos name object, which starts with a slash.

```plaintext
/AName

```

--------------------------------

### Get Field Object

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/JS_API_AcroJS.html

This example allows the script to manipulate the form field “Total” by means of the variable `f`.

```javascript
var f = this.getField("Total");
```

--------------------------------

### Get All Dad Node Attributes

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/JS_API_AcroJS.html

Retrieves all attributes of the 'dad' node. This example demonstrates iterating through the returned node list and printing each attribute.

```javascript
var b = XMLData.applyXPath( myXML, "//family/dad/attribute::*" );
for(var i=0; i < b.length; i++)
    console.println(b.item(i).saveXML('pretty'))
```

--------------------------------

### Running Mac OS Sample Applications from Command Line

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/plugin/Plugins_CreatingSimplePlug.html

Demonstrates how to navigate to the executable within a Mac OS application package and run it from the Terminal.

```bash
$ cd helowrld.app/Contents/MacOS/
$ helowrld

```

--------------------------------

### Accessing a Form Field

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/JS_API_AcroJS.html

This example demonstrates how to get a reference to a form field named 'Total' and store it in a JavaScript variable 'f' for manipulation.

```APIDOC
## Accessing a Form Field

### Description
This example allows the script to manipulate the form field "Total" by means of the variable `f`.

### Method
`getField(fieldName)`

### Endpoint
N/A (JavaScript method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
var f = this.getField("Total");
```

### Response
#### Success Response (Field Object)
- **f** (Field Object) - A reference to the specified form field.

#### Response Example
N/A
```

--------------------------------

### Advanced media playback with event handling

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/media.html

This example demonstrates opening a media player, counting markers, and handling script commands to control playback. It uses `app.media.openPlayer` and custom event listeners for `afterReady` and `afterScript`.

```javascript
var nMarkers=0;
var events = new app.media.Events;
events.add({
    // Count the number of quotes in this audio clip, save as nMarkers
    afterReady: function()
    {
        var g = player.markers;
        while ( (index =  g.get( { index: nMarkers } ) ) != null )

             nMarkers++;
    },
    // Each quote should be followed by a script, if the command is to

     // pause, then pause the player.
    afterScript: function( e ) {
        if ( e.media.command == "pause" ) player.pause();
    }
});
var player = app.media.openPlayer({
    rendition: this.media.getRendition( "myQuotes" ),
    settings: { autoPlay: false },
    events: events
});
// Randomly choose a quotation
function randomQuote() {
    var randomMarker, randomMarkerName;
    console.println("nMarkers = " + nMarkers);
    // Randomly choose an integer between 1 and nMarkers, inclusive
    randomMarker = Math.floor(Math.random() * 100) % ( nMarkers ) + 1;
    // Indicate what quotation we are playing
    this.getField("Quote").value = "Playing quote " + randomMarker;
    // The marker names are "quote 1", "quote 2", "quote 3", etc.
    randomMarkerName = "quote " + randomMarker;
    // See the marker with the name randomMarkerName
    player.seek( { marker: randomMarkerName } );
    player.play();
}


```

```javascript
try { randomQuote() } catch(e) {}

```

--------------------------------

### Create Menu Callback Functions

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/plugin/Plugins_Menu.html

This example demonstrates the creation of 'Execute', 'Compute-marked', and 'Compute-enabled' callback functions, along with their respective pointers and conversion to Acrobat callbacks. It also includes the initialization of menu variables and retrieval of the menubar.

```c
   /* Display a message box */
   ACCB1 void ACCB2 ShowMessage (void* data)
   {
   AVAlertNote ("A menu command was selected.");
   }
   ACCB1 ASBool ACCB2 ComputeMarkedProc (void* data)
   {
   ASBool expressionorcondition = true;
   if (expressionorcondition)
         return true;
   else return false;
   }
   ACCB1 ASBool ACCB2 ComputeEnabledProc (void* data)
   {
   if (AVAppGetNumDocs() > 0)
         return true;
   else return false;
   }
   ACCB1 ASBool ACCB2 PluginInit (void)
   {

//Declare menu callbacks
   AVExecuteProc ExecProcPtr = NULL;
   AVComputeEnabledProc CompEnabledProcPtr = NULL;
   AVComputeMarkedProc CompMarkedProcPtr = NULL;

//Declare menu variables
   AVMenu FileMenu = NULL;
   AVMenuItem NewItem = NULL;


//Retrieve the menu bar in Adobe Reader or Acrobat
   AVMenubar Themenubar = AVAppGetMenubar ();

//Create menu callbacks
   ExecProcPtr = ASCallbackCreateProto (AVExecuteProc, &ShowMessage);
   CompEnabledProcPtr = ASCallbackCreateProto (AVComputeEnabledProc,
   &ComputeEnabledProc);
   CompMarkedProcPtr = ASCallbackCreateProto (AVComputeMarkedProc,
   &ComputeMarkedProc);

//Retrieve the File menu
   FileMenu = AVmenubarAcquireMenuByName (Themenubar, "File");
   if (FileMenu)
   {

//Create a new menu item

```

--------------------------------

### Access Bookmark Root

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsdevguide/JS_Dev_ModifyUserInterface.html

Access the bookmarkRoot property of the current document to get the top node of the bookmark tree. This is the starting point for all bookmark operations.

```javascript
var myRoot = this.bookmarkRoot;
```

--------------------------------

### List Available MP3 Players

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/JS_API_AcroJS.html

This example retrieves a list of all available MP3 players and prints their properties to the debug console. It's useful for understanding which players are compatible with specific audio formats.

```javascript
var mp = app.media.getPlayers("audio/mp3")
for ( var i = 0; i < mp.length; i++) {
    console.println("nmp[" + i + "] Properties");
    for ( var p in mp[i] ) console.println(p + ": " + mp[i][p]);
}
```

--------------------------------

### Get Field Count and Iterate

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/interapp/IAC_API_FormsIntro.html

Retrieves the total number of fields in the collection and iterates through them. This example demonstrates accessing field values if they are terminal fields.

```VBScript
Dim Field As AFORMAUTLib.Field
Dim nFields As Long

nFields = Fields.Count

For Each Field In Fields
If Field.IsTerminal Then
print Field.Value
End If
Next Field
```

--------------------------------

### BeginOC Syntax Examples

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/pdfmark/pdfmark_OC_Interface.html

Illustrates the different ways to use the BeginOC procedure for nested visibility control of optional content groups. Ensure EndOC calls match BeginOC calls and are placed before showpage.

```postscript
ocgname BeginOC
```

```postscript
ocgnames BeginOC
```

```postscript
ocgname
policy
 BeginOC
```

```postscript
ocgnames
policy
 BeginOC
```

--------------------------------

### Advanced Soft Mask Dictionary Example

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/pdfmark/pdfmark_Basic.html

A comprehensive example showing the translation, color space setup, drawing of background elements, definition of a form with a transparency group, and its subsequent use as a soft mask in the Graphics state. This illustrates a practical application of soft mask dictionaries.

```postscript
280 0 translate
   /DeviceCMYK setcolorspace

   % Draw the background...

   0 0 0 0.2 setcolor 10 540 100 200 rectfill
   1 1 1 0 setcolor 10 540 200 200 rectstroke

   % Define the form...

   [ /_objdef {aForm} /BBox [ 10 540 210 740]
   /Group << /S /Transparency /K true>> /BP pdfmark
   /DeviceCMYK setcolorspace
   0.14 0.85 0.77 0.03 setcolor 72 600 50 0 360 arc fill
   0.12 0.02 0.78 0 setcolor 110 650 50 0 360 arc fill
   0.93 0.69 0.07 0.01 setcolor 147 600 50 0 360 arc fill
   [ /EP pdfmark

   % Draw the form...

   gsave
   [ /ca 0.5 /BM /Normal /SetTransparency pdfmark
   [   {aForm} /SP pdfmark
   grestore

   % Use the Form as Soft Mask...

   [ /SMask << /S /Alpha /G {aForm} >> /SetTransparency pdfmark
   ...
```

--------------------------------

### Configure and Open Media Player from URL Settings

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/JS_API_AcroJS.html

Configures media playback settings for a URL and then opens the player. This method first retrieves URL data and then uses it to set up the player, similar to the previous example but with a distinct function call for settings.

```javascript
var myURLClip = "http://www.example.com/myClip.mpg";
args = {
    URL: myURLClip,
    mimeType: "video/x-mpg",
    doc: this,
    settings:
    {
        players: app.media.getPlayers("video/x-mpg"),
        windowType: app.media.windowType.floating,
        floating: { height: 400, width: 600 }
    }
};
settings = app.media.getURLSettings(args)
args.settings = settings;
app.media.openPlayer(args);
```

--------------------------------

### Get Field Name

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/JS_API_AcroJS.html

Retrieves the fully qualified name of a field. For individual widgets, the name includes an appended widget index starting from Acrobat 6.0.

```javascript
var f = this.getField("myField");

// Displays "myField" in the console window
console.println(f.name);
```

--------------------------------

### Get Event Name in JavaScript

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/JS_API_AcroJS.html

This example shows how to retrieve the name of the current event as a string. The `name` property, combined with the `type`, uniquely identifies the event.

```javascript
Keystroke        Mouse Exit
Validate         WillPrint
Focus            DidPrint
Blur             WillSave
Format           DidSave
Calculate        Init
Mouse Up         Exec
Mouse Down       Open
Mouse Enter      Close


```

--------------------------------

### PIHandshake Method Implementation Example

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/plugin/Plugins_Pimech.html

This example demonstrates how a plugin's PIHandshake method registers its various callback functions with Acrobat or Adobe Reader using ASCallbackCreateProto. Ensure handshake functions are minimal to avoid hindering startup.

```c
ACCB1 ASBool ACCB2 PIHandshake(Uns32 handshakeVersion, void *handshakeData)
{
  if(handshakeVersion == HANDSHAKE_V0200)
  {
      PIHandshakeData_V0200 *hsData = (PIHandshakeData_V0200 *)handshakeData;
      hsData->extensionName = GetExtensionName();
      hsData->exportHFTsCallback =
          (void*)ASCallbackCreateProto(PIExportHFTsProcType,
              &PluginExportHFTs);
      hsData->importReplaceAndRegisterCallback =
          (void*)ASCallbackCreateProto(PIImportReplaceAndRegisterProcType,
              &PluginImportReplaceAndRegister);
      hsData->initCallback =
          (void*)ASCallbackCreateProto(PIInitProcType, &PluginLoad);
      hsData->unloadCallback =
          (void*)ASCallbackCreateProto(PIUnloadProcType, &PluginUnload);
      return true;
  }
  return false;
}

```

--------------------------------

### run Event

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/interapp/IAC_API_AppleEvtObjects.html

Launches the application and invokes its standard startup procedures. This is a required suite event.

```APIDOC
### run

Launches the application and invokes its standard startup procedures.

**Syntax**
```
run

```
```

--------------------------------

### Define and Show a Picture with pdfmark

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/pdfmark/pdfmark_Basic.html

This example demonstrates creating a reusable picture using BP and EP, then displaying it on the page multiple times with SP, including transformations.

```postscript
% draw a gray rectangle
0.5 setgray
0 0 100 100 rectfill

% create a picture
[ /BBox [0 0 100 100] /_objdef {MyPicture} /BP pdfmark

0 setgray
0 0 moveto 100 100 lineto stroke
100 0 moveto 0 100 lineto stroke
[ /EP pdfmark

% make the picture appear on the page

[   {MyPicture} /SP pdfmark
% make the picture appear in another place on the page
gsave
200 200 translate
[   {MyPicture} /SP pdfmark
grestore


% make the picture appear in another place on the page at a different size

gsave
100 400 translate
.5 .5 scale
[{MyPicture} /SP pdfmark
grestore


% draw another gray rectangle

0.5 setgray
512 692 100 100 rectfill showpage

```

--------------------------------

### PDF Creation and Content Stream Population (Full C Example)

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/plugin/Plugins_Cos.html

An entire C source file demonstrating the creation of a PDF document and populating it with a Cos content stream. The entry point is the MakeTheFile function.

```c
#include "ascalls.h"
#include "avcalls.h"
#include "avcalls.h"
#include "coscalls.h"
#include "pdcalls.h"
#include "ascalls.h"
#include "corcalls.h"
#include "dos.h"
#include <io.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>

//Declare global variables
CosObj PageStrm; /* To hold the newly created Cos stream */
CosObj AttrDict; /* As returned by CreateAttribsDict */
CosObj EncodeDict;

//Used to specify what filters are used to encode the stream if used for output.
CosObj ResDict; /* Resource dictionary for the page */
CosObj FontDictObj;
CosObj FontDict;
CosObj procArray;

//Set the page's resource key. Return true if everything is valid, else false.

ASBool SetResourceForPage (PDPage page)

{
CosObj PageCosObj;

//Make sure that the page is valid
if (!page)
  return false;

DURING

//Get a CosDoc object by using the PDPage page passed to this object
PageCosObj = PDPageGetCosObj(page);

  if (CosDictKnown (PageCosObj, ASAtomFromString ("Resources") == true))
      CosObjDestroy (CosDictGet (PageCosObj, ASAtomFromString ("Resources")));


//Place the ResDict object into the page's Resource Dictionary

```

--------------------------------

### Play Audio Clip Between Specific Times

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/media.html

This example plays an audio clip from a specified start time to a specified end time. Ensure the rendition is correctly identified by its name.

```javascript
var player = app.media.openPlayer({
    rendition: this.media.getRendition( "myAudio" ),
    doc: this,
    settings: {
        startAt: 3,
        endAt: 8
    }
});

```

--------------------------------

### Get PDF Version Extension Information

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/plugin/Plugins_Documents.html

Use PDDocGetVersionEx to retrieve Adobe-specific version extension information and the base PDF version. This method is available starting with Acrobat 9.0.

```c
// For example:
// PDDocGetVersionEx(pdDoc, &pdfVersion, &pdfVersionEx);
```

--------------------------------

### Bookmark with URI Action

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/pdfmark/pdfmark_Basic.html

Demonstrates creating a bookmark that launches a URI as its action. The action is defined using a dictionary with a '/Subtype' of '/URI'.

```postscript
% Bookmark with a URI as an action

[  /Count 0 /Title (The Adobe home page)
    /Action << /Subtype /URI /URI (http://www.adobe.com)>> /OUT pdfmark

```

--------------------------------

### Initialize PDF Library with Font Paths (Windows)

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/plugin/Plugins_CreatingSimplePlug.html

This example demonstrates how to specify custom font directories for the PDF Library on Windows. Ensure these paths are valid and accessible.

```c
pdflLibData.dirList[0]= strdup("C:MyfontfolderCMap");
 pdflLibData.dirList[1]= strdup("C:MyfontfolderCIDFont");
 pdflLibData.dirList[2]= strdup("C:MyfontfolderFont");

```

--------------------------------

### Get Dictionary Search Order (JavaScript)

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/JS_API_AcroJS.html

This snippet retrieves and displays the current order in which the spell checker searches through installed dictionaries. This order is typically set by the user in the Spelling Preferences panel.

```javascript
console.println( spell.languageOrder.toSource() );
```

--------------------------------

### Matrix4x4 Object Initialization and Transformation

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/js3dapi/index.html

Shows examples of creating Matrix4x4 objects and applying transformations like rotation and translation. A copy constructor is also demonstrated.

```javascript
m1 = new Matrix4x4().rotateAboutX(Math.PI/1.5).rotateAboutY(Math.PI/3);
 m2 = new Matrix4x4().rotateAboutZ(Math.PI/4).translate(new Vector3(0,5,0));
 m3 = new Matrix4x4(m1);

```

--------------------------------

### Get Recipient List for Encryption and Email

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/JS_API_AcroJS.html

This example demonstrates how to configure the recipient dialog to require both an email address and a certificate for each recipient. It then processes the returned Group objects to build an email list and display recipient information.

```javascript
var oOptions = { bAllowPermGroups: false,
    cNote: "Select the list of recipients. "
    + "Each person must have both an email address and a certificate.",
    bRequireEmail: true,
    bUserCert: true
};
var oGroups = security.chooseRecipientsDialog( oOptions );
// Display the list of recipients in an alert
// Build an email "to" mailList
var numCerts = oGroups[0].userEntities.length;
var cMsg = "The document will be encrypted for the following:n";
var mailList = new Array;
for( var g=0; g<numCerts; ++g )
{
    var ue = oGroups[0].userEntities[g];
    var oCert = ue.defaultEncryptCert;
    if( oCert == null )
        oCert = ue.certificates[0];
    cMsg += oCert.subjectCN + ", " + ue.email + "n";
    var oRDN = oCert.subjectDN;
    if( ue.email )
    {
        mailList[g] = ue.email;
    }
    else
        if ( oRDN.e )
        {
            mailList[g] = oRDN.e;
        }
}
var result = app.alert( cMsg );

```

--------------------------------

### Create Media Players with Different Window Types

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/media.html

Demonstrates creating media players in docked, full-screen, and floating window types. The default window type depends on the arguments provided to openPlayer.

```javascript
// Docked player that will be played in the associated ScreenAnnot
app.media.openPlayer({
    settings: { windowType: app.media.windowType.docked }
});
// Play in full screen mode, see also monitor and monitorType
app.media.openPlayer({
    settings: { windowType: app.media.windowType.fullScreen }
});
// Show the media clip in a floating window, also, see the floating property
var args = {
    settings: {
        windowType: app.media.windowType.floating,
        floating: {
            title: "A. C. Robat",
            width: 352,
            height: 240,
        }
    }
};
app.media.openPlayer( args );
```

--------------------------------

### Get and Set Button Caption with Icon Arrows

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/JS_API_AcroJS.html

This example demonstrates how to dynamically modify a button's caption to include visual cues (arrows) for mouse events. It also shows how to revert the caption when the mouse exits the button area.

```javascript
// A mouse enter event
event.target.buttonSetCaption("=> "+ event.target.buttonGetCaption()
    +" <=");

// A mouse exit event
var str = event.target.buttonGetCaption();
str = str.replace(/=>  <=/g, "");
event.target.buttonSetCaption(str);
```

--------------------------------

### Create Simple List

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/pdfmark/pdfmark_Logical.html

Construct a simple list with custom labels and body text. This example demonstrates defining list attributes like numbering and writing mode.

```pdfmark
/Helvetica-Bold findfont 18 scalefont setfont
 0 0 0 setrgbcolor

 [ /Subtype /L /Lang (en-US) /Title (Some salutations) /StPNE pdfmark


[ /_objdef {firstAttrObj} /type /dict /OBJ pdfmark
 [   {firstAttrObj} <</O /List /ListNumbering /LowerRoman>> /PUT pdfmark

[ /_objdef {secondAttrObj} /type /dict /OBJ pdfmark
 [   {secondAttrObj} <</O /Layout /WritingMode /LrTb>> /PUT pdfmark

[ /Obj {firstAttrObj} /StAttr pdfmark
 [ /Obj {secondAttrObj} /StAttr pdfmark

 /Helvetica-Oblique findfont 12 scalefont setfont

 [ /Subtype /LI /StPNE pdfmark
     [ /Subtype /Lbl /StPNE pdfmark
         [ /StBMC pdfmark
             48 238 moveto
             (i ) show
         [ /EMC pdfmark
     [ /StPop pdfmark
     [ /Subtype /LBody /Lang (en-cockney) /StPNE pdfmark
         [ /StBMC pdfmark
             72 238 moveto
             (whatcha) show
         [ /EMC pdfmark
     [ /StPop pdfmark
 [ /StPop pdfmark

 [ /Subtype /LI /StPNE pdfmark
     [ /Subtype /Lbl /StPNE pdfmark
         [ /StBMC pdfmark
             48 226 moveto
             (ii ) show
         [ /EMC pdfmark
     [ /StPop pdfmark
     [ /Subtype /LBody /Lang (fr) /StPNE pdfmark
         [ /StBMC pdfmark
             72 226 moveto
             (bon jour) show
         [ /EMC pdfmark
     [ /StPop pdfmark
 [ /StPop pdfmark

 [ /StPop pdfmark

```

--------------------------------

### Set and retrieve document base URL

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/doc.html

Get the current base URL of the document, set a new base URL for resolving relative web links, and then print the updated URL. This example also demonstrates adding a link that uses the base URL.

```javascript
console.println("Base URL was " + this.baseURL);
this.baseURL = "http://www.example.com/products/";
console.println("Base URL is " + this.baseURL);
// Add a link to the first page
var link = this.addLink(0, [200,200, 400, 300])
// Set an action that goes to the Example Reader page on the Example website.
link.setAction("this.getURL('reader',false)")

```

--------------------------------

### Connect to a Directory

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsdevguide/JS_Dev_Security.html

Establishes a connection to an existing directory using the security handler and directory index. Ensure the security handler is properly obtained.

```javascript
// Obtain the security handler:
var sh = security.getHandler("Adobe.PPKMS");
var dc = sh.directories[0].connect();
```

--------------------------------

### Remove Links from a Page

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/doc.html

Removes all links from a specified page within given coordinates. This method requires user permission to remove links. The example shows how to remove all links from every page of the document by iterating through pages and using getPageBox to get the page boundaries.

```javascript
// Remove all links from the document
for ( var p = 0; p < this.numPages; p++)
{
    var b = this.getPageBox("Crop", p);
    this.removeLinks(p, b);
}

```

--------------------------------

### Create a Combobox with Help Links in AcroJS

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/JS_API_AcroJS.html

This example shows how to programmatically create a combobox, set its items with associated URLs, and define a Keystroke action to launch a URL based on user selection.

```javascript
var c = this.addField({
    cName: "myHelp",
    cFieldType: "combobox",
    nPageNum: 0,
    oCoords: [72,12+3*72, 3*72, 0+3*72]
})
```

```javascript
c.setItems([
    ["Online Help", "http://www.example.com/myhelp.html"],
    ["How to Print", "http://www.example.com/myhelp.html#print"],
    ["How to eMail", "http://www.example.com/myhelp.html#email"]
]);
```

```javascript
c.setAction("Keystroke", "getHelp()");
```

```javascript
function getHelp() {
    if ( !event.willCommit && (event.changeEx != "") )
        app.launchURL(event.changeEx);
}
```

--------------------------------

### Import HFT using ASExtensionMgrGetHFT

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/plugin/Plugins_Hft.html

This C code demonstrates how to import an existing HFT by calling `ASExtensionMgrGetHFT` within the `PluginImportReplaceAndRegister` method. It requires an `ASAtom` for the HFT server name and an `ASVersion`.

```c
ACCB1 ASBool ACCB2 PluginImportReplaceAndRegister(void)
{
  gMyHFT = ASExtensionMgrGetHFT(ASAtomFromString("MyHFT"), 1);
  return (gMyHFT != NULL);
}

```

--------------------------------

### Example `setdistillerparams` Dictionary

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/pdfcreation/index.html

Shows a sample dictionary for the `setdistillerparams` operator, containing common PDF creation settings like encoding, transparency, and page rotation.

```postscript
<<
         /ASCII85EncodePages false
         /AllowTransparency false
         /AutoRotatePages /None
         /Binding /Left
         ...
>> setdistillerparams


```

--------------------------------

### Accessing and Manipulating 3D Annotations

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/js3dapi/index.html

This example demonstrates how to access the 3D JavaScript engine from within Acrobat's scripting environment to manipulate a 3D object. It shows how to get a reference to the 3D annotation context, retrieve a specific node by name, and apply transformations like rotation.

```APIDOC
## Accessing and Manipulating 3D Annotations

### Description
This example demonstrates how to access the 3D JavaScript engine from within Acrobat's scripting environment to manipulate a 3D object. It shows how to get a reference to the 3D annotation context, retrieve a specific node by name, and apply transformations like rotation.

### Method
JavaScript (within Acrobat)

### Endpoint
N/A (Scripting API)

### Parameters
N/A

### Request Example
```javascript
// Get index of page containing the Annot3D object (count starts at 0).
 pageIndex = this.pageNum;

 // Index of the Annot3D (count starts at 0).
 annotIndex = 0;

 // Get a reference to the Annot3D script context.
 c3d = this.getAnnots3D( pageIndex )[ annotIndex ].context3D;

 // Get a reference to the node in the scene named "Axes".
 axes = c3d.scene.nodes.getByName( "Axes" );

 // Rotate the object about the X-Axis PI/6 radians (30 degrees).
 axes.transform.rotateAboutXInPlace( Math.PI / 6 );
```

### Response
N/A (Direct manipulation of 3D object)
```

--------------------------------

### Start a specific alternate presentation

Source: https://opensource.adobe.com/dc-acrobat-sdk-docs/library/jsapiref/doc.html

Access a specific AlternatePresentation object by its name (e.g., 'MySlideShow') and start it using the start() method.

```javascript
// oMySlideShow is an AlternatePresentation object
oMySlideShow = this.alternatePresentations["MySlideShow"];
oMySlideShow.start();

```
Tokens:
Raw