Class PageAPI

Class PageAPI

Namespace: Aspose.Page.XPS.Features.EventBasedModifications
Assembly: Aspose.Page.dll (25.1.2)

Die Page Element-Modifikations-API.

public class PageAPI : IModificationAPI

Vererbung

objectPageAPI

Implementiert

IModificationAPI

Vererbte Mitglieder

object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Eigenschaften

Höhe

Gibt die Höhe der Seite zurück/setzt sie, ausgedrückt als eine reelle Zahl in Einheiten des effektiven Koordinatenraums.

public float Height { get; set; }

Eigenschaftswert

float

Seitenanzahl

Gibt die Anzahl der Seiten im aktiven Dokument zurück.

public int PageCount { get; }

Eigenschaftswert

int

Gesamtseitenanzahl

Gibt die Gesamtanzahl der Seiten in allen Dokumenten innerhalb des XPS-Dokuments zurück.

public int TotalPageCount { get; }

Eigenschaftswert

int

Utils

Erhält das Objekt, das zusätzliche Dienstprogramme über die formale XPS-Manipulations-API hinaus bereitstellt.

public DocumentUtils Utils { get; }

Eigenschaftswert

DocumentUtils

Breite

Gibt die Breite der Seite zurück/setzt sie, ausgedrückt als eine reelle Zahl in Einheiten des effektiven Koordinatenraums.

public float Width { get; set; }

Eigenschaftswert

float

Methoden

Add<t>(T)

Fügt ein Inhaltselement (Canvas, Path oder Glyphs) hinzu.

public T Add<t>(T element) where T : XpsContentElement

Parameter

element T

Element, das hinzugefügt werden soll.

Gibt zurück

T

Hinzugefügtes Element.

Typparameter

T

Der Typ des Elements.

AddCanvas()

Fügt der Seite ein neues Canvas hinzu.

public XpsCanvas AddCanvas()

Gibt zurück

XpsCanvas

Hinzugefügtes Canvas.

AddGlyphs(string, float, FontStyle, float, float, string)

Fügt der Seite neue Glyphen hinzu.

public XpsGlyphs AddGlyphs(string fontFamily, float fontRenderingEmSize, FontStyle fontStyle, float originX, float originY, string unicodeString)

Parameter

fontFamily string

Schriftfamilie.

fontRenderingEmSize float

Schriftgröße.

fontStyle FontStyle

Schriftstil.

originX float

X-Koordinate des Ursprungs der Glyphen.

originY float

Y-Koordinate des Ursprungs der Glyphen.

unicodeString string

String, der gedruckt werden soll.

Gibt zurück

XpsGlyphs

Hinzugefügte Glyphen.

AddGlyphs(XpsFont, float, float, float, string)

Fügt der Seite neue Glyphen hinzu.

public XpsGlyphs AddGlyphs(XpsFont font, float fontRenderingEmSize, float originX, float originY, string unicodeString)

Parameter

font XpsFont

Schriftressource.

fontRenderingEmSize float

Schriftgröße.

originX float

X-Koordinate des Ursprungs der Glyphen.

originY float

Y-Koordinate des Ursprungs der Glyphen.

unicodeString string

String, der gedruckt werden soll.

Gibt zurück

XpsGlyphs

Hinzugefügte Glyphen.

AddOutlineEntry(string, int, int)

Fügt dem Dokument einen Gliederungseintrag hinzu.

public void AddOutlineEntry(string description, int outlineLevel, int targetPageNumber)

Parameter

description string

Die Beschreibung des Eintrags.

outlineLevel int

Das Gliederungslevel.

targetPageNumber int

Die Zielseitenzahl.

AddPath(XpsPathGeometry)

Fügt der Seite einen neuen Pfad hinzu.

public XpsPath AddPath(XpsPathGeometry data)

Parameter

data XpsPathGeometry

Die Geometrie des Pfades.

Gibt zurück

XpsPath

Hinzugefügter Pfad.

CreateArcSegment(PointF, SizeF, float, bool, XpsSweepDirection, bool)

