XpsDocument class

XpsDocument class

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

Inheritance: XpsDocument → Document

The XpsDocument type exposes the following members:

Constructors

Constructor	Description
init	Creates empty XPS document with default page size.
init	Opens an existing XPS document located at the path.
init	Opens an existing document located at the path as XPS document.
init	Loads an existing document stored in the stream as XPS document.

Properties

Property	Description
utils	Gets the object that provides utilities beyond the formal XPS manipulation API.
active_document	Gets the active document number.
active_page	Gets the active page number within the active document.
page	Returns an XpsPage instance for active page.
document_count	Returns the number of documents inside the XPS package.
total_page_count	Returns total number of pages in all documents inside XPS document.
page_count	Returns the number of pages in the active document.
job_print_ticket	Returns/sets document’s job print ticket

Methods

Method	Description
save	Saves XPS document to XPS file located at the path.
save	Saves XPS document to stream.
save	Saves the document using the Device instance.
save_as_pdf	Saves the document in PDF format.
save_as_pdf	Saves the document in PDF format.
merge	Merging XPS documents to PDF using the Device instance.
merge	Merging several XPS files to one XPS document.
merge	Merging several XPS files to one XPS document.
merge_to_pdf	Merging XPS documents to PDF using the Device instance.
merge_to_pdf	Merging XPS documents to PDF using the Device instance.
add_canvas	Adds a canvas
add_canvas	Adds a new canvas to the active page.
add_path	Adds a path element
add_path	Adds a new path to the active page.
add_glyphs	Adds a glyphs element
add_glyphs	Adds new glyphs to the active page.
add_glyphs	Adds new glyphs to the active page.
add_document	Adds an empty document with default page size.
add_document	Adds an empty document with the first page dimensions width and height.
insert_document	Inserts an empty document with default page size at index position.
insert_document	Inserts an empty document with the first page dimensions width and height at index position.
add_page	Adds an empty page to the document with default page size.
add_page	Adds an empty page to the document with specified width and height.
add_page	Adds a page to the document.
insert_page	Inserts an empty page to the document with default page size at index position.
insert_page	Inserts an empty page to the document with specified width and height at index position.
insert_page	Inserts a page to the document at index position.
create_glyphs	Creates new glyphs.
create_glyphs	Creates new glyphs.
insert_glyphs	Inserts new glyphs to the active page at index position.
insert_glyphs	Inserts new glyphs to the active page at index position.
create_path_geometry	Creates a new path geometry specified with abbreviated form.
create_path_geometry	Creates a new path geometry.
create_path_geometry
create_path_figure	Creates a new path figure.
create_path_figure
create_solid_color_brush	Creates a new solid color brush.
create_solid_color_brush	Creates a new solid color brush.
create_gradient_stop	Creates a new gradient stop.
create_gradient_stop	Creates a new gradient stop.
create_linear_gradient_brush
create_linear_gradient_brush	Creates a new linear gradient brush.
create_radial_gradient_brush
create_radial_gradient_brush	Creates a new radial gradient brush.
create_image_brush	Creates a new image brush.
create_image_brush	Creates a new image brush.
create_color	Creates a new color.
create_color	Creates a new color in sRGB color space.
create_color	Creates a new color in sRGB color space.
create_color	Creates a new color in scRGB color space.
create_color	Creates a new color in scRGB color space.
create_color	Creates a new color in ICC based color space.
create_color	Creates a new color in ICC based color space.
create_image	Creates a new image resource out of image file located at the image_path.
create_image	Creates a new image resource out of stream.
create_icc_profile	Creates a new ICC profile resource out of ICC profile file located at the icc_profile_path.
create_icc_profile	Creates a new ICC profile resource out of stream.
create_font	Creates a new TrueType font resource.
create_font	Creates a new TrueType font resource out of stream.
select_active_document	Selects an active document for editing.
select_active_page	Selects an active document page for editing.
save_as_image	Saves the document in a bitmap image format.
save_as_ps	Saves the document in PS format.
get_document_print_ticket	Returns the print ticket of the document indexed by document_index.
set_document_print_ticket	Links the print_ticket to the document indexed by document_index.
get_page_print_ticket	Returns the print ticket of the page indexed by page_index in the document indexed by document_index.
set_page_print_ticket	Links the print_ticket to the page indexed by page_index in the document indexed by document_index.
remove_at	Removes an element at index position from the active page.
remove_document_at	Removes a document at index position.
remove_page	Removes a page from the document.
remove_page_at	Removes a page from the document at index position.
create_canvas	Creates a new canvas.
insert_canvas	Inserts a new canvas to the active page at index position.
create_path	Creates a new path.
insert_path	Inserts a new path to the active page at index position.
create_matrix	Creates a new affine transformation matrix.
create_arc_segment	Creates a new elliptical arc segment.
create_poly_line_segment	Creates a new polygonal drawing containing an arbitrary number of individual vertices.
create_poly_bezier_segment	Creates a new set of cubic Bézier curves.
create_poly_quadratic_bezier_segment	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.
create_visual_brush	Creates a new visual brush.
add_outline_entry	Adds an outline entry to the document.

See Also

• module aspose.page.xps
• class Device
• class Document
• class XpsDocument
• class XpsPage