Class PageAPI
Namespace: Aspose.Page.XPS.Features.EventBasedModifications
Assembly: Aspose.Page.dll (25.1.2)
API modyfikacji elementu Page.
public class PageAPI : IModificationAPIDziedziczenie
Implementuje
Członkowie dziedziczeni
object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Właściwości
Wysokość
Zwraca/ustawia wysokość strony, wyrażoną jako liczba rzeczywista w jednostkach efektywnej przestrzeni współrzędnych.
public float Height { get; set; }Wartość właściwości
LiczbaStron
Zwraca liczbę stron w aktywnym dokumencie.
public int PageCount { get; }Wartość właściwości
CałkowitaLiczbaStron
Zwraca całkowitą liczbę stron we wszystkich dokumentach w dokumencie XPS.
public int TotalPageCount { get; }Wartość właściwości
Narzędzia
Zwraca obiekt, który zapewnia dodatkowe funkcje poza formalnym API manipulacji XPS.
public DocumentUtils Utils { get; }Wartość właściwości
Szerokość
Zwraca/ustawia szerokość strony, wyrażoną jako liczba rzeczywista w jednostkach efektywnej przestrzeni współrzędnych.
public float Width { get; set; }Wartość właściwości
Metody
Dodaj<t>(T)
Dodaje element treści (Canvas, Path lub Glyphs).
public T Add<t>(T element) where T : XpsContentElementParametry
element T
Element do dodania.
Zwraca
T
Dodany element.
Parametry typu
T
Typ elementu.
DodajCanvas()
Dodaje nowy kanwas do strony.
public XpsCanvas AddCanvas()Zwraca
Dodany kanwas.
DodajGlyphs(string, float, FontStyle, float, float, string)
Dodaje nowe glify do strony.
public XpsGlyphs AddGlyphs(string fontFamily, float fontRenderingEmSize, FontStyle fontStyle, float originX, float originY, string unicodeString)Parametry
fontFamily string
Rodzina czcionek.
fontRenderingEmSize float
Rozmiar czcionki.
fontStyle FontStyle
Styl czcionki.
originX float
Współrzędna X początkowego punktu glifów.
originY float
Współrzędna Y początkowego punktu glifów.
unicodeString string
Napis do wydrukowania.
Zwraca
Dodane glify.
DodajGlyphs(XpsFont, float, float, float, string)
Dodaje nowe glify do strony.
public XpsGlyphs AddGlyphs(XpsFont font, float fontRenderingEmSize, float originX, float originY, string unicodeString)Parametry
font XpsFont
Zasób czcionki.
fontRenderingEmSize float
Rozmiar czcionki.
originX float
Współrzędna X początkowego punktu glifów.
originY float
Współrzędna Y początkowego punktu glifów.
unicodeString string
Napis do wydrukowania.
Zwraca
Dodane glify.
DodajOutlineEntry(string, int, int)
Dodaje wpis do spisu treści dokumentu.
public void AddOutlineEntry(string description, int outlineLevel, int targetPageNumber)Parametry
description string
Opis wpisu.
outlineLevel int
Poziom spisu treści.
targetPageNumber int
Numer docelowej strony.
DodajPath(XpsPathGeometry)
Dodaje nową ścieżkę do strony.
public XpsPath AddPath(XpsPathGeometry data)Parametry
data XpsPathGeometry
Geometria ścieżki.
Zwraca
Dodana ścieżka.
CreateArcSegment(PointF, SizeF, float, bool, XpsSweepDirection, bool)
Tworzy nowy segment łukowy.
public XpsArcSegment CreateArcSegment(PointF point, SizeF size, float rotationAngle, bool isLargeArc, XpsSweepDirection sweepDirection, bool isStroked = true)Parametry
point PointF
Koniec łuku eliptycznego.
size SizeF
Promień x i y łuku eliptycznego jako para x,y.
rotationAngle float
Określa, jak elipsa jest obrócona w stosunku do bieżącego układu współrzędnych.
isLargeArc bool
Określa, czy łuk jest rysowany z zakresem 180 lub większym.
sweepDirection XpsSweepDirection
Kierunek, w którym łuk jest rysowany.
isStroked bool
Określa, czy kontur dla tego segmentu ścieżki jest rysowany.
Zwraca
Nowy segment łukowy.
CreateCanvas()
Tworzy nowy kanwas.
public XpsCanvas CreateCanvas()Zwraca
Nowy kanwas.
CreateColor(Color)
Tworzy nowy kolor.
public XpsColor CreateColor(Color color)Parametry
color Color
Instancja koloru natywnego dla koloru RGB.
Zwraca
Nowy kolor.
CreateColor(int, int, int, int)
Tworzy nowy kolor w przestrzeni kolorów sRGB.
public XpsColor CreateColor(int a, int r, int g, int b)Parametry
a int
Składnik koloru alfa.
r int
Składnik koloru czerwonego.
g int
Składnik koloru zielonego.
b int
Składnik koloru niebieskiego.
Zwraca
Nowy kolor.
CreateColor(int, int, int)
Tworzy nowy kolor w przestrzeni kolorów sRGB.
public XpsColor CreateColor(int r, int g, int b)Parametry
r int
Składnik koloru czerwonego.
g int
Składnik koloru zielonego.
b int
Składnik koloru niebieskiego.
Zwraca
Nowy kolor.
CreateColor(float, float, float, float)
Tworzy nowy kolor w przestrzeni kolorów scRGB.
public XpsColor CreateColor(float a, float r, float g, float b)Parametry
a float
Składnik koloru alfa.
r float
Składnik koloru czerwonego.
g float
Składnik koloru zielonego.
b float
Składnik koloru niebieskiego.
Zwraca
Nowy kolor.
CreateColor(float, float, float)
Tworzy nowy kolor w przestrzeni kolorów scRGB.
public XpsColor CreateColor(float r, float g, float b)Parametry
r float
Składnik koloru czerwonego.
g float
Składnik koloru zielonego.
b float
Składnik koloru niebieskiego.
Zwraca
Nowy kolor.
CreateColor(string, params float[])
Tworzy nowy kolor w przestrzeni kolorów opartych na ICC.
public XpsColor CreateColor(string path, params float[] components)Parametry
path string
Ścieżka do profilu ICC.
components float[]
Składniki koloru.
Zwraca
Nowy kolor.
CreateColor(XpsIccProfile, params float[])
Tworzy nowy kolor w przestrzeni kolorów opartych na ICC.
public XpsColor CreateColor(XpsIccProfile iccProfile, params float[] components)Parametry
iccProfile XpsIccProfile
Zasób profilu ICC.
components float[]
Składniki koloru.
Zwraca
Nowy kolor.
CreateGlyphs(string, float, FontStyle, float, float, string)
Tworzy nowe glify.
public XpsGlyphs CreateGlyphs(string fontFamily, float fontRenderingEmSize, FontStyle fontStyle, float originX, float originY, string unicodeString)Parametry
fontFamily string
Rodzina czcionek.
fontRenderingEmSize float
Rozmiar czcionki.
fontStyle FontStyle
Styl czcionki.
originX float
Współrzędna X początkowego punktu glifów.
originY float
Współrzędna Y początkowego punktu glifów.
unicodeString string
Napis do wydrukowania.
Zwraca
Nowe glify.
CreateGlyphs(XpsFont, float, float, float, string)
Tworzy nowe glify.
public XpsGlyphs CreateGlyphs(XpsFont font, float fontRenderingEmSize, float originX, float originY, string unicodeString)Parametry
font XpsFont
Zasób czcionki.
fontRenderingEmSize float
Rozmiar czcionki.
originX float
Współrzędna X początkowego punktu glifów.
originY float
Współrzędna Y początkowego punktu glifów.
unicodeString string
Napis do wydrukowania.
Zwraca
Nowe glify.
CreateGradientStop(XpsColor, float)
Tworzy nowy punkt gradientu.
public XpsGradientStop CreateGradientStop(XpsColor color, float offset)Parametry
color XpsColor
Kolor punktu gradientu.
offset float
Przesunięcie gradientu.
Zwraca
Nowy punkt gradientu.
CreateGradientStop(Color, float)
Tworzy nowy punkt gradientu.
public XpsGradientStop CreateGradientStop(Color color, float offset)Parametry
color Color
Kolor punktu gradientu.
offset float
Przesunięcie gradientu.
Zwraca
Nowy punkt gradientu.
CreateImageBrush(XpsImage, RectangleF, RectangleF)
Tworzy nowy pędzel obrazkowy.
public XpsImageBrush CreateImageBrush(XpsImage image, RectangleF viewbox, RectangleF viewport)Parametry
image XpsImage
Zasób obrazu.
viewbox RectangleF
Pozycja i wymiary źródłowej zawartości pędzla.
viewport RectangleF
Obszar w przestrzeni współrzędnych zawierającej, w którym główny wzór pędzla jest (możliwie wielokrotnie) stosowany do wypełnienia obszaru, na który pędzel jest stosowany.
Zwraca
Nowy pędzel obrazkowy.
CreateImageBrush(string, RectangleF, RectangleF)
Tworzy nowy pędzel obrazkowy.
public XpsImageBrush CreateImageBrush(string imagePath, RectangleF viewbox, RectangleF viewport)Parametry
imagePath string
Ścieżka do obrazu, który ma być użyty jako wzór pędzla.
viewbox RectangleF
Pozycja i wymiary źródłowej zawartości pędzla.
viewport RectangleF
Obszar w przestrzeni współrzędnych zawierającej, w którym główny wzór pędzla jest (możliwie wielokrotnie) stosowany do wypełnienia obszaru, na który pędzel jest stosowany.
Zwraca
Nowy pędzel obrazkowy.
CreateLinearGradientBrush(List<xpsgradientstop>, PointF, PointF)
Tworzy nowy pędzel gradientowy liniowy.
public XpsLinearGradientBrush CreateLinearGradientBrush(List<xpsgradientstop> gradientStops, PointF startPoint, PointF endPoint)Parametry
gradientStops List<XpsGradientStop>
Lista punktów gradientu.
startPoint PointF
Punkt początkowy gradientu liniowego.
endPoint PointF
Punkt końcowy gradientu liniowego.
Zwraca
Nowy pędzel gradientowy liniowy.
CreateLinearGradientBrush(PointF, PointF)
Tworzy nowy pędzel gradientowy liniowy.
public XpsLinearGradientBrush CreateLinearGradientBrush(PointF startPoint, PointF endPoint)Parametry
startPoint PointF
Punkt początkowy gradientu liniowego.
endPoint PointF
Punkt końcowy gradientu liniowego.
Zwraca
Nowy pędzel gradientowy liniowy.
CreateMatrix(float, float, float, float, float, float)
Tworzy nową macierz transformacji afinicznej.
public XpsMatrix CreateMatrix(float m11, float m12, float m21, float m22, float m31, float m32)Parametry
m11 float
Element 11.
m12 float
Element 12.
m21 float
Element 21.
m22 float
Element 22.
m31 float
Element 31.
m32 float
Element 32.
Zwraca
Nowa macierz transformacji afinicznej.
CreatePath(XpsPathGeometry)
Tworzy nową ścieżkę.
public XpsPath CreatePath(XpsPathGeometry data)Parametry
data XpsPathGeometry
Geometria ścieżki.
Zwraca
Nowa ścieżka.
CreatePathFigure(PointF, bool)
Tworzy nową figurę ścieżki.
public XpsPathFigure CreatePathFigure(PointF startPoint, bool isClosed = false)Parametry
startPoint PointF
Punkt początkowy dla pierwszego segmentu figury ścieżki.
isClosed bool
Określa, czy ścieżka jest zamknięta. Jeśli ustawione na true, kontur jest rysowany jako “zamknięty”, a ostatni punkt w ostatnim segmencie figury ścieżki jest połączony z punktem określonym w atrybucie StartPoint, w przeciwnym razie kontur jest rysowany jako “otwarty”, a ostatni punkt nie jest połączony z punktem początkowym. Stosowane tylko, jeśli figura ścieżki jest używana w elemencie Path, który określa kontur.
Zwraca
Nowa figura ścieżki.
CreatePathFigure(PointF, List, bool)
Tworzy nową figurę ścieżki.
public XpsPathFigure CreatePathFigure(PointF startPoint, List<xpspathsegment> segments, bool isClosed = false)Parametry
startPoint PointF
Punkt początkowy dla pierwszego segmentu figury ścieżki.
segments List<XpsPathSegment>
Lista segmentów ścieżki.
isClosed bool
Określa, czy ścieżka jest zamknięta. Jeśli ustawione na true, kontur jest rysowany jako “zamknięty”, a ostatni punkt w ostatnim segmencie figury ścieżki jest połączony z punktem określonym w atrybucie StartPoint, w przeciwnym razie kontur jest rysowany jako “otwarty”, a ostatni punkt nie jest połączony z punktem początkowym. Stosowane tylko, jeśli figura ścieżki jest używana w elemencie Path, który określa kontur.
Zwraca
Nowa figura ścieżki.
CreatePathGeometry(string)
Tworzy nową geometrię ścieżki określoną w skróconej formie.
public XpsPathGeometry CreatePathGeometry(string abbreviatedGeometry)Parametry
abbreviatedGeometry string
Skrócona forma geometrii ścieżki.
Zwraca
Nowa geometria ścieżki.
CreatePathGeometry()
Tworzy nową geometrię ścieżki.
public XpsPathGeometry CreatePathGeometry()Zwraca
Nowa geometria ścieżki.
CreatePathGeometry(List<xpspathfigure>)
Tworzy nową geometrię ścieżki z określoną listą figur ścieżek.
public XpsPathGeometry CreatePathGeometry(List<xpspathfigure> pathFigures)Parametry
pathFigures List<XpsPathFigure>
Lista figur ścieżek.
Zwraca
Nowa geometria ścieżki.
CreatePolyBezierSegment(PointF[], bool)
Tworzy nowy zestaw krzywych Béziera sześciennego.
public XpsPolyBezierSegment CreatePolyBezierSegment(PointF[] points, bool isStroked = true)Parametry
points PointF[]
Punkty kontrolne dla wielu segmentów Béziera.
isStroked bool
Określa, czy kontur dla tego segmentu ścieżki jest rysowany.
Zwraca
Nowy segment krzywych Béziera sześciennego.
CreatePolyLineSegment(PointF[], bool)
Tworzy nowy rysunek wielokątny zawierający dowolną liczbę pojedynczych wierzchołków.
public XpsPolyLineSegment CreatePolyLineSegment(PointF[] points, bool isStroked = true)Parametry
points PointF[]
Zestaw współrzędnych dla wielu segmentów definiujących segment wielokątny.
isStroked bool
Określa, czy kontur dla tego segmentu ścieżki jest rysowany.
Zwraca
Nowy segment rysunku wielokątnego.
CreatePolyQuadraticBezierSegment(PointF[], bool)
Tworzy nowy zestaw krzywych Béziera kwadratowego z poprzedniego punktu w figurze ścieżki przez zestaw wierzchołków, używając określonych punktów kontrolnych.
public XpsPolyQuadraticBezierSegment CreatePolyQuadraticBezierSegment(PointF[] points, bool isStroked = true)Parametry
points PointF[]
Punkty kontrolne dla wielu segmentów Béziera kwadratowego.
isStroked bool
Określa, czy kontur dla tego segmentu ścieżki jest rysowany.
Zwraca
Nowy segment krzywych Béziera kwadratowego.
CreateRadialGradientBrush(List<xpsgradientstop>, PointF, PointF, float, float)
Tworzy nowy pędzel gradientowy radialny.
public XpsRadialGradientBrush CreateRadialGradientBrush(List<xpsgradientstop> gradientStops, PointF center, PointF gradientOrigin, float radiusX, float radiusY)Parametry
gradientStops List<XpsGradientStop>
Lista punktów gradientu.
center PointF
Punkt centralny gradientu radialnego (czyli środek elipsy).
gradientOrigin PointF
Punkt początkowy gradientu radialnego.
radiusX float
Promień w wymiarze x elipsy, która definiuje gradient radialny.
radiusY float
Promień w wymiarze y elipsy, która definiuje gradient radialny.
Zwraca
Nowy pędzel gradientowy radialny.
CreateRadialGradientBrush(PointF, PointF, float, float)
Tworzy nowy pędzel gradientowy radialny.
public XpsRadialGradientBrush CreateRadialGradientBrush(PointF center, PointF gradientOrigin, float radiusX, float radiusY)Parametry
center PointF
Punkt centralny gradientu radialnego (czyli środek elipsy).
gradientOrigin PointF
Punkt początkowy gradientu radialnego.
radiusX float
Promień w wymiarze x elipsy, która definiuje gradient radialny.
radiusY float
Promień w wymiarze y elipsy, która definiuje gradient radialny.
Zwraca
Nowy pędzel gradientowy radialny.
CreateSolidColorBrush(XpsColor)
Tworzy nowy pędzel wypełniający kolor.
public XpsSolidColorBrush CreateSolidColorBrush(XpsColor color)Parametry
color XpsColor
Kolor dla wypełnionych elementów.
Zwraca
Nowy pędzel wypełniający kolor.
CreateSolidColorBrush(Color)
Tworzy nowy pędzel wypełniający kolor.
public XpsSolidColorBrush CreateSolidColorBrush(Color color)Parametry
color Color
Kolor dla wypełnionych elementów.
Zwraca
Nowy pędzel wypełniający kolor.
CreateVisualBrush(XpsContentElement, RectangleF, RectangleF)
Tworzy nowy pędzel wizualny.
public XpsVisualBrush CreateVisualBrush(XpsContentElement element, RectangleF viewbox, RectangleF viewport)Parametry
element XpsContentElement
Element XPS (Canvas, Path lub Glyphs) dla właściwości wizualnej pędzla wizualnego.
viewbox RectangleF
Pozycja i wymiary źródłowej zawartości pędzla.
viewport RectangleF
Obszar w przestrzeni współrzędnych zawierającej, w którym główny wzór pędzla jest (możliwie wielokrotnie) stosowany do wypełnienia obszaru, na który pędzel jest stosowany.
Zwraca
Nowy pędzel wizualny.
Wstaw<t>(int, T)
Wstawia element (Canvas, Path lub Glyphs) na stronę w pozycji index.
public T Insert<t>(int index, T element) where T : XpsContentElementParametry
index int
Pozycja, w której element element powinien być wstawiony.
element T
Element do wstawienia.
Zwraca
T
Wstawiony element.
Parametry typu
T
Typ elementu.
WstawCanvas(int)
Wstawia nowy kanwas na stronę w pozycji index.
public XpsCanvas InsertCanvas(int index)Parametry
index int
Pozycja, w której nowy kanwas powinien być wstawiony.
Zwraca
Wstawiony kanwas.
WstawGlyphs(int, string, float, FontStyle, float, float, string)
Wstawia nowe glify na stronę w pozycji index.
public XpsGlyphs InsertGlyphs(int index, string fontFamily, float fontSize, FontStyle fontStyle, float originX, float originY, string unicodeString)Parametry
index int
Pozycja, w której nowe glify powinny być wstawione.
fontFamily string
Rodzina czcionek.
fontSize float
Rozmiar czcionki.
fontStyle FontStyle
Styl czcionki.
originX float
Współrzędna X początkowego punktu glifów.
originY float
Współrzędna Y początkowego punktu glifów.
unicodeString string
Napis do wydrukowania.
Zwraca
Wstawione glify.
WstawGlyphs(int, XpsFont, float, float, float, string)
Wstawia nowe glify na stronę w pozycji index.
public XpsGlyphs InsertGlyphs(int index, XpsFont font, float fontSize, float originX, float originY, string unicodeString)Parametry
index int
Pozycja, w której nowe glify powinny być wstawione.
font XpsFont
Zasób czcionki.
fontSize float
Rozmiar czcionki.
originX float
Współrzędna X początkowego punktu glifów.
originY float
Współrzędna Y początkowego punktu glifów.
unicodeString string
Napis do wydrukowania.
Zwraca
Wstawione glify.
WstawPath(int, XpsPathGeometry)
Wstawia nową ścieżkę na stronę w pozycji index.
public XpsPath InsertPath(int index, XpsPathGeometry data)Parametry
index int
Pozycja, w której nowa ścieżka powinna być wstawiona.
data XpsPathGeometry
Geometria ścieżki.
Zwraca
Wstawiona ścieżka.
Usuń<t>(T)
Usuwa element ze strony.
public T Remove<t>(T element) where T : XpsContentElementParametry
element T
Element do usunięcia.
Zwraca
T
Usunięty element.
Parametry typu
T
Typ elementu.
RemoveAt(int)
Usuwa element w pozycji index ze strony.
public XpsContentElement RemoveAt(int index)Parametry
index int
Pozycja, w której element powinien być usunięty.
Zwraca
Usunięty element.
