Class XpsDocument
Namespace: Aspose.Page.XPS
Assembly: Aspose.Page.dll (25.1.2)
מחלקה המאגדת את הישות הראשית של מסמך XPS המספקת שיטות מניפולציה לכל אלמנט XPS.
public sealed class XpsDocument : Document, IDisposable
ירושה
object ← Document ← XpsDocument
מיישמת
חברים שהורשו
object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
בונים
XpsDocument()
יוצר מסמך XPS ריק עם גודל עמוד ברירת מחדל.
public XpsDocument()
XpsDocument(string)
פותח מסמך XPS קיים הממוקם בpath
.
public XpsDocument(string path)
פרמטרים
path
string
מיקום המסמך.
XpsDocument(string, LoadOptions)
פותח מסמך קיים הממוקם בpath
כמסמך XPS.
public XpsDocument(string path, LoadOptions options)
פרמטרים
path
string
מיקום המסמך.
options
LoadOptions
אפשרויות טעינת המסמך.
XpsDocument(Stream, LoadOptions)
טוען מסמך קיים המאוחסן בstream
כמסמך XPS.
public XpsDocument(Stream stream, LoadOptions options)
פרמטרים
stream
Stream
זרם המסמך.
options
LoadOptions
אפשרויות טעינת המסמך.
מאפיינים
ActiveDocument
מחזיר את מספר המסמך הפעיל.
public int ActiveDocument { get; }
ערך מאפיין
ActivePage
מחזיר את מספר העמוד הפעיל בתוך המסמך הפעיל.
public int ActivePage { get; }
ערך מאפיין
DocumentCount
מחזיר את מספר המסמכים בתוך חבילת XPS.
public int DocumentCount { get; }
ערך מאפיין
JobPrintTicket
מחזיר/מגדיר את כרטיס ההדפסה של המסמך.
public JobPrintTicket JobPrintTicket { get; set; }
ערך מאפיין
Page
מחזיר מופע של Aspose.Page.XPS.XpsModel.XpsPage עבור העמוד הפעיל.
public XpsPage Page { get; }
ערך מאפיין
PageCount
מחזיר את מספר העמודים במסמך הפעיל.
public int PageCount { get; }
ערך מאפיין
TotalPageCount
מחזיר את המספר הכולל של עמודים בכל המסמכים בתוך מסמך XPS.
public int TotalPageCount { get; }
ערך מאפיין
Utils
מחזיר את האובייקט המספק כלים מעבר ל-API המניפולציה הרשמי של XPS.
public DocumentUtils Utils { get; }
ערך מאפיין
שיטות
Add<t>(T)
מוסיף אלמנט תוכן (Canvas, Path, או Glyphs).
public T Add<t>(T element) where T : XpsContentElement
פרמטרים
element
T
האלמנט שצריך להוסיף.
מחזיר
T
האלמנט שנוסף.
פרמטרי סוג
T
סוג האלמנט.
AddCanvas()
מוסיף קנבס חדש לעמוד הפעיל.
public XpsCanvas AddCanvas()
מחזיר
הקנבס שנוסף.
AddDocument(bool)
מוסיף מסמך ריק עם גודל עמוד ברירת מחדל.
public void AddDocument(bool activate = true)
פרמטרים
activate
bool
דגל המצביע האם לבחור את המסמך שנוסף כמסמך פעיל.
AddDocument(float, float, bool)
מוסיף מסמך ריק עם מידות העמוד הראשון
width
וheight
.
public void AddDocument(float width, float height, bool activate = true)
פרמטרים
width
float
רוחב העמוד הראשון.
height
float
גובה העמוד הראשון.
activate
bool
דגל המצביע האם לבחור את המסמך שנוסף כמסמך פעיל.
AddGlyphs(string, float, FontStyle, float, float, string)
מוסיף גליופים חדשים לעמוד הפעיל.
public XpsGlyphs AddGlyphs(string fontFamily, float fontRenderingEmSize, FontStyle fontStyle, float originX, float originY, string unicodeString)
פרמטרים
fontFamily
string
משפחת הפונטים.
fontRenderingEmSize
float
גודל הפונט.
fontStyle
FontStyle
סגנון הפונט.
originX
float
קואורדינטת ה-X של מקור הגליופים.
originY
float
קואורדינטת ה-Y של מקור הגליופים.
unicodeString
string
מחרוזת שתודפס.
מחזיר
הגליופים שנוספו.
AddGlyphs(XpsFont, float, float, float, string)
מוסיף גליופים חדשים לעמוד הפעיל.
public XpsGlyphs AddGlyphs(XpsFont font, float fontRenderingEmSize, float originX, float originY, string unicodeString)
פרמטרים
font
XpsFont
משאב הפונט.
fontRenderingEmSize
float
גודל הפונט.
originX
float
קואורדינטת ה-X של מקור הגליופים.
originY
float
קואורדינטת ה-Y של מקור הגליופים.
unicodeString
string
מחרוזת שתודפס.
מחזיר
הגליופים שנוספו.
AddOutlineEntry(string, int, XpsHyperlinkTarget)
מוסיף רשומת מתאר למסמך.
public void AddOutlineEntry(string description, int outlineLevel, XpsHyperlinkTarget target)
פרמטרים
description
string
תיאור הרשומה.
outlineLevel
int
רמת המתאר.
target
XpsHyperlinkTarget
המטרה של הרשומה.
AddPage(bool)
מוסיף עמוד ריק למסמך עם גודל עמוד ברירת מחדל.
public XpsPage AddPage(bool activate = true)
פרמטרים
activate
bool
דגל המצביע האם לבחור את העמוד שנוסף כעמוד פעיל.
מחזיר
העמוד שנוסף.
AddPage(float, float, bool)
מוסיף עמוד ריק למסמך עם
width
וheight
המצוינים.
public XpsPage AddPage(float width, float height, bool activate = true)
פרמטרים
width
float
רוחב עמוד חדש.
height
float
גובה עמוד חדש.
activate
bool
דגל המצביע האם לבחור את העמוד שנוסף כעמוד פעיל.
מחזיר
העמוד שנוסף.
Insert<t>(int, T)
מכניס אלמנט (Canvas, Path, או Glyphs) לעמוד הפעיל בעמדה index
.
public T Insert<t>(int index, T element) where T : XpsContentElement
פרמטרים
index
int
המיקום שבו יש להכניס את element
.
element
T
האלמנט שצריך להכניס.
מחזיר
T
האלמנט שהוכנס.
פרמטרי סוג
T
סוג האלמנט.
InsertCanvas(int)
מכניס קנבס חדש לעמוד הפעיל בעמדה index
.
public XpsCanvas InsertCanvas(int index)
פרמטרים
index
int
המיקום שבו יש להכניס קנבס חדש.
מחזיר
הקנבס שהוכנס.
InsertDocument(int, bool)
מכניס מסמך ריק עם גודל עמוד ברירת מחדל בעמדה index
.
public void InsertDocument(int index, bool activate = true)
פרמטרים
index
int
המיקום שבו יש להכניס מסמך.
activate
bool
דגל המצביע האם לבחור את המסמך שהוכנס כמסמך פעיל.
InsertDocument(int, float, float, bool)
מכניס מסמך ריק עם מידות העמוד הראשון
width
וheight
בעמדה index
.
public void InsertDocument(int index, float width, float height, bool activate = true)
פרמטרים
index
int
המיקום שבו יש להכניס מסמך.
width
float
רוחב העמוד הראשון.
height
float
גובה העמוד הראשון.
activate
bool
דגל המצביע האם לבחור את המסמך שהוכנס כמסמך פעיל.
InsertGlyphs(int, string, float, FontStyle, float, float, string)
מכניס גליופים חדשים לעמוד הפעיל בעמדה index
.
public XpsGlyphs InsertGlyphs(int index, string fontFamily, float fontSize, FontStyle fontStyle, float originX, float originY, string unicodeString)
פרמטרים
index
int
המיקום שבו יש להכניס גליופים חדשים.
fontFamily
string
משפחת הפונטים.
fontSize
float
גודל הפונט.
fontStyle
FontStyle
סגנון הפונט.
originX
float
קואורדינטת ה-X של מקור הגליופים.
originY
float
קואורדינטת ה-Y של מקור הגליופים.
unicodeString
string
מחרוזת שתודפס.
מחזיר
הגליופים שהוכנסו.
InsertPage(int, bool)
מכניס עמוד ריק למסמך עם גודל עמוד ברירת מחדל בעמדה index
.
public XpsPage InsertPage(int index, bool activate = true)
פרמטרים
index
int
המיקום שבו יש להכניס עמוד.
activate
bool
דגל המצביע האם לבחור את העמוד שהוכנס כעמוד פעיל.
מחזיר
העמוד שהוכנס.
InsertPage(int, XpsPage, bool)
מכניס עמוד למסמך בעמדה index
.
public XpsPage InsertPage(int index, XpsPage page, bool activate = true)
פרמטרים
index
int
המיקום שבו יש להוסיף עמוד.
page
XpsPage
העמוד שיש להכניס.
activate
bool
דגל המצביע האם לבחור את העמוד שהוכנס כעמוד פעיל.
מחזיר
העמוד שהוכנס.
InsertPath(int, XpsPathGeometry)
מכניס נתיב חדש לעמוד הפעיל בעמדה index
.
public XpsPath InsertPath(int index, XpsPathGeometry data)
פרמטרים
index
int
המיקום שבו יש להכניס נתיב חדש.
data
XpsPathGeometry
הגיאומטריה של הנתיב.
מחזיר
הנתיב שהוכנס.
Merge(string[], string)
ממזג מספר קבצי XPS למסמך XPS אחד.
public void Merge(string[] filesForMerge, string outXpsFilePath)
פרמטרים
filesForMerge
string[]
קבצי XPS למיזוג עם המסמך הזה.
outXpsFilePath
string
נתיב לקובץ XPS המוצא.
MergeToPdf(string[], string, PdfSaveOptions)
ממזג מסמכי XPS ל-PDF באמצעות מופע Aspose.Page.Device.
public void MergeToPdf(string[] filesForMerge, string outPdfFilePath, PdfSaveOptions options)
פרמטרים
filesForMerge
string[]
קבצי XPS למיזוג עם המסמך הזה למכשיר פלט.
outPdfFilePath
string
נתיב לקובץ PDF המוצא.
options
PdfSaveOptions
אפשרויות שמירה למסמך.
Remove<t>(T)
מסיר אלמנט מהעמוד הפעיל.
public T Remove<t>(T element) where T : XpsContentElement
פרמטרים
element
T
האלמנט שצריך להסיר.
מחזיר
T
האלמנט שהוסר.
פרמטרי סוג
T
סוג האלמנט.
RemoveAt(int)
מסיר אלמנט בעמדה index
מהעמוד הפעיל.
public XpsContentElement RemoveAt(int index)
פרמטרים
index
int
המיקום שבו יש להסיר את האלמנט.
מחזיר
האלמנט שהוסר.
RemoveDocumentAt(int)
מסיר מסמך בעמדה index
.
public void RemoveDocumentAt(int index)
פרמטרים
index
int
המיקום שבו יש להסיר מסמך.
RemovePageAt(int)
מסיר עמוד מהמסמך בעמדה index
.
public XpsPage RemovePageAt(int index)
פרמטרים
index
int
המיקום שבו יש להסיר עמוד.
מחזיר
העמוד שהוסר.
Save(string)
שומר מסמך XPS לקובץ XPS הנמצא בpath
.
public void Save(string path)
פרמטרים
path
string
מיקום המסמך.
SaveAsPdf(string, PdfSaveOptions)
שומר את המסמך בפורמט PDF.
public void SaveAsPdf(string outPdfFilePath, PdfSaveOptions options)
פרמטרים
outPdfFilePath
string
נתיב לקובץ PDF המוצא.
options
PdfSaveOptions
אפשרויות שמירה למסמך בפורמט PDF.