DocumentPageRestriction Enumeration

Summary

Specifies the page restriction mode used when saving a document.

Syntax

C++

Java

[SerializableAttribute()] 
[DataContractAttribute()] 
public enum DocumentPageRestriction

<DataContractAttribute()> 
<SerializableAttribute()> 
Public Enum DocumentPageRestriction

public enum DocumentPageRestriction

[DataContractAttribute()] 
[SerializableAttribute()] 
public enum class DocumentPageRestriction

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 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 DocumentWriterPage.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 DocumentWriterPage.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