LayerPD_Layer
ObjectPDText

A PDText is a graphic object (a subclass of PDGraphic) representing one or more character strings on a page.

For details, see the following sections in the PDF Reference:

Like paths, text can be stroked or filled, and can serve as a clipping path.

There are PDText methods to access the text-specific parameters in the graphics state. See Section 4.3, Graphics State, in the PDF Reference, for a discussion of graphics state.


Typedef Summary
 Typedef
 PDCharOffset
 PDText
 PDTextState
 PDTextStateP
Structure Summary
 Structure
 _t_PDTextState
A data structure containing information about the current text state.
Method Summary
 Method
 
void PDTextEnum(PDText text, PDStringEnumProc enumProc, void* clientData)
Enumerates the strings of a text object, calling a procedure for each string. The PDText object may be obtained from the PDGraphicEnumTextProc() callback of PDGraphicEnumMonitor.
 
void PDTextGetState(PDText obj, PDTextStateP stateP, ASInt32 stateLen)
Gets the text state for a text object. See Section 5.2 in the PDF Reference for a discussion of the text state parameters.

Typedefs Detail
PDCharOffset 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASUns16 PDCharOffset;

File: PDExpT.h
Line: 95
PDText 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_PDGraphic* PDText;

File: PDExpT.h
Line: 2412
PDTextState 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDTextState PDTextState;

File: PDExpT.h
Line: 2551
PDTextStateP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDTextState PDTextStateP;

File: PDExpT.h
Line: 2551


Structure Detail
_t_PDTextState
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDTextState {
 PDFont font; 
 
 ASFixed charSpacing; 
 
 ASFixed wordSpacing; 
 
 ASFixed horizontalScale; 
 
 ASFixed leading; 
 
 ASFixed textRise; 
 
 ASFixed textSize; 
 
 ASInt32 renderMode; 
 
 ASFixedMatrix textMatrix; 
}

A data structure containing information about the current text state.

See Also

PDTextGetState

File: PDExpT.h
Line: 2524

Elements
font  

Text font.

 
charSpacing  

Character spacing.

 
wordSpacing  

Word spacing.

 
horizontalScale  

Horizontal scaling.

 
leading  

Leading.

 
textRise  

Text rise.

 
textSize  

Text font size.

 
renderMode  

Text rendering mode.

 
textMatrix  

Text matrix.


Method Detail
PDTextEnum()
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDTextEnum(PDText text, PDStringEnumProc enumProc, void* clientData)

Enumerates the strings of a text object, calling a procedure for each string. The PDText object may be obtained from the PDGraphicEnumTextProc() callback of PDGraphicEnumMonitor.

Parameters

text — 

IN/OUT The text object whose strings are enumerated.
 
enumProc — 

IN/OUT A user-supplied callback to call for each text string in the text object. Enumeration ends if enumProc returns false.

 
clientData — 

IN/OUT A pointer to user-supplied data to pass to enumProc each time it is called.

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3605
PDTextGetState() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDTextGetState(PDText obj, PDTextStateP stateP, ASInt32 stateLen)

Gets the text state for a text object. See Section 5.2 in the PDF Reference for a discussion of the text state parameters.

Parameters

obj — 

IN/OUT The text object whose text state is obtained.
 
stateP — 

IN/OUT (Filled by the method) A pointer to a PDTextState structure containing the text state information.

 
stateLen — 

IN/OUT It must be sizeof(PDTextState).

Since

PI_PDMODEL_VERSION >= 0x00020000

File: PDProcs.h
Line: 3619



Copyright 2020 Adobe Systems Incorporated and its licensors. All rights reserved. Adobe and the Adobe logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. This product contains either BSAFE and/or TIPEM software by RSA Security, Inc. Portions utilize Microsoft Windows Media Technologies. Copyright © 2006 Microsoft Corporation. All Rights Reserved. Notices, terms and conditions pertaining to other third party software are located at http://www.adobe.com/go/thirdparty/ and incorporated herein by reference.
Wed Feb 7 2024, 2:16 pm IST