Erstellt ein neues elliptisches Bogensegment.

public XpsArcSegment CreateArcSegment(PointF point, SizeF size, float rotationAngle, bool isLargeArc, XpsSweepDirection sweepDirection, bool isStroked = true)

Parameter

point PointF

Der Endpunkt des elliptischen Bogens.

size SizeF

Der x- und y-Radius des elliptischen Bogens als x,y-Paar.

rotationAngle float

Gibt an, wie die Ellipse relativ zum aktuellen Koordinatensystem rotiert ist.

isLargeArc bool

Bestimmt, ob der Bogen mit einem Schwung von 180 oder mehr gezeichnet wird.

sweepDirection XpsSweepDirection

Die Richtung, in der der Bogen gezeichnet wird.

isStroked bool

Gibt an, ob die Linie für dieses Segment des Pfades gezeichnet wird.

Gibt zurück

XpsArcSegment

Neues elliptisches Bogensegment.

CreateCanvas()

Erstellt ein neues Canvas.

public XpsCanvas CreateCanvas()

Gibt zurück

XpsCanvas

Neues Canvas.

CreateColor(Color)

Erstellt eine neue Farbe.

public XpsColor CreateColor(Color color)

Parameter

color Color

Eine native Farbinstanz für RGB-Farbe.

Gibt zurück

XpsColor

Neue Farbe.

CreateColor(int, int, int, int)

Erstellt eine neue Farbe im sRGB-Farbraum.

public XpsColor CreateColor(int a, int r, int g, int b)

Parameter

a int

Die Alpha-Farbenkomponente.

r int

Die rote Farbenkomponente.

g int

Die grüne Farbenkomponente.

b int

Die blaue Farbenkomponente.

Gibt zurück

XpsColor

Neue Farbe.

CreateColor(int, int, int)

Erstellt eine neue Farbe im sRGB-Farbraum.

public XpsColor CreateColor(int r, int g, int b)

Parameter

r int

Die rote Farbenkomponente.

g int

Die grüne Farbenkomponente.

b int

Die blaue Farbenkomponente.

Gibt zurück

XpsColor

Neue Farbe.

CreateColor(float, float, float, float)

Erstellt eine neue Farbe im scRGB-Farbraum.

public XpsColor CreateColor(float a, float r, float g, float b)

Parameter

a float

Die Alpha-Farbenkomponente.

r float

Die rote Farbenkomponente.

g float

Die grüne Farbenkomponente.

b float

Die blaue Farbenkomponente.

Gibt zurück

XpsColor

Neue Farbe.

CreateColor(float, float, float)

Erstellt eine neue Farbe im scRGB-Farbraum.

public XpsColor CreateColor(float r, float g, float b)

Parameter

r float

Die rote Farbenkomponente.

g float

Die grüne Farbenkomponente.

b float

Die blaue Farbenkomponente.

Gibt zurück

XpsColor

Neue Farbe.

CreateColor(string, params float[])

Erstellt eine neue Farbe im ICC-basierten Farbraum.

public XpsColor CreateColor(string path, params float[] components)

Parameter

path string

Der Pfad zum ICC-Profil.

components float[]

Farbenkomponenten.

Gibt zurück

XpsColor

Neue Farbe.

CreateColor(XpsIccProfile, params float[])

Erstellt eine neue Farbe im ICC-basierten Farbraum.

public XpsColor CreateColor(XpsIccProfile iccProfile, params float[] components)

Parameter

iccProfile XpsIccProfile

Die ICC-Profilressource.

components float[]

Farbenkomponenten.

Gibt zurück

XpsColor

Neue Farbe.

CreateGlyphs(string, float, FontStyle, float, float, string)

Erstellt neue Glyphen.

public XpsGlyphs CreateGlyphs(string fontFamily, float fontRenderingEmSize, FontStyle fontStyle, float originX, float originY, string unicodeString)

Parameter

fontFamily string

Schriftfamilie.

fontRenderingEmSize float

Schriftgröße.

fontStyle FontStyle

Schriftstil.

originX float

