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; }Значение свойства
Утилиты
Получает объект, предоставляющий утилиты помимо формального XPS API манипуляции.
public DocumentUtils Utils { get; }Значение свойства
Ширина
Возвращает/устанавливает ширину страницы, выраженную как действительное число в единицах эффективного координатного пространства.
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
Позиция, в которой элемент должен быть удален.
Возвращает
Удаленный элемент.
