Aspose::Pdf::Facades::DocumentPrivilege Class Referencefinal

Represents the privileges for accessing Pdf file. Refer toPdfFileSecurity. There are 4 ways using this class: 1.Using predefined privilege directly. 2.Based on a predefined privilege and change some specifical permissions. 3.Based on a predefined privilege and change some specifical Adobe Professional permissions combination. 4.Mixes the way2 and way3. More...

Inherits System::IComparable< System::SharedPtr< System::Object > >.

Public Member Functions

bool get_AllowPrint ()
 Sets the permission which allow print or not. true is allow and false is forbidden. More...
 
void set_AllowPrint (bool value)
 Sets the permission which allow print or not. true is allow and false is forbidden. More...
 
bool get_AllowDegradedPrinting ()
 Sets the permission which allow degraded printing or not. true is allow and false is forbidden. More...
 
void set_AllowDegradedPrinting (bool value)
 Sets the permission which allow degraded printing or not. true is allow and false is forbidden. More...
 
bool get_AllowModifyContents ()
 Sets the permission which allow modify contents or not. true is allow and false is forbidden. More...
 
void set_AllowModifyContents (bool value)
 Sets the permission which allow modify contents or not. true is allow and false is forbidden. More...
 
bool get_AllowCopy ()
 Sets the permission which allow copy or not. true is allow and false is forbidden. More...
 
void set_AllowCopy (bool value)
 Sets the permission which allow copy or not. true is allow and false is forbidden. More...
 
bool get_AllowModifyAnnotations ()
 Sets the permission which allow modify annotations or not. true is allow and false is forbidden. More...
 
void set_AllowModifyAnnotations (bool value)
 Sets the permission which allow modify annotations or not. true is allow and false is forbidden. More...
 
bool get_AllowFillIn ()
 Sets the permission which allow fill in forms or not. true is allow and false is forbidden. More...
 
void set_AllowFillIn (bool value)
 Sets the permission which allow fill in forms or not. true is allow and false is forbidden. More...
 
bool get_AllowScreenReaders ()
 Sets the permission which allow screen readers or not. true is allow and false is forbidden. More...
 
void set_AllowScreenReaders (bool value)
 Sets the permission which allow screen readers or not. true is allow and false is forbidden. More...
 
bool get_AllowAssembly ()
 Sets the permission which allow assembly or not. true is allow and false is forbidden. More...
 
void set_AllowAssembly (bool value)
 Sets the permission which allow assembly or not. true is allow and false is forbidden. More...
 
void set_PrintAllowLevel (int32_t value)
 Sets the print level of document's privilege. Just as the Adobe Professional's Printing Allowed settings. 0: None. 1: Low Resolution (150 dpi). 2: High Resolution. More...
 
void set_ChangeAllowLevel (int32_t value)
 Sets the change level of document's privilege. Just as the Adobe Professional's Changes Allowed settings. 0: None. 1: Inserting, Deleting and Rotating pages. 2: Filling in form fields and signing existing signature fields. 3: Commenting, filling in form fields, and signing existing signature fields. 4: Any except extracting pages. More...
 
void set_CopyAllowLevel (int32_t value)
 Sets the copy level of document's privilege. Just as the Adobe Professional's permission settings. 0: None. 1: Enable text access for screen reader devices for the visually impaired. 2: Enable copying of text, images and other content. More...
 
int32_t CompareTo (System::SharedPtr< System::Object > obj)
 Compares two DocumentPrivilege objects.

Parameters
objThe object to compare with.
Returns
A signed integer that indicates the relative values of this instance and value. Less than zero this instance is less than value. Zero this instance is equal to value. Greater than zero this instance is greater than value.
More...
 
- Public Member Functions inherited from System::IComparable< System::SharedPtr< System::Object > >
virtual int CompareTo (System::SharedPtr< System::Object > other)=0
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Static Public Member Functions

static System::SharedPtr< DocumentPrivilegeget_DegradedPrinting ()
 Allows degraded printing. More...
 
static System::SharedPtr< DocumentPrivilegeget_Print ()
 Allows printing file. More...
 
static System::SharedPtr< DocumentPrivilegeget_ModifyContents ()
 Allows modifying file. More...
 
static System::SharedPtr< DocumentPrivilegeget_Copy ()
 Allows copying file. More...
 
static System::SharedPtr< DocumentPrivilegeget_ModifyAnnotations ()
 Allows modifying annotations of file. More...
 
static System::SharedPtr< DocumentPrivilegeget_FillIn ()
 Allows filling forms in file. More...
 
static System::SharedPtr< DocumentPrivilegeget_ScreenReaders ()
 Allows to reader on screen only. More...
 
static System::SharedPtr< DocumentPrivilegeget_Assembly ()
 Allows assemblying file. More...
 
