Class PageAPI
Namespace: Aspose.Page.XPS.Features.EventBasedModifications
Assembly: Aspose.Page.dll (25.1.2)
API לשינוי אלמנט הPage.
public class PageAPI : IModificationAPIירושה
מיישם
חברים ירושים
object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
מאפיינים
גובה
מחזיר/מגדיר את גובה הדף, המובע כמספר ממשי יחידות של מרחב הקואורדינטות האפקטיבי.
public float Height { get; set; }ערך המאפיין
מספר דפים
מחזיר את מספר הדפים במסמך הפעיל.
public int PageCount { get; }ערך המאפיין
סך כל הדפים
מחזיר את המספר הכולל של דפים בכל המסמכים בתוך מסמך XPS.
public int TotalPageCount { get; }ערך המאפיין
כלים
מקבל את האובייקט שמספק כלים מעבר ל-API הרשמי של מניפולציית XPS.
public DocumentUtils Utils { get; }ערך המאפיין
רוחב
מחזיר/מגדיר את רוחב הדף, המובע כמספר ממשי ב יחידות של מרחב הקואורדינטות האפקטיבי.
public float Width { get; set; }ערך המאפיין
שיטות
הוסף<t>(T)
מוסיף אלמנט תוכן (Canvas, Path, או Glyphs).
public T Add<t>(T element) where T : XpsContentElementפרמטרים
element T
אלמנט שיש להוסיף.
מחזיר
T
אלמנט שנוסף.
פרמטרי סוג
T
סוג האלמנט.
הוסףCanvas()
מוסיף קנבס חדש לדף.
public XpsCanvas AddCanvas()מחזיר
קנבס שנוסף.
הוסףGlyphs(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
מחרוזת שתודפס.
מחזיר
גליופים שנוספו.
הוסףGlyphs(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
מחרוזת שתודפס.
מחזיר
גליופים שנוספו.
הוסףOutlineEntry(string, int, int)
מוסיף רשומת מתאר למסמך.
public void AddOutlineEntry(string description, int outlineLevel, int targetPageNumber)פרמטרים
description string
תיאור הרשומה.
outlineLevel int
רמת המתאר.
targetPageNumber int
מספר הדף המיועד.
הוסףPath(XpsPathGeometry)
מוסיף נתיב חדש לדף.
public XpsPath AddPath(XpsPathGeometry data)פרמטרים
data XpsPathGeometry
הגיאומטריה של הנתיב.
מחזיר
נתיב שנוסף.
צורArcSegment(PointF, SizeF, float, bool, XpsSweepDirection, bool)
יוצר קטע קשת אליפטי חדש.
public XpsArcSegment CreateArcSegment(PointF point, SizeF size, float rotationAngle, bool isLargeArc, XpsSweepDirection sweepDirection, bool isStroked = true)פרמטרים
point PointF
נקודת הקצה של הקשת האליפטית.
size SizeF
הרדיוס x וה-y של הקשת האליפטית כמקבץ x,y.
rotationAngle float
מציין כיצד האליפסה מסתובבת ביחס למערכת הקואורדינטות הנוכחית.
isLargeArc bool
קובע אם הקשת נמשכת עם סיבוב של 180 או יותר.
sweepDirection XpsSweepDirection
הכיוון שבו הקשת נמשכת.
isStroked bool
מציין אם הקו עבור קטע זה של הנתיב נמשך.
מחזיר
קטע קשת אליפטי חדש.
צורCanvas()
יוצר קנבס חדש.
public XpsCanvas CreateCanvas()מחזיר
קנבס חדש.
צורColor(Color)
יוצר צבע חדש.
public XpsColor CreateColor(Color color)פרמטרים
color Color
אינסטנציה של צבע מקורי עבור צבע RGB.
מחזיר
צבע חדש.
צורColor(int, int, int, int)
יוצר צבע חדש במרחב הצבעים sRGB.
public XpsColor CreateColor(int a, int r, int g, int b)פרמטרים
a int
המרכיב האלפא של הצבע.
r int
המרכיב האדום של הצבע.
g int
המרכיב הירוק של הצבע.
b int
המרכיב הכחול של הצבע.
מחזיר
צבע חדש.
צורColor(int, int, int)
יוצר צבע חדש במרחב הצבעים sRGB.
public XpsColor CreateColor(int r, int g, int b)פרמטרים
r int
המרכיב האדום של הצבע.
g int
המרכיב הירוק של הצבע.
b int
המרכיב הכחול של הצבע.
מחזיר
צבע חדש.
צורColor(float, float, float, float)
יוצר צבע חדש במרחב הצבעים scRGB.
public XpsColor CreateColor(float a, float r, float g, float b)פרמטרים
a float
המרכיב האלפא של הצבע.
r float
המרכיב האדום של הצבע.
g float
המרכיב הירוק של הצבע.
b float
המרכיב הכחול של הצבע.
מחזיר
צבע חדש.
צורColor(float, float, float)
יוצר צבע חדש במרחב הצבעים scRGB.
public XpsColor CreateColor(float r, float g, float b)פרמטרים
r float
המרכיב האדום של הצבע.
g float
המרכיב הירוק של הצבע.
b float
המרכיב הכחול של הצבע.
מחזיר
צבע חדש.
צורColor(string, params float[])
יוצר צבע חדש במרחב צבעים מבוסס ICC.
public XpsColor CreateColor(string path, params float[] components)פרמטרים
path string
הנתיב לפרופיל ה-ICC.
components float[]
מרכיבי צבע.
מחזיר
צבע חדש.
צורColor(XpsIccProfile, params float[])
יוצר צבע חדש במרחב צבעים מבוסס ICC.
public XpsColor CreateColor(XpsIccProfile iccProfile, params float[] components)פרמטרים
iccProfile XpsIccProfile
משאב פרופיל ה-ICC.
components float[]
מרכיבי צבע.
מחזיר
צבע חדש.
צורGlyphs(string, float, FontStyle, float, float, string)
יוצר גליופים חדשים.
public XpsGlyphs CreateGlyphs(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
מחרוזת שתודפס.
מחזיר
גליופים חדשים.
צורGlyphs(XpsFont, float, float, float, string)
יוצר גליופים חדשים.
public XpsGlyphs CreateGlyphs(XpsFont font, float fontRenderingEmSize, float originX, float originY, string unicodeString)פרמטרים
font XpsFont
משאב גופן.
fontRenderingEmSize float
גודל הגופן.
originX float
קואורדינטת ה-X של מקור הגליופים.
originY float
קואורדינטת ה-Y של מקור הגליופים.
unicodeString string
מחרוזת שתודפס.
מחזיר
גליופים חדשים.
צורGradientStop(XpsColor, float)
יוצר תחנת גרדיאנט חדשה.
public XpsGradientStop CreateGradientStop(XpsColor color, float offset)פרמטרים
color XpsColor
צבע תחנת הגרדיאנט.
offset float
ההזזה של הגרדיאנט.
מחזיר
תחנת גרדיאנט חדשה.
צורGradientStop(Color, float)
יוצר תחנת גרדיאנט חדשה.
public XpsGradientStop CreateGradientStop(Color color, float offset)פרמטרים
color Color
צבע תחנת הגרדיאנט.
offset float
ההזזה של הגרדיאנט.
מחזיר
תחנת גרדיאנט חדשה.
צורImageBrush(XpsImage, RectangleF, RectangleF)
יוצר מברשת תמונה חדשה.
public XpsImageBrush CreateImageBrush(XpsImage image, RectangleF viewbox, RectangleF viewport)פרמטרים
image XpsImage
משאב תמונה.
viewbox RectangleF
המיקום והמידות של תוכן המקור של המברשת.
viewport RectangleF
האזור במרחב הקואורדינטות המכיל את התמונה העיקרית שניתן להחיל עליה את המברשת.
מחזיר
מברשת תמונה חדשה.
צורImageBrush(string, RectangleF, RectangleF)
יוצר מברשת תמונה חדשה.
public XpsImageBrush CreateImageBrush(string imagePath, RectangleF viewbox, RectangleF viewport)פרמטרים
imagePath string
הנתיב לתמונה שיש לקחת כקנבס.
viewbox RectangleF
המיקום והמידות של תוכן המקור של המברשת.
viewport RectangleF
האזור במרחב הקואורדינטות המכיל את התמונה העיקרית שניתן להחיל עליה את המברשת.
מחזיר
מברשת תמונה חדשה.
צורLinearGradientBrush(List<xpsgradientstop>, PointF, PointF)
יוצר מברשת גרדיאנט ליניארית חדשה.
public XpsLinearGradientBrush CreateLinearGradientBrush(List<xpsgradientstop> gradientStops, PointF startPoint, PointF endPoint)פרמטרים
gradientStops List<XpsGradientStop>
רשימת תחנות גרדיאנט.
startPoint PointF
נקודת ההתחלה של הגרדיאנט הליניארי.
endPoint PointF
נקודת הסיום של הגרדיאנט הליניארי.
מחזיר
מברשת גרדיאנט ליניארית חדשה.
צורLinearGradientBrush(PointF, PointF)
יוצר מברשת גרדיאנט ליניארית חדשה.
public XpsLinearGradientBrush CreateLinearGradientBrush(PointF startPoint, PointF endPoint)פרמטרים
startPoint PointF
נקודת ההתחלה של הגרדיאנט הליניארי.
endPoint PointF
נקודת הסיום של הגרדיאנט הליניארי.
מחזיר
מברשת גרדיאנט ליניארית חדשה.
צורMatrix(float, float, float, float, float, float)
יוצר מטריצת טרנספורמציה חדשה.
public XpsMatrix CreateMatrix(float m11, float m12, float m21, float m22, float m31, float m32)פרמטרים
m11 float
אלמנט 11.
m12 float
אלמנט 12.
m21 float
אלמנט 21.
m22 float
אלמנט 22.
m31 float
אלמנט 31.
m32 float
אלמנט 32.
מחזיר
מטריצת טרנספורמציה חדשה.
צורPath(XpsPathGeometry)
יוצר נתיב חדש.
public XpsPath CreatePath(XpsPathGeometry data)פרמטרים
data XpsPathGeometry
הגיאומטריה של הנתיב.
מחזיר
נתיב חדש.
צורPathFigure(PointF, bool)
יוצר דמות נתיב חדשה.
public XpsPathFigure CreatePathFigure(PointF startPoint, bool isClosed = false)פרמטרים
startPoint PointF
נקודת ההתחלה עבור הקטע הראשון של דמות הנתיב.
isClosed bool
קובע אם הנתיב סגור. אם מוגדר כ-true, הקו נמשך “סגור”, כלומר, הנקודה האחרונה בקטע האחרון של דמות הנתיב מחוברת עם הנקודה המצוינת במאפיין StartPoint, אחרת הקו נמשך “פתוח”, ו הנקודה האחרונה אינה מחוברת לנקודת ההתחלה. חל רק אם דמות הנתיב בשימוש באלמנט Path שמציין קו.
מחזיר
דמות נתיב חדשה.
צורPathFigure(PointF, List, bool)
יוצר דמות נתיב חדשה.
public XpsPathFigure CreatePathFigure(PointF startPoint, List<xpspathsegment> segments, bool isClosed = false)פרמטרים
startPoint PointF
נקודת ההתחלה עבור הקטע הראשון של דמות הנתיב.
segments List<XpsPathSegment>
רשימת קטעי הנתיב.
isClosed bool
קובע אם הנתיב סגור. אם מוגדר כ-true, הקו נמשך “סגור”, כלומר, הנקודה האחרונה בקטע האחרון של דמות הנתיב מחוברת עם הנקודה המצוינת במאפיין StartPoint, אחרת הקו נמשך “פתוח”, ו הנקודה האחרונה אינה מחוברת לנקודת ההתחלה. חל רק אם דמות הנתיב בשימוש באלמנט Path שמציין קו.
מחזיר
דמות נתיב חדשה.
צורPathGeometry(string)
יוצר גיאומטריית נתיב חדשה המוגדרת בצורה מקוצרת.
public XpsPathGeometry CreatePathGeometry(string abbreviatedGeometry)פרמטרים
abbreviatedGeometry string
צורת מקוצרת של גיאומטריית הנתיב.
מחזיר
גיאומטריית נתיב חדשה.
צורPathGeometry()
יוצר גיאומטריית נתיב חדשה.
public XpsPathGeometry CreatePathGeometry()מחזיר
גיאומטריית נתיב חדשה.
צורPathGeometry(List)
יוצר גיאומטריית נתיב חדשה עם רשימת דמויות נתיב ספציפיות.
public XpsPathGeometry CreatePathGeometry(List<xpspathfigure> pathFigures)פרמטרים
pathFigures List<XpsPathFigure>
רשימת דמויות הנתיב.
מחזיר
גיאומטריית נתיב חדשה.
צורPolyBezierSegment(PointF[], bool)
יוצר סט חדש של קווים קוביים של Bézier.
public XpsPolyBezierSegment CreatePolyBezierSegment(PointF[] points, bool isStroked = true)פרמטרים
points PointF[]
נקודות בקרה עבור מספר קטעי Bézier.
isStroked bool
קובע אם הקו עבור קטע זה של הנתיב נמשך.
מחזיר
קטע קווים קוביים של Bézier חדש.
צורPolyLineSegment(PointF[], bool)
יוצר ציור פוליגונלי חדש המכיל מספר שרירותי של קודקודים בודדים.
public XpsPolyLineSegment CreatePolyLineSegment(PointF[] points, bool isStroked = true)פרמטרים
points PointF[]
סט של קואורדינטות עבור הקטעים המרובים המגדירים את קטע הקו הפוליגונלי.
isStroked bool
קובע אם הקו עבור קטע זה של הנתיב נמשך.
מחזיר
קטע ציור פוליגונלי חדש.
צורPolyQuadraticBezierSegment(PointF[], bool)
יוצר סט חדש של קווים קוביים של Bézier מהנקודה הקודמת בדמות הנתיב דרך סט של קודקודים, תוך שימוש בנקודות בקרה ספציפיות.
public XpsPolyQuadraticBezierSegment CreatePolyQuadraticBezierSegment(PointF[] points, bool isStroked = true)פרמטרים
points PointF[]
נקודות בקרה עבור מספר קטעי Bézier קוביים.
isStroked bool
קובע אם הקו עבור קטע זה של הנתיב נמשך.
מחזיר
קטע קווים קוביים של Bézier חדש.
צורRadialGradientBrush(List<xpsgradientstop>, PointF, PointF, float, float)
יוצר מברשת גרדיאנט רדיאלי חדשה.
public XpsRadialGradientBrush CreateRadialGradientBrush(List<xpsgradientstop> gradientStops, PointF center, PointF gradientOrigin, float radiusX, float radiusY)פרמטרים
gradientStops List<XpsGradientStop>
רשימת תחנות גרדיאנט.
center PointF
נקודת המרכז של הגרדיאנט הרדיאלי (כלומר, מרכז האליפסה).
gradientOrigin PointF
נקודת המקור של הגרדיאנט הרדיאלי.
radiusX float
הרדיוס במימד x של האליפסה המגדירה את הגרדיאנט הרדיאלי.
radiusY float
הרדיוס במימד y של האליפסה המגדירה את הגרדיאנט הרדיאלי.
מחזיר
מברשת גרדיאנט רדיאלי חדשה.
צורRadialGradientBrush(PointF, PointF, float, float)
יוצר מברשת גרדיאנט רדיאלי חדשה.
public XpsRadialGradientBrush CreateRadialGradientBrush(PointF center, PointF gradientOrigin, float radiusX, float radiusY)פרמטרים
center PointF
נקודת המרכז של הגרדיאנט הרדיאלי (כלומר, מרכז האליפסה).
gradientOrigin PointF
נקודת המקור של הגרדיאנט הרדיאלי.
radiusX float
הרדיוס במימד x של האליפסה המגדירה את הגרדיאנט הרדיאלי.
radiusY float
הרדיוס במימד y של האליפסה המגדירה את הגרדיאנט הרדיאלי.
מחזיר
מברשת גרדיאנט רדיאלי חדשה.
צורSolidColorBrush(XpsColor)
יוצר מברשת צבע מוצק חדשה.
public XpsSolidColorBrush CreateSolidColorBrush(XpsColor color)פרמטרים
color XpsColor
הצבע עבור אלמנטים ממולאים.
מחזיר
מברשת צבע מוצק חדשה.
צורSolidColorBrush(Color)
יוצר מברשת צבע מוצק חדשה.
public XpsSolidColorBrush CreateSolidColorBrush(Color color)פרמטרים
color Color
הצבע עבור אלמנטים ממולאים.
מחזיר
מברשת צבע מוצק חדשה.
צורVisualBrush(XpsContentElement, RectangleF, RectangleF)
יוצר מברשת ויזואלית חדשה.
public XpsVisualBrush CreateVisualBrush(XpsContentElement element, RectangleF viewbox, RectangleF viewport)פרמטרים
element XpsContentElement
האלמנט XPS (Canvas, Path או Glyphs) עבור מאפיין הוויזואלי של המברשת.
viewbox RectangleF
המיקום והמידות של תוכן המקור של המברשת.
viewport RectangleF
האזור במרחב הקואורדינטות המכיל את התמונה העיקרית שניתן להחיל עליה את המברשת.
מחזיר
מברשת ויזואלית חדשה.
הכנס<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
סוג האלמנט.
הכנסCanvas(int)
מכניס קנבס חדש לדף במיקום index.
public XpsCanvas InsertCanvas(int index)פרמטרים
index int
המיקום שבו יש להכניס קנבס חדש.
מחזיר
קנבס שהוכנס.
הכנסGlyphs(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
מחרוזת שתודפס.
מחזיר
גליופים שהוכנסו.
הכנסGlyphs(int, XpsFont, float, float, float, string)
מכניס גליופים חדשים לדף במיקום index.
public XpsGlyphs InsertGlyphs(int index, XpsFont font, float fontSize, float originX, float originY, string unicodeString)פרמטרים
index int
המיקום שבו יש להכניס גליופים חדשים.
font XpsFont
משאב גופן.
fontSize float
גודל הגופן.
originX float
קואורדינטת ה-X של מקור הגליופים.
originY float
קואורדינטת ה-Y של מקור הגליופים.
unicodeString string
מחרוזת שתודפס.
מחזיר
גליופים שהוכנסו.
הכנסPath(int, XpsPathGeometry)
מכניס נתיב חדש לדף במיקום index.
public XpsPath InsertPath(int index, XpsPathGeometry data)פרמטרים
index int
המיקום שבו יש להכניס נתיב חדש.
data XpsPathGeometry
הגיאומטריה של הנתיב.
מחזיר
נתיב שהוכנס.
הסר<t>(T)
מסיר אלמנט מהדף.
public T Remove<t>(T element) where T : XpsContentElementפרמטרים
element T
אלמנט שיש להסיר.
מחזיר
T
אלמנט שהוסר.
פרמטרי סוג
T
סוג האלמנט.
הסרAt(int)
מסיר אלמנט במיקום index מהדף.
public XpsContentElement RemoveAt(int index)פרמטרים
index int
המיקום שבו יש להסיר את האלמנט.
מחזיר
אלמנט שהוסר.
