TextRun Class Documentation

classTextRun : 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

Constructor & Destructor Documentation

TextRun

TextRun(TextRunrhs, InternalConstructsignifier)

Parameters

rhs: TextRun
signifier: InternalConstruct

TextRun

TextRun(stringtext, Fontfont, GraphicStategstate, TextStatetstate, Matrixmatrix)

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

Advance

doubleAdvance[get]

BoundingBox

RectBoundingBox[get]

Clip

ClipClip[get, set]

Font

FontFont[get, set]

GraphicState

GraphicStateGraphicState[get, set]

Matrix

MatrixMatrix[get, set]

RawText

System.Byte[]RawText[get]

Text

stringText[get, set]

TextState

TextStateTextState[get]

Member Function Documentation

Clone

ElementClone()

Returns:

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.

Clone

ElementClone(ElementCloneFlagscloneFlags)

Parameters

cloneFlags: ElementCloneFlags

Flags that modify the cloning operation.

Returns:

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.

ConstructorRetrieve

static new static TextRunConstructorRetrieve(System.IntPtrignored)

Parameters

ignored: System.IntPtr

Returns:

new static TextRun

Dispose

voidDispose()

Returns:

void

DisposeChildren

voidDisposeChildren()

Returns:

void

Rotate

voidRotate(doubletheta)

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 ].

Scale

voidScale(doublesx, doublesy)

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 ].

Translate

voidTranslate(doubletx, doublety)

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 ].