.NET Framework Class Library
XpsDocument Class

Provides a Package that holds the content of an XPS document.

Inheritance Hierarchy
SystemObject
   System.Windows.Xps.PackagingXpsPartBase
    System.Windows.Xps.PackagingXpsDocument

Namespace:   System.Windows.Xps.Packaging
Assembly:  ReachFramework (in ReachFramework.dll)
Syntax
Public Class XpsDocument _
	Inherits [%$TOPIC/ms607517_en-us_VS_110_3_0_0_0_0%] _
	Implements [%$TOPIC/ms607517_en-us_VS_110_3_0_0_0_1%]
public class XpsDocument : [%$TOPIC/ms607517_en-us_VS_110_3_0_1_0_0%], 
	[%$TOPIC/ms607517_en-us_VS_110_3_0_1_0_1%]
public ref class XpsDocument : public [%$TOPIC/ms607517_en-us_VS_110_3_0_2_0_0%], 
	[%$TOPIC/ms607517_en-us_VS_110_3_0_2_0_1%]
type XpsDocument =  
    class 
        inherit [%$TOPIC/ms607517_en-us_VS_110_3_0_3_0_0%] 
        interface [%$TOPIC/ms607517_en-us_VS_110_3_0_3_0_1%] 
    end

The XpsDocument type exposes the following members.

Constructors
  NameDescription
Public method XpsDocument(Package)Initializes a new instance of the XpsDocument class with access to a specified XML Paper Specification (XPS)  Package and default interleaving, resource, and compression options.
Public method XpsDocument(Package, CompressionOption)Initializes a new instance of the XpsDocument class that is contained in a specified Package with specified default interleaving, resource, and compression options.
Public method XpsDocument(String, FileAccess)Initializes a new instance of the XpsDocument class that is contained in a specified Package file with default interleaving, resource, and compression options.
Public method XpsDocument(Package, CompressionOption, String)Initializes a new instance of the XpsDocument class that is contained in a specified Package with the specified default interleaving, resource, and compression options.
Public method XpsDocument(String, FileAccess, CompressionOption)Initializes a new instance of the XpsDocument class that is contained in a specified Package file with default interleaving, resource, and compression options.
Top
Properties
  NameDescription
Public property CoreDocumentPropertiesGets the core PackageProperties of the XPS document.
Public property FixedDocumentSequenceReaderGets an IXpsFixedDocumentSequenceReader for reading the document.
Public property IsReaderGets a value that indicates whether the package is readable.
Public property IsSignableGets a value that indicates whether the package can be digitally signed.
Public property IsWriterGets a value that indicates whether the package is writable.
Public property SignaturesGets a collection of XML Paper Specification (XPS) signatures that are associated with the package.
Public property ThumbnailGets or sets the XML Paper Specification (XPS) thumbnail image that is associated with the document.
Public property UriGets or sets the uniform resource identifier (URI) of the part. (Inherited from XpsPartBase.)
Top
Methods
  NameDescription
Public method AddFixedDocumentSequenceAdds a root FixedDocumentSequence to the package and returns a writer.
Public method AddThumbnailAdds a thumbnail image to the package.
Public method CloseCloses the XPS document Package.
Public method Static member CreateXpsDocumentWriterCreates an XpsDocumentWriter for writing an XpsDocument.
Protected method DisposeReleases the unmanaged resources that are used by the XpsDocument and optionally, releases the managed resources.
Public method Equals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetFixedDocumentSequenceReturns the fixed-document sequence at the root of the package.
Public method GetHashCodeServes as the default hash function. (Inherited from Object.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public method RemoveSignatureDeletes a signature from the package.
Public method SignDigitally(X509Certificate, Boolean, XpsDigSigPartAlteringRestrictions)Signs a collection of package parts with a specified X.509 certificate.
Public method SignDigitally(X509Certificate, Boolean, XpsDigSigPartAlteringRestrictions, Guid)Signs a collection of package parts by using a specified X.509 certificate.
Public method SignDigitally(X509Certificate, Boolean, XpsDigSigPartAlteringRestrictions, Guid, Boolean)Signs a collection of package parts with a specified X.509 certificate.
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method IDisposableDisposeThis member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. Use the type-safe Dispose method instead.
Top
Remarks

An XpsDocument contains a FixedDocumentSequence that comprises one or more FixedDocument elements.

The XpsDocument constructor is passed a reference to a Package for writing, storing, and reading the content elements of the document.

A new empty XPS  Package is created by using the Package constructor.

An existing XPS  Package is opened by using the PackageOpen method.

A FixedDocumentSequence root is added to an empty XPS  Package by calling the AddFixedDocumentSequence method.

PrintTicket elements with printer information and control can also be associated with the FixedDocumentSequence, or on individual FixedDocument and FixedPage elements that are stored in the XpsDocument.

For more information about XPS see the XML Paper Specification (XPS) available for download at http://go.microsoft.com/fwlink/?LinkID=65761.

Version Information

.NET Framework

Supported in: 4.6, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.