com.aspose.words

Class PdfPermissions

java.lang.Object

com.aspose.words.PdfPermissions

public class PdfPermissions
extends java.lang.Object

Specifies the operations that are allowed to a user on an encrypted PDF document.

Examples:

Shows how to set permissions on a saved PDF document.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 builder.writeln("Hello world!");

 // Extend permissions to allow the editing of annotations.
 PdfEncryptionDetails encryptionDetails =
         new PdfEncryptionDetails("password", "", PdfPermissions.MODIFY_ANNOTATIONS | PdfPermissions.DOCUMENT_ASSEMBLY);

 // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
 // to modify how that method converts the document to .PDF.
 PdfSaveOptions saveOptions = new PdfSaveOptions();

 // Enable encryption via the "EncryptionDetails" property.
 saveOptions.setEncryptionDetails(encryptionDetails);

 // When we open this document, we will need to provide the password before accessing its contents.
 doc.save(getArtifactsDir() + "PdfSaveOptions.EncryptionPermissions.pdf", saveOptions);
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALLOW_ALL Allows all operations on the PDF document.
static int	CONTENT_COPY Copy or otherwise extract text and graphics from the document by operations other than that controlled by CONTENT_COPY_FOR_ACCESSIBILITY.
static int	CONTENT_COPY_FOR_ACCESSIBILITY Extract text and graphics (in support of accessibility to users with disabilities or for other purposes).
static int	DISALLOW_ALL Disallows all operations on the PDF document.
static int	DOCUMENT_ASSEMBLY Assemble the document (insert, rotate, or delete pages and create document outline items or thumbnail images), even if MODIFY_CONTENTS is clear.
static int	FILL_IN Fill in existing interactive form fields (including signature fields), even if MODIFY_CONTENTS is clear.
static int	HIGH_RESOLUTION_PRINTING Print the document to a representation from which a faithful digital copy of the PDF content could be generated, based on an implementation-dependent algorithm.
static int	length
static int	MODIFY_ANNOTATIONS Add or modify text annotations, fill in interactive form fields, and, if MODIFY_CONTENTS is also set, create or modify interactive form fields (including signature fields).
static int	MODIFY_CONTENTS Modify the contents of the document by operations other than those controlled by MODIFY_ANNOTATIONS, FILL_IN, and DOCUMENT_ASSEMBLY.
static int	PRINTING Print the document (possibly not at the highest quality level, depending on whether HIGH_RESOLUTION_PRINTING is also set).

Method Summary

Modifier and Type	Method and Description
static int	fromName(java.lang.String pdfPermissionsName)
static int	fromNames(java.util.Set pdfPermissionsNames)
static java.lang.String	getName(int pdfPermissions)
static java.util.Set	getNames(int pdfPermissions)
static int[]	getValues()
static java.lang.String	toString(int pdfPermissions)
static java.lang.String	toStringSet(int attr)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DISALLOW_ALL

public static int DISALLOW_ALL

Disallows all operations on the PDF document. This is the default value.

ALLOW_ALL

public static int ALLOW_ALL

Allows all operations on the PDF document.

CONTENT_COPY

public static int CONTENT_COPY

Copy or otherwise extract text and graphics from the document by operations other than that controlled by CONTENT_COPY_FOR_ACCESSIBILITY.

CONTENT_COPY_FOR_ACCESSIBILITY

public static int CONTENT_COPY_FOR_ACCESSIBILITY

Extract text and graphics (in support of accessibility to users with disabilities or for other purposes).

MODIFY_CONTENTS

public static int MODIFY_CONTENTS

Modify the contents of the document by operations other than those controlled by MODIFY_ANNOTATIONS, FILL_IN, and DOCUMENT_ASSEMBLY.

MODIFY_ANNOTATIONS

public static int MODIFY_ANNOTATIONS

Add or modify text annotations, fill in interactive form fields, and, if MODIFY_CONTENTS is also set, create or modify interactive form fields (including signature fields).

FILL_IN

public static int FILL_IN

Fill in existing interactive form fields (including signature fields), even if MODIFY_CONTENTS is clear.

DOCUMENT_ASSEMBLY

public static int DOCUMENT_ASSEMBLY

Assemble the document (insert, rotate, or delete pages and create document outline items or thumbnail images), even if MODIFY_CONTENTS is clear.

PRINTING

public static int PRINTING

Print the document (possibly not at the highest quality level, depending on whether HIGH_RESOLUTION_PRINTING is also set).

HIGH_RESOLUTION_PRINTING

public static int HIGH_RESOLUTION_PRINTING

Print the document to a representation from which a faithful digital copy of the PDF content could be generated, based on an implementation-dependent algorithm. When this flag is clear (and PRINTING is set), printing shall be limited to a low-level representation of the appearance, possibly of degraded quality.

length

public static int length

Method Detail

getName

public static java.lang.String getName(int pdfPermissions)

getNames

public static java.util.Set getNames(int pdfPermissions)

toString

public static java.lang.String toString(int pdfPermissions)

toStringSet

public static java.lang.String toStringSet(int attr)

fromName

public static int fromName(java.lang.String pdfPermissionsName)

fromNames

public static int fromNames(java.util.Set pdfPermissionsNames)

getValues

public static int[] getValues()