Class

# PDFTransition

<div class="rst-class">

forsearch

</div>

PDF

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

## Description

Allows you to set a transition to a PDF Document page to be used by the viewer app when enabled in presentation or slide show modes.

## Properties

<div class="rst-class">

table-centered_columns_3_and_4

</div>

| Name                                 | Type                                   | Read-Only | Shared |
|--------------------------------------|----------------------------------------|-----------|--------|
| `Delay<pdftransition.delay>`         | `Integer</api/data_types/integer>`     |           |        |
| `Direction<pdftransition.direction>` | `Directions<pdftransition.directions>` |           |        |
| `Duration<pdftransition.duration>`   | `Double</api/data_types/double>`       |           |        |
| `Style<pdftransition.style>`         | `Styles<pdftransition.styles>`         |           |        |

## Methods

<div class="rst-class">

table-centered_column_4

</div>

| Name                                      | Parameters                                                                                                                                                                                                                 | Returns | Shared |
|-------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|--------|
| `Constructor<pdftransition.constructor0>` | `Optional</api/language/optional>` style As `PDFTransition<pdftransition.styles>` = `PDFTransition.Styles.None<pdftransition.styles>`, `Optional</api/language/optional>` duration As `Double</api/data_types/double>` = 1 |         |        |

## Enumerations

<div id="pdftransition.directions">

<div class="rst-class">

forsearch

</div>

</div>

PDFTransition.Directions

### Directions

> The various directions in which the transitions will move.
>
> | Enum                 |
> |----------------------|
> | Default              |
> | Horizontal           |
> | Vertical             |
> | LeftToRight          |
> | BottomToTop          |
> | RightToLeft          |
> | TopToBottom          |
> | TopLeftToBottomRight |
> | Inward               |
> | Outward              |
> | HorizontalInward     |
> | HorizontalOutward    |
> | VerticalInward       |
> | VerticalOutward      |

<div id="pdftransition.styles">

<div class="rst-class">

forsearch

</div>

</div>

PDFTransition.Styles

### Styles

> The visual effect of the transition.
>
> | Enum     | Description                                                                                                                                                                                                                                                                  |
> |----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
> | Blinds   | Multiple lines, evenly spaced across the screen, synchronously sweep in the same direction to reveal the next page. The lines may be either horizontal or vertical as specified by the Direction property. Horizontal lines move downward; Vertical lines move to the right. |
> | Box      | A rectangular box sweeps inward from the edges of the page or outward from the center, as specified by the Direction property.                                                                                                                                               |
> | Cover    | The next page slides on to the screen in the direction specified by the Direction property, covering the current page.                                                                                                                                                       |
> | Dissolve | The current page dissolves gradually to reveal the next page.                                                                                                                                                                                                                |
> | Fade     | The next page gradually becomes visible through the current page.                                                                                                                                                                                                            |
> | Fly      | Changes are flown in or out in the direction specified by the Direction property, to or from a location that is offscreen.                                                                                                                                                   |
> | Glitter  | Similar to Dissolve, except that the effect sweeps across the page in a wide band moving from one side of the screen to the other in the direction specified by the Direction property.                                                                                      |
> | None     | The next page replaces the current page with no special transition effect.                                                                                                                                                                                                   |
> | Push     | The current page slides off the screen while the next page slides in, pushing the current page out in the direction specified by the Direction property.                                                                                                                     |
> | Split    | Two lines sweep across the screen, revealing the next page. The lines may be either horizontal or vertical and may move inward from the edges of the page or outward from the center, as specified by the Direction property.                                                |
> | Uncover  | The current page slides off the screen in the direction specified by the Direction property, uncovering the next page in the direction specified by the Direction property.                                                                                                  |
> | Wipe     | A single line sweeps across the screen from one edge to the other in the direction specified by the Direction property.                                                                                                                                                      |

## Property descriptions

<div id="pdftransition.delay">

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

</div>

<div class="rst-class">

forsearch

</div>

PDFTransition.Delay

**Delay** As `Integer</api/data_types/integer>`

> Time in seconds before the transition begins.
>
> The default value is -1 which means a transition to the next page will not automatically occur.

<div id="pdftransition.direction">

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

</div>

<div class="rst-class">

forsearch

</div>

PDFTransition.Direction

**Direction** As `Directions<pdftransition.directions>`

> The direction in which the transition will occur.

<div id="pdftransition.duration">

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

</div>

<div class="rst-class">

forsearch

</div>

PDFTransition.Duration

**Duration** As `Double</api/data_types/double>`

> The time in seconds it will take for the transition effect to complete.
>
> The default value is 1.0.

<div id="pdftransition.style">

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

</div>

<div class="rst-class">

forsearch

</div>

PDFTransition.Style

**Style** As `Styles<pdftransition.styles>`

> The style of the transition.

## Method descriptions

<div id="pdftransition.constructor0">

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

</div>

<div class="rst-class">

forsearch

</div>

PDFTransition.Constructor

**Constructor**(`Optional</api/language/optional>` style As `PDFTransition<pdftransition.styles>` = `PDFTransition.Styles.None<pdftransition.styles>`, `Optional</api/language/optional>` duration As `Double</api/data_types/double>` = 1)

> <div class="note">
>
> <div class="title">
>
> Note
>
> </div>
>
> `Constructors</api/language/constructor>` are special methods called when you create an object with the `New</api/language/new>` keyword and pass in the parameters above.
>
> </div>
>
> Creates an instance of <span class="title-ref">PDFTransition</span> with the style and duration passed.

## Notes

Preview on MacOS does not support PDF transitions. Use Acrobat Reader instead.

## Compatibility

|                       |     |
|-----------------------|-----|
| **Project Types**     | All |
| **Operating Systems** | All |

<div id="pdf.pdftransition/see_also">

<div class="seealso">

`Object</api/data_types/additional_types/object>` parent class; `PDFDocument</api/pdf/pdfdocument>` class.

</div>

</div>