foxit.pdf.graphics.TextState Class Reference

Inherits SystemIDisposable.

Public Types

enum  Mode {
  Mode.e_ModeFill = 0, Mode.e_ModeStroke = 1, Mode.e_ModeFillStroke = 2, Mode.e_ModeInvisible = 3,
  Mode.e_ModeFillClip = 4, Mode.e_ModeStrokeClip = 5, Mode.e_ModeFillStrokeClip = 6, Mode.e_ModeClip = 7
}
 Enumeration for text mode.
More...
 

Public Member Functions

 TextState (int version, Font font, float font_size, float charspace, float wordspace, TextState.Mode textmode, PointF origin_position, float [] textmatrix)
 Constructor, with parameters.
More...
 
 TextState ()
 Constructor.

 
 TextState (TextState state)
 Constructor, with another TextState.

 
void Set (int version, Font font, float font_size, float charspace, float wordspace, TextState.Mode textmode, PointF origin_position, float [] textmatrix)
 Set value.
More...
 

Detailed Description

This class represents PDF text state.

Member Enumeration Documentation

◆ Mode

Enumeration for text mode.

Values of this enumeration should be used alone.

Enumerator
e_ModeFill 

Text mode: fill text.

e_ModeStroke 

Text mode: stroke text.

e_ModeFillStroke 

Text mode: fill and stroke text.

e_ModeInvisible 

Text mode: neither fill nor stroke text, to make it invisible.

e_ModeFillClip 

Text mode: fill text and add to path for clipping.

e_ModeStrokeClip 

Text mode: stroke text and add to path for clipping.

e_ModeFillStrokeClip 

Text mode: fill and stroke text, and add to path for clipping.

e_ModeClip 

Text mode: add text to path for clipping.

Constructor & Destructor Documentation

◆ TextState()

foxit.pdf.graphics.TextState.TextState ( int  version,
Font  font,
float  font_size,
float  charspace,
float  wordspace,
TextState.Mode  textmode,
PointF  origin_position,
float []  textmatrix 
)
inline

Constructor, with parameters.

Parameters
versionVersion of this structure, which is used to decide which members are useful. Currently, only 1 is valid.
font(Version 1) A valid Font object.
font_size(Version 1) Font size. It should be above 0.
charspace(Version 1) Character spacing.
wordspace(Version 1) Word spacing (only apply to space character).
textmode(Version 1) Text rendering mode. Please refer to e_ModeXXX values and it should be one of these values.
origin_position(Version 1) The origin point, in PDF coordinate system .
textmatrix(Version 1) Text transformation matrix.
Returns
None.

Member Function Documentation

◆ Set()

void foxit.pdf.graphics.TextState.Set ( int  version,
Font  font,
float  font_size,
float  charspace,
float  wordspace,
TextState.Mode  textmode,
PointF  origin_position,
float []  textmatrix 
)
inline

Set value.

Parameters
versionVersion of this structure, which is used to decide which members are useful. Currently, only 1 is valid.
font(Version 1) A valid Font object.
font_size(Version 1) Font size. It should be above 0.
charspace(Version 1) Character spacing.
wordspace(Version 1) Word spacing (only apply to space character).
textmode(Version 1) Text rendering mode. Please refer to e_ModeXXX values and it should be one of these values.
origin_position(Version 1) The origin point, in PDF coordinate system .
textmatrix(Version 1) Text transformation matrix.
Returns
None.

Foxit Software Corporation Logo
@2018 Foxit Software Incorporated. All rights reserved.