PDFEdit_Layer.PDEText (PDFL)

	Typedef
	PDEText A PDEElement representing text. It is a container for text as show strings or as individual characters. Each sub-element may have different graphics state properties. However, the same clip applies to all sub-elements of a PDEText. Also, the charpath of a PDEText can be used to represent a clip.
	PDETextState
	PDETextStateP

	Enumeration
	`PDETextFlags` A bit field used in PDEText methods.
	`PDETextRenderMode` Flags indicating text rendering mode set by the Tr operator.
	`PDETextStateWasSetFlags` A structure describing the text state that was set.

	Structure
	_t_PDETextState Attributes of a PDEText element.

	Method
	void PDETextAdd(INPDEText pdeText, INASUns32 flags, INASInt32 index, INASUns8* text, INASInt32 textLen, INPDEFont font, INPDEGraphicStateP gstateP, INASUns32 gstateLen, INPDETextStateP tstateP, INASUns32 tstateLen, INASFixedMatrixP textMatrixP, INASFixedMatrixP strokeMatrixP) Superseded by PDETextAddEx() in Acrobat 10.0.
	void PDETextAddEx(INPDEText pdeText, INASUns32 flags, INASInt32 index, INASUns8* text, INASInt32 textLen, INPDEFont font, INPDEGraphicStateP gstateP, INASUns32 gstateLen, INPDETextStateP tstateP, INASUns32 tstateLen, INASDoubleMatrixP textMatrixP, INASDoubleMatrixP strokeMatrixP) Supersedes PDETextAdd() in Acrobat 10.0.
	void PDETextAddGlyphs(INPDEText pdeText, INASUns32 flags, INASInt32 index, INPDEGlyphRunP glyphRun, INPDEFont font, INPDEGraphicStateP gstateP, INASUns32 gstateLen, INPDETextStateP tstateP, INASUns32 tstateLen, INASFixedMatrixP textMatrixP, INASFixedMatrixP strokeMatrixP) Superseded by PDETextAddGlyphsEx() in Acrobat 10.0.
	void PDETextAddGlyphsEx(INPDEText pdeText, INASUns32 flags, INASInt32 index, INPDEGlyphRunP glyphRun, INPDEFont font, INPDEGraphicStateP gstateP, INASUns32 gstateLen, INPDETextStateP tstateP, INASUns32 tstateLen, INASDoubleMatrixP textMatrixP, INASDoubleMatrixP strokeMatrixP) Supersedes PDETextAddGlyphs() in Acrobat 10.0.
	void PDETextAddItem(INPDEText text, INASInt32 addIndex, INPDETextItem textItem) Adds a text item to a text element at a given index position.
	PDEText PDETextCreate() Creates an empty text object.
	void PDETextGetAdvance(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTASFixedPointP advanceP) Gets the advance width of a character or a text element. Advance width is returned in either character space or user space. The advance width is the amount by which the current point advances when the character is drawn.
	void PDETextGetAdvanceWidth(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTASFixedPointP advanceP) Gets the advance width of a character or a text element. Advance width is returned in either character space or user space. The advance width is the amount by which the current point advances when the character is drawn.
	void PDETextGetBBox(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTASFixedRectP bboxP) Gets the bounding box of a character or a text run.
	PDEFont PDETextGetFont(INPDEText pdeText, INASUns32 flags, INASInt32 index) Gets the font for a text character or element.
	void PDETextGetGState(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTPDEGraphicStateP stateP, INASUns32 stateSize) Gets the graphics state of a character or a text run.
	void PDETextGetGStateEx(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTPDEGraphicStateExP stateP, INASUns32 stateSize) Gets the graphics state of a character or a text run.
	PDETextItem PDETextGetItem(INPDEText text, INASUns32 index) Obtains a text item from a text element at a given index position.
	void PDETextGetMatrix(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTASFixedMatrixP matrixP) Superseded by PDETextGetMatrixEx() in Acrobat 10.0.
	void PDETextGetMatrixEx(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTASDoubleMatrixP matrixP) Supersedes PDETextGetMatrix() in Acrobat 10.0.
	ASInt32 PDETextGetNumBytes(INPDEText pdeText, INASUns32 flags, INASInt32 index) Gets the number of bytes occupied by the character code or text run.
	ASInt32 PDETextGetNumChars(INPDEText pdeText) Gets the number of characters in a text object.
	ASInt32 PDETextGetNumRuns(INPDEText pdeText) Gets the number of text runs (show strings) in a text object.
	void PDETextGetQuad(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTASFixedQuadP quadP) Gets the quad bounding the specified text run or character.
	ASInt32 PDETextGetRunForChar(INPDEText pdeText, INASInt32 charIndex) Gets the index of the text run that contains the nth character in a text object.
	void PDETextGetState(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTPDETextStateP stateP, INASUns32 stateSize) Returns the text state of a character or a text element.
	void PDETextGetStrokeMatrix(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTASFixedMatrixP matrixP) Superseded by PDETextGetStrokeMatrixEx() in Acrobat 10.0.
	void PDETextGetStrokeMatrixEx(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTASDoubleMatrixP matrixP) Supersedes PDETextGetStrokeMatrix() in Acrobat 10.0.
	ASInt32 PDETextGetText(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTASUns8* textBuffer) Gets the text for a text run or character.
	void PDETextGetTextMatrix(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTASFixedMatrixP matrixP) Superseded by PDETextGetTextMatrixEx() in Acrobat 10.0.
	void PDETextGetTextMatrixEx(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTASDoubleMatrixP matrixP) Supersedes PDETextGetTextMatrix() in Acrobat 10.0.
	void PDETextGetTextState(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTPDETextStateP stateP, INASUns32 stateSize) Gets the text state of a character or a text element.
	ASBool PDETextIsAtPoint(INPDEText pdeText, INASUns32 flags, INASInt32 index, INASFixedPoint point) Tests whether a point is on specified text. It checks if the point is in a bounding box for the PDEText.
	ASBool PDETextIsAtRect(INPDEText pdeText, INASUns32 flags, INASInt32 index, INASFixedRect rect) Tests whether any part of a rectangle is on the specified text.
	void PDETextRemove(INPDEText pdeText, INASUns32 flags, INASInt32 index, INASInt32 count) Removes characters or text runs from a text object.
	void PDETextRemoveItems(INPDEText text, INASUns32 index, INASUns32 count) Removes contiguous text items from a text element starting at a given index position.
	void PDETextReplaceChars(INPDEText pdeText, INASUns32 flags, INASInt32 index, INASUns8* textBuffer, INASInt32 numChars) Replaces characters in a text object.
	ASInt32 PDETextRunGetCharOffset(INPDEText pdeText, INASInt32 runIndex) Gets the character offset of the first character of the specified text run.
	ASInt32 PDETextRunGetNumChars(INPDEText pdeText, INASInt32 runIndex) Gets the number of characters in a text run.
	void PDETextRunSetFont(INPDEText pdeText, INASInt32 runIndex, INPDEFont font) Sets the font of a text run.
	void PDETextRunSetGState(INPDEText pdeText, INASInt32 runIndex, INPDEGraphicStateP stateP, INASUns32 stateSize) Sets the graphics state of a text run.
	void PDETextRunSetGStateEx(INPDEText pdeText, INASInt32 runIndex, INPDEGraphicStateExP stateP, INASUns32 stateSize) Sets the graphics state of a text run.
	void PDETextRunSetMatrix(INPDEText pdeText, INASInt32 runIndex, INASFixedMatrixP matrixP) Superseded by PDETextRunSetMatrixEx() in Acrobat 10.0.
	void PDETextRunSetMatrixEx(INPDEText pdeText, INASInt32 runIndex, INASDoubleMatrixP matrixP) Supersedes PDETextRunSetMatrix() in Acrobat 10.0.
	void PDETextRunSetState(INPDEText pdeText, INASInt32 runIndex, INPDETextStateP stateP, INASUns32 stateSize) Sets the text state of a text run.
	void PDETextRunSetStrokeMatrix(INPDEText pdeText, INASInt32 runIndex, INASFixedMatrixP matrixP) Superseded by PDETextRunSetStrokeMatrixEx() in Acrobat 10.0.
	void PDETextRunSetStrokeMatrixEx(INPDEText pdeText, INASInt32 runIndex, INASDoubleMatrixP matrixP) Supersedes PDETextRunSetStrokeMatrix() in Acrobat 10.0.
	void PDETextRunSetTextMatrix(INPDEText pdeText, INASInt32 runIndex, INASFixedMatrixP matrixP) Superseded by PDETextRunSetTextMatrixEx() in Acrobat 10.0.
	void PDETextRunSetTextMatrixEx(INPDEText pdeText, INASInt32 runIndex, INASDoubleMatrixP matrixP) Supersedes PDETextRunSetTextMatrix() in Acrobat 10.0.
	void PDETextRunSetTextState(INPDEText pdeText, INASInt32 runIndex, INPDETextStateP stateP, INASUns32 stateSize) Sets the text state of a text run.
	void PDETextSplitRunAt(INPDEText pdeText, INASInt32 splitLoc) Splits a text run into two text runs.

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_PDEText* PDEText;