X-Koordinate des Ursprungs der Glyphen.

originY float

Y-Koordinate des Ursprungs der Glyphen.

unicodeString string

String, der gedruckt werden soll.

Gibt zurück

XpsGlyphs

Neue Glyphen.

CreateGlyphs(XpsFont, float, float, float, string)

Erstellt neue Glyphen.

public XpsGlyphs CreateGlyphs(XpsFont font, float fontRenderingEmSize, float originX, float originY, string unicodeString)

Parameter

font XpsFont

Schriftressource.

fontRenderingEmSize float

Schriftgröße.

originX float

X-Koordinate des Ursprungs der Glyphen.

originY float

Y-Koordinate des Ursprungs der Glyphen.

unicodeString string

String, der gedruckt werden soll.

Gibt zurück

XpsGlyphs

Neue Glyphen.

CreateGradientStop(XpsColor, float)

Erstellt einen neuen Farbverlauf-Stopp.

public XpsGradientStop CreateGradientStop(XpsColor color, float offset)

Parameter

color XpsColor

Die Farbe des Farbverlaufsstopps.

offset float

Der Farbverlauf-Offset.

Gibt zurück

XpsGradientStop

Neuer Farbverlauf-Stopp.

CreateGradientStop(Color, float)

Erstellt einen neuen Farbverlauf-Stopp.

public XpsGradientStop CreateGradientStop(Color color, float offset)

Parameter

color Color

Die Farbe des Farbverlaufsstopps.

offset float

Der Farbverlauf-Offset.

Gibt zurück

XpsGradientStop

Neuer Farbverlauf-Stopp.

CreateImageBrush(XpsImage, RectangleF, RectangleF)

Erstellt einen neuen Bildpinsel.

public XpsImageBrush CreateImageBrush(XpsImage image, RectangleF viewbox, RectangleF viewport)

Parameter

image XpsImage

Eine Bildressource.

viewbox RectangleF

Die Position und Abmessungen des Quellinhalts des Pinsels.

viewport RectangleF

Der Bereich im umgebenden Koordinatenraum des Hauptpinsels, der (möglicherweise wiederholt) angewendet wird, um den Bereich zu füllen, auf den der Pinsel angewendet wird.

Gibt zurück

XpsImageBrush

Neuer Bildpinsel.

CreateImageBrush(string, RectangleF, RectangleF)

Erstellt einen neuen Bildpinsel.

public XpsImageBrush CreateImageBrush(string imagePath, RectangleF viewbox, RectangleF viewport)

Parameter

imagePath string

Der Pfad zum Bild, das als Pinsel-Fliese verwendet werden soll.

viewbox RectangleF

Die Position und Abmessungen des Quellinhalts des Pinsels.

viewport RectangleF

Der Bereich im umgebenden Koordinatenraum des Hauptpinsels, der (möglicherweise wiederholt) angewendet wird, um den Bereich zu füllen, auf den der Pinsel angewendet wird.

Gibt zurück

XpsImageBrush

Neuer Bildpinsel.

CreateLinearGradientBrush(List<xpsgradientstop>, PointF, PointF)

Erstellt einen neuen linearen Farbverlauf-Pinsel.

public XpsLinearGradientBrush CreateLinearGradientBrush(List<xpsgradientstop> gradientStops, PointF startPoint, PointF endPoint)

Parameter

gradientStops List<XpsGradientStop&gt;

Die Liste der Farbverlaufstopps.

startPoint PointF

Der Startpunkt des linearen Farbverlaufs.

endPoint PointF

Der Endpunkt des linearen Farbverlaufs.

Gibt zurück

XpsLinearGradientBrush

Neuer linearer Farbverlauf-Pinsel.

CreateLinearGradientBrush(PointF, PointF)

Erstellt einen neuen linearen Farbverlauf-Pinsel.

public XpsLinearGradientBrush CreateLinearGradientBrush(PointF startPoint, PointF endPoint)

Parameter

startPoint PointF

Der Startpunkt des linearen Farbverlaufs.

endPoint PointF

