Class incapsulating the main entity of XPS document that provides manipulation methods for any XPS element. More...

Inherits Aspose::Page::Document, and System::IDisposable.

Public Member Functions
ASPOSE_PAGE_SHARED_API System::SharedPtr< DocumentUtils >	get_Utils () const
	Gets the object that provides utilities beyond the formal XPS manipulation API. More...

ASPOSE_PAGE_SHARED_API int32_t	get_ActiveDocument ()
	Gets the active document number. More...

ASPOSE_PAGE_SHARED_API int32_t	get_ActivePage ()
	Gets the active page number within the active document. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPage >	get_Page ()
	Returns an XpsPage instance for active page. More...

ASPOSE_PAGE_SHARED_API int32_t	get_DocumentCount ()
	Returns the number of documents inside the XPS package. More...

ASPOSE_PAGE_SHARED_API int32_t	get_TotalPageCount ()
	Returns total number of pages in all documents inside XPS document. More...

ASPOSE_PAGE_SHARED_API int32_t	get_PageCount ()
	Returns the number of pages in the active document. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< Aspose::Page::XPS::XpsMetadata::JobPrintTicket >	get_JobPrintTicket ()
	Returns/sets document's job print ticket More...

ASPOSE_PAGE_SHARED_API void	set_JobPrintTicket (System::SharedPtr< Aspose::Page::XPS::XpsMetadata::JobPrintTicket > value)
	Returns/sets document's job print ticket More...

ASPOSE_PAGE_SHARED_API	XpsDocument ()
	Creates empty XPS document with default page size. More...

ASPOSE_PAGE_SHARED_API	XpsDocument (System::String path)
	Opens an existing XPS document located at the path . More...

ASPOSE_PAGE_SHARED_API	XpsDocument (System::String path, System::SharedPtr< LoadOptions > options)
	Opens an existing document located at the path as XPS document. More...

ASPOSE_PAGE_SHARED_API	XpsDocument (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< LoadOptions > options)
	Loads an existing document stored in the stream as XPS document. More...

ASPOSE_PAGE_SHARED_API void	SelectActiveDocument (int32_t documentNumber)
	Selects an active document for editing. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPage >	SelectActivePage (int32_t pageNumber)
	Selects an active document page for editing. More...

ASPOSE_PAGE_SHARED_API void	Save (System::String path)
	Saves XPS document to XPS file located at the path . More...

ASPOSE_PAGE_SHARED_API void	Save (System::SharedPtr< System::IO::Stream > stream)
	Saves XPS document to stream. More...

ASPOSE_PAGE_SHARED_API void	Save (System::SharedPtr< Device > device, System::SharedPtr< SaveOptions > options) override
	Saves the document using the Device instance. More...

ASPOSE_PAGE_SHARED_API void	Merge (System::ArrayPtr< System::String > filesForMerge, System::SharedPtr< Device > device, System::SharedPtr< SaveOptions > options)
	Merging XPS documents to PDF using the Device instance. More...

ASPOSE_PAGE_SHARED_API void	Merge (System::ArrayPtr< System::String > filesForMerge, System::SharedPtr< System::IO::Stream > outStream)
	Merging several XPS files to one XPS document. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsMetadata::DocumentPrintTicket >	GetDocumentPrintTicket (int32_t documentIndex)
	Returns the print ticket of the document indexed by documentIndex . More...

ASPOSE_PAGE_SHARED_API void	SetDocumentPrintTicket (int32_t documentIndex, System::SharedPtr< XpsMetadata::DocumentPrintTicket > printTicket)
	Links the printTicket to the document indexed by documentIndex . More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsMetadata::PagePrintTicket >	GetPagePrintTicket (int32_t documentIndex, int32_t pageIndex)
	Returns the print ticket of the page indexed by pageIndex in the document indexed by documentIndex . More...

ASPOSE_PAGE_SHARED_API void	SetPagePrintTicket (int32_t documentIndex, int32_t pageIndex, System::SharedPtr< XpsMetadata::PagePrintTicket > printTicket)
	Links the printTicket to the page indexed by pageIndex in the document indexed by documentIndex . More...

template<typename T >
T	Add (T element)
	Adds a content element (Canvas, Path or Glyphs) More...

template<typename T >
T	Insert (int32_t index, T element)
	Inserts an element (Canvas, Path or Glyphs) to the active page at index position. More...

template<typename T >
T	Remove (T element)
	Removes an element from the active page. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsContentElement >	RemoveAt (int32_t index)
	Removes an element at index position from the active page. More...

ASPOSE_PAGE_SHARED_API void	AddDocument (bool activate=true)
	Adds an empty document with default page size. More...

ASPOSE_PAGE_SHARED_API void	AddDocument (float width, float height, bool activate=true)
	Adds an empty document with the first page dimensions width and height . More...

ASPOSE_PAGE_SHARED_API void	InsertDocument (int32_t index, bool activate=true)
	Inserts an empty document with default page size at index position. More...

ASPOSE_PAGE_SHARED_API void	InsertDocument (int32_t index, float width, float height, bool activate=true)
	Inserts an empty document with the first page dimensions width and height at index position. More...

