Class PageAPI
Namespace: Aspose.Page.XPS.Features.EventBasedModifications
Assembly: Aspose.Page.dll (25.1.2)
La API de modificación del elemento Page.
public class PageAPI : IModificationAPIHerencia
Implementa
Miembros heredados
object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Propiedades
Altura
Devuelve/establece la altura de la página, expresada como un número real en unidades del espacio de coordenadas efectivo.
public float Height { get; set; }Valor de la propiedad
PageCount
Devuelve el número de páginas en el documento activo.
public int PageCount { get; }Valor de la propiedad
TotalPageCount
Devuelve el número total de páginas en todos los documentos dentro del documento XPS.
public int TotalPageCount { get; }Valor de la propiedad
Utils
Obtiene el objeto que proporciona utilidades más allá de la API de manipulación XPS formal.
public DocumentUtils Utils { get; }Valor de la propiedad
Ancho
Devuelve/establece el ancho de la página, expresado como un número real en unidades del espacio de coordenadas efectivo.
public float Width { get; set; }Valor de la propiedad
Métodos
Add<t>(T)
Agrega un elemento de contenido (Canvas, Path o Glyphs).
public T Add<t>(T element) where T : XpsContentElementParámetros
element T
Elemento a agregar.
Devuelve
T
Elemento agregado.
Parámetros de tipo
T
El tipo del elemento.
AddCanvas()
Agrega un nuevo canvas a la página.
public XpsCanvas AddCanvas()Devuelve
Canvas agregado.
AddGlyphs(string, float, FontStyle, float, float, string)
Agrega nuevos glifos a la página.
public XpsGlyphs AddGlyphs(string fontFamily, float fontRenderingEmSize, FontStyle fontStyle, float originX, float originY, string unicodeString)Parámetros
fontFamily string
Familia de fuentes.
fontRenderingEmSize float
Tamaño de la fuente.
fontStyle FontStyle
Estilo de la fuente.
originX float
Coordenada X del origen de los glifos.
originY float
Coordenada Y del origen de los glifos.
unicodeString string
Cadena a imprimir.
Devuelve
Glifos agregados.
AddGlyphs(XpsFont, float, float, float, string)
Agrega nuevos glifos a la página.
public XpsGlyphs AddGlyphs(XpsFont font, float fontRenderingEmSize, float originX, float originY, string unicodeString)Parámetros
font XpsFont
Recurso de fuente.
fontRenderingEmSize float
Tamaño de la fuente.
originX float
Coordenada X del origen de los glifos.
originY float
Coordenada Y del origen de los glifos.
unicodeString string
Cadena a imprimir.
Devuelve
Glifos agregados.
AddOutlineEntry(string, int, int)
Agrega una entrada de esquema al documento.
public void AddOutlineEntry(string description, int outlineLevel, int targetPageNumber)Parámetros
description string
La descripción de la entrada.
outlineLevel int
El nivel del esquema.
targetPageNumber int
El número de página objetivo.
AddPath(XpsPathGeometry)
Agrega una nueva ruta a la página.
public XpsPath AddPath(XpsPathGeometry data)Parámetros
data XpsPathGeometry
La geometría de la ruta.
Devuelve
Ruta agregada.
CreateArcSegment(PointF, SizeF, float, bool, XpsSweepDirection, bool)
Crea un nuevo segmento de arco elíptico.
public XpsArcSegment CreateArcSegment(PointF point, SizeF size, float rotationAngle, bool isLargeArc, XpsSweepDirection sweepDirection, bool isStroked = true)Parámetros
point PointF
El punto final del arco elíptico.
size SizeF
El radio x e y del arco elíptico como un par x,y.
rotationAngle float
Indica cómo se rota la elipse en relación con el sistema de coordenadas actual.
isLargeArc bool
Determina si el arco se dibuja con un barrido de 180 o más.
sweepDirection XpsSweepDirection
La dirección en la que se dibuja el arco.
isStroked bool
Especifica si se dibuja el trazo para este segmento de la ruta.
Devuelve
Nuevo segmento de arco elíptico.
CreateCanvas()
Crea un nuevo canvas.
public XpsCanvas CreateCanvas()Devuelve
Nuevo canvas.
CreateColor(Color)
Crea un nuevo color.
public XpsColor CreateColor(Color color)Parámetros
color Color
Una instancia de color nativo para color RGB.
Devuelve
Nuevo color.
CreateColor(int, int, int, int)
Crea un nuevo color en el espacio de color sRGB.
public XpsColor CreateColor(int a, int r, int g, int b)Parámetros
a int
El componente de color alfa.
r int
El componente de color rojo.
g int
El componente de color verde.
b int
El componente de color azul.
Devuelve
Nuevo color.
CreateColor(int, int, int)
Crea un nuevo color en el espacio de color sRGB.
public XpsColor CreateColor(int r, int g, int b)Parámetros
r int
El componente de color rojo.
g int
El componente de color verde.
b int
El componente de color azul.
Devuelve
Nuevo color.
CreateColor(float, float, float, float)
Crea un nuevo color en el espacio de color scRGB.
public XpsColor CreateColor(float a, float r, float g, float b)Parámetros
a float
El componente de color alfa.
r float
El componente de color rojo.
g float
El componente de color verde.
b float
El componente de color azul.
Devuelve
Nuevo color.
CreateColor(float, float, float)
Crea un nuevo color en el espacio de color scRGB.
public XpsColor CreateColor(float r, float g, float b)Parámetros
r float
El componente de color rojo.
g float
El componente de color verde.
b float
El componente de color azul.
Devuelve
Nuevo color.
CreateColor(string, params float[])
Crea un nuevo color en el espacio de color basado en ICC.
public XpsColor CreateColor(string path, params float[] components)Parámetros
path string
La ruta al perfil ICC.
components float[]
Componentes de color.
Devuelve
Nuevo color.
CreateColor(XpsIccProfile, params float[])
Crea un nuevo color en el espacio de color basado en ICC.
public XpsColor CreateColor(XpsIccProfile iccProfile, params float[] components)Parámetros
iccProfile XpsIccProfile
El recurso del perfil ICC.
components float[]
Componentes de color.
Devuelve
Nuevo color.
CreateGlyphs(string, float, FontStyle, float, float, string)
Crea nuevos glifos.
public XpsGlyphs CreateGlyphs(string fontFamily, float fontRenderingEmSize, FontStyle fontStyle, float originX, float originY, string unicodeString)Parámetros
fontFamily string
Familia de fuentes.
fontRenderingEmSize float
Tamaño de la fuente.
fontStyle FontStyle
Estilo de la fuente.
originX float
Coordenada X del origen de los glifos.
originY float
Coordenada Y del origen de los glifos.
unicodeString string
Cadena a imprimir.
Devuelve
Nuevos glifos.
CreateGlyphs(XpsFont, float, float, float, string)
Crea nuevos glifos.
public XpsGlyphs CreateGlyphs(XpsFont font, float fontRenderingEmSize, float originX, float originY, string unicodeString)Parámetros
font XpsFont
Recurso de fuente.
fontRenderingEmSize float
Tamaño de la fuente.
originX float
Coordenada X del origen de los glifos.
originY float
Coordenada Y del origen de los glifos.
unicodeString string
Cadena a imprimir.
Devuelve
Nuevos glifos.
CreateGradientStop(XpsColor, float)
Crea un nuevo punto de parada de gradiente.
public XpsGradientStop CreateGradientStop(XpsColor color, float offset)Parámetros
color XpsColor
El color del punto de parada de gradiente.
offset float
El desplazamiento del gradiente.
Devuelve
Nuevo punto de parada de gradiente.
CreateGradientStop(Color, float)
Crea un nuevo punto de parada de gradiente.
public XpsGradientStop CreateGradientStop(Color color, float offset)Parámetros
color Color
El color del punto de parada de gradiente.
offset float
El desplazamiento del gradiente.
Devuelve
Nuevo punto de parada de gradiente.
CreateImageBrush(XpsImage, RectangleF, RectangleF)
Crea un nuevo pincel de imagen.
public XpsImageBrush CreateImageBrush(XpsImage image, RectangleF viewbox, RectangleF viewport)Parámetros
image XpsImage
Un recurso de imagen.
viewbox RectangleF
La posición y dimensiones del contenido fuente del pincel.
viewport RectangleF
La región en el espacio de coordenadas que se aplica (posiblemente repetidamente) para llenar la región a la que se aplica el pincel.
Devuelve
Nuevo pincel de imagen.
CreateImageBrush(string, RectangleF, RectangleF)
Crea un nuevo pincel de imagen.
public XpsImageBrush CreateImageBrush(string imagePath, RectangleF viewbox, RectangleF viewport)Parámetros
imagePath string
La ruta a la imagen que se tomará como azulejo del pincel.
viewbox RectangleF
La posición y dimensiones del contenido fuente del pincel.
viewport RectangleF
La región en el espacio de coordenadas que se aplica (posiblemente repetidamente) para llenar la región a la que se aplica el pincel.
Devuelve
Nuevo pincel de imagen.
CreateLinearGradientBrush(List<xpsgradientstop>, PointF, PointF)
Crea un nuevo pincel de gradiente lineal.
public XpsLinearGradientBrush CreateLinearGradientBrush(List<xpsgradientstop> gradientStops, PointF startPoint, PointF endPoint)Parámetros
gradientStops List<XpsGradientStop>
La lista de puntos de parada de gradiente.
startPoint PointF
El punto de inicio del gradiente lineal.
endPoint PointF
El punto final del gradiente lineal.
Devuelve
Nuevo pincel de gradiente lineal.
CreateLinearGradientBrush(PointF, PointF)
Crea un nuevo pincel de gradiente lineal.
public XpsLinearGradientBrush CreateLinearGradientBrush(PointF startPoint, PointF endPoint)Parámetros
startPoint PointF
El punto de inicio del gradiente lineal.
endPoint PointF
El punto final del gradiente lineal.
Devuelve
Nuevo pincel de gradiente lineal.
CreateMatrix(float, float, float, float, float, float)
Crea una nueva matriz de transformación afín.
public XpsMatrix CreateMatrix(float m11, float m12, float m21, float m22, float m31, float m32)Parámetros
m11 float
Elemento 11.
m12 float
Elemento 12.
m21 float
Elemento 21.
m22 float
Elemento 22.
m31 float
Elemento 31.
m32 float
Elemento 32.
Devuelve
Nueva matriz de transformación afín.
CreatePath(XpsPathGeometry)
Crea una nueva ruta.
public XpsPath CreatePath(XpsPathGeometry data)Parámetros
data XpsPathGeometry
La geometría de la ruta.
Devuelve
Nueva ruta.
CreatePathFigure(PointF, bool)
Crea una nueva figura de ruta.
public XpsPathFigure CreatePathFigure(PointF startPoint, bool isClosed = false)Parámetros
startPoint PointF
El punto de inicio para el primer segmento de la figura de ruta.
isClosed bool
Especifica si la ruta está cerrada. Si se establece en verdadero, el trazo se dibuja “cerrado”, es decir, el último punto en el último segmento de la figura de ruta se conecta con el punto especificado en el atributo StartPoint, de lo contrario, el trazo se dibuja “abierto”, y el último punto no se conecta con el punto de inicio. Solo aplicable si la figura de ruta se utiliza en un elemento de ruta que especifica un trazo.
Devuelve
Nueva figura de ruta.
CreatePathFigure(PointF, List, bool)
Crea una nueva figura de ruta.
public XpsPathFigure CreatePathFigure(PointF startPoint, List<xpspathsegment> segments, bool isClosed = false)Parámetros
startPoint PointF
El punto de inicio para el primer segmento de la figura de ruta.
segments List<XpsPathSegment>
Lista de segmentos de ruta.
isClosed bool
Especifica si la ruta está cerrada. Si se establece en verdadero, el trazo se dibuja “cerrado”, es decir, el último punto en el último segmento de la figura de ruta se conecta con el punto especificado en el atributo StartPoint, de lo contrario, el trazo se dibuja “abierto”, y el último punto no se conecta con el punto de inicio. Solo aplicable si la figura de ruta se utiliza en un elemento de ruta que especifica un trazo.
Devuelve
Nueva figura de ruta.
CreatePathGeometry(string)
Crea una nueva geometría de ruta especificada con forma abreviada.
public XpsPathGeometry CreatePathGeometry(string abbreviatedGeometry)Parámetros
abbreviatedGeometry string
Forma abreviada de la geometría de la ruta.
Devuelve
Nueva geometría de ruta.
CreatePathGeometry()
Crea una nueva geometría de ruta.
public XpsPathGeometry CreatePathGeometry()Devuelve
Nueva geometría de ruta.
CreatePathGeometry(List<xpspathfigure>)
Crea una nueva geometría de ruta con una lista especificada de figuras de ruta.
public XpsPathGeometry CreatePathGeometry(List<xpspathfigure> pathFigures)Parámetros
pathFigures List<XpsPathFigure>
Lista de figuras de ruta.
Devuelve
Nueva geometría de ruta.
CreatePolyBezierSegment(PointF[], bool)
Crea un nuevo conjunto de curvas Bézier cúbicas.
public XpsPolyBezierSegment CreatePolyBezierSegment(PointF[] points, bool isStroked = true)Parámetros
points PointF[]
Puntos de control para múltiples segmentos de Bézier.
isStroked bool
Especifica si se dibuja el trazo para este segmento de la ruta.
Devuelve
Nuevo segmento de curvas Bézier cúbicas.
CreatePolyLineSegment(PointF[], bool)
Crea un nuevo dibujo poligonal que contiene un número arbitrario de vértices individuales.
public XpsPolyLineSegment CreatePolyLineSegment(PointF[] points, bool isStroked = true)Parámetros
points PointF[]
Un conjunto de coordenadas para los múltiples segmentos que definen el segmento de línea poligonal.
isStroked bool
Especifica si se dibuja el trazo para este segmento de la ruta.
Devuelve
Nuevo segmento de dibujo poligonal.
CreatePolyQuadraticBezierSegment(PointF[], bool)
Crea un nuevo conjunto de curvas Bézier cuadráticas desde el punto anterior en la figura de ruta a través de un conjunto de vértices, utilizando puntos de control especificados.
public XpsPolyQuadraticBezierSegment CreatePolyQuadraticBezierSegment(PointF[] points, bool isStroked = true)Parámetros
points PointF[]
Puntos de control para múltiples segmentos de Bézier cuadráticas.
isStroked bool
Especifica si se dibuja el trazo para este segmento de la ruta.
Devuelve
Nuevo segmento de curvas Bézier cuadráticas.
CreateRadialGradientBrush(List<xpsgradientstop>, PointF, PointF, float, float)
Crea un nuevo pincel de gradiente radial.
public XpsRadialGradientBrush CreateRadialGradientBrush(List<xpsgradientstop> gradientStops, PointF center, PointF gradientOrigin, float radiusX, float radiusY)Parámetros
gradientStops List<XpsGradientStop>
La lista de puntos de parada de gradiente.
center PointF
El punto central del gradiente radial (es decir, el centro de la elipse).
gradientOrigin PointF
El punto de origen del gradiente radial.
radiusX float
El radio en la dimensión x de la elipse que define el gradiente radial.
radiusY float
El radio en la dimensión y de la elipse que define el gradiente radial.
Devuelve
Nuevo pincel de gradiente radial.
CreateRadialGradientBrush(PointF, PointF, float, float)
Crea un nuevo pincel de gradiente radial.
public XpsRadialGradientBrush CreateRadialGradientBrush(PointF center, PointF gradientOrigin, float radiusX, float radiusY)Parámetros
center PointF
El punto central del gradiente radial (es decir, el centro de la elipse).
gradientOrigin PointF
El punto de origen del gradiente radial.
radiusX float
El radio en la dimensión x de la elipse que define el gradiente radial.
radiusY float
El radio en la dimensión y de la elipse que define el gradiente radial.
Devuelve
Nuevo pincel de gradiente radial.
CreateSolidColorBrush(XpsColor)
Crea un nuevo pincel de color sólido.
public XpsSolidColorBrush CreateSolidColorBrush(XpsColor color)Parámetros
color XpsColor
El color para elementos rellenos.
Devuelve
Nuevo pincel de color sólido.
CreateSolidColorBrush(Color)
Crea un nuevo pincel de color sólido.
public XpsSolidColorBrush CreateSolidColorBrush(Color color)Parámetros
color Color
El color para elementos rellenos.
Devuelve
Nuevo pincel de color sólido.
CreateVisualBrush(XpsContentElement, RectangleF, RectangleF)
Crea un nuevo pincel visual.
public XpsVisualBrush CreateVisualBrush(XpsContentElement element, RectangleF viewbox, RectangleF viewport)Parámetros
element XpsContentElement
El elemento XPS (Canvas, Path o Glyphs) para la propiedad Visual del pincel visual.
viewbox RectangleF
La posición y dimensiones del contenido fuente del pincel.
viewport RectangleF
La región en el espacio de coordenadas que se aplica (posiblemente repetidamente) para llenar la región a la que se aplica el pincel.
Devuelve
Nuevo pincel visual.
Insert<t>(int, T)
Inserta un elemento (Canvas, Path o Glyphs) en la página en la posición index.
public T Insert<t>(int index, T element) where T : XpsContentElementParámetros
index int
Posición en la que se debe insertar un element.
element T
Elemento a insertar.
Devuelve
T
Elemento insertado.
Parámetros de tipo
T
El tipo del elemento.
InsertCanvas(int)
Inserta un nuevo canvas en la página en la posición index.
public XpsCanvas InsertCanvas(int index)Parámetros
index int
Posición en la que se debe insertar un nuevo canvas.
Devuelve
Canvas insertado.
InsertGlyphs(int, string, float, FontStyle, float, float, string)
Inserta nuevos glifos en la página en la posición index.
public XpsGlyphs InsertGlyphs(int index, string fontFamily, float fontSize, FontStyle fontStyle, float originX, float originY, string unicodeString)Parámetros
index int
Posición en la que se deben insertar nuevos glifos.
fontFamily string
Familia de fuentes.
fontSize float
Tamaño de la fuente.
fontStyle FontStyle
Estilo de la fuente.
originX float
Coordenada X del origen de los glifos.
originY float
Coordenada Y del origen de los glifos.
unicodeString string
Cadena a imprimir.
Devuelve
Glifos insertados.
InsertGlyphs(int, XpsFont, float, float, float, string)
Inserta nuevos glifos en la página en la posición index.
public XpsGlyphs InsertGlyphs(int index, XpsFont font, float fontSize, float originX, float originY, string unicodeString)Parámetros
index int
Posición en la que se deben insertar nuevos glifos.
font XpsFont
Recurso de fuente.
fontSize float
Tamaño de la fuente.
originX float
Coordenada X del origen de los glifos.
originY float
Coordenada Y del origen de los glifos.
unicodeString string
Cadena a imprimir.
Devuelve
Glifos insertados.
InsertPath(int, XpsPathGeometry)
Inserta una nueva ruta en la página en la posición index.
public XpsPath InsertPath(int index, XpsPathGeometry data)Parámetros
index int
Posición en la que se debe insertar una nueva ruta.
data XpsPathGeometry
La geometría de la ruta.
Devuelve
Ruta insertada.
Remove<t>(T)
Elimina un elemento de la página.
public T Remove<t>(T element) where T : XpsContentElementParámetros
element T
Elemento a eliminar.
Devuelve
T
Elemento eliminado.
Parámetros de tipo
T
El tipo del elemento.
RemoveAt(int)
Elimina un elemento en la posición index de la página.
public XpsContentElement RemoveAt(int index)Parámetros
index int
Posición en la que se debe eliminar el elemento.
Devuelve
Elemento eliminado.
