DTWAIN_SetPDFTextElementLong

Top  Previous  Next

The DTWAIN_SetPDFTextElementLong sets one of the integer characteristics within a DTWAIN_PDFTEXTELEMENT.

 

DTWAIN_BOOL DTWAIN_SetPDFTextElementFloat (

DTWAIN_PDFTEXTELEMENT

TextElement,

LONG

arg1,

LONG

arg2,

LONG

Item );

 

Parameters

TextElement

The DTWAIN_PDFTEXTELEMENT to set.

 

arg1, arg2

Value(s) that will be used to set the DTWAIN_PDFTEXTELEMENT

 

Item

The item within the DTWAIN_PDFTEXTELEMENT to set


Return Values

TRUE if successful, FALSE otherwise.  If the function returns FALSE, call DTWAIN_GetLastError() to get extended information.

 

Comments

The DTWAIN_SetPDFTextElementLong sets the various integer characteristics of TextElement.


The values that will be used are described in two arguments arg1 and arg2


The Item denotes which values within TextElement to set.  The value of Item must be one of the following:


Value of Item

Values set within the DTWAIN_PDFTEXTELEMENT

DTWAIN_PDFTEXTELEMENT_COLOR

arg1 is an RGB color value, arg2 is ignored

DTWAIN_PDFTEXTELEMENT_DISPLAYFLAGS

arg1 is the displayFlag to use for the text element, arg2 is ignored

DTWAIN_PDFTEXTELEMENT_POSITION

arg1 is x-position on page, arg2 is y-position on page

DTWAIN_PDFTEXTELEMENT_RENDERMODE

arg1 is the render mode, arg2 is ignored

DTWAIN_PDFTEXTELEMENT_STROKEWIDTH

arg1 is the stroke width, arg2 is ignored.

DTWAIN_PDFTEXTELEMENT_TRANSFORMORDER

arg1 is the transform order, arg2 is ignored



For DTWAIN_PDFTEXTLEMENT_DISPLAYFLAGS,  these flags denote which pages (current page, odd pages, even pages, all pages, etc.) to display the text.  See the Page Display Flags and the displayFlags argument for DTWAIN_AddPDFText for more information.