ASPOSE_PAGE_SHARED_API void	RemoveDocumentAt (int32_t index)
	Removes a document at index position. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPage >	AddPage (bool activate=true)
	Adds an empty page to the document with default page size. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPage >	AddPage (float width, float height, bool activate=true)
	Adds an empty page to the document with specified width and height . More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPage >	AddPage (System::SharedPtr< XpsModel::XpsPage > page, bool activate=true)
	Adds a page to the document. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPage >	RemovePage (System::SharedPtr< XpsModel::XpsPage > page)
	Removes a page from the document. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPage >	InsertPage (int32_t index, bool activate=true)
	Inserts an empty page to the document with default page size at index position. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPage >	InsertPage (int32_t index, float width, float height, bool activate=true)
	Inserts an empty page to the document with specified width and height at index position. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPage >	InsertPage (int32_t index, System::SharedPtr< XpsModel::XpsPage > page, bool activate=true)
	Inserts a page to the document at index position. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPage >	RemovePageAt (int32_t index)
	Removes a page from the document at index position. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsCanvas >	CreateCanvas ()
	Creates a new canvas. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsCanvas >	AddCanvas ()
	Adds a new canvas to the active page. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsCanvas >	InsertCanvas (int32_t index)
	Inserts a new canvas to the active page at index position. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPath >	CreatePath (System::SharedPtr< XpsModel::XpsPathGeometry > data)
	Creates a new path. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPath >	AddPath (System::SharedPtr< XpsModel::XpsPathGeometry > data)
	Adds a new path to the active page. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPath >	InsertPath (int32_t index, System::SharedPtr< XpsModel::XpsPathGeometry > data)
	Inserts a new path to the active page at index position. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsGlyphs >	CreateGlyphs (System::String fontFamily, float fontRenderingEmSize, System::Drawing::FontStyle fontStyle, float originX, float originY, System::String unicodeString)
	Creates new glyphs. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsGlyphs >	CreateGlyphs (System::SharedPtr< XpsModel::XpsFont > font, float fontRenderingEmSize, float originX, float originY, System::String unicodeString)
	Creates new glyphs. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsGlyphs >	AddGlyphs (System::String fontFamily, float fontRenderingEmSize, System::Drawing::FontStyle fontStyle, float originX, float originY, System::String unicodeString)
	Adds new glyphs to the active page. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsGlyphs >	InsertGlyphs (int32_t index, System::String fontFamily, float fontSize, System::Drawing::FontStyle fontStyle, float originX, float originY, System::String unicodeString)
	Inserts new glyphs to the active page at index position. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsGlyphs >	AddGlyphs (System::SharedPtr< XpsModel::XpsFont > font, float fontRenderingEmSize, float originX, float originY, System::String unicodeString)
	Adds new glyphs to the active page. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsGlyphs >	InsertGlyphs (int32_t index, System::SharedPtr< XpsModel::XpsFont > font, float fontSize, float originX, float originY, System::String unicodeString)
	Inserts new glyphs to the active page at index position. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsMatrix >	CreateMatrix (float m11, float m12, float m21, float m22, float m31, float m32)
	Creates a new affine transformation matrix. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPathGeometry >	CreatePathGeometry (System::String abbreviatedGeometry)
	Creates a new path geometry specified with abbreviated form. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPathGeometry >	CreatePathGeometry ()
	Creates a new path geometry. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPathGeometry >	CreatePathGeometry (System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< XpsModel::XpsPathFigure >>> pathFigures)
	Creates a new path geometry with specified list of path figures. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPathFigure >	CreatePathFigure (System::Drawing::PointF startPoint, bool isClosed=false)
	Creates a new path figure. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPathFigure >	CreatePathFigure (System::Drawing::PointF startPoint, System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< XpsModel::XpsPathSegment >>> segments, bool isClosed=false)
	Creates a new path figure. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsArcSegment >	CreateArcSegment (System::Drawing::PointF point, System::Drawing::SizeF size, float rotationAngle, bool isLargeArc, XpsModel::XpsSweepDirection sweepDirection, bool isStroked=true)
	Creates a new elliptical arc segment. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPolyLineSegment >	CreatePolyLineSegment (System::ArrayPtr< System::Drawing::PointF > points, bool isStroked=true)
	Creates a new polygonal drawing containing an arbitrary number of individual vertices. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPolyBezierSegment >	CreatePolyBezierSegment (System::ArrayPtr< System::Drawing::PointF > points, bool isStroked=true)
	Creates a new set of cubic Bézier curves. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsPolyQuadraticBezierSegment >	CreatePolyQuadraticBezierSegment (System::ArrayPtr< System::Drawing::PointF > points, bool isStroked=true)
	Creates a new set of quadratic Bézier curves from the previous point in the path figure through a set of vertices, using specified control points. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsSolidColorBrush >	CreateSolidColorBrush (System::SharedPtr< XpsModel::XpsColor > color)
	Creates a new solid color brush. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsSolidColorBrush >	CreateSolidColorBrush (System::Drawing::Color color)
	Creates a new solid color brush. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsGradientStop >	CreateGradientStop (System::SharedPtr< XpsModel::XpsColor > color, float offset)
	Creates a new gradient stop. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsGradientStop >	CreateGradientStop (System::Drawing::Color color, float offset)
	Creates a new gradient stop. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsLinearGradientBrush >	CreateLinearGradientBrush (System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< XpsModel::XpsGradientStop >>> gradientStops, System::Drawing::PointF startPoint, System::Drawing::PointF endPoint)
	Creates a new linear gradient brush. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsLinearGradientBrush >	CreateLinearGradientBrush (System::Drawing::PointF startPoint, System::Drawing::PointF endPoint)
	Creates a new linear gradient brush. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsRadialGradientBrush >	CreateRadialGradientBrush (System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< XpsModel::XpsGradientStop >>> gradientStops, System::Drawing::PointF center, System::Drawing::PointF gradientOrigin, float radiusX, float radiusY)
	Creates a new radial gradient brush. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsRadialGradientBrush >	CreateRadialGradientBrush (System::Drawing::PointF center, System::Drawing::PointF gradientOrigin, float radiusX, float radiusY)
	Creates a new radial gradient brush. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsVisualBrush >	CreateVisualBrush (System::SharedPtr< XpsModel::XpsContentElement > element, System::Drawing::RectangleF viewbox, System::Drawing::RectangleF viewport)
	Creates a new visual brush. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsImageBrush >	CreateImageBrush (System::SharedPtr< XpsModel::XpsImage > image, System::Drawing::RectangleF viewbox, System::Drawing::RectangleF viewport)
	Creates a new image brush. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsImageBrush >	CreateImageBrush (System::String imagePath, System::Drawing::RectangleF viewbox, System::Drawing::RectangleF viewport)
	Creates a new image brush. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsColor >	CreateColor (System::Drawing::Color color)
	Creates a new color. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsColor >	CreateColor (int32_t a, int32_t r, int32_t g, int32_t b)
	Creates a new color in sRGB color space. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsColor >	CreateColor (int32_t r, int32_t g, int32_t b)
	Creates a new color in sRGB color space. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsColor >	CreateColor (float a, float r, float g, float b)
	Creates a new color in scRGB color space. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsColor >	CreateColor (float r, float g, float b)
	Creates a new color in scRGB color space. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsColor >	CreateColor (System::String path, const System::ArrayPtr< float > &components)
	Creates a new color in ICC based color space. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsColor >	CreateColor (System::SharedPtr< XpsModel::XpsIccProfile > iccProfile, const System::ArrayPtr< float > &components)
	Creates a new color in ICC based color space. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsImage >	CreateImage (System::String imagePath)
	Creates a new image resource out of image file located at the imagePath . More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsImage >	CreateImage (System::SharedPtr< System::IO::Stream > stream)
	Creates a new image resource out of stream . More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsIccProfile >	CreateIccProfile (System::String iccProfilePath)
	Creates a new ICC profile resource out of ICC profile file located at the iccProfilePath . More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsIccProfile >	CreateIccProfile (System::SharedPtr< System::IO::Stream > stream)
	Creates a new ICC profile resource out of stream . More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsFont >	CreateFont (System::String fontFamily, System::Drawing::FontStyle fontStyle)
	Creates a new TrueType font resource. More...

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsModel::XpsFont >	CreateFont (System::SharedPtr< System::IO::Stream > stream)
	Creates a new TrueType font resource out of stream. More...

