DocumentActions
Overview
DocumentActions is a class in Aspose.PDF FOSS for Java.
Document-level action triggers (ISO 32000-1:2008, §12.6.4.1, p.417).
This class provides 13 methods for working with DocumentActions objects in Java programs.
Available methods include: DocumentActions, getAfterPrinting, getAfterSaving, getBeforeClosing, getBeforePrinting, getBeforeSaving, getOpenAction, setAfterPrinting, setAfterSaving, setBeforeClosing, setBeforePrinting, setBeforeSaving, and 1 additional methods.
All public members are accessible to any Java application after installing the Aspose.PDF FOSS for Java package.
Properties: afterPrinting, afterSaving, beforeClosing, beforePrinting, beforeSaving, openAction.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
openAction | PdfAction | Read | Returns the action that runs when the document is opened |
| ({@code /OpenAction}), or {@code null} if absent or the entry is a | |||
| destination array instead of an action. | |||
beforeClosing | PdfAction | Read | @return the will-close action ({@code /AA/WC}), or null. |
beforeSaving | PdfAction | Read | @return the will-save action ({@code /AA/WS}), or null. |
afterSaving | PdfAction | Read | @return the did-save action ({@code /AA/DS}), or null. |
beforePrinting | PdfAction | Read | @return the will-print action ({@code /AA/WP}), or null. |
afterPrinting | PdfAction | Read | @return the did-print action ({@code /AA/DP}), or null. |
Methods
| Signature | Description |
|---|---|
DocumentActions(catalog: COSDictionary, document: Document) | Wraps the given catalog dictionary as a document-actions view. |
getOpenAction() → PdfAction | Returns the action that runs when the document is opened |
| ({@code /OpenAction}), or {@code null} if absent or the entry is a | |
| destination array instead of an action. | |
setOpenAction(action: PdfAction) | Sets the {@code /OpenAction} entry. |
getBeforeClosing() → PdfAction | @return the will-close action ({@code /AA/WC}), or null. |
getBeforeSaving() → PdfAction | @return the will-save action ({@code /AA/WS}), or null. |
getAfterSaving() → PdfAction | @return the did-save action ({@code /AA/DS}), or null. |
getBeforePrinting() → PdfAction | @return the will-print action ({@code /AA/WP}), or null. |
getAfterPrinting() → PdfAction | @return the did-print action ({@code /AA/DP}), or null. |
setBeforeClosing(action: PdfAction) | Sets the will-close ({@code /AA/WC}) action; null removes the entry. |
setBeforeSaving(action: PdfAction) | Sets the will-save ({@code /AA/WS}) action; null removes the entry. |
setAfterSaving(action: PdfAction) | Sets the did-save ({@code /AA/DS}) action; null removes the entry. |
setBeforePrinting(action: PdfAction) | Sets the will-print ({@code /AA/WP}) action; null removes the entry. |
setAfterPrinting(action: PdfAction) | Sets the did-print ({@code /AA/DP}) action; null removes the entry. |