A PDEElement representing text. It is a container for text as show strings or as individual characters. Each sub-element may have different graphics state properties. However, the same clip applies to all sub-elements of a PDEText. Also, the charpath of a PDEText can be used to represent a clip.

See Also

PDEElement (superclass)
PDETextCreate
PDERelease

Examples

PDEText pdeText = NULL;

PDEText pdeText = NULL; /* container for text */

PDEText pdeText; // container for text

more...

File: PEExpT.h

Line: 163

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDETextState PDETextState;

File: PEExpT.h

Line: 841

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDETextState PDETextStateP;

File: PEExpT.h

Line: 841

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDETextFlags {

  kPDETextRun = 0x0001,


 


  kPDETextChar = 0x0002,


 


  kPDETextPageSpace = 0x0004,


 


  kPDETextGetBounds = 0x0008

}

File: PEExpT.h

Line: 1656

Elements

	kPDETextRun	Text run.

	kPDETextChar	Character (text run with only one character).

	kPDETextPageSpace	Obtain the advance width in page space.

	kPDETextGetBounds	Fill in the left and right bounds of the text run's bounding box.

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDETextRenderMode {

  kPDETextFill,


 


  kPDETextStroke,


 


  kPDETextFillAndStroke,


 


  kPDETextInvisible

}

See Also

PDETextCreate

File: PEExpT.h

Line: 1675

Elements

	kPDETextFill	Fill text.

	kPDETextStroke	Stroke text.

	kPDETextFillAndStroke	Fill and stroke text.

	kPDETextInvisible	Text with no fill and no stroke (invisible).

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDETextStateWasSetFlags {

  kPDECharSpacingWasSet = 0x0001,


 


  kPDEWordSpacingWasSet = 0x0002,


 


  kPDERenderModeWasSet = 0x0004,


 


  kPDEFontSizeWasSet = 0x0008,


 


  kPDEHScaleWasSet = 0x0010,


 


  kPDETextRiseWasSet = 0x0020

}

File: PEExpT.h

Line: 631