ASPOSE_PAGE_SHARED_API void	AddOutlineEntry (System::String description, int32_t outlineLevel, System::SharedPtr< XpsModel::XpsHyperlinkTarget > target)
	Adds an outline entry to the document. More...

ASPOSE_PAGE_SHARED_API void	Assert ()

ASPOSE_PAGE_SHARED_API void	Dispose () override
	Disposes the instance. More...

Public Member Functions inherited from Aspose::Page::Document
ASPOSE_PAGE_SHARED_API	Document ()

Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API	Object ()
	Creates object. Initializes all internal data structures. More...

virtual ASPOSECPP_SHARED_API	~Object ()
	Destroys object. Frees all internal data structures. More...

ASPOSECPP_SHARED_API	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value. More...

Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object. More...

int	SharedCount () const
	Gets current value of shared reference counter. More...

ASPOSECPP_SHARED_API void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...

ASPOSECPP_SHARED_API void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...

virtual ASPOSECPP_SHARED_API bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics. More...

virtual ASPOSECPP_SHARED_API int32_t	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...

virtual ASPOSECPP_SHARED_API String	ToString () const
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...

virtual ASPOSECPP_SHARED_API ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...

virtual ASPOSECPP_SHARED_API const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call. More...

virtual ASPOSECPP_SHARED_API bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...

virtual ASPOSECPP_SHARED_API void	SetTemplateWeakPtr (uint32_t argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...

virtual ASPOSECPP_SHARED_API bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only. More...

template<>
bool	Equals (float const &objA, float const &objB)

template<>
bool	Equals (double const &objA, double const &objB)

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)

template<>
bool	ReferenceEquals (String const &str1, String const &str2)

Protected Member Functions
System::SharedPtr< XpsPackageParts::FixedDocument >	get_ActiveDocumentInternal ()

System::SharedPtr< XpsModel::XpsContext >	get_Context () const

ASPOSE_PAGE_SHARED_API void	SetVentureLicense (System::SharedPtr< Aspose::Page::LicenseManagement::VentureLicense > license) override

ASPOSE_PAGE_SHARED_API System::SharedPtr< Aspose::Page::LicenseManagement::VentureLicense >	GetVentureLicense () override

void	PrepareSaving (System::SharedPtr< Device > device, System::SharedPtr< SaveOptions > options)

void	SerializeDocumentSequence (System::SharedPtr< Aspose::OpcPackaging::OpcPackage > package)

virtual ASPOSE_PAGE_SHARED_API	~XpsDocument ()

Protected Member Functions inherited from Aspose::Page::Document
void	SetPlugin (Plugins::Plugin plugin)

virtual ASPOSE_PAGE_SHARED_API void	SetVentureLicense (System::SharedPtr< LicenseManagement::VentureLicense > license)

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr. More...

template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style. More...

template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style. More...

static const TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...

Protected Attributes inherited from Aspose::Page::Document
System::SharedPtr< LicenseManagement::VentureLicense >	_ventureLicense

Plugins::Plugin	_usedByPlugin

Detailed Description

Class incapsulating the main entity of XPS document that provides manipulation methods for any XPS element.

Constructor & Destructor Documentation

◆ XpsDocument() [1/4]

ASPOSE_PAGE_SHARED_API Aspose::Page::XPS::XpsDocument::XpsDocument ( )

Creates empty XPS document with default page size.

◆ XpsDocument() [2/4]

ASPOSE_PAGE_SHARED_API Aspose::Page::XPS::XpsDocument::XpsDocument ( System::String path )

Opens an existing XPS document located at the path .

Parameters

path	Location of the document.

◆ XpsDocument() [3/4]

ASPOSE_PAGE_SHARED_API Aspose::Page::XPS::XpsDocument::XpsDocument	(	System::String	path,
		System::SharedPtr< LoadOptions >	options
	)

Opens an existing document located at the path as XPS document.

Parameters

path	Location of the document.
options	Document loading options.

◆ XpsDocument() [4/4]

ASPOSE_PAGE_SHARED_API Aspose::Page::XPS::XpsDocument::XpsDocument	(	System::SharedPtr< System::IO::Stream >	stream,
		System::SharedPtr< LoadOptions >	options
	)

Loads an existing document stored in the stream as XPS document.

Parameters

stream	Document stream.
options	Document loading options.

◆ ~XpsDocument()

virtual ASPOSE_PAGE_SHARED_API Aspose::Page::XPS::XpsDocument::~XpsDocument ( )

protectedvirtual

Member Function Documentation

◆ Add()

template<typename T >

T Aspose::Page::XPS::XpsDocument::Add ( T element )

inline

Adds a content element (Canvas, Path or Glyphs)

Template Parameters

T	The type of the element.

Parameters

element Element to be added.

Returns: Added element.

◆ AddCanvas()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsCanvas> Aspose::Page::XPS::XpsDocument::AddCanvas ( )

Adds a new canvas to the active page.

Returns: Added canvas.

.

◆ AddDocument() [1/2]

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsDocument::AddDocument ( bool activate = true )

Adds an empty document with default page size.

Parameters

activate Flag indicating whether to select added document as active.

◆ AddDocument() [2/2]

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsDocument::AddDocument	(	float	width,
		float	height,
		bool	activate = `true`
	)

Adds an empty document with the first page dimensions width and height .

Parameters

width	Width of the first page.
height	Height of the first page.
activate	Flag indicating whether to select added document as active.

