PageRestriction Property

Summary

Indicates whether there can be blank pages and overlay images.

Syntax

Objective-C

C++

Java

public DocumentPageRestriction PageRestriction { get; set; }

Public Property PageRestriction As DocumentPageRestriction

@property (nonatomic, assign) LTDocumentPageRestriction pageRestriction

public DocumentPageRestriction getPageRestriction() 
public void setPageRestriction(DocumentPageRestriction pageRestriction)

public: 
property DocumentPageRestriction PageRestriction { 
   DocumentPageRestriction get(); 
   void set (    DocumentPageRestriction ); 
}

Property Value

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

Remarks

You can use the PageRestriction property to control the page creation process used by the DocumentWriter.

DocumentPageRestriction.Default requires a valid EMF handle in the DocumentWriterEmfPage.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 ImageOverText option set to true), then an overlay image must be present in the DocumentWriterSvgPage.Image property of the page.

DocumentPageRestriction.Relaxed does not require an EMF handle in the DocumentWriterEmfPage.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 ImageOverText option set to true) and an overlay image is not present in the DocumentWriterSvgPage.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.

Requirements

Target Platforms