static System::SharedPtr< DocumentPrivilegeget_AllowAll ()
 All allowed. More...
 
static System::SharedPtr< DocumentPrivilegeget_ForbidAll ()
 All Forbidded. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Protected Member Functions

int32_t get_Value ()
 
 DocumentPrivilege (int32_t value)
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 

Detailed Description

Represents the privileges for accessing Pdf file. Refer toPdfFileSecurity. There are 4 ways using this class: 1.Using predefined privilege directly. 2.Based on a predefined privilege and change some specifical permissions. 3.Based on a predefined privilege and change some specifical Adobe Professional permissions combination. 4.Mixes the way2 and way3.

[C#]
//Way1: Using predefined privilege directly.
//Way2: Based on a predefined privilege and change some specifical permissions.
DocumentPrivilege privilege = DocumentPrivilege.AllowAll;
privilege.AllowPrint = false;
privilege.AllowModifyContents = false;
//Way3: Based on a predefined privilege and change some specifical Adobe Professional permissions combination.
DocumentPrivilege privilege = DocumentPrivilege.ForbidAll;
privilege.ChangeAllowLevel = 1;
privilege.PrintAllowLevel = 2;
//Way4: Mixes the way2 and way3
DocumentPrivilege privilege = DocumentPrivilege.ForbidAll;
privilege.ChangeAllowLevel = 1;
privilege.AllowPrint = true;
[Visual Basic]
'Way1: Using predefined privilege directly.
Dim privilege As DocumentPrivilege = DocumentPrivilege.Print
'Way2: Based on a predefined privilege and change some specifical permissions.
Dim privilege As DocumentPrivilege = DocumentPrivilege.AllowAll
privilege.AllowPrint = False
privilege.AllowModifyContents = False
'Way3: Based on a predefined privilege and change some specifical Adobe Professional permissions combination.
Dim privilege As DocumentPrivilege = DocumentPrivilege.ForbidAll
privilege.ChangeAllowLevel = 1
privilege.PrintAllowLevel = 2
'Way4: Mixes the way2 and way3
Dim privilege As DocumentPrivilege = DocumentPrivilege.ForbidAll
privilege.ChangeAllowLevel = 1
privilege.AllowPrint = True

Constructor & Destructor Documentation

◆ DocumentPrivilege()

Aspose::Pdf::Facades::DocumentPrivilege::DocumentPrivilege ( int32_t  value)
protected

Member Function Documentation

◆ CompareTo()

int32_t Aspose::Pdf::Facades::DocumentPrivilege::CompareTo ( System::SharedPtr< System::Object obj)

Compares two DocumentPrivilege objects.

Parameters
objThe object to compare with.
Returns
A signed integer that indicates the relative values of this instance and value. Less than zero this instance is less than value. Zero this instance is equal to value. Greater than zero this instance is greater than value.

◆ get_AllowAll()

static System::SharedPtr<DocumentPrivilege> Aspose::Pdf::Facades::DocumentPrivilege::get_AllowAll ( )
static

All allowed.

◆ get_AllowAssembly()

bool Aspose::Pdf::Facades::DocumentPrivilege::get_AllowAssembly ( )

Sets the permission which allow assembly or not. true is allow and false is forbidden.

◆ get_AllowCopy()

bool Aspose::Pdf::Facades::DocumentPrivilege::get_AllowCopy ( )

Sets the permission which allow copy or not. true is allow and false is forbidden.

◆ get_AllowDegradedPrinting()

bool Aspose::Pdf::Facades::DocumentPrivilege::get_AllowDegradedPrinting ( )

Sets the permission which allow degraded printing or not. true is allow and false is forbidden.

◆ get_AllowFillIn()

bool Aspose::Pdf::Facades::DocumentPrivilege::get_AllowFillIn ( )

Sets the permission which allow fill in forms or not. true is allow and false is forbidden.

◆ get_AllowModifyAnnotations()

bool Aspose::Pdf::Facades::DocumentPrivilege::get_AllowModifyAnnotations ( )

Sets the permission which allow modify annotations or not. true is allow and false is forbidden.

◆ get_AllowModifyContents()

bool Aspose::Pdf::Facades::DocumentPrivilege::get_AllowModifyContents ( )

Sets the permission which allow modify contents or not. true is allow and false is forbidden.

◆ get_AllowPrint()

bool Aspose::Pdf::Facades::DocumentPrivilege::get_AllowPrint ( )

Sets the permission which allow print or not. true is allow and false is forbidden.

◆ get_AllowScreenReaders()

bool Aspose::Pdf::Facades::DocumentPrivilege::get_AllowScreenReaders ( )

Sets the permission which allow screen readers or not. true is allow and false is forbidden.

◆ get_Assembly()

static System::SharedPtr<DocumentPrivilege> Aspose::Pdf::Facades::DocumentPrivilege::get_Assembly ( )
static

Allows assemblying file.

◆ get_Copy()

static System::SharedPtr<DocumentPrivilege> Aspose::Pdf::Facades::DocumentPrivilege::get_Copy ( )
static

Allows copying file.

◆ get_DegradedPrinting()

static System::SharedPtr<DocumentPrivilege> Aspose::Pdf::Facades::DocumentPrivilege::get_DegradedPrinting ( )
static

Allows degraded printing.

◆ get_FillIn()

static System::SharedPtr<DocumentPrivilege> Aspose::Pdf::Facades::DocumentPrivilege::get_FillIn ( )
static

Allows filling forms in file.

◆ get_ForbidAll()

static System::SharedPtr<DocumentPrivilege> Aspose::Pdf::Facades::DocumentPrivilege::get_ForbidAll ( )
static

All Forbidded.

◆ get_ModifyAnnotations()

static System::SharedPtr<DocumentPrivilege> Aspose::Pdf::Facades::DocumentPrivilege::get_ModifyAnnotations ( )
static

Allows modifying annotations of file.

◆ get_ModifyContents()

static System::SharedPtr<DocumentPrivilege> Aspose::Pdf::Facades::DocumentPrivilege::get_ModifyContents ( )
static

Allows modifying file.

◆ get_Print()

static System::SharedPtr<DocumentPrivilege> Aspose::Pdf::Facades::DocumentPrivilege::get_Print ( )
static

Allows printing file.

◆ get_ScreenReaders()

static System::SharedPtr<DocumentPrivilege> Aspose::Pdf::Facades::DocumentPrivilege::get_ScreenReaders ( )
static

Allows to reader on screen only.

◆ get_Value()

int32_t Aspose::Pdf::Facades::DocumentPrivilege::get_Value ( )
protected

◆ set_AllowAssembly()

void Aspose::Pdf::Facades::DocumentPrivilege::set_AllowAssembly ( bool  value)

Sets the permission which allow assembly or not. true is allow and false is forbidden.

◆ set_AllowCopy()

void Aspose::Pdf::Facades::DocumentPrivilege::set_AllowCopy ( bool  value)

Sets the permission which allow copy or not. true is allow and false is forbidden.

◆ set_AllowDegradedPrinting()

void Aspose::Pdf::Facades::DocumentPrivilege::set_AllowDegradedPrinting ( bool  value)

Sets the permission which allow degraded printing or not. true is allow and false is forbidden.

◆ set_AllowFillIn()

void Aspose::Pdf::Facades::DocumentPrivilege::set_AllowFillIn ( bool  value)

Sets the permission which allow fill in forms or not. true is allow and false is forbidden.

◆ set_AllowModifyAnnotations()

void Aspose::Pdf::Facades::DocumentPrivilege::set_AllowModifyAnnotations ( bool  value)

Sets the permission which allow modify annotations or not. true is allow and false is forbidden.

◆ set_AllowModifyContents()

void Aspose::Pdf::Facades::DocumentPrivilege::set_AllowModifyContents ( bool  value)

Sets the permission which allow modify contents or not. true is allow and false is forbidden.

◆ set_AllowPrint()

void Aspose::Pdf::Facades::DocumentPrivilege::set_AllowPrint ( bool  value)

Sets the permission which allow print or not. true is allow and false is forbidden.

◆ set_AllowScreenReaders()

void Aspose::Pdf::Facades::DocumentPrivilege::set_AllowScreenReaders ( bool  value)

Sets the permission which allow screen readers or not. true is allow and false is forbidden.

◆ set_ChangeAllowLevel()

void Aspose::Pdf::Facades::DocumentPrivilege::set_ChangeAllowLevel ( int32_t  value)

Sets the change level of document's privilege. Just as the Adobe Professional's Changes Allowed settings. 0: None. 1: Inserting, Deleting and Rotating pages. 2: Filling in form fields and signing existing signature fields. 3: Commenting, filling in form fields, and signing existing signature fields. 4: Any except extracting pages.

◆ set_CopyAllowLevel()

void Aspose::Pdf::Facades::DocumentPrivilege::set_CopyAllowLevel ( int32_t  value)

Sets the copy level of document's privilege. Just as the Adobe Professional's permission settings. 0: None. 1: Enable text access for screen reader devices for the visually impaired. 2: Enable copying of text, images and other content.

◆ set_PrintAllowLevel()

void Aspose::Pdf::Facades::DocumentPrivilege::set_PrintAllowLevel ( int32_t  value)

Sets the print level of document's privilege. Just as the Adobe Professional's Printing Allowed settings. 0: None. 1: Low Resolution (150 dpi). 2: High Resolution.