L_SetTXTOptions
#include "Ltfil.h"
L_LTFIL_API L_INT L_SetTXTOptions(pTxtOptions)
pFILETXTOPTIONS pTxtOptions; |
/* pointer to FILETXTOPTIONS structure */ |
Sets the file options used by LEADTOOLS when loading TXT files.
Parameter |
Description |
pTxtOptions |
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 |
dTopMarg |
1 inch |
dBottomMarg |
1 inch |
dRightMarg |
1.25 inch |
dLeftMarg |
1.25 inch |
dPaperWidth |
8.27 inch |
dPaperHeight |
11.69 inch |
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
Windows 2000 / XP/Vista.
See Also
Functions: |
|
Topics: |
|
|
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; /* Get the current TXT options */ nRet = L_GetTXTOptions(&TxtOptions,sizeof(FILETXTOPTIONS)); if(nRet != SUCCESS) return nRet; /*Change margin values */ TxtOptions.bEnabled = TRUE; TxtOptions.dTopMarg = dTopMarg; TxtOptions.dBottomMarg = dBottomMarg; TxtOptions.dLeftMarg = dLeftMarg; TxtOptions.dRightMarg = dRightMarg; 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; /* 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(TEXT("C:\\Program Files\\LEAD Technologies\\LEADTOOLS 15\\Images\\Result.BMP"), pBitmap, FILE_BMP, 24, 0, NULL); if(nRet != SUCCESS) return nRet; return SUCCESS; }