DocumentPageRestriction Enumeration

Specifies the page restriction mode used when saving a document.

Syntax

C#
Visual Basic
WinRT C#
Objective-C
Java
WinRT JavaScript
C++

public enum DocumentPageRestriction : System.Enum, System.IComparable, System.IConvertible, System.IFormattable

'Declaration
 
Public Enum DocumentPageRestriction 
   Inherits System.Enum
   Implements System.IComparable, System.IConvertible, System.IFormattable

'Usage
 
Dim instance As DocumentPageRestriction

public enum DocumentPageRestriction : System.IComparable, System.IConvertible, System.IFormattable

Leadtools.Forms.DocumentWriters.DocumentPageRestriction = function() { };
Leadtools.Forms.DocumentWriters.DocumentPageRestriction.prototype = {

  Default = 0,
	Relaxed = 1,
	
 };

public enum class DocumentPageRestriction : public System.Enum, System.IComparable, System.IConvertible, System.IFormattable

Members

Value	Member	Description
0	Default	Default page restriction, requires emf handle to create document.
1	Relaxed	Relaxed page restrictions, emf handle is not mandatory to create document.

Remarks

The DocumentPageRestriction enumeration is used as the type for the DocumentOptions.PageRestriction property.

Use the DocumentOptions.PageRestriction property to control the page creation process used by the DocumentWriter.

DocumentPageRestriction.Default requires a valid EMF handle in the DocumentPage.EmfHandle property in order to create a document and thus does not support empty pages. Also, if the document supports overlay images (for example, PDF with the PdfDocumentOptions.ImageOverText option set to true), then an overlay image must be present in the DocumentPage.Image property of the page.

DocumentPageRestriction.Relaxed does not require an EMF handle in the DocumentPage.EmfHandle property and thus supports creating of a document with zero or more empty pages. Also, if the document supports overlay images (for example, PDF with the PdfDocumentOptions.ImageOverText option set to true) and an overlay image is not present in the DocumentPage.Image property of the page, then no overlay is automatically assumed and the page will be created successfully.

Example

For an example, refer to DocumentWriter.

Inheritance Hierarchy

System.Object
   System.ValueType
      System.Enum
         Leadtools.Forms.DocumentWriters.DocumentPageRestriction

Requirements

Target Platforms

Reference

Leadtools.Forms.DocumentWriters Namespace
Programming with LEADTOOLS Document Writers
Files to be Included with Your Application
Unlocking Special LEAD Features