FullScreen properties

backgroundColor

escapeExits

transitions

clickAdvances

isFullScreen

usePageTiming

cursor

loop

useTimer

defaultTransition

timeDelay

 

backgroundColor

5.0

P 

 

 

The background color of the screen in full screen mode. See Color arrays for details.

Type

Color Array

Access

R/W

Example

   app.fs.backgroundColor = color.ltGray;

clickAdvances

5.0

P 

 

 

Specifies whether a mouse click anywhere on the page causes the page to advance.

Type

Boolean

Access

R/W

cursor

5.0

P 

 

 

Determines the behavior of the pointer in full screen mode. The convenience cursor object defines all the valid cursor behaviors:

Cursor Behavior

Keyword

Always hidden

cursor.hidden 

Hidden after delay

cursor.delay 

Visible

cursor.visible 

Type

Number

Access

R/W

Example

   app.fs.cursor = cursor.visible;

defaultTransition

5.0

P 

 

 

The default transition to use when advancing pages in full screen mode. Use transitions to obtain list of valid transition names supported by the viewer.

“No Transition” is equivalent to app.fs.defaultTransition = ""; 

Type

String

Access

R/W

Example

Put the document into presentation mode.

   app.fs.defaultTransition = "WipeDown";

   app.fs.isFullScreen = true;

escapeExits

5.0

P 

S 

 

A Boolean value specifying the escape key can be used to exit full screen mode.

Note:(Version 8.0) This property can only set to false during batch and console events. See Privileged versus non-privileged context for details. The event object contains a discussion of JavaScript events.

Type

Boolean

Access

R/W

isFullScreen

5.0

 

 

 

If true, the viewer is in full screen mode rather than regular viewing mode, which is possible only if one or more documents are open for viewing.

Note:A PDF document being viewed from within a web browser cannot be put into full screen mode.

Type

Boolean

Access

R/W

Example

   app.fs.isFullScreen = true;

In the above example, the viewer is set to full screen mode. If isFullScreen was previously false, the default viewing mode would be set. (The default viewing mode is defined as the original mode the Acrobat application was in before full screen mode was initiated.)

loop

5.0

P 

 

 

Specifies whether the document will loop around to the beginning of the document in response to a page advance (whether generated by mouse click, keyboard, or timer) in full screen mode.

Type

Boolean

Access

R/W

timeDelay

5.0

P 

 

 

The default number of seconds before the page automatically advances in full screen mode. See useTimer to activate or deactivate automatic page turning.

Type

Number

Access

R/W

Example

Set full screen properties, then go into full screen mode.

   app.fs.timeDelay = 5;          // Delay 5 seconds

   app.fs.useTimer = true;        // Activate automatic page turning

   app.fs.usePageTiming = true;   // Allow page override

   app.fs.isFullScreen = true;    // Go into full screen

transitions

5.0

 

 

 

An array of strings representing valid transition names implemented in the viewer. No Transition is equivalent to setting defaultTransition to the empty string:

app.fs.defaultTransition = "";

Type

Array

Access

R

Example

Produce a listing of the currently supported transition names.

   console.println("[" + app.fs.transitions + "]");

usePageTiming

5.0

P 

 

 

Specifies whether automatic page turning will respect the values specified for individual pages in full screen mode. Set transition properties of individual pages using setPageTransitions.

Type

Boolean

Access

R/W

useTimer

5.0

P 

 

 

Specifies whether automatic page turning is enabled in full screen mode. Use timeDelay to set the default time interval before proceeding to the next page.

Type

Boolean

Access

R/W