Class PageAPI

Class PageAPI

Namespace: Aspose.Page.XPS.Features.EventBasedModifications
Assembly: Aspose.Page.dll (25.1.2)

Page 要素修正 API。

public class PageAPI : IModificationAPI

継承

objectPageAPI

実装

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; }

プロパティ値

float

ページ数

アクティブなドキュメント内のページ数を返します。

public int PageCount { get; }

プロパティ値

int

総ページ数

XPS ドキュメント内のすべてのドキュメントの総ページ数を返します。

public int TotalPageCount { get; }

プロパティ値

int

ユーティリティ

正式な XPS 操作 API を超えたユーティリティを提供するオブジェクトを取得します。

public DocumentUtils Utils { get; }

プロパティ値

DocumentUtils

ページの幅を返す/設定します。実数として表現され、効果的な座標空間の単位で表されます。

public float Width { get; set; }

プロパティ値

float

メソッド

Add<t>(T)

コンテンツ要素 (Canvas、Path、または Glyphs) を追加します。

public T Add<t>(T element) where T : XpsContentElement

パラメータ

element T

追加される要素。

戻り値

T

追加された要素。

型パラメータ

T

要素の型。

AddCanvas()

ページに新しいキャンバスを追加します。

public XpsCanvas AddCanvas()

戻り値

XpsCanvas

追加されたキャンバス。

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

印刷される文字列。

戻り値

XpsGlyphs

追加されたグリフ。

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

印刷される文字列。

戻り値

XpsGlyphs

追加されたグリフ。

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

パスの幾何学。

戻り値

XpsPath

追加されたパス。

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

このパスのセグメントのストロークが描画されるかどうかを指定します。

戻り値

XpsArcSegment

新しい楕円弧セグメント。

CreateCanvas()

新しいキャンバスを作成します。

public XpsCanvas CreateCanvas()

戻り値

XpsCanvas

新しいキャンバス。

CreateColor(Color)

新しい色を作成します。

public XpsColor CreateColor(Color color)

パラメータ

color Color

RGB 色のためのネイティブカラーインスタンス。

戻り値

XpsColor

新しい色。

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

青色コンポーネント。

戻り値

XpsColor

新しい色。

CreateColor(int, int, int)

sRGB カラースペースで新しい色を作成します。

public XpsColor CreateColor(int r, int g, int b)

パラメータ

r int

赤色コンポーネント。

g int

緑色コンポーネント。

b int

青色コンポーネント。

戻り値

XpsColor

新しい色。

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

青色コンポーネント。

戻り値

XpsColor

新しい色。

CreateColor(float, float, float)

scRGB カラースペースで新しい色を作成します。

public XpsColor CreateColor(float r, float g, float b)

パラメータ

r float

赤色コンポーネント。

g float

緑色コンポーネント。

b float

青色コンポーネント。

戻り値

XpsColor

新しい色。

CreateColor(string, params float[])

ICC ベースのカラースペースで新しい色を作成します。

public XpsColor CreateColor(string path, params float[] components)

パラメータ

path string

ICC プロファイルへのパス。

components float[]

カラーコンポーネント。

戻り値

XpsColor

新しい色。

CreateColor(XpsIccProfile, params float[])

ICC ベースのカラースペースで新しい色を作成します。

public XpsColor CreateColor(XpsIccProfile iccProfile, params float[] components)

パラメータ

iccProfile XpsIccProfile

ICC プロファイルリソース。

components float[]

カラーコンポーネント。

戻り値

XpsColor

新しい色。

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

印刷される文字列。

戻り値

XpsGlyphs

新しいグリフ。

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

印刷される文字列。

戻り値

XpsGlyphs

新しいグリフ。

CreateGradientStop(XpsColor, float)

新しいグラデーションストップを作成します。

public XpsGradientStop CreateGradientStop(XpsColor color, float offset)

パラメータ

color XpsColor

グラデーションストップの色。

offset float

グラデーションオフセット。

戻り値

XpsGradientStop

新しいグラデーションストップ。

CreateGradientStop(Color, float)

新しいグラデーションストップを作成します。

public XpsGradientStop CreateGradientStop(Color color, float offset)

パラメータ

color Color

グラデーションストップの色。

offset float

グラデーションオフセット。

戻り値

XpsGradientStop

新しいグラデーションストップ。

CreateImageBrush(XpsImage, RectangleF, RectangleF)

新しいイメージブラシを作成します。

public XpsImageBrush CreateImageBrush(XpsImage image, RectangleF viewbox, RectangleF viewport)

パラメータ

image XpsImage

イメージリソース。