Der Endpunkt des linearen Farbverlaufs.

Gibt zurück

XpsLinearGradientBrush

Neuer linearer Farbverlauf-Pinsel.

CreateMatrix(float, float, float, float, float, float)

Erstellt eine neue affine Transformationsmatrix.

public XpsMatrix CreateMatrix(float m11, float m12, float m21, float m22, float m31, float m32)

Parameter

m11 float

Element 11.

m12 float

Element 12.

m21 float

Element 21.

m22 float

Element 22.

m31 float

Element 31.

m32 float

Element 32.

Gibt zurück

XpsMatrix

Neue affine Transformationsmatrix.

CreatePath(XpsPathGeometry)

Erstellt einen neuen Pfad.

public XpsPath CreatePath(XpsPathGeometry data)

Parameter

data XpsPathGeometry

Die Geometrie des Pfades.

Gibt zurück

XpsPath

Neuer Pfad.

CreatePathFigure(PointF, bool)

Erstellt eine neue Pfadfigur.

public XpsPathFigure CreatePathFigure(PointF startPoint, bool isClosed = false)

Parameter

startPoint PointF

Der Startpunkt für das erste Segment der Pfadfigur.

isClosed bool

Gibt an, ob der Pfad geschlossen ist. Wenn auf true gesetzt, wird die Linie “geschlossen” gezeichnet, d.h. der letzte Punkt im letzten Segment der Pfadfigur wird mit dem Punkt verbunden, der im Attribut StartPoint angegeben ist, andernfalls wird die Linie “offen” gezeichnet, und der letzte Punkt ist nicht mit dem Startpunkt verbunden. Nur anwendbar, wenn die Pfadfigur in einem Pfadelement verwendet wird, das eine Linie angibt.

Gibt zurück

XpsPathFigure

Neue Pfadfigur.

CreatePathFigure(PointF, List, bool)

Erstellt eine neue Pfadfigur.

public XpsPathFigure CreatePathFigure(PointF startPoint, List<xpspathsegment> segments, bool isClosed = false)

Parameter

startPoint PointF

Der Startpunkt für das erste Segment der Pfadfigur.

segments List<XpsPathSegment&gt;

Liste der Pfadsegmente.

isClosed bool

Gibt an, ob der Pfad geschlossen ist. Wenn auf true gesetzt, wird die Linie “geschlossen” gezeichnet, d.h. der letzte Punkt im letzten Segment der Pfadfigur wird mit dem Punkt verbunden, der im Attribut StartPoint angegeben ist, andernfalls wird die Linie “offen” gezeichnet, und der letzte Punkt ist nicht mit dem Startpunkt verbunden. Nur anwendbar, wenn die Pfadfigur in einem Pfadelement verwendet wird, das eine Linie angibt.

Gibt zurück

XpsPathFigure

Neue Pfadfigur.

CreatePathGeometry(string)

Erstellt eine neue Pfadgeometrie, die mit abgekürzter Form angegeben wird.

public XpsPathGeometry CreatePathGeometry(string abbreviatedGeometry)

Parameter

abbreviatedGeometry string

Abgekürzte Form der Pfadgeometrie.

Gibt zurück

XpsPathGeometry

Neue Pfadgeometrie.

CreatePathGeometry()

Erstellt eine neue Pfadgeometrie.

public XpsPathGeometry CreatePathGeometry()

Gibt zurück

XpsPathGeometry

Neue Pfadgeometrie.

CreatePathGeometry(List<xpspathfigure>)

Erstellt eine neue Pfadgeometrie mit einer angegebenen Liste von Pfadfiguren.

public XpsPathGeometry CreatePathGeometry(List<xpspathfigure> pathFigures)

Parameter

pathFigures List<XpsPathFigure&gt;

Liste der Pfadfiguren.

Gibt zurück

XpsPathGeometry

Neue Pfadgeometrie.

CreatePolyBezierSegment(PointF[], bool)

Erstellt eine neue Menge kubischer Bézierkurven.

public XpsPolyBezierSegment CreatePolyBezierSegment(PointF[] points, bool isStroked = true)