Elements

	kPDECharSpacingWasSet	Character spacing was set corresponding to the Tc operator.

	kPDEWordSpacingWasSet	Word spacing was set corresponding to the Tw operator.

	kPDERenderModeWasSet	Text rendering mode was set corresponding to the Tr operator.

	kPDEFontSizeWasSet	TBD

	kPDEHScaleWasSet	TBD

	kPDETextRiseWasSet	TBD

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDETextState {

  ASUns32 wasSetFlags;  


 


  ASFixed charSpacing;  


 


  ASFixed wordSpacing;  


 


  ASInt32 renderMode;  


 


  ASFixed fontSize;  


 


  ASFixed hScale;  


 


  ASFixed textRise;  

}

Attributes of a PDEText element.

File: PEExpT.h

Line: 808

Elements

	wasSetFlags	PDETextStateWasSetFlags indicates whether an attribute has been set.

	charSpacing	Character spacing was set corresponding to the Tc operator.

	wordSpacing	Word spacing corresponding to the Tw operator.

	renderMode	Text rendering mode corresponding to the Tr operator.

	fontSize	Default is `1`.

	hScale	Default is `100` (meaning 100%).

	textRise	Specifies the distance, in text space units that are not scaled, to move the baseline up or down from its default location. See Section 5.2.6 in the PDF Reference.

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextAdd(INPDEText pdeText, INASUns32 flags, INASInt32 index, INASUns8* text, INASInt32 textLen, INPDEFont font, INPDEGraphicStateP gstateP, INASUns32 gstateLen, INPDETextStateP tstateP, INASUns32 tstateLen, INASFixedMatrixP textMatrixP, INASFixedMatrixP strokeMatrixP)

Superseded by PDETextAddEx() in Acrobat 10.0.

Adds a character or a text run to a PDEThe text object.

Parameters

pdeText —

The text object to which a character or text run is added.

flags —

A PDETextFlags that specifies what kind of text to add. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

index —

The index after which to add the character or text run.

text —

A pointer to the characters to add. Note that passing NULL for the text can invalidate the text object, but will not raise an error. Callers must not pass NULL for this parameter.

textLen —

The length of the text in bytes.

font —

The font for the element.

gstateP —

A pointer to a PDEGraphicStateP structure with the graphics state for the element.

gstateLen —

The length of the graphics state for the element.

tstateP —

A pointer to a PDETextState structure with the text state for the element. Note that PDFEdit ignores the wasSetFlags flag of the PDETextState structure, so you must initialize the PDETextState fields.

tstateLen —

The length of the text state for the element.

textMatrixP —

A pointer to an ASFixedMatrix that holds the matrix for the element.

strokeMatrixP —

A pointer to an ASFixedMatrix that holds the matrix for the line width when stroking text. It may be NULL. Note that this field is not currently used (Acrobat 5 and later).

Exceptions

pdErrBadResMetrics
peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00040000

Note

This method does not change the reference count of pdeText; however, the reference count of the objects in the gstateP parameter are incremented.

File: PEWProcs.h

Line: 423

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextAddEx(INPDEText pdeText, INASUns32 flags, INASInt32 index, INASUns8* text, INASInt32 textLen, INPDEFont font, INPDEGraphicStateP gstateP, INASUns32 gstateLen, INPDETextStateP tstateP, INASUns32 tstateLen, INASDoubleMatrixP textMatrixP, INASDoubleMatrixP strokeMatrixP)

Supersedes PDETextAdd() in Acrobat 10.0.

Adds a character or a text run to a PDEThe text object.

Parameters

pdeText —

The text object to which a character or text run is added.

flags —

A PDETextFlags that specifies what kind of text to add. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

index —

The index after which to add the character or text run.

text —

A pointer to the characters to add. Note that passing NULL for the text can invalidate the text object, but will not raise an error. Callers must not pass NULL for this parameter.

textLen —

The length of the text in bytes.

font —

The font for the element.

gstateP —

A pointer to a PDEGraphicStateP structure with the graphics state for the element.

gstateLen —

The length of the graphics state for the element.

tstateP —

A pointer to a PDETextState structure with the text state for the element. Note that PDFEdit ignores the wasSetFlags flag of the PDETextState structure, so you must initialize the PDETextState fields.

tstateLen —

The length of the text state for the element.

textMatrixP —

A pointer to an ASDoubleMatrix that holds the matrix for the element.

strokeMatrixP —

A pointer to an ASDoubleMatrix that holds the matrix for the line width when stroking text. It may be NULL. Note that this field is not currently used (Acrobat 5 and later).

Exceptions

pdErrBadResMetrics
peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_WRITE_VERSION >= 0x000A0000

Note

This method does not change the reference count of pdeText; however, the reference count of the objects in the gstateP parameter are incremented.

Examples

