PDFEdit_Layer.PDETextItem (Acrobat)

	Typedef
	PDETextItem A reference to a PDETextItem.

	Method
	ASUns32 PDETextItemCopyText(INPDETextItem textItem, OUTASUns8* buffer, INASUns32 bufferSize) Copies the text from a text item element into a character buffer.
	PDETextItem PDETextItemCreate(INASUns8* text, INASUns32 textLen, IN PDEFont font, INPDEGraphicStateP gStateP, INASUns32 gStateLen, INPDETextStateP textStateP, INASUns32 textStateLen, INASFixedMatrix* textMatrixP) Superseded by PDETextItemCreateEx() in Acrobat 10.0.
	PDETextItem PDETextItemCreateEx(INASUns8* text, INASUns32 textLen, IN PDEFont font, INPDEGraphicStateP gStateP, INASUns32 gStateLen, INPDETextStateP textStateP, INASUns32 textStateLen, INASDoubleMatrix* textMatrixP) Supersedes PDETextItemCreate() in Acrobat 10.0.
	PDEFont PDETextItemGetFont(INPDETextItem textItem) Gets the font for a text item.
	void PDETextItemGetGState(INPDETextItem textItem, OUTPDEGraphicStateP stateP, INASUns32 stateSize) Gets the graphics state for a text item.
	ASUns32 PDETextItemGetTextLen(INPDETextItem textItem) Gets the text length for a text item.
	void PDETextItemGetTextMatrix(INPDETextItem textItem, INASUns32 charOffset, OUTASFixedMatrix* textMatrixP) Superseded by PDETextItemGetTextMatrixEx() in Acrobat 10.0.
	void PDETextItemGetTextMatrixEx(INPDETextItem textItem, INASUns32 charOffset, OUTASDoubleMatrix* textMatrixP) Supersedes PDETextItemGetTextMatrix() in Acrobat 10.0.
	void PDETextItemGetTextState(INPDETextItem textItem, OUTPDETextStateP textStateP, INASUns32 textStateSize) Gets the text state of a text item.
	void PDETextItemRemoveChars(INPDETextItem textItem, INASUns32 charOffset, INASUns32 count) Removes contiguous characters from a text item.
	void PDETextItemReplaceChars(INPDETextItem textItem, INASUns32 charIndex, INASUns8* newChar, INASUns32 newCharLen) Replaces characters in a text item.
	void PDETextItemReplaceText(INPDETextItem textItem, INASUns8* newText, INASUns32 newTextLen) Replaces all of the text in a text item.
	void PDETextItemSetFont(INPDETextItem textItem, IN PDEFont font) Sets the font for a text item.
	void PDETextItemSetGState(INPDETextItem textItem, OUTPDEGraphicStateP stateP, INASUns32 stateSize) Sets the graphics state for a text item.
	void PDETextItemSetTextMatrix(INPDETextItem textItem, INASFixedMatrix* textMatrixP) Superseded by PDETextItemSetTextMatrixEx() in Acrobat 10.0.
	void PDETextItemSetTextMatrixEx(INPDETextItem textItem, INASDoubleMatrix* textMatrixP) Supersedes PDETextItemSetTextMatrix() in Acrobat 10.0.
	void PDETextItemSetTextState(INPDETextItem textItem, INPDETextStateP textStateP, INASUns32 textStateSize) Sets the text state for a text item.

Typedefs Detail

PDETextItem

Product availability: All

Platform availability: All

Syntax

typedef struct _t_PDETextItem* PDETextItem;

A reference to a PDETextItem.

File: PEExpT.h

Line: 425

Method Detail

PDETextItemCopyText

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASUns32 PDETextItemCopyText(INPDETextItem textItem, OUTASUns8* buffer, INASUns32 bufferSize)

Copies the text from a text item element into a character buffer.

Parameters

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

	`buffer` —	(Filled by the method) A pointer to a buffer in which to store the copy.

	`bufferSize` —	The length of the text buffer in bytes.

Returns

The length in bytes of textItem.

Exceptions

pdErrBadResMetrics
peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_READ_VERSION >= 0x00060000

File: PERProcs.h

Line: 2864

PDETextItemCreate

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