◆ AddGlyphs() [1/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsGlyphs> Aspose::Page::XPS::XpsDocument::AddGlyphs	(	System::String	fontFamily,
		float	fontRenderingEmSize,
		System::Drawing::FontStyle	fontStyle,
		float	originX,
		float	originY,
		System::String	unicodeString
	)

Adds new glyphs to the active page.

Parameters

fontFamily	Font family.
fontRenderingEmSize	Font size.
fontStyle	Font style.
originX	Glyphs origin X coordinate.
originY	Glyphs origin Y coordinate.
unicodeString	String to be printed.

Returns: Added glyphs.

◆ AddGlyphs() [2/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsGlyphs> Aspose::Page::XPS::XpsDocument::AddGlyphs	(	System::SharedPtr< XpsModel::XpsFont >	font,
		float	fontRenderingEmSize,
		float	originX,
		float	originY,
		System::String	unicodeString
	)

Adds new glyphs to the active page.

Parameters

font	Font resource.
fontRenderingEmSize	Font size.
originX	Glyphs origin X coordinate.
originY	Glyphs origin Y coordinate.
unicodeString	String to be printed.

Returns: Added glyphs.

◆ AddOutlineEntry()

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsDocument::AddOutlineEntry	(	System::String	description,
		int32_t	outlineLevel,
		System::SharedPtr< XpsModel::XpsHyperlinkTarget >	target
	)

Adds an outline entry to the document.

Parameters

description	The entry description.
outlineLevel	The outline level.
target	The entry target.

◆ AddPage() [1/3]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPage> Aspose::Page::XPS::XpsDocument::AddPage ( bool activate = true )

Adds an empty page to the document with default page size.

Parameters

activate Flag indicating whether to select added page as active.

Returns: Added page.

◆ AddPage() [2/3]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPage> Aspose::Page::XPS::XpsDocument::AddPage	(	float	width,
		float	height,
		bool	activate = `true`
	)

Adds an empty page to the document with specified width and height .

Parameters

width	Width of a new page.
height	Height of a new page.
activate	Flag indicating whether to select added page as active.

Returns: Added page.

◆ AddPage() [3/3]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPage> Aspose::Page::XPS::XpsDocument::AddPage	(	System::SharedPtr< XpsModel::XpsPage >	page,
		bool	activate = `true`
	)

Adds a page to the document.

Parameters

page	Page to be added.
activate	Flag indicating whether to select added page as active.

Returns: Added page.

◆ AddPath()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPath> Aspose::Page::XPS::XpsDocument::AddPath ( System::SharedPtr< XpsModel::XpsPathGeometry > data )

Adds a new path to the active page.

Parameters

data	The geometry of the path.

Returns: Added path.

◆ Assert()

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsDocument::Assert ( )

◆ CreateArcSegment()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsArcSegment> Aspose::Page::XPS::XpsDocument::CreateArcSegment	(	System::Drawing::PointF	point,
		System::Drawing::SizeF	size,
		float	rotationAngle,
		bool	isLargeArc,
		XpsModel::XpsSweepDirection	sweepDirection,
		bool	isStroked = `true`
	)

Creates a new elliptical arc segment.

Parameters

point	The endpoint of the elliptical arc.
size	The x and y radius of the elliptical arc as an x,y pair.
rotationAngle	Indicates how the ellipse is rotated relative to the current coordinate system.
isLargeArc	Determines whether the arc is drawn with a sweep of 180 or greater.
sweepDirection	The direction in which the arc is drawn.
isStroked	Specifies whether the stroke for this segment of the path is drawn.

Returns: New elliptical arc segment.

◆ CreateCanvas()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsCanvas> Aspose::Page::XPS::XpsDocument::CreateCanvas ( )

Creates a new canvas.

Returns: New canvas.

◆ CreateColor() [1/7]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsColor> Aspose::Page::XPS::XpsDocument::CreateColor ( System::Drawing::Color color )

Creates a new color.

Parameters

color A native color instance for RGB color.

Returns: New color.

◆ CreateColor() [2/7]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsColor> Aspose::Page::XPS::XpsDocument::CreateColor	(	int32_t	a,
		int32_t	r,
		int32_t	g,
		int32_t	b
	)

Creates a new color in sRGB color space.

Parameters

a	The alpha color component.
r	The red color component.
g	The green color component.
b	The blue color component.

Returns: New color.

◆ CreateColor() [3/7]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsColor> Aspose::Page::XPS::XpsDocument::CreateColor	(	int32_t	r,
		int32_t	g,
		int32_t	b
	)

Creates a new color in sRGB color space.

Parameters

r	The red color component.
g	The green color component.
b	The blue color component.

Returns: New color.

◆ CreateColor() [4/7]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsColor> Aspose::Page::XPS::XpsDocument::CreateColor	(	float	a,
		float	r,
		float	g,
		float	b
	)

Creates a new color in scRGB color space.

Parameters

a	The alpha color component.
r	The red color component.
g	The green color component.
b	The blue color component.

Returns: New color.

◆ CreateColor() [5/7]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsColor> Aspose::Page::XPS::XpsDocument::CreateColor	(	float	r,
		float	g,
		float	b
	)

Creates a new color in scRGB color space.

Parameters

r	The red color component.
g	The green color component.
b	The blue color component.

Returns: New color.

◆ CreateColor() [6/7]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsColor> Aspose::Page::XPS::XpsDocument::CreateColor	(	System::String	path,
		const System::ArrayPtr< float > &	components
	)

Creates a new color in ICC based color space.

Parameters

path	The path to the ICC profile.
components	Color components.

Returns: New color.

◆ CreateColor() [7/7]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsColor> Aspose::Page::XPS::XpsDocument::CreateColor	(	System::SharedPtr< XpsModel::XpsIccProfile >	iccProfile,
		const System::ArrayPtr< float > &	components
	)

Creates a new color in ICC based color space.

Parameters

iccProfile	The ICC profile resource.
components	Color components.

Returns: New color.

◆ CreateFont() [1/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsFont> Aspose::Page::XPS::XpsDocument::CreateFont	(	System::String	fontFamily,
		System::Drawing::FontStyle	fontStyle
	)

Creates a new TrueType font resource.

Parameters

fontFamily	The font family.
fontStyle	The font style.

Returns: New TrueType font resource.

◆ CreateFont() [2/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsFont> Aspose::Page::XPS::XpsDocument::CreateFont ( System::SharedPtr< System::IO::Stream > stream )

Creates a new TrueType font resource out of stream.

Parameters

stream The stream containing the ICC profile to take as a resource.

Returns: New TrueType font resource.

◆ CreateGlyphs() [1/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsGlyphs> Aspose::Page::XPS::XpsDocument::CreateGlyphs	(	System::String	fontFamily,
		float	fontRenderingEmSize,
		System::Drawing::FontStyle	fontStyle,
		float	originX,
		float	originY,
		System::String	unicodeString
	)

Creates new glyphs.

Parameters

fontFamily	Font family.
fontRenderingEmSize	Font size.
fontStyle	Font style.
originX	Glyphs origin X coordinate.
originY	Glyphs origin Y coordinate.
unicodeString	String to be printed.

Returns: New glyphs.

◆ CreateGlyphs() [2/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsGlyphs> Aspose::Page::XPS::XpsDocument::CreateGlyphs	(	System::SharedPtr< XpsModel::XpsFont >	font,
		float	fontRenderingEmSize,
		float	originX,
		float	originY,
		System::String	unicodeString
	)

Creates new glyphs.

Parameters

font	Font resource.
fontRenderingEmSize	Font size.
originX	Glyphs origin X coordinate.
originY	Glyphs origin Y coordinate.
unicodeString	String to be printed.

Returns: New glyphs.

◆ CreateGradientStop() [1/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsGradientStop> Aspose::Page::XPS::XpsDocument::CreateGradientStop	(	System::SharedPtr< XpsModel::XpsColor >	color,
		float	offset
	)

Creates a new gradient stop.

Parameters

color	The gradient stop color.
offset	The gradient offset.

Returns: New gradient stop.

◆ CreateGradientStop() [2/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsGradientStop> Aspose::Page::XPS::XpsDocument::CreateGradientStop	(	System::Drawing::Color	color,
		float	offset
	)

Creates a new gradient stop.

Parameters

color	The gradient stop color.
offset	The gradient offset.

Returns: New gradient stop.

◆ CreateIccProfile() [1/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsIccProfile> Aspose::Page::XPS::XpsDocument::CreateIccProfile ( System::String iccProfilePath )

Creates a new ICC profile resource out of ICC profile file located at the iccProfilePath .

Parameters

iccProfilePath The path to the ICC profile to take as a resource.

Returns: New ICC profile resource.

◆ CreateIccProfile() [2/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsIccProfile> Aspose::Page::XPS::XpsDocument::CreateIccProfile ( System::SharedPtr< System::IO::Stream > stream )

Creates a new ICC profile resource out of stream .

Parameters

stream The stream containing the ICC profile to take as a resource.

Returns: New ICC profile resource.

◆ CreateImage() [1/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsImage> Aspose::Page::XPS::XpsDocument::CreateImage ( System::String imagePath )

Creates a new image resource out of image file located at the imagePath .

Parameters

imagePath The path to the image to take as a resource.

Returns: New image resource.

◆ CreateImage() [2/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsImage> Aspose::Page::XPS::XpsDocument::CreateImage ( System::SharedPtr< System::IO::Stream > stream )

Creates a new image resource out of stream .

Parameters

stream The stream containing the image to take as a resource.

Returns: New image resource.

◆ CreateImageBrush() [1/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsImageBrush> Aspose::Page::XPS::XpsDocument::CreateImageBrush	(	System::SharedPtr< XpsModel::XpsImage >	image,
		System::Drawing::RectangleF	viewbox,
		System::Drawing::RectangleF	viewport
	)

Creates a new image brush.

Parameters

image	An image resource.
viewbox	The position and dimensions of the brush's source content.
viewport	The region in the containing coordinate space of the prime brush tile that is (possibly repeatedly) applied to fill the region to which the brush is applied

Returns: New image brush.

◆ CreateImageBrush() [2/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsImageBrush> Aspose::Page::XPS::XpsDocument::CreateImageBrush	(	System::String	imagePath,
		System::Drawing::RectangleF	viewbox,
		System::Drawing::RectangleF	viewport
	)

Creates a new image brush.

Parameters

imagePath	The path to the image to take as a brush tile.
viewbox	The position and dimensions of the brush's source content.
viewport	The region in the containing coordinate space of the prime brush tile that is (possibly repeatedly) applied to fill the region to which the brush is applied

Returns: New image brush.

◆ CreateLinearGradientBrush() [1/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsLinearGradientBrush> Aspose::Page::XPS::XpsDocument::CreateLinearGradientBrush	(	System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< XpsModel::XpsGradientStop >>>	gradientStops,
		System::Drawing::PointF	startPoint,
		System::Drawing::PointF	endPoint
	)

Creates a new linear gradient brush.

Parameters

gradientStops	The list of gradient stops.
startPoint	The starting point of the linear gradient.
endPoint	The end point of the linear gradient.

Returns: New linear gradient brush.

◆ CreateLinearGradientBrush() [2/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsLinearGradientBrush> Aspose::Page::XPS::XpsDocument::CreateLinearGradientBrush	(	System::Drawing::PointF	startPoint,
		System::Drawing::PointF	endPoint
	)

Creates a new linear gradient brush.

Parameters

startPoint	The starting point of the linear gradient.
endPoint	The end point of the linear gradient.

Returns: New linear gradient brush.

◆ CreateMatrix()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsMatrix> Aspose::Page::XPS::XpsDocument::CreateMatrix	(	float	m11,
		float	m12,
		float	m21,
		float	m22,
		float	m31,
		float	m32
	)

Creates a new affine transformation matrix.

Parameters

m11	Element 11.
m12	Element 12.
m21	Element 21.
m22	Element 22.
m31	Element 31.
m32	Element 32.

Returns: New affine transformation matrix.

◆ CreatePath()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPath> Aspose::Page::XPS::XpsDocument::CreatePath ( System::SharedPtr< XpsModel::XpsPathGeometry > data )

Creates a new path.

Parameters

data	The geometry of the path.

Returns: New path.

◆ CreatePathFigure() [1/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPathFigure> Aspose::Page::XPS::XpsDocument::CreatePathFigure	(	System::Drawing::PointF	startPoint,
		bool	isClosed = `false`
	)

Creates a new path figure.

Parameters

startPoint	The starting point for the first segment of the path figure.
isClosed	Specifies whether the path is closed. If set to true, the stroke is drawn "closed", that is, the last point in the last segment of the path figure is connected with the point specified in the StartPoint attribute, otherwise the stroke is drawn "open", and the last point is not connected to the start point. Only applicable if the path figure is used in a Path element that specifies a stroke.

Returns: New path figure.

◆ CreatePathFigure() [2/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPathFigure> Aspose::Page::XPS::XpsDocument::CreatePathFigure	(	System::Drawing::PointF	startPoint,
		System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< XpsModel::XpsPathSegment >>>	segments,
		bool	isClosed = `false`
	)

Creates a new path figure.

Parameters

startPoint	The starting point for the first segment of the path figure.
segments	List of path segments.
isClosed	Specifies whether the path is closed. If set to true, the stroke is drawn "closed", that is, the last point in the last segment of the path figure is connected with the point specified in the StartPoint attribute, otherwise the stroke is drawn "open", and the last point is not connected to the start point. Only applicable if the path figure is used in a Path element that specifies a stroke.

Returns: New path figure.

◆ CreatePathGeometry() [1/3]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPathGeometry> Aspose::Page::XPS::XpsDocument::CreatePathGeometry ( System::String abbreviatedGeometry )

Creates a new path geometry specified with abbreviated form.

Parameters

abbreviatedGeometry Abbreviated form of path geometry.

Returns: New path geometry.

◆ CreatePathGeometry() [2/3]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPathGeometry> Aspose::Page::XPS::XpsDocument::CreatePathGeometry ( )

Creates a new path geometry.

Returns: New path geometry.

.

◆ CreatePathGeometry() [3/3]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPathGeometry> Aspose::Page::XPS::XpsDocument::CreatePathGeometry ( System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< XpsModel::XpsPathFigure >>> pathFigures )

Creates a new path geometry with specified list of path figures.

Parameters

pathFigures List of path figures.

Returns: New path geometry.

◆ CreatePolyBezierSegment()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPolyBezierSegment> Aspose::Page::XPS::XpsDocument::CreatePolyBezierSegment	(	System::ArrayPtr< System::Drawing::PointF >	points,
		bool	isStroked = `true`
	)

Creates a new set of cubic Bézier curves.

Parameters

points	Control points for multiple Bézier segments.
isStroked	Specifies whether the stroke for this segment of the path is drawn.

Returns: New cubic Bézier curves segment.

◆ CreatePolyLineSegment()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPolyLineSegment> Aspose::Page::XPS::XpsDocument::CreatePolyLineSegment	(	System::ArrayPtr< System::Drawing::PointF >	points,
		bool	isStroked = `true`
	)

Creates a new polygonal drawing containing an arbitrary number of individual vertices.

Parameters

points	A set of coordinates for the multiple segments that define the poly line segment.
isStroked	Specifies whether the stroke for this segment of the path is drawn.

Returns: New polygonal drawing segment.

◆ CreatePolyQuadraticBezierSegment()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPolyQuadraticBezierSegment> Aspose::Page::XPS::XpsDocument::CreatePolyQuadraticBezierSegment	(	System::ArrayPtr< System::Drawing::PointF >	points,
		bool	isStroked = `true`
	)

Creates a new set of quadratic Bézier curves from the previous point in the path figure through a set of vertices, using specified control points.

Parameters

points	Control points for multiple quadratic Bézier segments.
isStroked	Specifies whether the stroke for this segment of the path is drawn.

Returns: New quadratic Bézier curves segment.

◆ CreateRadialGradientBrush() [1/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsRadialGradientBrush> Aspose::Page::XPS::XpsDocument::CreateRadialGradientBrush	(	System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< XpsModel::XpsGradientStop >>>	gradientStops,
		System::Drawing::PointF	center,
		System::Drawing::PointF	gradientOrigin,
		float	radiusX,
		float	radiusY
	)

Creates a new radial gradient brush.

Parameters

gradientStops	The list of gradient stops.
center	The center point of the radial gradient (that is, the center of the ellipse).
gradientOrigin	The origin point of the radial gradient.
radiusX	The radius in the x dimension of the ellipse which defines the radial gradient.
radiusY	The radius in the y dimension of the ellipse which defines the radial gradient.

Returns: New radial gradient brush.

◆ CreateRadialGradientBrush() [2/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsRadialGradientBrush> Aspose::Page::XPS::XpsDocument::CreateRadialGradientBrush	(	System::Drawing::PointF	center,
		System::Drawing::PointF	gradientOrigin,
		float	radiusX,
		float	radiusY
	)

Creates a new radial gradient brush.

Parameters

center	The center point of the radial gradient (that is, the center of the ellipse).
gradientOrigin	The origin point of the radial gradient.
radiusX	The radius in the x dimension of the ellipse which defines the radial gradient.
radiusY	The radius in the y dimension of the ellipse which defines the radial gradient.

Returns: New radial gradient brush.

◆ CreateSolidColorBrush() [1/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsSolidColorBrush> Aspose::Page::XPS::XpsDocument::CreateSolidColorBrush ( System::SharedPtr< XpsModel::XpsColor > color )

Creates a new solid color brush.

Parameters

color The color for filled elements.

Returns: New solid color brush.

◆ CreateSolidColorBrush() [2/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsSolidColorBrush> Aspose::Page::XPS::XpsDocument::CreateSolidColorBrush ( System::Drawing::Color color )

Creates a new solid color brush.

Parameters

color The color for filled elements.

Returns: New solid color brush.

◆ CreateVisualBrush()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsVisualBrush> Aspose::Page::XPS::XpsDocument::CreateVisualBrush	(	System::SharedPtr< XpsModel::XpsContentElement >	element,
		System::Drawing::RectangleF	viewbox,
		System::Drawing::RectangleF	viewport
	)

Creates a new visual brush.

Parameters

element	The XPS element (Canvas, Path or Glyphs) for Visual property od visual brush.
viewbox	The position and dimensions of the brush's source content.
viewport	The region in the containing coordinate space of the prime brush tile that is (possibly repeatedly) applied to fill the region to which the brush is applied

Returns: New visual brush.

◆ Dispose()

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsDocument::Dispose ( )

overridevirtual

Disposes the instance.

Reimplemented from System::IDisposable.

◆ get_ActiveDocument()

ASPOSE_PAGE_SHARED_API int32_t Aspose::Page::XPS::XpsDocument::get_ActiveDocument ( )

Gets the active document number.

◆ get_ActiveDocumentInternal()

System::SharedPtr<XpsPackageParts::FixedDocument> Aspose::Page::XPS::XpsDocument::get_ActiveDocumentInternal ( )

protected

◆ get_ActivePage()

ASPOSE_PAGE_SHARED_API int32_t Aspose::Page::XPS::XpsDocument::get_ActivePage ( )

Gets the active page number within the active document.

◆ get_Context()

System::SharedPtr<XpsModel::XpsContext> Aspose::Page::XPS::XpsDocument::get_Context ( ) const

protected

◆ get_DocumentCount()

ASPOSE_PAGE_SHARED_API int32_t Aspose::Page::XPS::XpsDocument::get_DocumentCount ( )

Returns the number of documents inside the XPS package.

◆ get_JobPrintTicket()

ASPOSE_PAGE_SHARED_API System::SharedPtr<Aspose::Page::XPS::XpsMetadata::JobPrintTicket> Aspose::Page::XPS::XpsDocument::get_JobPrintTicket ( )

Returns/sets document's job print ticket

◆ get_Page()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPage> Aspose::Page::XPS::XpsDocument::get_Page ( )

Returns an XpsPage instance for active page.

◆ get_PageCount()

ASPOSE_PAGE_SHARED_API int32_t Aspose::Page::XPS::XpsDocument::get_PageCount ( )

Returns the number of pages in the active document.

◆ get_TotalPageCount()

ASPOSE_PAGE_SHARED_API int32_t Aspose::Page::XPS::XpsDocument::get_TotalPageCount ( )

Returns total number of pages in all documents inside XPS document.

◆ get_Utils()

ASPOSE_PAGE_SHARED_API System::SharedPtr<DocumentUtils> Aspose::Page::XPS::XpsDocument::get_Utils ( ) const

Gets the object that provides utilities beyond the formal XPS manipulation API.

◆ GetDocumentPrintTicket()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsMetadata::DocumentPrintTicket> Aspose::Page::XPS::XpsDocument::GetDocumentPrintTicket ( int32_t documentIndex )

Returns the print ticket of the document indexed by documentIndex .

Parameters

documentIndex Index of the document whose print ticket to return.

Returns: Document's print ticket.

◆ GetPagePrintTicket()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsMetadata::PagePrintTicket> Aspose::Page::XPS::XpsDocument::GetPagePrintTicket	(	int32_t	documentIndex,
		int32_t	pageIndex
	)

Returns the print ticket of the page indexed by pageIndex in the document indexed by documentIndex .

Parameters

documentIndex	Index of the document.
pageIndex	Index of the page whose print ticket to return.

Returns: Page's print ticket.

◆ GetVentureLicense()

ASPOSE_PAGE_SHARED_API System::SharedPtr<Aspose::Page::LicenseManagement::VentureLicense> Aspose::Page::XPS::XpsDocument::GetVentureLicense ( )

overrideprotectedvirtual

Reimplemented from Aspose::Page::Document.

◆ Insert()

template<typename T >

T Aspose::Page::XPS::XpsDocument::Insert	(	int32_t	index,
		T	element
	)

inline

Inserts an element (Canvas, Path or Glyphs) to the active page at index position.

Template Parameters

T	The type of the element.

Parameters

index	Position at which an element should be inserted.
element	Element to be inserted.

Returns: Inserted element.

◆ InsertCanvas()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsCanvas> Aspose::Page::XPS::XpsDocument::InsertCanvas ( int32_t index )

Inserts a new canvas to the active page at index position.

Parameters

index Position at which a new canvas should be inserted.

Returns: Inserted canvas.

◆ InsertDocument() [1/2]

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsDocument::InsertDocument	(	int32_t	index,
		bool	activate = `true`
	)

Inserts an empty document with default page size at index position.

Parameters

index	Position at which a document should be inserted.
activate	Flag indicating whether to select inserted document as active.

◆ InsertDocument() [2/2]

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsDocument::InsertDocument	(	int32_t	index,
		float	width,
		float	height,
		bool	activate = `true`
	)

Inserts an empty document with the first page dimensions width and height at index position.

Parameters

index	Position at which a document should be inserted.
width	Width of the first page.
height	Height of the first page.
activate	Flag indicating whether to select inserted document as active.

◆ InsertGlyphs() [1/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsGlyphs> Aspose::Page::XPS::XpsDocument::InsertGlyphs	(	int32_t	index,
		System::String	fontFamily,
		float	fontSize,
		System::Drawing::FontStyle	fontStyle,
		float	originX,
		float	originY,
		System::String	unicodeString
	)

Inserts new glyphs to the active page at index position.

Parameters

index	Position at which new glyphs should be inserted.
fontFamily	Font family.
fontSize	Font size.
fontStyle	Font style.
originX	Glyphs origin X coordinate.
originY	Glyphs origin Y coordinate.
unicodeString	String to be printed.

Returns: Inserted glyphs.

◆ InsertGlyphs() [2/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsGlyphs> Aspose::Page::XPS::XpsDocument::InsertGlyphs	(	int32_t	index,
		System::SharedPtr< XpsModel::XpsFont >	font,
		float	fontSize,
		float	originX,
		float	originY,
		System::String	unicodeString
	)

Inserts new glyphs to the active page at index position.

Parameters

index	Position at which new glyphs should be inserted.
font	Font resource.
fontSize	Font size.
originX	Glyphs origin X coordinate.
originY	Glyphs origin Y coordinate.
unicodeString	String to be printed.

Returns: Inserted glyphs.

◆ InsertPage() [1/3]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPage> Aspose::Page::XPS::XpsDocument::InsertPage	(	int32_t	index,
		bool	activate = `true`
	)

Inserts an empty page to the document with default page size at index position.

Parameters

index	Position at which a page should be inserted.
activate	Flag indicating whether to select inserted page as active.

Returns: Inserted page.

◆ InsertPage() [2/3]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPage> Aspose::Page::XPS::XpsDocument::InsertPage	(	int32_t	index,
		float	width,
		float	height,
		bool	activate = `true`
	)

Inserts an empty page to the document with specified width and height at index position.

Parameters

index	Position at which a page should be inserted.
width	Width of a new page.
height	Height of a new page.
activate	Flag indicating whether to select inserted page as active.

Returns: Inserted page.

◆ InsertPage() [3/3]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPage> Aspose::Page::XPS::XpsDocument::InsertPage	(	int32_t	index,
		System::SharedPtr< XpsModel::XpsPage >	page,
		bool	activate = `true`
	)

Inserts a page to the document at index position.

Parameters

index	Position at which a page should be added.
page	Page to be inserted.
activate	Flag indicating whether to select inserted page as active.

Returns: Inserted page.

◆ InsertPath()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPath> Aspose::Page::XPS::XpsDocument::InsertPath	(	int32_t	index,
		System::SharedPtr< XpsModel::XpsPathGeometry >	data
	)

Inserts a new path to the active page at index position.

Parameters

index	Position at which a new path should be inserted.
data	The geometry of the path.

Returns: Inserted path.

◆ Merge() [1/2]

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsDocument::Merge	(	System::ArrayPtr< System::String >	filesForMerge,
		System::SharedPtr< Device >	device,
		System::SharedPtr< SaveOptions >	options
	)

Merging XPS documents to PDF using the Device instance.

Parameters

filesForMerge	XPS files for merging with this document to an output device.
device	The Device instance.
options	Document saving options.

◆ Merge() [2/2]

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsDocument::Merge	(	System::ArrayPtr< System::String >	filesForMerge,
		System::SharedPtr< System::IO::Stream >	outStream
	)

Merging several XPS files to one XPS document.

Parameters

filesForMerge	XPS files for merging with this document.
outStream	The output stream where to save merged XPS documents.

◆ PrepareSaving()

void Aspose::Page::XPS::XpsDocument::PrepareSaving	(	System::SharedPtr< Device >	device,
		System::SharedPtr< SaveOptions >	options
	)

protected

◆ Remove()

template<typename T >

T Aspose::Page::XPS::XpsDocument::Remove ( T element )

inline

Removes an element from the active page.

Template Parameters

T	The type of the element.

Parameters

element Element to be removed.

Returns: Removed element.

◆ RemoveAt()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsContentElement> Aspose::Page::XPS::XpsDocument::RemoveAt ( int32_t index )

Removes an element at index position from the active page.

Parameters

index Position at which element should be removed.

Returns: Removed element.

◆ RemoveDocumentAt()

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsDocument::RemoveDocumentAt ( int32_t index )

Removes a document at index position.

Parameters

index Position at which a document should be removed.

◆ RemovePage()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPage> Aspose::Page::XPS::XpsDocument::RemovePage ( System::SharedPtr< XpsModel::XpsPage > page )

Removes a page from the document.

Parameters

page	Page to be removed.

Returns: Removed page.

◆ RemovePageAt()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPage> Aspose::Page::XPS::XpsDocument::RemovePageAt ( int32_t index )

Removes a page from the document at index position.

Parameters

index Position at which a page should be removed.

Returns: Removed page.

◆ Save() [1/3]

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsDocument::Save ( System::String path )

Saves XPS document to XPS file located at the path .

Parameters

path	Location of the document.

◆ Save() [2/3]

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsDocument::Save ( System::SharedPtr< System::IO::Stream > stream )

Saves XPS document to stream.

Parameters

stream Stream XPS document to be saved into.

◆ Save() [3/3]

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsDocument::Save	(	System::SharedPtr< Device >	device,
		System::SharedPtr< SaveOptions >	options
	)

overridevirtual

Saves the document using the Device instance.

Parameters

device	The Device instance.
options	Document saving options.

Implements Aspose::Page::Document.

◆ SelectActiveDocument()

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsDocument::SelectActiveDocument ( int32_t documentNumber )

Selects an active document for editing.

Parameters

documentNumber A document number.

Exceptions

System::ArgumentException Thrown when documentNumber is out of bounds.

◆ SelectActivePage()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsModel::XpsPage> Aspose::Page::XPS::XpsDocument::SelectActivePage ( int32_t pageNumber )

Selects an active document page for editing.

Parameters

pageNumber A page number.

Returns: XpsPage instance for active page.

Exceptions

System::ArgumentException Thrown when pageNumber is out of bounds.

◆ SerializeDocumentSequence()

void Aspose::Page::XPS::XpsDocument::SerializeDocumentSequence ( System::SharedPtr< Aspose::OpcPackaging::OpcPackage > package )

protected

◆ set_JobPrintTicket()

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsDocument::set_JobPrintTicket ( System::SharedPtr< Aspose::Page::XPS::XpsMetadata::JobPrintTicket > value )

Returns/sets document's job print ticket

◆ SetDocumentPrintTicket()

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsDocument::SetDocumentPrintTicket	(	int32_t	documentIndex,
		System::SharedPtr< XpsMetadata::DocumentPrintTicket >	printTicket
	)

Links the printTicket to the document indexed by documentIndex .

Parameters

documentIndex	Index of the document to link the print ticket to.
printTicket	The print ticket to link.

◆ SetPagePrintTicket()

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsDocument::SetPagePrintTicket	(	int32_t	documentIndex,
		int32_t	pageIndex,
		System::SharedPtr< XpsMetadata::PagePrintTicket >	printTicket
	)

Links the printTicket to the page indexed by pageIndex in the document indexed by documentIndex .

Parameters

documentIndex	Index of the document.
pageIndex	Index of the page to link the print ticket to.
printTicket	The print ticket to link.

◆ SetVentureLicense()

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsDocument::SetVentureLicense ( System::SharedPtr< Aspose::Page::LicenseManagement::VentureLicense > license )

overrideprotected

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XpsDocument() [1/4]

◆ XpsDocument() [2/4]

◆ XpsDocument() [3/4]

◆ XpsDocument() [4/4]

◆ ~XpsDocument()

Member Function Documentation

◆ Add()

◆ AddCanvas()

◆ AddDocument() [1/2]

◆ AddDocument() [2/2]

◆ AddGlyphs() [1/2]

◆ AddGlyphs() [2/2]

◆ AddOutlineEntry()

◆ AddPage() [1/3]

◆ AddPage() [2/3]

◆ AddPage() [3/3]

◆ AddPath()

◆ Assert()

◆ CreateArcSegment()

◆ CreateCanvas()

◆ CreateColor() [1/7]

◆ CreateColor() [2/7]

◆ CreateColor() [3/7]

◆ CreateColor() [4/7]

◆ CreateColor() [5/7]

◆ CreateColor() [6/7]

◆ CreateColor() [7/7]

◆ CreateFont() [1/2]

◆ CreateFont() [2/2]

◆ CreateGlyphs() [1/2]

◆ CreateGlyphs() [2/2]

◆ CreateGradientStop() [1/2]

◆ CreateGradientStop() [2/2]

◆ CreateIccProfile() [1/2]

◆ CreateIccProfile() [2/2]

◆ CreateImage() [1/2]

◆ CreateImage() [2/2]

◆ CreateImageBrush() [1/2]

◆ CreateImageBrush() [2/2]

◆ CreateLinearGradientBrush() [1/2]

◆ CreateLinearGradientBrush() [2/2]

◆ CreateMatrix()

◆ CreatePath()

◆ CreatePathFigure() [1/2]

◆ CreatePathFigure() [2/2]

◆ CreatePathGeometry() [1/3]

◆ CreatePathGeometry() [2/3]

◆ CreatePathGeometry() [3/3]

◆ CreatePolyBezierSegment()

◆ CreatePolyLineSegment()

◆ CreatePolyQuadraticBezierSegment()

◆ CreateRadialGradientBrush() [1/2]

◆ CreateRadialGradientBrush() [2/2]

◆ CreateSolidColorBrush() [1/2]

◆ CreateSolidColorBrush() [2/2]

◆ CreateVisualBrush()

◆ Dispose()

◆ get_ActiveDocument()

◆ get_ActiveDocumentInternal()

◆ get_ActivePage()

◆ get_Context()

◆ get_DocumentCount()

◆ get_JobPrintTicket()

◆ get_Page()

◆ get_PageCount()

◆ get_TotalPageCount()

◆ get_Utils()

◆ GetDocumentPrintTicket()

◆ GetPagePrintTicket()

◆ GetVentureLicense()

◆ Insert()

◆ InsertCanvas()

◆ InsertDocument() [1/2]

◆ InsertDocument() [2/2]

◆ InsertGlyphs() [1/2]