Parameter

points PointF[]

Kontrollpunkte für mehrere Béziersegmente.

isStroked bool

Gibt an, ob die Linie für dieses Segment des Pfades gezeichnet wird.

Gibt zurück

XpsPolyBezierSegment

Neues kubisches Bézierkurven-Segment.

CreatePolyLineSegment(PointF[], bool)

Erstellt eine neue polygonale Zeichnung mit einer beliebigen Anzahl von einzelnen Scheitelpunkten.

public XpsPolyLineSegment CreatePolyLineSegment(PointF[] points, bool isStroked = true)

Parameter

points PointF[]

Eine Menge von Koordinaten für die mehreren Segmente, die das polylinien Segment definieren.

isStroked bool

Gibt an, ob die Linie für dieses Segment des Pfades gezeichnet wird.

Gibt zurück

XpsPolyLineSegment

Neues polygonales Zeichnungssegment.

CreatePolyQuadraticBezierSegment(PointF[], bool)

Erstellt eine neue Menge quadratischer Bézierkurven vom vorherigen Punkt in der Pfadfigur durch eine Menge von Scheitelpunkten unter Verwendung der angegebenen Kontrollpunkte.

public XpsPolyQuadraticBezierSegment CreatePolyQuadraticBezierSegment(PointF[] points, bool isStroked = true)

Parameter

points PointF[]

Kontrollpunkte für mehrere quadratische Béziersegmente.

isStroked bool

Gibt an, ob die Linie für dieses Segment des Pfades gezeichnet wird.

Gibt zurück

XpsPolyQuadraticBezierSegment

Neues quadratisches Bézierkurven-Segment.

CreateRadialGradientBrush(List<xpsgradientstop>, PointF, PointF, float, float)

Erstellt einen neuen radialen Farbverlauf-Pinsel.

public XpsRadialGradientBrush CreateRadialGradientBrush(List<xpsgradientstop> gradientStops, PointF center, PointF gradientOrigin, float radiusX, float radiusY)

Parameter

gradientStops List<XpsGradientStop&gt;

Die Liste der Farbverlaufstopps.

center PointF

Der Mittelpunkt des radialen Farbverlaufs (d.h. der Mittelpunkt der Ellipse).

gradientOrigin PointF

Der Ursprungsort des radialen Farbverlaufs.

radiusX float

Der Radius in der x-Dimension der Ellipse, die den radialen Farbverlauf definiert.

radiusY float

Der Radius in der y-Dimension der Ellipse, die den radialen Farbverlauf definiert.

Gibt zurück

XpsRadialGradientBrush

Neuer radialer Farbverlauf-Pinsel.

CreateRadialGradientBrush(PointF, PointF, float, float)

Erstellt einen neuen radialen Farbverlauf-Pinsel.

public XpsRadialGradientBrush CreateRadialGradientBrush(PointF center, PointF gradientOrigin, float radiusX, float radiusY)

Parameter

center PointF

Der Mittelpunkt des radialen Farbverlaufs (d.h. der Mittelpunkt der Ellipse).

gradientOrigin PointF

Der Ursprungsort des radialen Farbverlaufs.

radiusX float

Der Radius in der x-Dimension der Ellipse, die den radialen Farbverlauf definiert.

radiusY float

Der Radius in der y-Dimension der Ellipse, die den radialen Farbverlauf definiert.

Gibt zurück

XpsRadialGradientBrush

Neuer radialer Farbverlauf-Pinsel.

CreateSolidColorBrush(XpsColor)

Erstellt einen neuen einfarbigen Pinsel.

public XpsSolidColorBrush CreateSolidColorBrush(XpsColor color)

Parameter

color XpsColor

Die Farbe für gefüllte Elemente.

Gibt zurück

XpsSolidColorBrush

Neuer einfarbiger Pinsel.

CreateSolidColorBrush(Color)

Erstellt einen neuen einfarbigen Pinsel.

public XpsSolidColorBrush CreateSolidColorBrush(Color color)

Parameter

color Color