PDETextAddEx(pdeText, /* add text: font name */

PDETextAddEx(pdeText, /* add text: font type */

PDETextAddEx(pdeText, /* add text: font char set */

more...

File: PEWProcs.h

Line: 4072

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextAddGlyphs(INPDEText pdeText, INASUns32 flags, INASInt32 index, INPDEGlyphRunP glyphRun, INPDEFont font, INPDEGraphicStateP gstateP, INASUns32 gstateLen, INPDETextStateP tstateP, INASUns32 tstateLen, INASFixedMatrixP textMatrixP, INASFixedMatrixP strokeMatrixP)

Superseded by PDETextAddGlyphsEx() in Acrobat 10.0.

Adds Unicode text to a PDEText object.

Parameters

pdeText —

The text object to which a character or text run is added.

flags —

A PDETextFlags that specifies what kind of text to add. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

index —

The index after which to add the character or text run.

glyphRun —

A pointer to a PDEGlyphRun structure with Unicode data, GlyphIDs and their correspondence.

font —

The font for the element.

gstateP —

A pointer to a PDEGraphicStateP structure with the graphics state for the element.

gstateLen —

The length of the graphics state for the element.

tstateP —

A pointer to a PDETextState structure with text state for the element. Note that PDFEdit ignores the wasSetFlags flag of the PDETextState structure, so you must initialize the PDETextState fields.

tstateLen —

The length of the text state for the element.

textMatrixP —

A pointer to an ASFixedMatrix that holds the matrix for the element.

strokeMatrixP —

A pointer to an ASFixedMatrix that holds the matrix for the line width when stroking text. It may be NULL. Note that, currently, this field is not used. (Acrobat 5)

See Also

PDETextAdd
PDETextAddGlyphsEx

Exceptions

pdErrBadResMetrics
peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00070000

Note

This method does not change the reference count of pdeText; however, the reference count of the objects in the gstateP parameter are incremented.

File: PEWProcs.h

Line: 2932

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextAddGlyphsEx(INPDEText pdeText, INASUns32 flags, INASInt32 index, INPDEGlyphRunP glyphRun, INPDEFont font, INPDEGraphicStateP gstateP, INASUns32 gstateLen, INPDETextStateP tstateP, INASUns32 tstateLen, INASDoubleMatrixP textMatrixP, INASDoubleMatrixP strokeMatrixP)

Supersedes PDETextAddGlyphs() in Acrobat 10.0.

Adds Unicode text to a PDEText object.

Parameters

pdeText —

The text object to which a character or text run is added.

flags —

A PDETextFlags that specifies what kind of text to add. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

index —

The index after which to add the character or text run.

glyphRun —

A pointer to a PDEGlyphRun structure with Unicode data, GlyphIDs and their correspondence.

font —

The font for the element.

gstateP —

A pointer to a PDEGraphicStateP structure with the graphics state for the element.

gstateLen —

The length of the graphics state for the element.

tstateP —

A pointer to a PDETextState structure with text state for the element. Note that PDFEdit ignores the wasSetFlags flag of the PDETextState structure, so you must initialize the PDETextState fields.

tstateLen —

The length of the text state for the element.

textMatrixP —

A pointer to an ASDoubleMatrix that holds the matrix for the element.

strokeMatrixP —

A pointer to an ASDoubleMatrix that holds the matrix for the line width when stroking text. It may be NULL. Note that, currently, this field is not used. (Acrobat 5)

See Also

PDETextAddEx
PDETextAddGlyphs

Exceptions

pdErrBadResMetrics
peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_WRITE_VERSION >= 0x000A0000

Note

This method does not change the reference count of pdeText; however, the reference count of the objects in the gstateP parameter are incremented.

File: PEWProcs.h

Line: 4007

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextAddItem(INPDEText text, INASInt32 addIndex, INPDETextItem textItem)

Adds a text item to a text element at a given index position.

Parameters

	`text` —	The text object to which the text item is added.

	`addIndex` —	The index of the text item in `pdeText`.

	`textItem` —	The text item to add.

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00060000

File: PEWProcs.h

Line: 2824

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





PDEText PDETextCreate()

Creates an empty text object.

Call PDERelease() to dispose of the returned text object when finished with it.

Returns

An empty text object.

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00040000

Examples

pdeText = PDETextCreate();

pdeText = PDETextCreate(); /* create new text run */

pdeText = PDETextCreate(); // create new text run

more...

File: PEWProcs.h

Line: 474

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextGetAdvance(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTASFixedPointP advanceP)

Gets the advance width of a character or a text element. Advance width is returned in either character space or user space. The advance width is the amount by which the current point advances when the character is drawn.

Advance width may be horizontal or vertical, depending on the writing style. Thus advanceP has both a horizontal and vertical component.

Parameters

pdeText —

A text object containing a character or text run whose advance width is found.

flags —

A PDETextFlags value that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

In addition, set the kPDETextPageSpace flag to obtain the advance width in user space. If it is not set, the advance width is in character space. If this flag is not set, this method returns a value that is independent of any sizes, matrices, or scaling, simply adding up the font's raw glyph widths, supplemented only by unscaled character and word spacing. This differs from the behavior of the older function, PDETextGetAdvanceWidth().

index —

The index of the character or text run in pdeText.

advanceP —

(Filled by the method) A pointer to a ASFixedPoint value indicating the advance width.

See Also

PDETextGetAdvanceWidth

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

File: PERProcs.h

Line: 2774

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextGetAdvanceWidth(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTASFixedPointP advanceP)

Gets the advance width of a character or a text element. Advance width is returned in either character space or user space. The advance width is the amount by which the current point advances when the character is drawn.

Advance width may be horizontal or vertical, depending on the writing style. Thus advanceP has both a horizontal and vertical component.

Parameters

pdeText —

A text object containing a character or text run whose advance width is found.

flags —

A PDETextFlags value that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

In addition, set the kPDETextPageSpace flag to obtain the advance width in user space. If it is not set, the advance width is in character space.

index —

The index of the character or text run in pdeText.

advanceP —

(Filled by the method) A pointer to a ASFixedPoint value indicating the advance width.

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

File: PERProcs.h

Line: 663

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextGetBBox(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTASFixedRectP bboxP)

Gets the bounding box of a character or a text run.

Parameters

pdeText —

IN/OUT A text object containing a character or text run whose bounding box is found.

flags —

IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

index —

IN/OUT The index of the character or text run in pdeText.

bboxP —

IN/OUT (Filled by the method) A pointer to ASFixedRect to set to the bounding box of specified character or text run.

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

Examples

PDETextGetBBox( pdeText, kPDETextRun, 0, &bbox );

File: PERProcs.h

Line: 438

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





PDEFont PDETextGetFont(INPDEText pdeText, INASUns32 flags, INASInt32 index)

Gets the font for a text character or element.

Parameters

pdeText —

IN/OUT A text object containing a character or text run whose font is found.

flags —

IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

index —

IN/OUT The index of the character or text run in pdeText.

Returns

The font of the specified character or text run.

See Also

PDETextRunSetFont

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

Note

This method does not change the reference count of the returned PDEFont.

File: PERProcs.h

Line: 547

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextGetGState(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTPDEGraphicStateP stateP, INASUns32 stateSize)

Gets the graphics state of a character or a text run.

Parameters

pdeText —

A text object containing a character or text run whose graphics state is found.

flags —

A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

index —

The index of the character or text run in pdeText.

stateP —

(Filled by the method) A pointer to a PDEGraphicState structure with the graphics state of the specified character or text run.

stateSize —

The size of the stateP buffer in bytes.

See Also

PDETextRunSetGState
PDETextGetGStateEx

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

Note

This method does not increment the reference count of the objects in stateP.

File: PERProcs.h

Line: 475

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextGetGStateEx(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTPDEGraphicStateExP stateP, INASUns32 stateSize)

Gets the graphics state of a character or a text run.

This method fills PDEGraphicStateEx as output which is higher precision alternative of PDEGraphicState structure.

Parameters

pdeText —

A text object containing a character or text run whose graphics state is found.

flags —

A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

index —

The index of the character or text run in pdeText.

stateP —

(Filled by the method) A pointer to a PDEGraphicStateExP structure with the graphics state of the specified character or text run.

stateSize —

The size of the stateP buffer in bytes.

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_READ_VERSION >= 0x000B0000

Note

This method does not increment the reference count of the objects in stateP.

File: PERProcs.h

Line: 3651

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





PDETextItem PDETextGetItem(INPDEText text, INASUns32 index)

Obtains a text item from a text element at a given index position.

Parameters

	`text` —	Text object from which the text item is obtained.

	`index` —	The index of the text item in `pdeText`.

Returns

The text item object.

See Also

PDETextAddItem
PDETextItemCreate

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_READ_VERSION >= 0x00060000

File: PERProcs.h

Line: 2905

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextGetMatrix(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTASFixedMatrixP matrixP)

Superseded by PDETextGetMatrixEx() in Acrobat 10.0.

Returns the matrix of a character or a text element. Unlike PDETextGetTextMatrix(), this function does not take fontSize, hScale, and textRise in the textState into account.

Parameters

pdeText —

IN/OUT A text object containing a character or text run whose graphics state is found.

flags —

IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

index —

IN/OUT The index of the character or text run in pdeText.

matrixP —

IN/OUT (Filled by the method) An ASFixedMatrixP that holds the matrix of the specified character or text run.

See Also

PDETextGetTextMatrix
PDETextGetMatrixEx

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_READ_VERSION >= 0x00050000

File: PERProcs.h

Line: 2581

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextGetMatrixEx(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTASDoubleMatrixP matrixP)

Supersedes PDETextGetMatrix() in Acrobat 10.0.

Returns the matrix of a character or a text element. Unlike PDETextGetTextMatrixEx(), this function does not take fontSize, hScale, and textRise in the textState into account.

Parameters

pdeText —

IN/OUT A text object containing a character or text run whose graphics state is found.

flags —

IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

index —

IN/OUT The index of the character or text run in pdeText.

matrixP —

IN/OUT (Filled by the method) An ASDoubleMatrixP that holds the matrix of the specified character or text run.

See Also

PDETextGetTextMatrixEx
PDETextGetMatrix

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_READ_VERSION >= 0x000A0000

File: PERProcs.h

Line: 3504

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 PDETextGetNumBytes(INPDEText pdeText, INASUns32 flags, INASInt32 index)

Gets the number of bytes occupied by the character code or text run.

Parameters

pdeText —

IN/OUT A PDEText object returned from one of the PDETextCreate methods whose text is examined.

flags —

IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

index —

IN/OUT The index of the character or text run in pdeText.

Returns

The number of bytes occupied by the text run or character.

See Also

PDEFontGetNumCodeBytes

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

File: PERProcs.h

Line: 1795

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 PDETextGetNumChars(INPDEText pdeText)

Gets the number of characters in a text object.

Parameters

pdeText —

IN/OUT A text object whose number of characters is found.

Returns

The total number of characters in pdeText.

See Also

PDETextGetNumRuns
PDETextGetRunForChar

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

File: PERProcs.h

Line: 334

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 PDETextGetNumRuns(INPDEText pdeText)

Gets the number of text runs (show strings) in a text object.

Parameters

pdeText —

IN/OUT A text object whose number of text runs is found.

Returns

The number of text runs in pdeText.

See Also

PDETextGetNumBytes
PDETextGetRunForChar

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

File: PERProcs.h

Line: 349

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextGetQuad(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTASFixedQuadP quadP)

Gets the quad bounding the specified text run or character.

The advance portion of the quad is based on the left side bearing and advance width.

Parameters

pdeText —

IN/OUT A text object containing a character or text run whose quad is found.

flags —

IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object.

It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

In addition, if the kPDETextBounding flag is set, PDETextGetQuad() uses the font descriptor's FontBBox, which is the smallest rectangle that encloses all characters in the font. The advance portion is based on the x-coordinates of the left and right sides of FontBBox and the advance width.

index —

IN/OUT The index of the character or text run in pdeText.

quadP —

IN/OUT (Filled by the method) A pointer to ASFixedQuad that bounds the specified character or text run.

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

File: PERProcs.h

Line: 1506

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 PDETextGetRunForChar(INPDEText pdeText, INASInt32 charIndex)

Gets the index of the text run that contains the nth character in a text object.

Parameters

	`pdeText` —	IN/OUT A text object to examine.

	`charIndex` —	IN/OUT The number of the character to find in `pdeText`.

Returns

The index of the text run with the specified character index into pdeText.

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

File: PERProcs.h

Line: 387

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextGetState(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTPDETextStateP stateP, INASUns32 stateSize)

Returns the text state of a character or a text element.

Parameters

pdeText —

IN/OUT A text object containing a character or text run whose text state is found.

flags —

IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

index —

IN/OUT The index of the character or text run in pdeText.

stateP —

IN/OUT (Filled by the method) A pointer to a PDETextState structure to fill with the text state of the specified character or text run.

stateSize —

IN/OUT The size of the stateP buffer in bytes.

Exceptions

genErrBadParm
peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00050000

File: PERProcs.h

Line: 2469

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextGetStrokeMatrix(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTASFixedMatrixP matrixP)

Superseded by PDETextGetStrokeMatrixEx() in Acrobat 10.0.

Gets the stroke matrix of a character or a text run.

Parameters

pdeText —

A text object containing a character or text run whose stroke matrix is found.

flags —

A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

index —

The index of the character or text run in pdeText.

matrixP —

(Filled by the method) A pointer to ASFixedMatrix that holds the stroke matrix of the specified character or text run. This matrix is the transformation for line widths when stroking. The h and v values of the matrix are ignored.

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

Note

Currently this method returns no valid information (Acrobat 5 and later).

File: PERProcs.h

Line: 622

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextGetStrokeMatrixEx(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTASDoubleMatrixP matrixP)

Supersedes PDETextGetStrokeMatrix() in Acrobat 10.0.

Gets the stroke matrix of a character or a text run.

Parameters

pdeText —

A text object containing a character or text run whose stroke matrix is found.

flags —

A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

index —

The index of the character or text run in pdeText.

matrixP —

(Filled by the method) A pointer to ASDoubleMatrix that holds the stroke matrix of the specified character or text run. This matrix is the transformation for line widths when stroking. The h and v values of the matrix are ignored.

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_READ_VERSION >= 0x000A0000

Note

Currently this method returns no valid information (Acrobat 5 and later).

File: PERProcs.h

Line: 3428

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 PDETextGetText(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTASUns8* textBuffer)

Gets the text for a text run or character.

Parameters

pdeText —

IN/OUT A text object containing a character or text run whose text is found.

flags —

IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

index —

IN/OUT The index of the character or text run in pdeText.

textBuffer —

IN/OUT (Filled by the method) The text of the specified character or text run. textBuffer must be large enough to hold the returned text. If textBuffer is NULL, it returns the number of bytes required to hold the data.

Returns

The number of bytes in the text run or character.

Exceptions

genErrBadParm
peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

File: PERProcs.h

Line: 698

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextGetTextMatrix(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTASFixedMatrixP matrixP)

Superseded by PDETextGetTextMatrixEx() in Acrobat 10.0.

Gets the matrix of a character or a text run.

Parameters

pdeText —

A text object containing a character or text run whose matrix is found.

flags —

A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

index —

The index of the character or text run in pdeText.

matrixP —

(Filled by the method) A pointer to ASFixedMatrix that holds the matrix of the specified character or text run. This is the transformation matrix from user space to the current text space. The h and v values of the matrix indicate the origin of the first character.

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

File: PERProcs.h

Line: 585

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextGetTextMatrixEx(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTASDoubleMatrixP matrixP)

Supersedes PDETextGetTextMatrix() in Acrobat 10.0.

Gets the matrix of a character or a text run.

Parameters

pdeText —

A text object containing a character or text run whose matrix is found.

flags —

A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

index —

The index of the character or text run in pdeText.

matrixP —

(Filled by the method) A pointer to ASDoubleMatrix that holds the matrix of the specified character or text run. This is the transformation matrix from user space to the current text space. The h and v values of the matrix indicate the origin of the first character.

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_READ_VERSION >= 0x000A0000

File: PERProcs.h

Line: 3391

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextGetTextState(INPDEText pdeText, INASUns32 flags, INASInt32 index, OUTPDETextStateP stateP, INASUns32 stateSize)

Gets the text state of a character or a text element.

Parameters

pdeText —

IN/OUT A text object containing a character or text run whose text state is found.

flags —

IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

index —

IN/OUT The index of the character or text run in pdeText.

stateP —

IN/OUT (Filled by the method) A pointer to a PDETextState structure to fill with the text state of the specified character or text run.

stateSize —

IN/OUT The size of the stateP buffer in bytes.

See Also

PDETextGetState
PDETextRunSetTextState

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

Note

This function handles only charSpacing, wordSpacing, and renderMode for backward compatibility. For all attributes, use PDETextGetState() instead.

File: PERProcs.h

Line: 514

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool PDETextIsAtPoint(INPDEText pdeText, INASUns32 flags, INASInt32 index, INASFixedPoint point)

Tests whether a point is on specified text. It checks if the point is in a bounding box for the PDEText.

Parameters

pdeText —

IN/OUT The text to test.

flags —

IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

index —

IN/OUT The index of the character or text run in pdeText.

point —

IN/OUT The point, specified in user space coordinates.

Returns

true if the point is on the text, false otherwise.

See Also

PDEElementIsAtPoint
PDEElementIsAtRect

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

File: PERProcs.h

Line: 1918

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool PDETextIsAtRect(INPDEText pdeText, INASUns32 flags, INASInt32 index, INASFixedRect rect)

Tests whether any part of a rectangle is on the specified text.

Parameters

pdeText —

IN/OUT The text to test.

flags —

IN/OUT A PDETextFlags flag that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

index —

IN/OUT The index of the character or text run in pdeText.

rect —

IN/OUT The rectangle, specified in user space coordinates.

Returns

true if the text is on the rectangle, false otherwise.

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

File: PERProcs.h

Line: 1950

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextRemove(INPDEText pdeText, INASUns32 flags, INASInt32 index, INASInt32 count)

Removes characters or text runs from a text object.

Parameters

pdeText —

IN/OUT The text object from which text is removed.

flags —

IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

index —

IN/OUT The index of the character or text run in pdeText.

count —

IN/OUT The number of characters or text runs to remove.

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00040000

Note

This method decrements the reference count of objects associated with the pdeText in the graphic state and font.

File: PEWProcs.h

Line: 461

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextRemoveItems(INPDEText text, INASUns32 index, INASUns32 count)

Removes contiguous text items from a text element starting at a given index position.

Parameters

	`text` —	The text object from which the text items are removed.

	`index` —	The index of the first text item in `pdeText` to remove.

	`count` —	The number of text items to remove.

See Also

PDETextAddItem
PDETextGetItem

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00060000

File: PEWProcs.h

Line: 2844

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextReplaceChars(INPDEText pdeText, INASUns32 flags, INASInt32 index, INASUns8* textBuffer, INASInt32 numChars)

Replaces characters in a text object.

This method does not change the number of characters in the text object; extra characters are ignored.

Parameters

pdeText —

IN/OUT The text object in which characters are replaced.

flags —

IN/OUT A PDETextFlags that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. It must be one of the following values:

Value	Description
kPDETextChar	Used for a text character.
kPDETextRun	Used for a text run.

index —

IN/OUT The index of the character or text run in pdeText.

textBuffer —

IN/OUT Replacement text.

numChars —

IN/OUT The number of bytes to replace.

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00040000

File: PEWProcs.h

Line: 1443

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 PDETextRunGetCharOffset(INPDEText pdeText, INASInt32 runIndex)

Gets the character offset of the first character of the specified text run.

Parameters

	`pdeText` —	IN/OUT A text object containing a character or text run whose graphics state is found.

	`runIndex` —	IN/OUT The index of the text run whose first character's index is returned.

Returns

The character offset of the first character of the specified text run in pdeText.

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

File: PERProcs.h

Line: 370

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 PDETextRunGetNumChars(INPDEText pdeText, INASInt32 runIndex)

Gets the number of characters in a text run.

Parameters

	`pdeText` —	IN/OUT A text object containing a text run whose number of characters is found.

	`runIndex` —	IN/OUT The index of the text run whose number of characters is returned.

Returns

The number of characters in the specified text run.

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_READ_VERSION >= 0x00040000

File: PERProcs.h

Line: 406

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextRunSetFont(INPDEText pdeText, INASInt32 runIndex, INPDEFont font)

Sets the font of a text run.

Parameters

	`pdeText` —	IN/OUT The text object containing a text run whose font is set.

	`runIndex` —	IN/OUT The index of the text run.

	`font` —	IN/OUT The font set for the text run.

See Also

PDETextGetFont

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00040000

Note

This method decrements the reference count of the previous font and increments the reference count of the new font.

File: PEWProcs.h

Line: 315

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextRunSetGState(INPDEText pdeText, INASInt32 runIndex, INPDEGraphicStateP stateP, INASUns32 stateSize)

Sets the graphics state of a text run.

Parameters

	`pdeText` —	The text object containing a text run whose graphics state is set.

	`runIndex` —	The index of the text run.

	`stateP` —	A pointer to a PDEGraphicState structure with the graphics state to set.

	`stateSize` —	The size of the `stateP` buffer in bytes.

See Also

PDETextGetGState
PDETextRunSetGStateEx

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00040000

Note

This method increments the reference count of objects in stateP.

File: PEWProcs.h

Line: 265

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextRunSetGStateEx(INPDEText pdeText, INASInt32 runIndex, INPDEGraphicStateExP stateP, INASUns32 stateSize)

Sets the graphics state of a text run.

This method takes pointer to PDEGraphicStateEx as input which is higher precision alternative of PDEGraphicState structure.

Parameters

	`pdeText` —	The text object containing a text run whose graphics state is set.

	`runIndex` —	The index of the text run.

	`stateP` —	A pointer to a PDEGraphicStateEx structure with the graphics state to set.

	`stateSize` —	The size of the `stateP` buffer in bytes.

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_WRITE_VERSION >= 0x000B0000

Note

This method increments the reference count of objects in stateP.

File: PEWProcs.h

Line: 4247

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextRunSetMatrix(INPDEText pdeText, INASInt32 runIndex, INASFixedMatrixP matrixP)

Superseded by PDETextRunSetMatrixEx() in Acrobat 10.0.

Sets the matrix of a text run. Unlike PDETextRunSetTextMatrix(), this function does not change fontSize, hScale, and textRise in the textState of PDEText.

Parameters

	`pdeText` —	IN/OUT The text object containing a text run.

	`runIndex` —	IN/OUT The index of the text run.

	`matrixP` —	IN/OUT ASFixedMatrixP pointer.

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00050000

File: PEWProcs.h

Line: 2512

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextRunSetMatrixEx(INPDEText pdeText, INASInt32 runIndex, INASDoubleMatrixP matrixP)

Supersedes PDETextRunSetMatrix() in Acrobat 10.0.

Sets the matrix of a text run. Unlike PDETextRunSetTextMatrixEx(), this function does not change fontSize, hScale, and textRise in the textState of PDEText.

Parameters

	`pdeText` —	IN/OUT The text object containing a text run.

	`runIndex` —	IN/OUT The index of the text run.

	`matrixP` —	IN/OUT ASDoubleMatrixP pointer.

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_WRITE_VERSION >= 0x000A0000

File: PEWProcs.h

Line: 4146

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextRunSetState(INPDEText pdeText, INASInt32 runIndex, INPDETextStateP stateP, INASUns32 stateSize)

Sets the text state of a text run.

Parameters

	`pdeText` —	The text object containing a text run whose state is set.

	`runIndex` —	The index of the text run.

	`stateP` —	A pointer to a PDETextState structure with the state to set.

	`stateSize` —	The size of the `stateP` buffer in bytes.

See Also

PDETextRunSetTextState

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00050000

File: PEWProcs.h

Line: 2303

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextRunSetStrokeMatrix(INPDEText pdeText, INASInt32 runIndex, INASFixedMatrixP matrixP)

Superseded by PDETextRunSetStrokeMatrixEx() in Acrobat 10.0.

Sets the stroke matrix of a text run.

Parameters

	`pdeText` —	The text object containing a text run whose stroke matrix is set.

	`runIndex` —	The index of the text run.

	`matrixP` —	A pointer to an ASFixedMatrix that holds the stroke matrix.

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00040000

Note

Currently this method is not implemented (Acrobat 5 and later).

File: PEWProcs.h

Line: 359

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextRunSetStrokeMatrixEx(INPDEText pdeText, INASInt32 runIndex, INASDoubleMatrixP matrixP)

Supersedes PDETextRunSetStrokeMatrix() in Acrobat 10.0.

Sets the stroke matrix of a text run.

Parameters

	`pdeText` —	The text object containing a text run whose stroke matrix is set.

	`runIndex` —	The index of the text run.

	`matrixP` —	A pointer to an ASDoubleMatrix that holds the stroke matrix.

See Also

PDETextGetStrokeMatrixEx

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_WRITE_VERSION >= 0x000A0000

Note

Currently this method is not implemented (Acrobat 10 and later).

File: PEWProcs.h

Line: 3854

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextRunSetTextMatrix(INPDEText pdeText, INASInt32 runIndex, INASFixedMatrixP matrixP)

Superseded by PDETextRunSetTextMatrixEx() in Acrobat 10.0.

Sets the text matrix of a text run.

Parameters

	`pdeText` —	IN/OUT The text object containing a text run whose text matrix is set.

	`runIndex` —	IN/OUT The index of the text run.

	`matrixP` —	IN/OUT A pointer to an ASFixedMatrix that holds the text matrix.

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00040000

File: PEWProcs.h

Line: 337

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextRunSetTextMatrixEx(INPDEText pdeText, INASInt32 runIndex, INASDoubleMatrixP matrixP)

Supersedes PDETextRunSetTextMatrix() in Acrobat 10.0.

Sets the text matrix of a text run.

Parameters

	`pdeText` —	IN/OUT The text object containing a text run whose text matrix is set.

	`runIndex` —	IN/OUT The index of the text run.

	`matrixP` —	IN/OUT A pointer to an ASDoubleMatrix that holds the text matrix.

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_WRITE_VERSION >= 0x000A0000

File: PEWProcs.h

Line: 3832

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextRunSetTextState(INPDEText pdeText, INASInt32 runIndex, INPDETextStateP stateP, INASUns32 stateSize)

Sets the text state of a text run.

Parameters

	`pdeText` —	The text object containing a text run whose text state is set.

	`runIndex` —	The index of the text run.

	`stateP` —	A pointer to a PDETextState structure with text state.

	`stateSize` —	The size of the `stateP` buffer in bytes.

See Also

PDETextGetTextState
PDETextRunSetState

Exceptions

peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00040000

Note

This method has the following side effect (Acrobat 5 and later): It modifies the text matrix of the run. In order to maintain backward compatibility, this method only directly operates on the first four fields of PDETextState. When it is called, it calculates a new text matrix with three additional fields: fontSize, hScale, and textRise (see PDETextState). To avoid this behavior, use PDETextRunSetState() instead (which was added to address this problem).

File: PEWProcs.h

Line: 294

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextSplitRunAt(INPDEText pdeText, INASInt32 splitLoc)

Splits a text run into two text runs.

Parameters

	`pdeText` —	The text object containing a text run to split.

	`splitLoc` —	The split location, relative to the text object. The first text run is from character index `0` up to `splitLoc`. The second text run is from `splitLoc + 1` to the end of the run.

See Also

PDETextIsAtPoint
PDETextReplaceChars

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00040000

File: PEWProcs.h

Line: 1389

Acrobat API Reference	All Layers \| All Objects \| Index \| Samples \| Frames No Frames
PDEText	Typedefs \| Enumerations \| Structures \| Methods

	kPDETextRun = 0x0001,

	kPDETextChar = 0x0002,

	kPDETextPageSpace = 0x0004,

	kPDETextGetBounds = 0x0008

	kPDETextFill,

	kPDETextStroke,

	kPDETextFillAndStroke,

	kPDETextInvisible

	kPDECharSpacingWasSet = 0x0001,

	kPDEWordSpacingWasSet = 0x0002,

	kPDERenderModeWasSet = 0x0004,

	kPDEFontSizeWasSet = 0x0008,

	kPDEHScaleWasSet = 0x0010,

	kPDETextRiseWasSet = 0x0020

	ASUns32 wasSetFlags;

	ASFixed charSpacing;

	ASFixed wordSpacing;

	ASInt32 renderMode;

	ASFixed fontSize;

	ASFixed hScale;

	ASFixed textRise;

Layer	PDFEdit_Layer
Object	PDEText