Class PageAPI
Namespace: Aspose.Page.XPS.Features.EventBasedModifications
Assembly: Aspose.Page.dll (25.1.2)
A API de modificação do elemento Page.
public class PageAPI : IModificationAPIHerança
Implementa
Membros Herdados
object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Propriedades
Altura
Retorna/configura a altura da página, expressa como um número real em unidades do espaço de coordenadas efetivo.
public float Height { get; set; }Valor da Propriedade
ContagemDePáginas
Retorna o número de páginas no documento ativo.
public int PageCount { get; }Valor da Propriedade
ContagemTotalDePáginas
Retorna o número total de páginas em todos os documentos dentro do documento XPS.
public int TotalPageCount { get; }Valor da Propriedade
Utilitários
Obtém o objeto que fornece utilidades além da API de manipulação XPS formal.
public DocumentUtils Utils { get; }Valor da Propriedade
Largura
Retorna/configura a largura da página, expressa como um número real em unidades do espaço de coordenadas efetivo.
public float Width { get; set; }Valor da Propriedade
Métodos
Adicionar<t>(T)
Adiciona um elemento de conteúdo (Canvas, Path ou Glyphs).
public T Add<t>(T element) where T : XpsContentElementParâmetros
element T
Elemento a ser adicionado.
Retorna
T
Elemento adicionado.
Parâmetros de Tipo
T
O tipo do elemento.
AdicionarCanvas()
Adiciona um novo canvas à página.
public XpsCanvas AddCanvas()Retorna
Canvas adicionado.
AdicionarGlyphs(string, float, FontStyle, float, float, string)
Adiciona novos glifos à página.
public XpsGlyphs AddGlyphs(string fontFamily, float fontRenderingEmSize, FontStyle fontStyle, float originX, float originY, string unicodeString)Parâmetros
fontFamily string
Família de fontes.
fontRenderingEmSize float
Tamanho da fonte.
fontStyle FontStyle
Estilo da fonte.
originX float
Coordenada X de origem dos glifos.
originY float
Coordenada Y de origem dos glifos.
unicodeString string
String a ser impressa.
Retorna
Glifos adicionados.
AdicionarGlyphs(XpsFont, float, float, float, string)
Adiciona novos glifos à página.
public XpsGlyphs AddGlyphs(XpsFont font, float fontRenderingEmSize, float originX, float originY, string unicodeString)Parâmetros
font XpsFont
Recurso de fonte.
fontRenderingEmSize float
Tamanho da fonte.
originX float
Coordenada X de origem dos glifos.
originY float
Coordenada Y de origem dos glifos.
unicodeString string
String a ser impressa.
Retorna
Glifos adicionados.
AdicionarEntradaDeEsboço(string, int, int)
Adiciona uma entrada de esboço ao documento.
public void AddOutlineEntry(string description, int outlineLevel, int targetPageNumber)Parâmetros
description string
A descrição da entrada.
outlineLevel int
O nível do esboço.
targetPageNumber int
O número da página de destino.
AdicionarCaminho(XpsPathGeometry)
Adiciona um novo caminho à página.
public XpsPath AddPath(XpsPathGeometry data)Parâmetros
data XpsPathGeometry
A geometria do caminho.
Retorna
Caminho adicionado.
CriarSegmentoArco(PointF, SizeF, float, bool, XpsSweepDirection, bool)
Cria um novo 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
O ponto final do arco elíptico.
size SizeF
O raio x e y do arco elíptico como um par x,y.
rotationAngle float
Indica como a elipse é rotacionada em relação ao sistema de coordenadas atual.
isLargeArc bool
Determina se o arco é desenhado com uma varredura de 180 ou mais.
sweepDirection XpsSweepDirection
A direção em que o arco é desenhado.
isStroked bool
Especifica se o traço para este segmento do caminho é desenhado.
Retorna
Novo segmento de arco elíptico.
CriarCanvas()
Cria um novo canvas.
public XpsCanvas CreateCanvas()Retorna
Novo canvas.
CriarCor(Color)
Cria uma nova cor.
public XpsColor CreateColor(Color color)Parâmetros
color Color
Uma instância de cor nativa para cor RGB.
Retorna
Nova cor.
CriarCor(int, int, int, int)
Cria uma nova cor no espaço de cor sRGB.
public XpsColor CreateColor(int a, int r, int g, int b)Parâmetros
a int
O componente de cor alfa.
r int
O componente de cor vermelha.
g int
O componente de cor verde.
b int
O componente de cor azul.
Retorna
Nova cor.
CriarCor(int, int, int)
Cria uma nova cor no espaço de cor sRGB.
public XpsColor CreateColor(int r, int g, int b)Parâmetros
r int
O componente de cor vermelha.
g int
O componente de cor verde.
b int
O componente de cor azul.
Retorna
Nova cor.
CriarCor(float, float, float, float)
Cria uma nova cor no espaço de cor scRGB.
public XpsColor CreateColor(float a, float r, float g, float b)Parâmetros
a float
O componente de cor alfa.
r float
O componente de cor vermelha.
g float
O componente de cor verde.
b float
O componente de cor azul.
Retorna
Nova cor.
CriarCor(float, float, float)
Cria uma nova cor no espaço de cor scRGB.
public XpsColor CreateColor(float r, float g, float b)Parâmetros
r float
O componente de cor vermelha.
g float
O componente de cor verde.
b float
O componente de cor azul.
Retorna
Nova cor.
CriarCor(string, params float[])
Cria uma nova cor no espaço de cor baseado em ICC.
public XpsColor CreateColor(string path, params float[] components)Parâmetros
path string
O caminho para o perfil ICC.
components float[]
Componentes de cor.
Retorna
Nova cor.
CriarCor(XpsIccProfile, params float[])
Cria uma nova cor no espaço de cor baseado em ICC.
public XpsColor CreateColor(XpsIccProfile iccProfile, params float[] components)Parâmetros
iccProfile XpsIccProfile
O recurso do perfil ICC.
components float[]
Componentes de cor.
Retorna
Nova cor.
CriarGlyphs(string, float, FontStyle, float, float, string)
Cria novos glifos.
public XpsGlyphs CreateGlyphs(string fontFamily, float fontRenderingEmSize, FontStyle fontStyle, float originX, float originY, string unicodeString)Parâmetros
fontFamily string
Família de fontes.
fontRenderingEmSize float
Tamanho da fonte.
fontStyle FontStyle
Estilo da fonte.
originX float
Coordenada X de origem dos glifos.
originY float
Coordenada Y de origem dos glifos.
unicodeString string
String a ser impressa.
Retorna
Novos glifos.
CriarGlyphs(XpsFont, float, float, float, string)
Cria novos glifos.
public XpsGlyphs CreateGlyphs(XpsFont font, float fontRenderingEmSize, float originX, float originY, string unicodeString)Parâmetros
font XpsFont
Recurso de fonte.
fontRenderingEmSize float
Tamanho da fonte.
originX float
Coordenada X de origem dos glifos.
originY float
Coordenada Y de origem dos glifos.
unicodeString string
String a ser impressa.
Retorna
Novos glifos.
CriarParadaDeGradiente(XpsColor, float)
Cria uma nova parada de gradiente.
public XpsGradientStop CreateGradientStop(XpsColor color, float offset)Parâmetros
color XpsColor
A cor da parada de gradiente.
offset float
O deslocamento do gradiente.
Retorna
Nova parada de gradiente.
CriarParadaDeGradiente(Color, float)
Cria uma nova parada de gradiente.
public XpsGradientStop CreateGradientStop(Color color, float offset)Parâmetros
color Color
A cor da parada de gradiente.
offset float
O deslocamento do gradiente.
Retorna
Nova parada de gradiente.
CriarPincelDeImagem(XpsImage, RectangleF, RectangleF)
Cria um novo pincel de imagem.
public XpsImageBrush CreateImageBrush(XpsImage image, RectangleF viewbox, RectangleF viewport)Parâmetros
image XpsImage
Um recurso de imagem.
viewbox RectangleF
A posição e dimensões do conteúdo de origem do pincel.
viewport RectangleF
A região no espaço de coordenadas que é aplicada (possivelmente repetidamente) para preencher a região à qual o pincel é aplicado.
Retorna
Novo pincel de imagem.
CriarPincelDeImagem(string, RectangleF, RectangleF)
Cria um novo pincel de imagem.
public XpsImageBrush CreateImageBrush(string imagePath, RectangleF viewbox, RectangleF viewport)Parâmetros
imagePath string
O caminho para a imagem a ser utilizada como tile do pincel.
viewbox RectangleF
A posição e dimensões do conteúdo de origem do pincel.
viewport RectangleF
A região no espaço de coordenadas que é aplicada (possivelmente repetidamente) para preencher a região à qual o pincel é aplicado.
Retorna
Novo pincel de imagem.
CriarPincelDeGradienteLinear(List<xpsgradientstop>, PointF, PointF)
Cria um novo pincel de gradiente linear.
public XpsLinearGradientBrush CreateLinearGradientBrush(List<xpsgradientstop> gradientStops, PointF startPoint, PointF endPoint)Parâmetros
gradientStops List<XpsGradientStop>
A lista de paradas de gradiente.
startPoint PointF
O ponto inicial do gradiente linear.
endPoint PointF
O ponto final do gradiente linear.
Retorna
Novo pincel de gradiente linear.
CriarPincelDeGradienteLinear(PointF, PointF)
Cria um novo pincel de gradiente linear.
public XpsLinearGradientBrush CreateLinearGradientBrush(PointF startPoint, PointF endPoint)Parâmetros
startPoint PointF
O ponto inicial do gradiente linear.
endPoint PointF
O ponto final do gradiente linear.
Retorna
Novo pincel de gradiente linear.
CriarMatriz(float, float, float, float, float, float)
Cria uma nova matriz de transformação afim.
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.
Retorna
Nova matriz de transformação afim.
CriarCaminho(XpsPathGeometry)
Cria um novo caminho.
public XpsPath CreatePath(XpsPathGeometry data)Parâmetros
data XpsPathGeometry
A geometria do caminho.
Retorna
Novo caminho.
CriarFiguraDeCaminho(PointF, bool)
Cria uma nova figura de caminho.
public XpsPathFigure CreatePathFigure(PointF startPoint, bool isClosed = false)Parâmetros
startPoint PointF
O ponto inicial para o primeiro segmento da figura de caminho.
isClosed bool
Especifica se o caminho está fechado. Se definido como verdadeiro, o traço é desenhado “fechado”, ou seja, o último ponto no último segmento da figura de caminho é conectado ao ponto especificado no atributo StartPoint, caso contrário, o traço é desenhado “aberto”, e o último ponto não é conectado ao ponto inicial. Apenas aplicável se a figura de caminho for utilizada em um elemento Path que especifica um traço.
Retorna
Nova figura de caminho.
CriarFiguraDeCaminho(PointF, List, bool)
Cria uma nova figura de caminho.
public XpsPathFigure CreatePathFigure(PointF startPoint, List<xpspathsegment> segments, bool isClosed = false)Parâmetros
startPoint PointF
O ponto inicial para o primeiro segmento da figura de caminho.
segments List<XpsPathSegment>
Lista de segmentos de caminho.
isClosed bool
Especifica se o caminho está fechado. Se definido como verdadeiro, o traço é desenhado “fechado”, ou seja, o último ponto no último segmento da figura de caminho é conectado ao ponto especificado no atributo StartPoint, caso contrário, o traço é desenhado “aberto”, e o último ponto não é conectado ao ponto inicial. Apenas aplicável se a figura de caminho for utilizada em um elemento Path que especifica um traço.
Retorna
Nova figura de caminho.
CriarGeometriaDeCaminho(string)
Cria uma nova geometria de caminho especificada com forma abreviada.
public XpsPathGeometry CreatePathGeometry(string abbreviatedGeometry)Parâmetros
abbreviatedGeometry string
Forma abreviada da geometria do caminho.
Retorna
Nova geometria de caminho.
CriarGeometriaDeCaminho()
Cria uma nova geometria de caminho.
public XpsPathGeometry CreatePathGeometry()Retorna
Nova geometria de caminho.
CriarGeometriaDeCaminho(List)
Cria uma nova geometria de caminho com lista especificada de figuras de caminho.
public XpsPathGeometry CreatePathGeometry(List<xpspathfigure> pathFigures)Parâmetros
pathFigures List<XpsPathFigure>
Lista de figuras de caminho.
Retorna
Nova geometria de caminho.
CriarSegmentoPolyBezier(PointF[], bool)
Cria um novo conjunto de curvas Bézier cúbicas.
public XpsPolyBezierSegment CreatePolyBezierSegment(PointF[] points, bool isStroked = true)Parâmetros
points PointF[]
Pontos de controle para múltiplos segmentos Bézier.
isStroked bool
Especifica se o traço para este segmento do caminho é desenhado.
Retorna
Novo segmento de curvas Bézier cúbicas.
CriarSegmentoPolyLine(PointF[], bool)
Cria um novo desenho poligonal contendo um número arbitrário de vértices individuais.
public XpsPolyLineSegment CreatePolyLineSegment(PointF[] points, bool isStroked = true)Parâmetros
points PointF[]
Um conjunto de coordenadas para os múltiplos segmentos que definem o segmento de linha poligonal.
isStroked bool
Especifica se o traço para este segmento do caminho é desenhado.
Retorna
Novo segmento de desenho poligonal.
CriarSegmentoPolyQuadraticBezier(PointF[], bool)
Cria um novo conjunto de curvas Bézier quadráticas a partir do ponto anterior na figura do caminho através de um conjunto de vértices, usando pontos de controle especificados.
public XpsPolyQuadraticBezierSegment CreatePolyQuadraticBezierSegment(PointF[] points, bool isStroked = true)Parâmetros
points PointF[]
Pontos de controle para múltiplos segmentos Bézier quadráticos.
isStroked bool
Especifica se o traço para este segmento do caminho é desenhado.
Retorna
Novo segmento de curvas Bézier quadráticas.
CriarPincelDeGradienteRadial(List<xpsgradientstop>, PointF, PointF, float, float)
Cria um novo pincel de gradiente radial.
public XpsRadialGradientBrush CreateRadialGradientBrush(List<xpsgradientstop> gradientStops, PointF center, PointF gradientOrigin, float radiusX, float radiusY)Parâmetros
gradientStops List<XpsGradientStop>
A lista de paradas de gradiente.
center PointF
O ponto central do gradiente radial (ou seja, o centro da elipse).
gradientOrigin PointF
O ponto de origem do gradiente radial.
radiusX float
O raio na dimensão x da elipse que define o gradiente radial.
radiusY float
O raio na dimensão y da elipse que define o gradiente radial.
Retorna
Novo pincel de gradiente radial.
CriarPincelDeGradienteRadial(PointF, PointF, float, float)
Cria um novo pincel de gradiente radial.
public XpsRadialGradientBrush CreateRadialGradientBrush(PointF center, PointF gradientOrigin, float radiusX, float radiusY)Parâmetros
center PointF
O ponto central do gradiente radial (ou seja, o centro da elipse).
gradientOrigin PointF
O ponto de origem do gradiente radial.
radiusX float
O raio na dimensão x da elipse que define o gradiente radial.
radiusY float
O raio na dimensão y da elipse que define o gradiente radial.
Retorna
Novo pincel de gradiente radial.
CriarPincelDeCorSólida(XpsColor)
Cria um novo pincel de cor sólida.
public XpsSolidColorBrush CreateSolidColorBrush(XpsColor color)Parâmetros
color XpsColor
A cor para elementos preenchidos.
Retorna
Novo pincel de cor sólida.
CriarPincelDeCorSólida(Color)
Cria um novo pincel de cor sólida.
public XpsSolidColorBrush CreateSolidColorBrush(Color color)Parâmetros
color Color
A cor para elementos preenchidos.
Retorna
Novo pincel de cor sólida.
CriarPincelVisual(XpsContentElement, RectangleF, RectangleF)
Cria um novo pincel visual.
public XpsVisualBrush CreateVisualBrush(XpsContentElement element, RectangleF viewbox, RectangleF viewport)Parâmetros
element XpsContentElement
O elemento XPS (Canvas, Path ou Glyphs) para a propriedade Visual do pincel visual.
viewbox RectangleF
A posição e dimensões do conteúdo de origem do pincel.
viewport RectangleF
A região no espaço de coordenadas que é aplicada (possivelmente repetidamente) para preencher a região à qual o pincel é aplicado.
Retorna
Novo pincel visual.
Inserir<t>(int, T)
Insere um elemento (Canvas, Path ou Glyphs) na página na posição index.
public T Insert<t>(int index, T element) where T : XpsContentElementParâmetros
index int
Posição na qual um element deve ser inserido.
element T
Elemento a ser inserido.
Retorna
T
Elemento inserido.
Parâmetros de Tipo
T
O tipo do elemento.
InserirCanvas(int)
Insere um novo canvas na página na posição index.
public XpsCanvas InsertCanvas(int index)Parâmetros
index int
Posição na qual um novo canvas deve ser inserido.
Retorna
Canvas inserido.
InserirGlyphs(int, string, float, FontStyle, float, float, string)
Insere novos glifos na página na posição index.
public XpsGlyphs InsertGlyphs(int index, string fontFamily, float fontSize, FontStyle fontStyle, float originX, float originY, string unicodeString)Parâmetros
index int
Posição na qual novos glifos devem ser inseridos.
fontFamily string
Família de fontes.
fontSize float
Tamanho da fonte.
fontStyle FontStyle
Estilo da fonte.
originX float
Coordenada X de origem dos glifos.
originY float
Coordenada Y de origem dos glifos.
unicodeString string
String a ser impressa.
Retorna
Glifos inseridos.
InserirGlyphs(int, XpsFont, float, float, float, string)
Insere novos glifos na página na posição index.
public XpsGlyphs InsertGlyphs(int index, XpsFont font, float fontSize, float originX, float originY, string unicodeString)Parâmetros
index int
Posição na qual novos glifos devem ser inseridos.
font XpsFont
Recurso de fonte.
fontSize float
Tamanho da fonte.
originX float
Coordenada X de origem dos glifos.
originY float
Coordenada Y de origem dos glifos.
unicodeString string
String a ser impressa.
Retorna
Glifos inseridos.
InserirCaminho(int, XpsPathGeometry)
Insere um novo caminho na página na posição index.
public XpsPath InsertPath(int index, XpsPathGeometry data)Parâmetros
index int
Posição na qual um novo caminho deve ser inserido.
data XpsPathGeometry
A geometria do caminho.
Retorna
Caminho inserido.
Remover<t>(T)
Remove um elemento da página.
public T Remove<t>(T element) where T : XpsContentElementParâmetros
element T
Elemento a ser removido.
Retorna
T
Elemento removido.
Parâmetros de Tipo
T
O tipo do elemento.
RemoverNa(int)
Remove um elemento na posição index da página.
public XpsContentElement RemoveAt(int index)Parâmetros
index int
Posição na qual o elemento deve ser removido.
Retorna
Elemento removido.
