LFileSettings::SetRTFOptions

#include "ltwrappr.h"

static L_INT LFileSettings::SetRTFOptions(pOptions)

const pFILERTFOPTIONS 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. If an RTF file is loaded without first calling this function, the following default values will be used:

FILERTFOPTIONS Member:

Default value:

dTopMarg

1 inch

dBottomMarg

1 inch

dRightMarg

1.25 inches

dLeftMarg

1.25 inches

dPaperWidth

8.27 inches

dPaperHeight

11.69 inches

nXResolution

96 DPI

nYResolution

96 DPI

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.

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

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:

LFileSettings::SetPDFOptions

Topics:

Raster Image Functions: Loading Files

Example

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

L_INT LFileSettings__SetRTFOptionsExample(L_TCHAR* pszRTFFileName, LBitmap* plBitmap, L_DOUBLE dTopMarg, L_DOUBLE dBottomMarg, L_DOUBLE dLeftMarg, L_DOUBLE dRightMarg)
{
   L_INT nRet;
   FILERTFOPTIONS RtfOptions;
   /* Get the current RTF options */   
   nRet = LFileSettings::GetRTFOptions(&RtfOptions,sizeof(FILERTFOPTIONS)); 
   if(nRet != SUCCESS)
      return nRet;
   /*Change margin values */
   RtfOptions.dTopMarg =     dTopMarg; 
   RtfOptions.dBottomMarg = dBottomMarg; 
   RtfOptions.dLeftMarg = dLeftMarg; 
   RtfOptions.dRightMarg =    dRightMarg; 
   /* Set new RTF options */
   nRet = LFileSettings::SetRTFOptions(&RtfOptions); 
   if(nRet != SUCCESS)
      return nRet;
   /* Now load the RTF file */
   nRet = plBitmap->Load(pszRTFFileName,
                  0,
                  ORDER_RGB,
                  NULL,
                  NULL );
   if(nRet != SUCCESS)
      return nRet;
   return SUCCESS;
}