Class PdfPage

PDF Page

Inheritance

System.Object

PdfObject

PdfPage

Inherited Members

PdfObject.ObjectId

PdfObject.GetReference()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Azos.Media.PDF.DocumentModel

Assembly: Azos.Media.dll

Syntax

public class PdfPage : PdfObject, IPdfObject

Properties

Elements

Page elements

Declaration

public List<PdfElement> Elements { get; }

Property Value

Type	Description
System.Collections.Generic.List<PdfElement>

Height

Page's height

Declaration

public float Height { get; }

Property Value

Type	Description
System.Single

UserUnit

User space units (the default user space unit is 1/72 inch)

Declaration

public float UserUnit { get; }

Property Value

Type	Description
System.Single

Width

Page's width

Declaration

public float Width { get; }

Property Value

Type	Description
System.Single

Methods

Add(PdfElement)

Adds PDF element to page's elements collection

Declaration

public void Add(PdfElement element)

Parameters

Type	Name	Description
PdfElement	element

AddCircle(Single, Single, Single, PdfColor)

Add circle primitive to the page

Declaration

public PathElement AddCircle(float centerX, float centerY, float r, PdfColor fill)

Parameters

Type	Name	Description
System.Single	centerX
System.Single	centerY
System.Single	r
PdfColor	fill

Returns

Type	Description
PathElement

AddCircle(Single, Single, Single, PdfColor, Single)

Add circle primitive to the page

Declaration

public PathElement AddCircle(float centerX, float centerY, float r, PdfColor fill, float borderThickness)

Parameters

Type	Name	Description
System.Single	centerX
System.Single	centerY
System.Single	r
PdfColor	fill
System.Single	borderThickness

Returns

Type	Description
PathElement

AddCircle(Single, Single, Single, PdfColor, Single, PdfColor)

Add circle primitive to the page

Declaration

public PathElement AddCircle(float centerX, float centerY, float r, PdfColor fill, float borderThickness, PdfColor borderColor)

Parameters

Type	Name	Description
System.Single	centerX
System.Single	centerY
System.Single	r
PdfColor	fill
System.Single	borderThickness
PdfColor	borderColor

Returns

Type	Description
PathElement

AddCircle(Single, Single, Single, PdfColor, Single, PdfColor, PdfLineType)

Add circle primitive to the page

Declaration

public PathElement AddCircle(float centerX, float centerY, float r, PdfColor fill, float borderThickness, PdfColor borderColor, PdfLineType borderType)

Parameters

Type	Name	Description
System.Single	centerX
System.Single	centerY
System.Single	r
PdfColor	fill
System.Single	borderThickness
PdfColor	borderColor
PdfLineType	borderType

Returns

Type	Description
PathElement

AddCircle(Single, Single, Single, PdfDrawStyle)

Add circle primitive to the page

Declaration

public PathElement AddCircle(float centerX, float centerY, float r, PdfDrawStyle borderStyle)

Parameters

Type	Name	Description
System.Single	centerX
System.Single	centerY
System.Single	r
PdfDrawStyle	borderStyle

Returns

Type	Description
PathElement

AddImage(String)

Add image to the page

Declaration

public ImageElement AddImage(string filePath)

Parameters

Type	Name	Description
System.String	filePath

Returns

Type	Description
ImageElement

AddImage(String, Single, Single)

Add image to the page

Declaration

public ImageElement AddImage(string filePath, float width, float height)

Parameters

Type	Name	Description
System.String	filePath
System.Single	width
System.Single	height

Returns

Type	Description
ImageElement

AddLine(Single, Single, Single, Single)

Add line primitive to the page

Declaration

public PathElement AddLine(float x1, float y1, float x2, float y2)

Parameters

Type	Name	Description
System.Single	x1
System.Single	y1
System.Single	x2
System.Single	y2

Returns

Type	Description
PathElement

AddLine(Single, Single, Single, Single, PdfDrawStyle)

Add line primitive to the page

Declaration

public PathElement AddLine(float x1, float y1, float x2, float y2, PdfDrawStyle style)

Parameters

Type	Name	Description
System.Single	x1
System.Single	y1
System.Single	x2
System.Single	y2
PdfDrawStyle	style

Returns

Type	Description
PathElement

AddLine(Single, Single, Single, Single, Single)

Add line primitive to the page

Declaration

public PathElement AddLine(float x1, float y1, float x2, float y2, float thickness)

Parameters

Type	Name	Description
System.Single	x1
System.Single	y1
System.Single	x2
System.Single	y2
System.Single	thickness

Returns

Type	Description
PathElement

AddLine(Single, Single, Single, Single, Single, PdfColor)

Add line primitive to the page

Declaration

public PathElement AddLine(float x1, float y1, float x2, float y2, float thickness, PdfColor color)

Parameters

Type	Name	Description
System.Single	x1
System.Single	y1
System.Single	x2
System.Single	y2
System.Single	thickness
PdfColor	color

Returns

Type	Description
PathElement

AddLine(Single, Single, Single, Single, Single, PdfColor, PdfLineType)

