In This Topic ▼

L_SetTXTOptions

Summary

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

Syntax

#include "Ltfil.h"

L_LTFIL_API L_INT L_SetTXTOptions(pTxtOptions)

Parameters

pFILETXTOPTIONS pTxtOptions

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

Returns

Value	Meaning
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:

Member	Default 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

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.

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 SetTXTFileExample(L_TCHAR     * pszTXTFileName, 
                                         pBITMAPHANDLE pBitmap, 
                                         L_DOUBLE      dTopMarg, 
                                         L_DOUBLE      dBottomMarg, 
                                         L_DOUBLE      dLeftMarg, 
                                         L_DOUBLE      dRightMarg) 
{ 
   L_INT nRet; 
   FILETXTOPTIONS TxtOptions; 
   RASTERIZEDOCOPTIONS RasterizeOptions; 
 
   /* Get the current TXT options */ 
   nRet = L_GetTXTOptions(&TxtOptions,sizeof(FILETXTOPTIONS)); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   /* Enable loading TXT files */ 
   TxtOptions.bEnabled = TRUE; 
   /* Set color and font values */ 
   TxtOptions.crFontColor = RGB( 0xFF, 0x00 , 0x00); 
   TxtOptions.nFontSize = 12; 
   TxtOptions.bBold = TRUE; 
 
   /* Set new TXT options */ 
   nRet = L_SetTXTOptions(&TxtOptions); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   /* Get the current Rasterize document options */ 
   nRet = L_GetRasterizeDocOptions(&RasterizeOptions, sizeof(RasterizeOptions)); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   /* Change margin values */ 
   RasterizeOptions.dTopMargin = dTopMarg; 
   RasterizeOptions.dBottomMargin = dBottomMarg;  
   RasterizeOptions.dLeftMargin = dLeftMarg; 
   RasterizeOptions.dRightMargin = dRightMarg; 
 
   /* Set new Rasterize document options */ 
   nRet = L_SetRasterizeDocOptions(&RasterizeOptions); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   /* Now load the TXT file */ 
   if(pBitmap->Flags.Allocated) 
      L_FreeBitmap(pBitmap); 
   nRet = L_LoadBitmap (pszTXTFileName, pBitmap, sizeof(BITMAPHANDLE), 0, ORDER_RGB, NULL,  NULL); 
   if(nRet != SUCCESS) 
      return nRet; 
   nRet = L_SaveBitmap(MAKE_IMAGE_PATH(TEXT("Result.BMP")), pBitmap, FILE_BMP, 24, 0, NULL); 
   if(nRet != SUCCESS) 
      return nRet; 
   return SUCCESS; 
}