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()
Властивості
Height
Повертає/встановлює висоту сторінки, виражену як дійсне число в одиницях ефективної координатної системи.
public float Height { get; set; }Значення властивості
PageCount
Повертає кількість сторінок у активному документі.
public int PageCount { get; }Значення властивості
TotalPageCount
Повертає загальну кількість сторінок у всіх документах всередині XPS документа.
public int TotalPageCount { get; }Значення властивості
Utils
Отримує об’єкт, який надає утиліти, що виходять за межі формального API маніпуляцій XPS.
public DocumentUtils Utils { get; }Значення властивості
Width
Повертає/встановлює ширину сторінки, виражену як дійсне число в одиницях ефективної координатної системи.
public float Width { get; set; }Значення властивості
Методи
Add<t>(T)
Додає елемент контенту (Canvas, Path або Glyphs).
public T Add<t>(T element) where T : XpsContentElementПараметри
element T
Елемент, який потрібно додати.
Повертає
T
Доданий елемент.
Параметри типу
T
Тип елемента.
AddCanvas()
Додає новий канвас до сторінки.
public XpsCanvas AddCanvas()Повертає
Доданий канвас.
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, int)
Додає запис вмісту до документа.
public void AddOutlineEntry(string description, int outlineLevel, int targetPageNumber)Параметри
description string
Опис запису.
outlineLevel int
Рівень вмісту.
targetPageNumber int
Номер цільової сторінки.
AddPath(XpsPathGeometry)
Додає новий шлях до сторінки.
public XpsPath AddPath(XpsPathGeometry data)Параметри
data XpsPathGeometry
Геометрія шляху.
Повертає
Доданий шлях.
CreateArcSegment(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
Вказує, чи малюється обводка для цього сегмента шляху.
Повертає
Новий еліптичний дуговий сегмент.
CreateCanvas()
Створює новий канвас.
public XpsCanvas CreateCanvas()Повертає
Новий канвас.
CreateColor(Color)
Створює новий колір.
public XpsColor CreateColor(Color color)Параметри
color Color
Екземпляр кольору для RGB кольору.
Повертає
Новий колір.
CreateColor(int, int, int, int)
Створює новий колір у колірному просторі sRGB.
public XpsColor CreateColor(int a, int r, int g, int b)Параметри
a int
Компонента альфа кольору.
r int
Компонента червоного кольору.
g int
Компонента зеленого кольору.
b int
Компонента синього кольору.
Повертає
Новий колір.
CreateColor(int, int, int)
Створює новий колір у колірному просторі sRGB.
public XpsColor CreateColor(int r, int g, int b)Параметри
r int
Компонента червоного кольору.
g int
Компонента зеленого кольору.
b int
Компонента синього кольору.
Повертає
Новий колір.
CreateColor(float, float, float, float)
Створює новий колір у колірному просторі scRGB.
public XpsColor CreateColor(float a, float r, float g, float b)Параметри
a float
Компонента альфа кольору.
r float
Компонента червоного кольору.
g float
Компонента зеленого кольору.
b float
Компонента синього кольору.
Повертає
Новий колір.
CreateColor(float, float, float)
Створює новий колір у колірному просторі scRGB.
public XpsColor CreateColor(float r, float g, float b)Параметри
r float
Компонента червоного кольору.
g float
Компонента зеленого кольору.
b float
Компонента синього кольору.
Повертає
Новий колір.
CreateColor(string, params float[])
Створює новий колір у колірному просторі на основі ICC.
public XpsColor CreateColor(string path, params float[] components)Параметри
path string
Шлях до профілю ICC.
components float[]
Компоненти кольору.
Повертає
Новий колір.
CreateColor(XpsIccProfile, params float[])
Створює новий колір у колірному просторі на основі ICC.
public XpsColor CreateColor(XpsIccProfile iccProfile, params float[] components)Параметри
iccProfile XpsIccProfile
Ресурс профілю ICC.
components float[]
Компоненти кольору.
Повертає
Новий колір.
CreateGlyphs(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
Рядок, який потрібно надрукувати.
Повертає
Нові гліфи.
CreateGlyphs(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
Рядок, який потрібно надрукувати.
Повертає
Нові гліфи.
CreateGradientStop(XpsColor, float)
Створює нову градієнтну зупинку.
public XpsGradientStop CreateGradientStop(XpsColor color, float offset)Параметри
color XpsColor
Колір градієнтної зупинки.
offset float
Зсув градієнта.
Повертає
Нова градієнтна зупинка.
CreateGradientStop(Color, float)
Створює нову градієнтну зупинку.
public XpsGradientStop CreateGradientStop(Color color, float offset)Параметри
color Color
Колір градієнтної зупинки.
offset float
Зсув градієнта.
Повертає
Нова градієнтна зупинка.
CreateImageBrush(XpsImage, RectangleF, RectangleF)
Створює нову кисть зображення.
public XpsImageBrush CreateImageBrush(XpsImage image, RectangleF viewbox, RectangleF viewport)Параметри
image XpsImage
Ресурс зображення.
viewbox RectangleF
Позиція та розміри вмісту джерела кисті.
viewport RectangleF
Область у координатному просторі, що містить основну плитку кисті, яка (можливо, неодноразово) застосовується для заповнення області, до якої застосовується кисть.
Повертає
Нова кисть зображення.
CreateImageBrush(string, RectangleF, RectangleF)
Створює нову кисть зображення.
public XpsImageBrush CreateImageBrush(string imagePath, RectangleF viewbox, RectangleF viewport)Параметри
imagePath string
Шлях до зображення, яке потрібно взяти як плитку кисті.
viewbox RectangleF
Позиція та розміри вмісту джерела кисті.
viewport RectangleF
Область у координатному просторі, що містить основну плитку кисті, яка (можливо, неодноразово) застосовується для заповнення області, до якої застосовується кисть.
Повертає
Нова кисть зображення.
CreateLinearGradientBrush(List<xpsgradientstop>, PointF, PointF)
Створює нову кисть лінійного градієнта.
public XpsLinearGradientBrush CreateLinearGradientBrush(List<xpsgradientstop> gradientStops, PointF startPoint, PointF endPoint)Параметри
gradientStops List<XpsGradientStop>
Список градієнтних зупинок.
startPoint PointF
Початкова точка лінійного градієнта.
endPoint PointF
Кінцева точка лінійного градієнта.
Повертає
Нова кисть лінійного градієнта.
CreateLinearGradientBrush(PointF, PointF)
Створює нову кисть лінійного градієнта.
public XpsLinearGradientBrush CreateLinearGradientBrush(PointF startPoint, PointF endPoint)Параметри
startPoint PointF
Початкова точка лінійного градієнта.
endPoint PointF
Кінцева точка лінійного градієнта.
Повертає
Нова кисть лінійного градієнта.
CreateMatrix(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.
Повертає
Нова матриця афінної трансформації.
CreatePath(XpsPathGeometry)
Створює новий шлях.
public XpsPath CreatePath(XpsPathGeometry data)Параметри
data XpsPathGeometry
Геометрія шляху.
Повертає
Новий шлях.
CreatePathFigure(PointF, bool)
Створює нову фігуру шляху.
public XpsPathFigure CreatePathFigure(PointF startPoint, bool isClosed = false)Параметри
startPoint PointF
Початкова точка для першого сегмента фігури шляху.
isClosed bool
Вказує, чи шлях закритий. Якщо встановлено в true, обводка малюється “закритою”, тобто остання точка в останньому сегменті фігури шляху з’єднується з точкою, зазначеною в атрибуті StartPoint, інакше обводка малюється “відкритою”, і остання точка не з’єднується з початковою точкою. Застосовується лише якщо фігура шляху використовується в елементі Path, який вказує на обводку.
Повертає
Нова фігура шляху.
CreatePathFigure(PointF, List, bool)
Створює нову фігуру шляху.
public XpsPathFigure CreatePathFigure(PointF startPoint, List<xpspathsegment> segments, bool isClosed = false)Параметри
startPoint PointF
Початкова точка для першого сегмента фігури шляху.
segments List<XpsPathSegment>
Список сегментів шляху.
isClosed bool
Вказує, чи шлях закритий. Якщо встановлено в true, обводка малюється “закритою”, тобто остання точка в останньому сегменті фігури шляху з’єднується з точкою, зазначеною в атрибуті StartPoint, інакше обводка малюється “відкритою”, і остання точка не з’єднується з початковою точкою. Застосовується лише якщо фігура шляху використовується в елементі Path, який вказує на обводку.
Повертає
Нова фігура шляху.
CreatePathGeometry(string)
Створює нову геометрію шляху, вказану в скороченій формі.
public XpsPathGeometry CreatePathGeometry(string abbreviatedGeometry)Параметри
abbreviatedGeometry string
Скорочена форма геометрії шляху.
Повертає
Нова геометрія шляху.
CreatePathGeometry()
Створює нову геометрію шляху.
public XpsPathGeometry CreatePathGeometry()Повертає
Нова геометрія шляху.
CreatePathGeometry(List<xpspathfigure>)
Створює нову геометрію шляху зі зазначеного списку фігур шляху.
public XpsPathGeometry CreatePathGeometry(List<xpspathfigure> pathFigures)Параметри
pathFigures List<XpsPathFigure>
Список фігур шляху.
Повертає
Нова геометрія шляху.
CreatePolyBezierSegment(PointF[], bool)
Створює новий набір кубічних кривих Безьє.
public XpsPolyBezierSegment CreatePolyBezierSegment(PointF[] points, bool isStroked = true)Параметри
points PointF[]
Контрольні точки для кількох сегментів Безьє.
isStroked bool
Вказує, чи малюється обводка для цього сегмента шляху.
Повертає
Новий сегмент кубічних кривих Безьє.
CreatePolyLineSegment(PointF[], bool)
Створює новий полігональний малюнок, що містить довільну кількість окремих вершин.
public XpsPolyLineSegment CreatePolyLineSegment(PointF[] points, bool isStroked = true)Параметри
points PointF[]
Набір координат для кількох сегментів, які визначають сегмент полігональної лінії.
isStroked bool
Вказує, чи малюється обводка для цього сегмента шляху.
Повертає
Новий сегмент полігонального малюнка.
CreatePolyQuadraticBezierSegment(PointF[], bool)
Створює новий набір квадратичних кривих Безьє з попередньої точки у фігурі шляху через набір вершин, використовуючи вказані контрольні точки.
public XpsPolyQuadraticBezierSegment CreatePolyQuadraticBezierSegment(PointF[] points, bool isStroked = true)Параметри
points PointF[]
Контрольні точки для кількох квадратичних сегментів Безьє.
isStroked bool
Вказує, чи малюється обводка для цього сегмента шляху.
Повертає
Новий сегмент квадратичних кривих Безьє.
CreateRadialGradientBrush(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-вимірі еліпса, що визначає радіальний градієнт.
Повертає
Нова кисть радіального градієнта.
CreateRadialGradientBrush(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-вимірі еліпса, що визначає радіальний градієнт.
Повертає
Нова кисть радіального градієнта.
CreateSolidColorBrush(XpsColor)
Створює нову кисть одноколірного кольору.
public XpsSolidColorBrush CreateSolidColorBrush(XpsColor color)Параметри
color XpsColor
Колір для заповнених елементів.
Повертає
Нова кисть одноколірного кольору.
CreateSolidColorBrush(Color)
Створює нову кисть одноколірного кольору.
public XpsSolidColorBrush CreateSolidColorBrush(Color color)Параметри
color Color
Колір для заповнених елементів.
Повертає
Нова кисть одноколірного кольору.
CreateVisualBrush(XpsContentElement, RectangleF, RectangleF)
Створює нову візуальну кисть.
public XpsVisualBrush CreateVisualBrush(XpsContentElement element, RectangleF viewbox, RectangleF viewport)Параметри
element XpsContentElement
Елемент XPS (Canvas, Path або Glyphs) для візуальної властивості візуальної кисті.
viewbox RectangleF
Позиція та розміри вмісту джерела кисті.
viewport RectangleF
Область у координатному просторі, що містить основну плитку кисті, яка (можливо, неодноразово) застосовується для заповнення області, до якої застосовується кисть.
Повертає
Нова візуальна кисть.
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
Позиція, в якій новий канвас має бути вставлений.
Повертає
Вставлений канвас.
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
Рядок, який потрібно надрукувати.
Повертає
Вставлені гліфи.
InsertGlyphs(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
Рядок, який потрібно надрукувати.
Повертає
Вставлені гліфи.
InsertPath(int, XpsPathGeometry)
Вставляє новий шлях на сторінку у позицію index.
public XpsPath InsertPath(int index, XpsPathGeometry data)Параметри
index int
Позиція, в якій новий шлях має бути вставлений.
data XpsPathGeometry
Геометрія шляху.
Повертає
Вставлений шлях.
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
Позиція, на якій елемент має бути видалений.
Повертає
Видалений елемент.