Die Farbe für gefüllte Elemente.

Gibt zurück

XpsSolidColorBrush

Neuer einfarbiger Pinsel.

CreateVisualBrush(XpsContentElement, RectangleF, RectangleF)

Erstellt einen neuen visuellen Pinsel.

public XpsVisualBrush CreateVisualBrush(XpsContentElement element, RectangleF viewbox, RectangleF viewport)

Parameter

element XpsContentElement

Das XPS-Element (Canvas, Path oder Glyphs) für die visuelle Eigenschaft des visuellen Pinsels.

viewbox RectangleF

Die Position und Abmessungen des Quellinhalts des Pinsels.

viewport RectangleF

Der Bereich im umgebenden Koordinatenraum des Hauptpinsels, der (möglicherweise wiederholt) angewendet wird, um den Bereich zu füllen, auf den der Pinsel angewendet wird.

Gibt zurück

XpsVisualBrush

Neuer visueller Pinsel.

Insert<t>(int, T)

Fügt ein Element (Canvas, Path oder Glyphs) an der index-Position zur Seite hinzu.

public T Insert<t>(int index, T element) where T : XpsContentElement

Parameter

index int

Position, an der ein element eingefügt werden soll.

element T

Element, das eingefügt werden soll.

Gibt zurück

T

Eingefügtes Element.

Typparameter

T

Der Typ des Elements.

InsertCanvas(int)

Fügt der Seite an der index-Position ein neues Canvas hinzu.

public XpsCanvas InsertCanvas(int index)

Parameter

index int

Position, an der ein neues Canvas eingefügt werden soll.

Gibt zurück

XpsCanvas

Eingefügtes Canvas.

InsertGlyphs(int, string, float, FontStyle, float, float, string)

Fügt der Seite an der index-Position neue Glyphen hinzu.

public XpsGlyphs InsertGlyphs(int index, string fontFamily, float fontSize, FontStyle fontStyle, float originX, float originY, string unicodeString)

Parameter

index int

Position, an der neue Glyphen eingefügt werden sollen.

fontFamily string

Schriftfamilie.

fontSize float

Schriftgröße.

fontStyle FontStyle

Schriftstil.

originX float

X-Koordinate des Ursprungs der Glyphen.

originY float

Y-Koordinate des Ursprungs der Glyphen.

unicodeString string

String, der gedruckt werden soll.

Gibt zurück

XpsGlyphs

Eingefügte Glyphen.

InsertGlyphs(int, XpsFont, float, float, float, string)

Fügt der Seite an der index-Position neue Glyphen hinzu.

public XpsGlyphs InsertGlyphs(int index, XpsFont font, float fontSize, float originX, float originY, string unicodeString)

Parameter

index int

Position, an der neue Glyphen eingefügt werden sollen.

font XpsFont

Schriftressource.

fontSize float

Schriftgröße.

originX float

X-Koordinate des Ursprungs der Glyphen.

originY float

Y-Koordinate des Ursprungs der Glyphen.

unicodeString string

String, der gedruckt werden soll.

Gibt zurück

XpsGlyphs

Eingefügte Glyphen.

InsertPath(int, XpsPathGeometry)

Fügt der Seite an der index-Position einen neuen Pfad hinzu.

public XpsPath InsertPath(int index, XpsPathGeometry data)

Parameter

index int

Position, an der ein neuer Pfad eingefügt werden soll.

data XpsPathGeometry

Die Geometrie des Pfades.

Gibt zurück

XpsPath

Eingefügter Pfad.

Remove<t>(T)

Entfernt ein Element von der Seite.

public T Remove<t>(T element) where T : XpsContentElement

Parameter

element T

Element, das entfernt werden soll.

Gibt zurück

T

Entferntes Element.

Typparameter

T

Der Typ des Elements.

RemoveAt(int)

Entfernt ein Element an der index-Position von der Seite.

public XpsContentElement RemoveAt(int index)

Parameter

index int

Position, an der das Element entfernt werden soll.

Gibt zurück

XpsContentElement

Entferntes Element.

 Deutsch