TextRun Class

class TextRun : Element

Namespace:Datalogics::PDFL

Inherits from:: Element

Detailed Description

Represents one or more contiguous characters in a text object.

All the characters contained within a text run have the same style, color, font, and size.

Referenced by

Text

Uses types

Clip Element ElementCloneFlags Font GraphicState Matrix Rect TextState

Constructor & Destructor Documentation

TextRun(string text, Font font, GraphicState gstate, TextState tstate, Matrix matrix)

Parameters

text: string: The text content for this run.
font: Font: The font to use for rendering the text.
gstate: GraphicState: The graphic state (colors, line width, etc.) for this text run.
tstate: TextState: The text state (character spacing, word spacing, font size, etc.) for this text run.
matrix: Matrix: The transformation matrix positioning this text run in user space.

Creates a new TextRun with the specified text, font, graphic state, text state, and matrix.

Property Documentation

double Advance[get]

Deprecated, use Text.GetAdvanceForTextRun(int textRunIndex) instead. This version does not indicate the direction of the advance width.

The advance width of this run of text, in user space.

The advance width is the amount by which the current point advances when the text run is drawn.

Rect BoundingBox[get]

The bounding box for this element.

The bounding box is a rectangle that is guaranteed to encompass the element, but it is not guaranteed to be the smallest box that could contain the element. For example, if the element is a Path that contains an arc, the bounding box encompasses the bezier control points, and not just the curve itself.

Clip Clip[get, set]

Gets the current Clip for an Element.

Font Font[get, set]

The font used to render this TextRun.

GraphicState GraphicState[get, set]

The graphic state (colors, line width, etc.) of the text run.

May return null if this element does not have a GraphicState.

Matrix Matrix[get, set]

The transformation matrix for the element.

System.Byte[] RawText[get]

The raw, un-interpreted text as character codes of this TextRun.

string Text[get, set]

The Unicode text content of this TextRun.

TextState TextState[get]

The text state parameters (character spacing, word spacing, font size, etc.) of this TextRun.

Member Function Documentation

Element Clone()

Returns:

Element

The copied element.

Makes a copy of the element.

Make a copy of an element to obtain a new element that has a distinct set of attributes.

Note: TextRun objects may not be cloned.

Element Clone(ElementCloneFlags cloneFlags)

Parameters

cloneFlags: ElementCloneFlags: Flags that modify the cloning operation.

Returns:

Element

The copied element.

Makes a copy of the element.

Make a copy of an element to obtain a new element that has a distinct set of attributes.

Note: TextRun objects may not be cloned.

void Dispose()

Returns:

void

void Rotate(double theta)

Parameters

theta: double: The rotation angle in degrees.

Returns:

void

Rotate an element by theta degrees counterclockwise using the matrix [ cos T sin T -sin T cos T 0 0 ].

void Scale(double sx, double sy)

Parameters

sx: double: The horizontal scale factor.
sy: double: The vertical scale factor.

Returns:

void

Scale an element by (sx,sy) units using the matrix [ sx 0 0 sy 0 0 ].

void Translate(double tx, double ty)

Parameters

tx: double: The horizontal translation distance in user space units.
ty: double: The vertical translation distance in user space units.

Returns:

void

Translate an element by (tx,ty) units using the matrix [ 1 0 0 1 tx ty ].