PDETextItem PDETextItemCreate(INASUns8* text, INASUns32 textLen, IN PDEFont font, INPDEGraphicStateP gStateP, INASUns32 gStateLen, INPDETextStateP textStateP, INASUns32 textStateLen, INASFixedMatrix* textMatrixP)

Superseded by PDETextItemCreateEx() in Acrobat 10.0.

Creates a text item element containing a character or text run, which can be added to a PDEText text object.

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

Parameters

	`text` —	A pointer to the characters to add. Note that passing `NULL` for 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.

	`textStateP` —	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.

	`textStateLen` —	The length of the text state for the element.

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

Returns

Exceptions

pdErrBadResMetrics
peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00060000

File: PEWProcs.h

Line: 2662

PDETextItemCreateEx

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





PDETextItem PDETextItemCreateEx(INASUns8* text, INASUns32 textLen, IN PDEFont font, INPDEGraphicStateP gStateP, INASUns32 gStateLen, INPDETextStateP textStateP, INASUns32 textStateLen, INASDoubleMatrix* textMatrixP)

Supersedes PDETextItemCreate() in Acrobat 10.0.

Creates a text item element containing a character or text run, which can be added to a PDEText text object.

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

Parameters

	`text` —	A pointer to the characters to add. Note that passing `NULL` for 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.

	`textStateP` —	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.

	`textStateLen` —	The length of the text state for the element.

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

Returns

Exceptions

pdErrBadResMetrics
peErrWrongPDEObjectType
genErrBadParm

Since

PI_PDFEDIT_WRITE_VERSION >= 0x000A0000

File: PEWProcs.h

Line: 3915

PDETextItemGetFont

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





PDEFont PDETextItemGetFont(INPDETextItem textItem)

Gets the font for a text item.

Parameters

textItem —

The text item whose font is obtained.

Returns

The font of the specified text item.

See Also

PDETextItemSetFont

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_READ_VERSION >= 0x00060000

File: PERProcs.h

Line: 2787

PDETextItemGetGState

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextItemGetGState(INPDETextItem textItem, OUTPDEGraphicStateP stateP, INASUns32 stateSize)

Gets the graphics state for a text item.

Parameters

	`textItem` —	Text item whose graphic state is obtained.

	`stateP` —	(Filled by the method) A pointer to a PDEGraphicStateP structure with graphics state of the text item.

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

See Also

PDETextItemSetGState

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_READ_VERSION >= 0x00060000

File: PERProcs.h

Line: 2883

PDETextItemGetTextLen

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASUns32 PDETextItemGetTextLen(INPDETextItem textItem)

Gets the text length for a text item.

Parameters

textItem —

The text item whose text length is obtained.

Returns

The text length in bytes.

See Also

PDETextItemCopyText

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_READ_VERSION >= 0x00060000

File: PERProcs.h

Line: 2840

PDETextItemGetTextMatrix

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextItemGetTextMatrix(INPDETextItem textItem, INASUns32 charOffset, OUTASFixedMatrix* textMatrixP)

Superseded by PDETextItemGetTextMatrixEx() in Acrobat 10.0.

Gets the text matrix for a character in a text item.

Parameters

	`textItem` —	The text item.

	`charOffset` —	The offset of the character whose text matrix is obtained.

	`textMatrixP` —	(Filled by the method) A pointer to a ASFixedMatrix structure with the text matrix of the character.

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_READ_VERSION >= 0x00060000

File: PERProcs.h

Line: 2808

PDETextItemGetTextMatrixEx

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextItemGetTextMatrixEx(INPDETextItem textItem, INASUns32 charOffset, OUTASDoubleMatrix* textMatrixP)

Supersedes PDETextItemGetTextMatrix() in Acrobat 10.0.

Gets the text matrix for a character in a text item.

Parameters

	`textItem` —	The text item.

	`charOffset` —	The offset of the character whose text matrix is obtained.

	`textMatrixP` —	(Filled by the method) A pointer to a ASDoubleMatrix structure with the text matrix of the character.

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_READ_VERSION >= 0x000A0000

File: PERProcs.h

Line: 3464

PDETextItemGetTextState

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextItemGetTextState(INPDETextItem textItem, OUTPDETextStateP textStateP, INASUns32 textStateSize)