viewbox RectangleF

ブラシのソースコンテンツの位置と寸法。

viewport RectangleF

ブラシが適用される領域を埋めるために(繰り返し)適用されるプライムブラシタイルの領域。

戻り値

XpsImageBrush

新しいイメージブラシ。

CreateImageBrush(string, RectangleF, RectangleF)

新しいイメージブラシを作成します。

public XpsImageBrush CreateImageBrush(string imagePath, RectangleF viewbox, RectangleF viewport)

パラメータ

imagePath string

ブラシタイルとして使用するイメージへのパス。

viewbox RectangleF

ブラシのソースコンテンツの位置と寸法。

viewport RectangleF

ブラシが適用される領域を埋めるために(繰り返し)適用されるプライムブラシタイルの領域。

戻り値

XpsImageBrush

新しいイメージブラシ。

CreateLinearGradientBrush(List<xpsgradientstop>, PointF, PointF)

新しい線形グラデーションブラシを作成します。

public XpsLinearGradientBrush CreateLinearGradientBrush(List<xpsgradientstop> gradientStops, PointF startPoint, PointF endPoint)

パラメータ

gradientStops List<XpsGradientStop&gt;

グラデーションストップのリスト。

startPoint PointF

線形グラデーションの開始点。

endPoint PointF

線形グラデーションの終点。

戻り値

XpsLinearGradientBrush

新しい線形グラデーションブラシ。

CreateLinearGradientBrush(PointF, PointF)

新しい線形グラデーションブラシを作成します。

public XpsLinearGradientBrush CreateLinearGradientBrush(PointF startPoint, PointF endPoint)

パラメータ

startPoint PointF

線形グラデーションの開始点。

endPoint PointF

線形グラデーションの終点。

戻り値

XpsLinearGradientBrush

新しい線形グラデーションブラシ。

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。

戻り値

XpsMatrix

新しいアフィン変換行列。

CreatePath(XpsPathGeometry)

新しいパスを作成します。

public XpsPath CreatePath(XpsPathGeometry data)

パラメータ

data XpsPathGeometry

パスの幾何学。

戻り値

XpsPath

新しいパス。

CreatePathFigure(PointF, bool)

新しいパスフィギュアを作成します。

public XpsPathFigure CreatePathFigure(PointF startPoint, bool isClosed = false)

パラメータ

startPoint PointF

パスフィギュアの最初のセグメントの開始点。

isClosed bool

パスが閉じられているかどうかを指定します。true に設定すると、ストロークが「閉じて」描画され、パスフィギュアの最後のセグメントの最後の点が StartPoint 属性で指定された点に接続されます。そうでない場合、ストロークは「開いて」描画され、最後の点は開始点に接続されません。パスフィギュアがストロークを指定する Path 要素で使用される場合のみ適用されます。

戻り値

XpsPathFigure

新しいパスフィギュア。

CreatePathFigure(PointF, List<xpspathsegment>, bool)

新しいパスフィギュアを作成します。

public XpsPathFigure CreatePathFigure(PointF startPoint, List<xpspathsegment> segments, bool isClosed = false)

パラメータ

startPoint PointF

パスフィギュアの最初のセグメントの開始点。

segments List<XpsPathSegment&gt;

パスセグメントのリスト。

isClosed bool

パスが閉じられているかどうかを指定します。true に設定すると、ストロークが「閉じて」描画され、パスフィギュアの最後のセグメントの最後の点が StartPoint 属性で指定された点に接続されます。そうでない場合、ストロークは「開いて」描画され、最後の点は開始点に接続されません。パスフィギュアがストロークを指定する Path 要素で使用される場合のみ適用されます。

戻り値

XpsPathFigure

新しいパスフィギュア。

CreatePathGeometry(string)

省略形で指定された新しいパス幾何学を作成します。

public XpsPathGeometry CreatePathGeometry(string abbreviatedGeometry)

パラメータ

abbreviatedGeometry string

パス幾何学の省略形。

戻り値

XpsPathGeometry

新しいパス幾何学。

CreatePathGeometry()

新しいパス幾何学を作成します。

public XpsPathGeometry CreatePathGeometry()

戻り値

XpsPathGeometry

新しいパス幾何学。

CreatePathGeometry(List<xpspathfigure>)

指定されたパスフィギュアのリストを持つ新しいパス幾何学を作成します。

public XpsPathGeometry CreatePathGeometry(List<xpspathfigure> pathFigures)

パラメータ

pathFigures List<XpsPathFigure&gt;

パスフィギュアのリスト。

戻り値

XpsPathGeometry

新しいパス幾何学。

