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; }
مقدار ویژگی
ابزارها
شیای را که ابزارهای فراتر از API دستکاری XPS رسمی را فراهم میکند، دریافت میکند.
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 که یک stroke را مشخص میکند، استفاده شود.
بازگشت
شکل مسیر جدید.
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 که یک stroke را مشخص میکند، استفاده شود.
بازگشت
شکل مسیر جدید.
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
موقعیتی که عنصر باید حذف شود.
بازگشت
عنصر حذفشده.