Gets the text state of a text item.

Parameters

	`textItem` —	The text item whose text state is obtained.

	`textStateP` —	(Filled by the method) A pointer to a PDETextStateP structure with text state of the text item.

	`textStateSize` —	The size of the `texStateP` structure in bytes.

See Also

PDETextItemSetTextState

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_READ_VERSION >= 0x00060000

File: PERProcs.h

Line: 2827

PDETextItemRemoveChars

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextItemRemoveChars(INPDETextItem textItem, INASUns32 charOffset, INASUns32 count)

Removes contiguous characters from a text item.

Parameters

	`textItem` —	The text item whose characters are removed.

	`charOffset` —	The offset of the first character to remove.

	`count` —	The number of characters to remove.

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00060000

File: PEWProcs.h

Line: 2796

PDETextItemReplaceChars

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextItemReplaceChars(INPDETextItem textItem, INASUns32 charIndex, INASUns8* newChar, INASUns32 newCharLen)

Replaces characters in a text item.

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

Parameters

	`textItem` —	The text item whose characters are replaced.

	`charIndex` —	The index position of the characters to replace.

	`newChar` —	The replacement text.

	`newCharLen` —	The number of bytes to replace.

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00060000

File: PEWProcs.h

Line: 2777

PDETextItemReplaceText

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextItemReplaceText(INPDETextItem textItem, INASUns8* newText, INASUns32 newTextLen)

Replaces all of the text in a text item.

Parameters

	`textItem` —	The text item whose text are replaced.

	`newText` —	The replacement text.

	`newTextLen` —	The number of bytes to replace.

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00060000

File: PEWProcs.h

Line: 2752

PDETextItemSetFont

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextItemSetFont(INPDETextItem textItem, IN PDEFont font)

Sets the font for a text item.

Parameters

	`textItem` —	The text item whose font is set.

	`font` —	The new font object.

See Also

PDETextItemGetFont

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00060000

File: PEWProcs.h

Line: 2680

PDETextItemSetGState

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextItemSetGState(INPDETextItem textItem, OUTPDEGraphicStateP stateP, INASUns32 stateSize)

Sets the graphics state for a text item.

Parameters

	`textItem` —	Text item whose graphics state is set.

	`stateP` —	A pointer to a PDEGraphicStateP structure with graphics state of the text item.

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

See Also

PDETextItemGetGState

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00060000

File: PEWProcs.h

Line: 2734

PDETextItemSetTextMatrix

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextItemSetTextMatrix(INPDETextItem textItem, INASFixedMatrix* textMatrixP)

Superseded by PDETextItemSetTextMatrixEx() in Acrobat 10.0.

Sets the text matrix for a text item.

Parameters

	`textItem` —	The text item whose text matrix is set.

	`textMatrixP` —	A pointer to a ASFixedMatrix structure with the new text matrix of the text item.

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00060000

File: PEWProcs.h

Line: 2699

PDETextItemSetTextMatrixEx

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextItemSetTextMatrixEx(INPDETextItem textItem, INASDoubleMatrix* textMatrixP)

Supersedes PDETextItemSetTextMatrix() in Acrobat 10.0.

Sets the text matrix for a text item.

Parameters

	`textItem` —	The text item whose text matrix is set.

	`textMatrixP` —	A pointer to a ASDoubleMatrix structure with the new text matrix of the text item.

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_WRITE_VERSION >= 0x000A0000

File: PEWProcs.h

Line: 3934

PDETextItemSetTextState

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDETextItemSetTextState(INPDETextItem textItem, INPDETextStateP textStateP, INASUns32 textStateSize)

Sets the text state for a text item.

Parameters

	`textItem` —	The text item whose text state is set.

	`textStateP` —	A PDETextStateP structure with the new text state of the text item.

	`textStateSize` —	The size of the `textStateP` structure in bytes.

See Also

PDETextItemGetTextState

Exceptions

peErrWrongPDEObjectType
genErrBadParm
pdErrBadResMetrics

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00060000

File: PEWProcs.h

Line: 2717

Acrobat API Reference	All Layers \| All Objects \| Index \| Samples \| Frames No Frames
PDETextItem	Typedefs \| Methods

Layer	PDFEdit_Layer
Object	PDETextItem