Class PageAPI
Namespace: Aspose.Page.XPS.Features.EventBasedModifications
Assembly: Aspose.Page.dll (25.1.2)
L’API de modification de l’élément Page.
public class PageAPI : IModificationAPIHéritage
Implémente
Membres hérités
object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Propriétés
Hauteur
Renvoie/ définit la hauteur de la page, exprimée comme un nombre réel dans les unités de l’espace de coordonnées effectif.
public float Height { get; set; }Valeur de propriété
CompteDePages
Renvoie le nombre de pages dans le document actif.
public int PageCount { get; }Valeur de propriété
CompteTotalDesPages
Renvoie le nombre total de pages dans tous les documents à l’intérieur du document XPS.
public int TotalPageCount { get; }Valeur de propriété
Utilitaires
Obtient l’objet qui fournit des utilitaires au-delà de l’API de manipulation XPS formelle.
public DocumentUtils Utils { get; }Valeur de propriété
Largeur
Renvoie/ définit la largeur de la page, exprimée comme un nombre réel dans les unités de l’espace de coordonnées effectif.
public float Width { get; set; }Valeur de propriété
Méthodes
Ajouter<t>(T)
Ajoute un élément de contenu (Canvas, Path ou Glyphs).
public T Add<t>(T element) where T : XpsContentElementParamètres
element T
Élément à ajouter.
Renvoie
T
Élément ajouté.
Paramètres de type
T
Le type de l’élément.
AjouterCanvas()
Ajoute un nouveau canevas à la page.
public XpsCanvas AddCanvas()Renvoie
Canevas ajouté.
AjouterGlyphes(string, float, FontStyle, float, float, string)
Ajoute de nouveaux glyphes à la page.
public XpsGlyphs AddGlyphs(string fontFamily, float fontRenderingEmSize, FontStyle fontStyle, float originX, float originY, string unicodeString)Paramètres
fontFamily string
Famille de police.
fontRenderingEmSize float
Taille de police.
fontStyle FontStyle
Style de police.
originX float
Coordonnée X d’origine des glyphes.
originY float
Coordonnée Y d’origine des glyphes.
unicodeString string
Chaîne à imprimer.
Renvoie
Glyphes ajoutés.
AjouterGlyphes(XpsFont, float, float, float, string)
Ajoute de nouveaux glyphes à la page.
public XpsGlyphs AddGlyphs(XpsFont font, float fontRenderingEmSize, float originX, float originY, string unicodeString)Paramètres
font XpsFont
Ressource de police.
fontRenderingEmSize float
Taille de police.
originX float
Coordonnée X d’origine des glyphes.
originY float
Coordonnée Y d’origine des glyphes.
unicodeString string
Chaîne à imprimer.
Renvoie
Glyphes ajoutés.
AjouterEntréeDePlan(string, int, int)
Ajoute une entrée au plan dans le document.
public void AddOutlineEntry(string description, int outlineLevel, int targetPageNumber)Paramètres
description string
La description de l’entrée.
outlineLevel int
Le niveau de plan.
targetPageNumber int
Le numéro de page cible.
AjouterChemin(XpsPathGeometry)
Ajoute un nouveau chemin à la page.
public XpsPath AddPath(XpsPathGeometry data)Paramètres
data XpsPathGeometry
La géométrie du chemin.
Renvoie
Chemin ajouté.
CréerArcSegment(PointF, SizeF, float, bool, XpsSweepDirection, bool)
Crée un nouveau segment d’arc elliptique.
public XpsArcSegment CreateArcSegment(PointF point, SizeF size, float rotationAngle, bool isLargeArc, XpsSweepDirection sweepDirection, bool isStroked = true)Paramètres
point PointF
Le point d’extrémité de l’arc elliptique.
size SizeF
Le rayon x et y de l’arc elliptique sous forme de paire x,y.
rotationAngle float
Indique comment l’ellipse est tournée par rapport au système de coordonnées actuel.
isLargeArc bool
Détermine si l’arc est dessiné avec une portée de 180 ou plus.
sweepDirection XpsSweepDirection
La direction dans laquelle l’arc est dessiné.
isStroked bool
Spécifie si le trait pour ce segment du chemin est dessiné.
Renvoie
Nouveau segment d’arc elliptique.
CréerCanvas()
Crée un nouveau canevas.
public XpsCanvas CreateCanvas()Renvoie
Nouveau canevas.
CréerCouleur(Color)
Crée une nouvelle couleur.
public XpsColor CreateColor(Color color)Paramètres
color Color
Une instance de couleur native pour la couleur RVB.
Renvoie
Nouvelle couleur.
CréerCouleur(int, int, int, int)
Crée une nouvelle couleur dans l’espace de couleur sRGB.
public XpsColor CreateColor(int a, int r, int g, int b)Paramètres
a int
Le composant de couleur alpha.
r int
Le composant de couleur rouge.
g int
Le composant de couleur verte.
b int
Le composant de couleur bleue.
Renvoie
Nouvelle couleur.
CréerCouleur(int, int, int)
Crée une nouvelle couleur dans l’espace de couleur sRGB.
public XpsColor CreateColor(int r, int g, int b)Paramètres
r int
Le composant de couleur rouge.
g int
Le composant de couleur verte.
b int
Le composant de couleur bleue.
Renvoie
Nouvelle couleur.
CréerCouleur(float, float, float, float)
Crée une nouvelle couleur dans l’espace de couleur scRGB.
public XpsColor CreateColor(float a, float r, float g, float b)Paramètres
a float
Le composant de couleur alpha.
r float
Le composant de couleur rouge.
g float
Le composant de couleur verte.
b float
Le composant de couleur bleue.
Renvoie
Nouvelle couleur.
CréerCouleur(float, float, float)
Crée une nouvelle couleur dans l’espace de couleur scRGB.
public XpsColor CreateColor(float r, float g, float b)Paramètres
r float
Le composant de couleur rouge.
g float
Le composant de couleur verte.
b float
Le composant de couleur bleue.
Renvoie
Nouvelle couleur.
CréerCouleur(string, params float[])
Crée une nouvelle couleur dans l’espace de couleur basé sur l’ICC.
public XpsColor CreateColor(string path, params float[] components)Paramètres
path string
Le chemin vers le profil ICC.
components float[]
Composants de couleur.
Renvoie
Nouvelle couleur.
CréerCouleur(XpsIccProfile, params float[])
Crée une nouvelle couleur dans l’espace de couleur basé sur l’ICC.
public XpsColor CreateColor(XpsIccProfile iccProfile, params float[] components)Paramètres
iccProfile XpsIccProfile
La ressource de profil ICC.
components float[]
Composants de couleur.
Renvoie
Nouvelle couleur.
CréerGlyphes(string, float, FontStyle, float, float, string)
Crée de nouveaux glyphes.
public XpsGlyphs CreateGlyphs(string fontFamily, float fontRenderingEmSize, FontStyle fontStyle, float originX, float originY, string unicodeString)Paramètres
fontFamily string
Famille de police.
fontRenderingEmSize float
Taille de police.
fontStyle FontStyle
Style de police.
originX float
Coordonnée X d’origine des glyphes.
originY float
Coordonnée Y d’origine des glyphes.
unicodeString string
Chaîne à imprimer.
Renvoie
Nouveaux glyphes.
CréerGlyphes(XpsFont, float, float, float, string)
Crée de nouveaux glyphes.
public XpsGlyphs CreateGlyphs(XpsFont font, float fontRenderingEmSize, float originX, float originY, string unicodeString)Paramètres
font XpsFont
Ressource de police.
fontRenderingEmSize float
Taille de police.
originX float
Coordonnée X d’origine des glyphes.
originY float
Coordonnée Y d’origine des glyphes.
unicodeString string
Chaîne à imprimer.
Renvoie
Nouveaux glyphes.
CréerGradientStop(XpsColor, float)
Crée un nouveau point de dégradé.
public XpsGradientStop CreateGradientStop(XpsColor color, float offset)Paramètres
color XpsColor
La couleur du point de dégradé.
offset float
Le décalage du dégradé.
Renvoie
Nouveau point de dégradé.
CréerGradientStop(Color, float)
Crée un nouveau point de dégradé.
public XpsGradientStop CreateGradientStop(Color color, float offset)Paramètres
color Color
La couleur du point de dégradé.
offset float
Le décalage du dégradé.
Renvoie
Nouveau point de dégradé.
CréerImageBrush(XpsImage, RectangleF, RectangleF)
Crée un nouveau pinceau d’image.
public XpsImageBrush CreateImageBrush(XpsImage image, RectangleF viewbox, RectangleF viewport)Paramètres
image XpsImage
Une ressource d’image.
viewbox RectangleF
La position et les dimensions du contenu source du pinceau.
viewport RectangleF
La région dans l’espace de coordonnées contenant le carreau principal du pinceau qui est (possiblement à plusieurs reprises) appliqué pour remplir la région à laquelle le pinceau est appliqué.
Renvoie
Nouveau pinceau d’image.
CréerImageBrush(string, RectangleF, RectangleF)
Crée un nouveau pinceau d’image.
public XpsImageBrush CreateImageBrush(string imagePath, RectangleF viewbox, RectangleF viewport)Paramètres
imagePath string
Le chemin vers l’image à utiliser comme carreau de pinceau.
viewbox RectangleF
La position et les dimensions du contenu source du pinceau.
viewport RectangleF
La région dans l’espace de coordonnées contenant le carreau principal du pinceau qui est (possiblement à plusieurs reprises) appliqué pour remplir la région à laquelle le pinceau est appliqué.
Renvoie
Nouveau pinceau d’image.
CréerPinceauDégradéLin(List<xpsgradientstop>, PointF, PointF)
Crée un nouveau pinceau dégradé linéaire.
public XpsLinearGradientBrush CreateLinearGradientBrush(List<xpsgradientstop> gradientStops, PointF startPoint, PointF endPoint)Paramètres
gradientStops List<XpsGradientStop>
La liste des points de dégradé.
startPoint PointF
Le point de départ du dégradé linéaire.
endPoint PointF
Le point d’arrivée du dégradé linéaire.
Renvoie
Nouveau pinceau dégradé linéaire.
CréerPinceauDégradéLin(PointF, PointF)
Crée un nouveau pinceau dégradé linéaire.
public XpsLinearGradientBrush CreateLinearGradientBrush(PointF startPoint, PointF endPoint)Paramètres
startPoint PointF
Le point de départ du dégradé linéaire.
endPoint PointF
Le point d’arrivée du dégradé linéaire.
Renvoie
Nouveau pinceau dégradé linéaire.
CréerMatrice(float, float, float, float, float, float)
Crée une nouvelle matrice de transformation affine.
public XpsMatrix CreateMatrix(float m11, float m12, float m21, float m22, float m31, float m32)Paramètres
m11 float
Élément 11.
m12 float
Élément 12.
m21 float
Élément 21.
m22 float
Élément 22.
m31 float
Élément 31.
m32 float
Élément 32.
Renvoie
Nouvelle matrice de transformation affine.
CréerChemin(XpsPathGeometry)
Crée un nouveau chemin.
public XpsPath CreatePath(XpsPathGeometry data)Paramètres
data XpsPathGeometry
La géométrie du chemin.
Renvoie
Nouveau chemin.
CréerFigureDeChemin(PointF, bool)
Crée une nouvelle figure de chemin.
public XpsPathFigure CreatePathFigure(PointF startPoint, bool isClosed = false)Paramètres
startPoint PointF
Le point de départ pour le premier segment de la figure de chemin.
isClosed bool
Spécifie si le chemin est fermé. Si défini sur vrai, le trait est dessiné “fermé”, c’est-à-dire que le dernier point du dernier segment de la figure de chemin est connecté au point spécifié dans l’attribut StartPoint, sinon le trait est dessiné “ouvert”, et le dernier point n’est pas connecté au point de départ. Applicable uniquement si la figure de chemin est utilisée dans un élément Path qui spécifie un trait.
Renvoie
Nouvelle figure de chemin.
CréerFigureDeChemin(PointF, List, bool)
Crée une nouvelle figure de chemin.
public XpsPathFigure CreatePathFigure(PointF startPoint, List<xpspathsegment> segments, bool isClosed = false)Paramètres
startPoint PointF
Le point de départ pour le premier segment de la figure de chemin.
segments List<XpsPathSegment>
Liste des segments de chemin.
isClosed bool
Spécifie si le chemin est fermé. Si défini sur vrai, le trait est dessiné “fermé”, c’est-à-dire que le dernier point du dernier segment de la figure de chemin est connecté au point spécifié dans l’attribut StartPoint, sinon le trait est dessiné “ouvert”, et le dernier point n’est pas connecté au point de départ. Applicable uniquement si la figure de chemin est utilisée dans un élément Path qui spécifie un trait.
Renvoie
Nouvelle figure de chemin.
CréerGéométrieDeChemin(string)
Crée une nouvelle géométrie de chemin spécifiée avec une forme abrégée.
public XpsPathGeometry CreatePathGeometry(string abbreviatedGeometry)Paramètres
abbreviatedGeometry string
Forme abrégée de la géométrie du chemin.
Renvoie
Nouvelle géométrie de chemin.
CréerGéométrieDeChemin()
Crée une nouvelle géométrie de chemin.
public XpsPathGeometry CreatePathGeometry()Renvoie
Nouvelle géométrie de chemin.
CréerGéométrieDeChemin(List)
Crée une nouvelle géométrie de chemin avec une liste spécifiée de figures de chemin.
public XpsPathGeometry CreatePathGeometry(List<xpspathfigure> pathFigures)Paramètres
pathFigures List<XpsPathFigure>
Liste des figures de chemin.
Renvoie
Nouvelle géométrie de chemin.
CréerSegmentBezierPoly(PointF[], bool)
Crée un nouvel ensemble de courbes Bézier cubiques.
public XpsPolyBezierSegment CreatePolyBezierSegment(PointF[] points, bool isStroked = true)Paramètres
points PointF[]
Points de contrôle pour plusieurs segments de Bézier.
isStroked bool
Spécifie si le trait pour ce segment du chemin est dessiné.
Renvoie
Nouveau segment de courbes Bézier cubiques.
CréerSegmentLignePoly(PointF[], bool)
Crée un nouveau dessin polygonal contenant un nombre arbitraire de sommets individuels.
public XpsPolyLineSegment CreatePolyLineSegment(PointF[] points, bool isStroked = true)Paramètres
points PointF[]
Un ensemble de coordonnées pour les multiples segments qui définissent le segment de ligne polygonal.
isStroked bool
Spécifie si le trait pour ce segment du chemin est dessiné.
Renvoie
Nouveau segment de dessin polygonal.
CréerSegmentBezierQuadratiquePoly(PointF[], bool)
Crée un nouvel ensemble de courbes Bézier quadratiques à partir du point précédent dans la figure de chemin à travers un ensemble de sommets, en utilisant des points de contrôle spécifiés.
public XpsPolyQuadraticBezierSegment CreatePolyQuadraticBezierSegment(PointF[] points, bool isStroked = true)Paramètres
points PointF[]
Points de contrôle pour plusieurs segments de Bézier quadratiques.
isStroked bool
Spécifie si le trait pour ce segment du chemin est dessiné.
Renvoie
Nouveau segment de courbes Bézier quadratiques.
CréerPinceauDégradéRadial(List<xpsgradientstop>, PointF, PointF, float, float)
Crée un nouveau pinceau dégradé radial.
public XpsRadialGradientBrush CreateRadialGradientBrush(List<xpsgradientstop> gradientStops, PointF center, PointF gradientOrigin, float radiusX, float radiusY)Paramètres
gradientStops List<XpsGradientStop>
La liste des points de dégradé.
center PointF
Le point central du dégradé radial (c’est-à-dire le centre de l’ellipse).
gradientOrigin PointF
Le point d’origine du dégradé radial.
radiusX float
Le rayon dans la dimension x de l’ellipse qui définit le dégradé radial.
radiusY float
Le rayon dans la dimension y de l’ellipse qui définit le dégradé radial.
Renvoie
Nouveau pinceau dégradé radial.
CréerPinceauDégradéRadial(PointF, PointF, float, float)
Crée un nouveau pinceau dégradé radial.
public XpsRadialGradientBrush CreateRadialGradientBrush(PointF center, PointF gradientOrigin, float radiusX, float radiusY)Paramètres
center PointF
Le point central du dégradé radial (c’est-à-dire le centre de l’ellipse).
gradientOrigin PointF
Le point d’origine du dégradé radial.
radiusX float
Le rayon dans la dimension x de l’ellipse qui définit le dégradé radial.
radiusY float
Le rayon dans la dimension y de l’ellipse qui définit le dégradé radial.
Renvoie
Nouveau pinceau dégradé radial.
CréerPinceauCouleurSolide(XpsColor)
Crée un nouveau pinceau de couleur solide.
public XpsSolidColorBrush CreateSolidColorBrush(XpsColor color)Paramètres
color XpsColor
La couleur pour les éléments remplis.
Renvoie
Nouveau pinceau de couleur solide.
CréerPinceauCouleurSolide(Color)
Crée un nouveau pinceau de couleur solide.
public XpsSolidColorBrush CreateSolidColorBrush(Color color)Paramètres
color Color
La couleur pour les éléments remplis.
Renvoie
Nouveau pinceau de couleur solide.
CréerPinceauVisuel(XpsContentElement, RectangleF, RectangleF)
Crée un nouveau pinceau visuel.
public XpsVisualBrush CreateVisualBrush(XpsContentElement element, RectangleF viewbox, RectangleF viewport)Paramètres
element XpsContentElement
L’élément XPS (Canvas, Path ou Glyphs) pour la propriété Visuelle du pinceau visuel.
viewbox RectangleF
La position et les dimensions du contenu source du pinceau.
viewport RectangleF
La région dans l’espace de coordonnées contenant le carreau principal du pinceau qui est (possiblement à plusieurs reprises) appliqué pour remplir la région à laquelle le pinceau est appliqué.
Renvoie
Nouveau pinceau visuel.
Insérer<t>(int, T)
Insère un élément (Canvas, Path ou Glyphs) dans la page à la position index.
public T Insert<t>(int index, T element) where T : XpsContentElementParamètres
index int
Position à laquelle un element doit être inséré.
element T
Élément à insérer.
Renvoie
T
Élément inséré.
Paramètres de type
T
Le type de l’élément.
InsérerCanvas(int)
Insère un nouveau canevas dans la page à la position index.
public XpsCanvas InsertCanvas(int index)Paramètres
index int
Position à laquelle un nouveau canevas doit être inséré.
Renvoie
Canevas inséré.
InsérerGlyphes(int, string, float, FontStyle, float, float, string)
Insère de nouveaux glyphes dans la page à la position index.
public XpsGlyphs InsertGlyphs(int index, string fontFamily, float fontSize, FontStyle fontStyle, float originX, float originY, string unicodeString)Paramètres
index int
Position à laquelle de nouveaux glyphes doivent être insérés.
fontFamily string
Famille de police.
fontSize float
Taille de police.
fontStyle FontStyle
Style de police.
originX float
Coordonnée X d’origine des glyphes.
originY float
Coordonnée Y d’origine des glyphes.
unicodeString string
Chaîne à imprimer.
Renvoie
Glyphes insérés.
InsérerGlyphes(int, XpsFont, float, float, float, string)
Insère de nouveaux glyphes dans la page à la position index.
public XpsGlyphs InsertGlyphs(int index, XpsFont font, float fontSize, float originX, float originY, string unicodeString)Paramètres
index int
Position à laquelle de nouveaux glyphes doivent être insérés.
font XpsFont
Ressource de police.
fontSize float
Taille de police.
originX float
Coordonnée X d’origine des glyphes.
originY float
Coordonnée Y d’origine des glyphes.
unicodeString string
Chaîne à imprimer.
Renvoie
Glyphes insérés.
InsérerChemin(int, XpsPathGeometry)
Insère un nouveau chemin dans la page à la position index.
public XpsPath InsertPath(int index, XpsPathGeometry data)Paramètres
index int
Position à laquelle un nouveau chemin doit être inséré.
data XpsPathGeometry
La géométrie du chemin.
Renvoie
Chemin inséré.
Supprimer<t>(T)
Supprime un élément de la page.
public T Remove<t>(T element) where T : XpsContentElementParamètres
element T
Élément à supprimer.
Renvoie
T
Élément supprimé.
Paramètres de type
T
Le type de l’élément.
SupprimerÀ(int)
Supprime un élément à la position index de la page.
public XpsContentElement RemoveAt(int index)Paramètres
index int
Position à laquelle l’élément doit être supprimé.
Renvoie
Élément supprimé.
