L_SetRTFOptions

Show in webframe

#include "l_bitmap.h"

L_LTFIL_API L_INT L_SetRTFOptions(pOptions)

/* pointer to a structure */

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

Parameter	Description
pOptions	Pointer to a structure that contains the options to use when loading RTF files.

Returns

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

Comments

The uStructSize member of the FILERTFOPTIONS structure must be set before calling this function.

The values set by this function are valid for the current thread. To change the values used by the current thread, this function must be called again.

Required DLLs and Libraries

LTFIL
File format DLLs

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:	L_GetRTFOptions, L_GetEmfHandleFromRtf
Topics:	Raster Image Functions: Loading Files
	Loading and Saving Images

For a list of functions that utilize the LOADFILEOPTION or SAVEFILEOPTION structures, refer to Functions Utilizing the LOADFILEOPTION or SAVEFILEOPTION structures.

Example

This example loads a RTF file, with a top margin, bottom margin, left margin, right margin defined by the user

#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName


 L_INT SetRTFOptionsExample(L_TCHAR     * pszRTFFileName,
                                           pBITMAPHANDLE pBitmap,
                                           L_DOUBLE      dTopMarg,
                                           L_DOUBLE      dBottomMarg,
                                           L_DOUBLE      dLeftMarg,
                                           L_DOUBLE      dRightMarg)
{
   L_INT nRet;
   FILERTFOPTIONS RtfOptions;
   RASTERIZEDOCOPTIONS RasterizeOptions;

   /* Get the current RTF options */
   nRet = L_GetRTFOptions(&RtfOptions, sizeof(FILERTFOPTIONS));
   if(nRet != SUCCESS)
      return nRet;

   /* Change back color to white */
   RtfOptions.crBackColor = RGB(255, 255, 255);

   /* Set new RTF options */
   nRet = L_SetRTFOptions(&RtfOptions);
   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 RTF file */
   if(pBitmap->Flags.Allocated)
      L_FreeBitmap(pBitmap);
   nRet = L_LoadBitmap(pszRTFFileName, 
                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;
}