LEADTOOLS Image File Support (Leadtools.Codecs assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
LoadMetafile Method
See Also 
Leadtools.Codecs Namespace > CodecsRtfOptions Class : LoadMetafile Method



fileName
The source RTF file.
pageNumber
The 1-based page number to load.
fileName
The source RTF file.
pageNumber
The 1-based page number to load.
Loads the specified RTF file as a Windows Enhanced Metafile.

Syntax

Visual Basic (Declaration) 
Public Function LoadMetafile( _
   ByVal fileName As String, _
   ByVal pageNumber As Integer _
) As IntPtr
Visual Basic (Usage)Copy Code
Dim instance As CodecsRtfOptions
Dim fileName As String
Dim pageNumber As Integer
Dim value As IntPtr
 
value = instance.LoadMetafile(fileName, pageNumber)
C# 
public IntPtr LoadMetafile( 
   string fileName,
   int pageNumber
)
C++/CLI 
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.

Example

Visual BasicCopy Code
<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
C#Copy Code
[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";
}
SilverlightCSharpCopy Code
SilverlightVBCopy Code

Remarks

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

Requirements

Target Platforms: Silverlight, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)

See Also