GrapeCity.Documents.Pdf.Page.GetTextMap

GetTextMap Method

GetTextMap(ViewState, bool, float, float, bool)

Builds and returns a text map for the current page.

Note that the X/Y resolutions of pixels used by the text map's methods and properties are the X/Y resolutions passed to this method (dpiX and dpiY).

Note also that the current value of the RecognitionAlgorithm property affects the map that is created.

Declaration

public ITextMap GetTextMap(ViewState viewState, bool includeTextPosition, float dpiX = 72, float dpiY = 72, bool ignoreErrors = true)

Parameters

Type	Name	Description
ViewState	viewState	The ViewState object.
bool	includeTextPosition	Indicates whether to include information about text positions in content stream. This must be true to enable using the map's DeleteText(TextMapFragment, DeleteTextMode) or ReplaceText(TextMapFragment, string, Font, float?) methods. If those methods are not going to be used, pass false to improve speed/memory usage of the text map.
float	dpiX	The horizontal resolution of the map (the default is 72dpi).
float	dpiY	The vertical resolution of the map (the default is 72dpi).
bool	ignoreErrors	Indicates whether to ignore errors in PDF content streams during rendering.

Returns

Type	Description
ITextMap	An ITextMap object containing the page text map.

GetTextMap(ViewState, float, float, bool)

Builds and returns a text map for the current page.

Note that the X/Y resolutions of pixels used by the text map's methods and properties are the X/Y resolutions passed to this method (dpiX and dpiY).

Note also that the current value of the RecognitionAlgorithm property affects the map that is created.

Declaration

public ITextMap GetTextMap(ViewState viewState, float dpiX = 72, float dpiY = 72, bool ignoreErrors = true)

Parameters

Type	Name	Description
ViewState	viewState	The ViewState object.
float	dpiX	The horizontal resolution of the map (the default is 72dpi).
float	dpiY	The vertical resolution of the map (the default is 72dpi).
bool	ignoreErrors	Indicates whether to ignore errors in PDF content streams during rendering.

Returns

Type	Description
ITextMap	An ITextMap object containing the page text map.

GetTextMap(bool, float, float, bool)

Builds and returns a text map for the current page.

Note that the X/Y resolutions of pixels used by the text map's methods and properties are the X/Y resolutions passed to this method (dpiX and dpiY).

Note also that the current value of the RecognitionAlgorithm property affects the map that is created.

Declaration

public ITextMap GetTextMap(bool includeTextPosition, float dpiX = 72, float dpiY = 72, bool ignoreErrors = true)

Parameters

Type	Name	Description
bool	includeTextPosition	Indicates whether to include information about text positions in content stream. This must be true to enable using the map's DeleteText(TextMapFragment, DeleteTextMode) or ReplaceText(TextMapFragment, string, Font, float?) methods. If those methods are not going to be used, pass false to improve speed/memory usage of the text map.
float	dpiX	The horizontal resolution of the map (the default is 72dpi).
float	dpiY	The vertical resolution of the map (the default is 72dpi).
bool	ignoreErrors	Indicates whether to ignore errors in PDF content streams during rendering.

Returns

Type	Description
ITextMap	An ITextMap object containing the page text map.

GetTextMap(float, float, bool)

Builds and returns a text map for the current page.

Note that the X/Y resolutions of pixels used by the text map's methods and properties are the X/Y resolutions passed to this method (dpiX and dpiY).

Note also that the current value of the RecognitionAlgorithm property affects the map that is created.

Declaration

public ITextMap GetTextMap(float dpiX = 72, float dpiY = 72, bool ignoreErrors = true)

Parameters

Type	Name	Description
float	dpiX	The horizontal resolution of the map (the default is 72dpi).
float	dpiY	The vertical resolution of the map (the default is 72dpi).
bool	ignoreErrors	Indicates whether to ignore errors in PDF content streams during rendering.

Returns

Type	Description
ITextMap	An ITextMap object containing the page text map.