Collapse All Expand All

LFileSettings::SetTXTOptions

#include "ltwrappr.h"

static L_INT LFileSettings::SetTXTOptions(pOptions)

const pFILETXTOPTIONS pOptions;

/* pointer to FILETXTOPTIONS structure */

Sets the file options used by LEADTOOLS when loading TXT files.

Parameter	Description
pOptions	Pointer to the FILETXTOPTIONS structure that contains the options to use when loading TXT.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

The uStructSize member of the FILETXTOPTIONS structure must be set before calling this function. If a TXT file is loaded without first setting the options using this function, the following default values will be used for the FILETXTOPTIONS members:

Parameter	Value
bEnabled	FALSE
crFontColor	RGB( 0, 0, 0)
crHighlight	RGB( 0xFF, 0xFF, 0xFF)
nFontSize	12
pFaceName	"Courier New"
bBold	FALSE
bItalic	FALSE
bUnderLine	FALSE
bStrikeThrough	FALSE
bUseSystemLocale	FALSE

Required DLLs and Libraries

LTFIL For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

See Also

Functions:	LFileSettings::GetTXTOptions
Topics:	Raster Image Functions: Loading Files
	Loading and Saving Images

Example

This example loads a TXT file, with a top margin, bottom margin, left margin,

right margin ,font color, font size and bold formatting defined by the user.

L_INT LFileSettings__SetTXTOptionsExample( L_TCHAR *pszTXTFileName, LFile* pLeadFile, L_DOUBLE dTopMarg, L_DOUBLE dBottomMarg, L_DOUBLE dLeftMarg, L_DOUBLE dRightMarg)
{
   L_INT nRet = FAILURE;
   FILETXTOPTIONS TxtOptions;
   /* Get the current TXT options */
   nRet = LFileSettings::GetTXTOptions(&TxtOptions,sizeof(FILETXTOPTIONS));
   if(nRet != SUCCESS)
      return nRet;
   /*Change margin values */
   TxtOptions.uStructSize = sizeof(TxtOptions);
   TxtOptions.crFontColor = RGB( 0xFF, 0x00 , 0x00);
   TxtOptions.nFontSize = 12;
   TxtOptions.bBold = TRUE;
   /* Set new TXT options */
   nRet = LFileSettings::SetTXTOptions(&TxtOptions);
   if(nRet != SUCCESS)
      return nRet;
   RASTERIZEDOCOPTIONS docOpts;
   memset(&docOpts, 0, sizeof(RASTERIZEDOCOPTIONS));
   LFileSettings::GetRasterizeDocOptions(&docOpts, sizeof(RASTERIZEDOCOPTIONS));
   /*Change margin values */
   docOpts.dTopMargin     = dTopMarg; 
   docOpts.dBottomMargin  = dBottomMarg; 
   docOpts.dLeftMargin    = dLeftMarg; 
   docOpts.dRightMargin   = dRightMarg; 
   LFileSettings::SetRasterizeDocOptions(&docOpts);
   /* Now load the TXT file */
   pLeadFile->SetFileName(pszTXTFileName);
   nRet = pLeadFile->Load( );
   if(nRet != SUCCESS)
      return nRet;
   return SUCCESS;
}