Add line primitive to the page

Declaration

public PathElement AddLine(float x1, float y1, float x2, float y2, float thickness, PdfColor color, PdfLineType type)

Parameters

Type	Name	Description
System.Single	x1
System.Single	y1
System.Single	x2
System.Single	y2
System.Single	thickness
PdfColor	color
PdfLineType	type

Returns

Type	Description
PathElement

AddPath(Single, Single)

Add path to the page

Declaration

public PathElement AddPath(float x, float y)

Parameters

Type	Name	Description
System.Single	x
System.Single	y

Returns

Type	Description
PathElement

AddPath(Single, Single, PdfDrawStyle)

Add path to the page

Declaration

public PathElement AddPath(float x, float y, PdfDrawStyle style)

Parameters

Type	Name	Description
System.Single	x
System.Single	y
PdfDrawStyle	style

Returns

Type	Description
PathElement

AddPath(Single, Single, Single)

Add path to the page

Declaration

public PathElement AddPath(float x, float y, float thickness)

Parameters

Type	Name	Description
System.Single	x
System.Single	y
System.Single	thickness

Returns

Type	Description
PathElement

AddPath(Single, Single, Single, PdfColor)

Add path to the page

Declaration

public PathElement AddPath(float x, float y, float thickness, PdfColor color)

Parameters

Type	Name	Description
System.Single	x
System.Single	y
System.Single	thickness
PdfColor	color

Returns

Type	Description
PathElement

AddPath(Single, Single, Single, PdfColor, PdfLineType)

Add path to the page

Declaration

public PathElement AddPath(float x, float y, float thickness, PdfColor color, PdfLineType type)

Parameters

Type	Name	Description
System.Single	x
System.Single	y
System.Single	thickness
PdfColor	color
PdfLineType	type

Returns

Type	Description
PathElement

AddRectangle(Single, Single, Single, Single, PdfColor)

Add rectangle primitive to the page

Declaration

public RectangleElement AddRectangle(float x1, float y1, float x2, float y2, PdfColor fill)

Parameters

Type	Name	Description
System.Single	x1
System.Single	y1
System.Single	x2
System.Single	y2
PdfColor	fill

Returns

Type	Description
RectangleElement

AddRectangle(Single, Single, Single, Single, PdfColor, Single)

Add rectangle primitive to the page

Declaration

public RectangleElement AddRectangle(float x1, float y1, float x2, float y2, PdfColor fill, float borderThickness)

Parameters

Type	Name	Description
System.Single	x1
System.Single	y1
System.Single	x2
System.Single	y2
PdfColor	fill
System.Single	borderThickness

Returns

Type	Description
RectangleElement

AddRectangle(Single, Single, Single, Single, PdfColor, Single, PdfColor)

Add rectangle primitive to the page

Declaration

public RectangleElement AddRectangle(float x1, float y1, float x2, float y2, PdfColor fill, float borderThickness, PdfColor borderColor)

Parameters

Type	Name	Description
System.Single	x1
System.Single	y1
System.Single	x2
System.Single	y2
PdfColor	fill
System.Single	borderThickness
PdfColor	borderColor

Returns

Type	Description
RectangleElement

AddRectangle(Single, Single, Single, Single, PdfColor, Single, PdfColor, PdfLineType)

Add rectangle primitive to the page

Declaration

public RectangleElement AddRectangle(float x1, float y1, float x2, float y2, PdfColor fill, float borderThickness, PdfColor borderColor, PdfLineType borderType)

Parameters

Type	Name	Description
System.Single	x1
System.Single	y1
System.Single	x2
System.Single	y2
PdfColor	fill
System.Single	borderThickness
PdfColor	borderColor
PdfLineType	borderType

Returns

Type	Description
RectangleElement

AddRectangle(Single, Single, Single, Single, PdfDrawStyle)

Add rectangle primitive to the page

Declaration

public RectangleElement AddRectangle(float x1, float y1, float x2, float y2, PdfDrawStyle style)

Parameters

Type	Name	Description
System.Single	x1
System.Single	y1
System.Single	x2
System.Single	y2
PdfDrawStyle	style

Returns

Type	Description
RectangleElement

AddText(String)

Add raw text to the page

Declaration

public TextElement AddText(string text)

Parameters

Type	Name	Description
System.String	text

Returns

Type	Description
TextElement

AddText(String, Single, PdfFont)

Add raw text to the page

Declaration

public TextElement AddText(string text, float fontSize, PdfFont font)

Parameters

Type	Name	Description
System.String	text
System.Single	fontSize
PdfFont	font

Returns

Type	Description
TextElement

AddText(String, Single, PdfFont, PdfColor)

Add raw text to the page

Declaration

public TextElement AddText(string text, float fontSize, PdfFont font, PdfColor foreground)

Parameters

Type	Name	Description
System.String	text
System.Single	fontSize
PdfFont	font
PdfColor	foreground

Returns

Type	Description
TextElement

Extension Methods

