LoadMetafile Method

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public IntPtr LoadMetafile( 
   string fileName,
   int pageNumber
)

'Declaration
 
Public Function LoadMetafile( _
   ByVal fileName As String, _
   ByVal pageNumber As Integer _
) As IntPtr

'Usage
 
Dim instance As CodecsRtfOptions
Dim fileName As String
Dim pageNumber As Integer
Dim value As IntPtr
 
value = instance.LoadMetafile(fileName, pageNumber)

public IntPtr LoadMetafile( 
   string fileName,
   int pageNumber
)

 function Leadtools.Codecs.CodecsRtfOptions.LoadMetafile( 
   fileName ,
   pageNumber 
)

public:
IntPtr LoadMetafile( 
   String^ fileName,
   int pageNumber
)

Parameters

fileName: The source RTF file.
pageNumber: The 1-based page number to load.

Return Value

The Windows Enhanced Metafile this method creates.

This method uses the following members of the current CodecsRasterizeDocumentLoadOptions set in RasterCodecs.Options.RasterizeDocument.Load to determine the page size, resolution and margins:

Also, it uses the following members of the current CodecsRtfLoadOptions set in RasterCodecs.Options.Rtf.Load to determine the back color to use:

CodecsRtfLoadOptions.BackColor

So you must set these options according to your application needs before calling this method. The number of pages inside the RTF file will depend on the Rasterize Document options.

You must destroy the Windows Enhanced Metafile (EMF) handle this method creates manually using the DeleteEnhMetaFile Windows API.

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

<DllImport("Gdi32")> _
   Private Shared Function DeleteEnhMetaFile(ByVal hemf As IntPtr) As Integer
   End Function
   Public Sub LoadRtfAsMetafileExample()
      Dim codecs As New RasterCodecs()

      Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1.rtf")

      ' Load the source file as a metafile
      Dim hemf As IntPtr = codecs.Options.Rtf.LoadMetafile(srcFileName, 1)

      If hemf <> IntPtr.Zero Then
         ' Use the metafile here

         ' Finally, delete it using the Windows API
         DeleteEnhMetaFile(hemf)
      End If

      ' Clean up
      codecs.Dispose()
   End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class

[DllImport("Gdi32")]
     private static extern int DeleteEnhMetaFile(IntPtr hemf);
     public void LoadRtfAsMetafileExample()
     {
         RasterCodecs codecs = new RasterCodecs();

         string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.rtf");

         // Load the source file as a metafile
         IntPtr hemf = codecs.Options.Rtf.LoadMetafile(srcFileName, 1);

         if (hemf != IntPtr.Zero)
         {
             // Use the metafile here

             // Finally, delete it using the Windows API
             DeleteEnhMetaFile(hemf);
         }

         // Clean up
         codecs.Dispose();
     }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

CodecsRtfOptions Class
CodecsRtfOptions Members