CreatePolyBezierSegment(PointF[], bool)

新しいセットの三次ベジェ曲線を作成します。

public XpsPolyBezierSegment CreatePolyBezierSegment(PointF[] points, bool isStroked = true)

パラメータ

points PointF[]

複数のベジェセグメントの制御点。

isStroked bool

このパスのセグメントのストロークが描画されるかどうかを指定します。

戻り値

XpsPolyBezierSegment

新しい三次ベジェ曲線セグメント。

CreatePolyLineSegment(PointF[], bool)

任意の数の個々の頂点を含む新しい多角形描画を作成します。

public XpsPolyLineSegment CreatePolyLineSegment(PointF[] points, bool isStroked = true)

パラメータ

points PointF[]

多くのセグメントを定義するための座標のセット。

isStroked bool

このパスのセグメントのストロークが描画されるかどうかを指定します。

戻り値

XpsPolyLineSegment

新しい多角形描画セグメント。

CreatePolyQuadraticBezierSegment(PointF[], bool)

指定された制御点を使用して、パスフィギュア内の前の点から頂点のセットを通る新しい二次ベジェ曲線を作成します。

public XpsPolyQuadraticBezierSegment CreatePolyQuadraticBezierSegment(PointF[] points, bool isStroked = true)

パラメータ

points PointF[]

複数の二次ベジェセグメントの制御点。

isStroked bool

このパスのセグメントのストロークが描画されるかどうかを指定します。

戻り値

XpsPolyQuadraticBezierSegment

新しい二次ベジェ曲線セグメント。

CreateRadialGradientBrush(List<xpsgradientstop>, PointF, PointF, float, float)

新しい放射状グラデーションブラシを作成します。

public XpsRadialGradientBrush CreateRadialGradientBrush(List<xpsgradientstop> gradientStops, PointF center, PointF gradientOrigin, float radiusX, float radiusY)

パラメータ

gradientStops List<XpsGradientStop&gt;

グラデーションストップのリスト。

center PointF

放射状グラデーションの中心点(楕円の中心)。

gradientOrigin PointF

放射状グラデーションの起点。

radiusX float

放射状グラデーションを定義する楕円の x 次元の半径。

radiusY float

放射状グラデーションを定義する楕円の y 次元の半径。

戻り値

XpsRadialGradientBrush

新しい放射状グラデーションブラシ。

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 次元の半径。

戻り値

XpsRadialGradientBrush

新しい放射状グラデーションブラシ。

CreateSolidColorBrush(XpsColor)

新しいソリッドカラーのブラシを作成します。

public XpsSolidColorBrush CreateSolidColorBrush(XpsColor color)

パラメータ

color XpsColor

塗りつぶされた要素の色。

戻り値

XpsSolidColorBrush

新しいソリッドカラーのブラシ。

CreateSolidColorBrush(Color)

新しいソリッドカラーのブラシを作成します。

public XpsSolidColorBrush CreateSolidColorBrush(Color color)

パラメータ

color Color

塗りつぶされた要素の色。

戻り値

XpsSolidColorBrush

新しいソリッドカラーのブラシ。

CreateVisualBrush(XpsContentElement, RectangleF, RectangleF)

新しいビジュアルブラシを作成します。

public XpsVisualBrush CreateVisualBrush(XpsContentElement element, RectangleF viewbox, RectangleF viewport)

パラメータ

element XpsContentElement

ビジュアルブラシのビジュアルプロパティのための XPS 要素(Canvas、Path または Glyphs)。

viewbox RectangleF

ブラシのソースコンテンツの位置と寸法。

viewport RectangleF

ブラシが適用される領域を埋めるために(繰り返し)適用されるプライムブラシタイルの領域。

戻り値

XpsVisualBrush

新しいビジュアルブラシ。

Insert<t>(int, T)

ページの index 位置に要素 (Canvas、Path、または Glyphs) を挿入します。

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

新しいキャンバスを挿入する位置。

戻り値

XpsCanvas

挿入されたキャンバス。

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

印刷される文字列。

戻り値

XpsGlyphs

挿入されたグリフ。

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

印刷される文字列。

戻り値

XpsGlyphs

挿入されたグリフ。

InsertPath(int, XpsPathGeometry)

ページの index 位置に新しいパスを挿入します。

public XpsPath InsertPath(int index, XpsPathGeometry data)

パラメータ

index int

新しいパスを挿入する位置。

data XpsPathGeometry

パスの幾何学。

戻り値

XpsPath

挿入されたパス。

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

削除される要素の位置。

戻り値

XpsContentElement

削除された要素。

 日本語