LEADTOOLS Forms (Leadtools.Forms.DocumentWriters assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
PageRestriction Property
See Also 
Leadtools.Forms.DocumentWriters Namespace > DocumentOptions Class : PageRestriction Property



The PageRestriction Property is available as an add-on to the LEADTOOLS Document and Medical Imaging toolkits.

Gets or sets a value that indicates whether there can be blank pages and overlay images.

Syntax

Visual Basic (Declaration) 
Public Property PageRestriction As DocumentPageRestriction
Visual Basic (Usage)Copy Code
Dim instance As DocumentOptions
Dim value As DocumentPageRestriction
 
instance.PageRestriction = value
 
value = instance.PageRestriction
C# 
public DocumentPageRestriction PageRestriction {get; set;}
C++/CLI 
public:
property DocumentPageRestriction PageRestriction {
   DocumentPageRestriction get();
   void set (    DocumentPageRestriction value);
}

Property Value

A DocumentPageRestriction enumeration member that specifies the current document page restriction.

Example

For an example, refer to DocumentWriter.

Remarks

You can 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.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also

Leadtools.Forms.DocumentWriters requires a Document or Medical toolkit license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features