Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

XpsFixedDocument

OfficeIMO.Xps

Namespace
OfficeIMO.Xps
Assembly
OfficeIMO.Xps
Source revision
0eef6a5756b9 with working tree changes
Modifiers
sealed

An editable native fixed document. Page references retain their attributes and link-target declarations.

Inheritance

  • object
  • XpsFixedDocument

Usage

Explore 5 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 3

Accepted by parameters 2

Methods

public XpsPage AddPage(double width = 816, double height = 1056, string language = "en-US") #

Appends a new page, including when this fixed document was loaded from a package.

Parameters

width double = 816 optional
height double = 1056 optional
language string = "en-US" optional

Returns

XpsPage
public XElement? GetDocumentStructureMarkup(CancellationToken cancellationToken = default) #

Returns detached relationship-owned DocumentStructure markup, or null when none is attached.

Parameters

cancellationToken System.Threading.CancellationToken = default optional

Returns

XElement?
public XElement GetMarkup() #

Returns a detached copy of native fixed-document markup.

Returns

XElement
InsertPage 2 overloads
public XpsPage InsertPage(int index, double width = 816, double height = 1056, string language = "en-US") #

Inserts a new native page at the specified zero-based index.

Parameters

index int required
width double = 816 optional
height double = 1056 optional
language string = "en-US" optional

Returns

XpsPage
public void InsertPage(int index, XpsPage page) #

Inserts another reference to a page owned by this package. The page and its relative resource base are shared.

Parameters

index int required
page OfficeIMO.Xps.XpsPage required
public void MovePage(int sourceIndex, int destinationIndex) #

Moves a page reference to its final zero-based index, preserving its native attributes and link targets.

Parameters

sourceIndex int required
destinationIndex int required
public void MovePageTo(int sourceIndex, XpsFixedDocument destination, int destinationIndex) #

Moves one page reference to another fixed document in this package, retaining reference metadata and the page's resource base.

Parameters

sourceIndex int required
destination OfficeIMO.Xps.XpsFixedDocument required
destinationIndex int required
public void RemovePageAt(int index) #

Removes one page reference. The page part and associated resources remain in the package.

Parameters

index int required
public void ReplaceDocumentStructureMarkup(XElement markup) #

Creates or replaces native outlines and story addresses, retaining unknown markup and unrelated relationships.

Parameters

markup System.Xml.Linq.XElement required

Properties

public string PartName { get; } #

Native package part name, without a leading slash.

public IReadOnlyList<XpsPage> Pages { get; } #

Pages in this fixed document, including repeated references to shared native pages.