CollectionUtils.ConcatArray<T>(T, T[])

CoreUtils.NonNull<T>(T, String)

ObjectValueConversion.AsString(Object, String, ConvertErrorHandling)

ObjectValueConversion.AsNonNullOrEmptyString(Object)

ObjectValueConversion.AsLaconicConfig(Object, ConfigSectionNode, String, ConvertErrorHandling)

ObjectValueConversion.AsJSONConfig(Object, ConfigSectionNode, String, ConvertErrorHandling)

ObjectValueConversion.AsXMLConfig(Object, ConfigSectionNode, ConvertErrorHandling)

ObjectValueConversion.AsChar(Object, Char, ConvertErrorHandling)

ObjectValueConversion.AsNullableChar(Object, Nullable<Char>, ConvertErrorHandling)

ObjectValueConversion.AsByte(Object, Byte, ConvertErrorHandling)

ObjectValueConversion.AsNullableByte(Object, Nullable<Byte>, ConvertErrorHandling)

ObjectValueConversion.AsSByte(Object, SByte, ConvertErrorHandling)

ObjectValueConversion.AsNullableSByte(Object, Nullable<SByte>, ConvertErrorHandling)

ObjectValueConversion.AsShort(Object, Int16, ConvertErrorHandling)

ObjectValueConversion.AsNullableShort(Object, Nullable<Int16>, ConvertErrorHandling)

ObjectValueConversion.AsUShort(Object, UInt16, ConvertErrorHandling)

ObjectValueConversion.AsNullableUShort(Object, Nullable<UInt16>, ConvertErrorHandling)

ObjectValueConversion.AsInt(Object, Int32, ConvertErrorHandling)

ObjectValueConversion.AsNullableInt(Object, Nullable<Int32>, ConvertErrorHandling)

ObjectValueConversion.AsUInt(Object, UInt32, ConvertErrorHandling)

ObjectValueConversion.AsNullableUInt(Object, Nullable<UInt32>, ConvertErrorHandling)

ObjectValueConversion.AsLong(Object, Int64, ConvertErrorHandling)

ObjectValueConversion.AsNullableLong(Object, Nullable<Int64>, ConvertErrorHandling)

ObjectValueConversion.AsULong(Object, UInt64, ConvertErrorHandling)

ObjectValueConversion.AsNullableULong(Object, Nullable<UInt64>, ConvertErrorHandling)

ObjectValueConversion.AsDouble(Object, Double, ConvertErrorHandling)

ObjectValueConversion.AsNullableDouble(Object, Nullable<Double>, ConvertErrorHandling)

ObjectValueConversion.AsFloat(Object, Single, ConvertErrorHandling)

ObjectValueConversion.AsNullableFloat(Object, Nullable<Single>, ConvertErrorHandling)

ObjectValueConversion.AsDecimal(Object, Decimal, ConvertErrorHandling)

ObjectValueConversion.AsNullableDecimal(Object, Nullable<Decimal>, ConvertErrorHandling)

ObjectValueConversion.AsBool(Object, Boolean, ConvertErrorHandling)

ObjectValueConversion.AsNullableBool(Object, Nullable<Boolean>, ConvertErrorHandling)

ObjectValueConversion.AsGUID(Object, Guid, ConvertErrorHandling)

ObjectValueConversion.AsNullableGUID(Object, Nullable<Guid>, ConvertErrorHandling)

ObjectValueConversion.AsDateTime(Object)

ObjectValueConversion.AsDateTime(Object, DateTime, ConvertErrorHandling)

ObjectValueConversion.AsNullableDateTime(Object, Nullable<DateTime>, ConvertErrorHandling)

ObjectValueConversion.AsGDID(Object)

ObjectValueConversion.AsGDID(Object, GDID, ConvertErrorHandling)

ObjectValueConversion.AsNullableGDID(Object, Nullable<GDID>, ConvertErrorHandling)

ObjectValueConversion.AsGDIDSymbol(Object)

ObjectValueConversion.AsGDIDSymbol(Object, GDIDSymbol, ConvertErrorHandling)

ObjectValueConversion.AsNullableGDIDSymbol(Object, Nullable<GDIDSymbol>, ConvertErrorHandling)

ObjectValueConversion.AsTimeSpan(Object)

ObjectValueConversion.AsTimeSpan(Object, TimeSpan, ConvertErrorHandling)

ObjectValueConversion.AsNullableTimeSpan(Object, Nullable<TimeSpan>, ConvertErrorHandling)

ObjectValueConversion.AsEnum<TEnum>(Object, TEnum, ConvertErrorHandling)

ObjectValueConversion.AsNullableEnum<TEnum>(Object, Nullable<TEnum>, ConvertErrorHandling)

ObjectValueConversion.AsUri(Object, Uri, ConvertErrorHandling)

JSONExtensions.ToJSON(Object, JSONWritingOptions)

JSONExtensions.ToJSON(Object, TextWriter, JSONWritingOptions)

JSONExtensions.ToJSON(Object, Stream, JSONWritingOptions, Encoding)