Metafile Class

Defines a graphic metafile. A metafile contains records that describe a sequence of graphics operations that can be recorded (constructed) and played back (displayed). This class is not inheritable.

System.Object
  System.MarshalByRefObject
    System.Drawing.Image
      System.Drawing.Imaging.Metafile

Namespace:  System.Drawing.Imaging
Assembly:  System.Drawing (in System.Drawing.dll)

[SerializableAttribute]
public sealed class Metafile : Image

The Metafile type exposes the following members.

  NameDescription
Public methodMetafile(Stream)Initializes a new instance of the Metafile class from the specified data stream.
Public methodMetafile(String)Initializes a new instance of the Metafile class from the specified file name.
Public methodMetafile(IntPtr, Boolean)Initializes a new instance of the Metafile class from the specified handle.
Public methodMetafile(IntPtr, EmfType)Initializes a new instance of the Metafile class from the specified handle to a device context and an EmfType enumeration that specifies the format of the Metafile.
Public methodMetafile(IntPtr, WmfPlaceableFileHeader)Initializes a new instance of the Metafile class from the specified handle and a WmfPlaceableFileHeader.
Public methodMetafile(IntPtr, Rectangle)Initializes a new instance of the Metafile class from the specified device context, bounded by the specified rectangle.
Public methodMetafile(IntPtr, RectangleF)Initializes a new instance of the Metafile class from the specified device context, bounded by the specified rectangle.
Public methodMetafile(Stream, IntPtr)Initializes a new instance of the Metafile class from the specified data stream.
Public methodMetafile(String, IntPtr)Initializes a new instance of the Metafile class with the specified file name.
Public methodMetafile(IntPtr, EmfType, String)Initializes a new instance of the Metafile class from the specified handle to a device context and an EmfType enumeration that specifies the format of the Metafile. A string can be supplied to name the file.
Public methodMetafile(IntPtr, WmfPlaceableFileHeader, Boolean)Initializes a new instance of the Metafile class from the specified handle and a WmfPlaceableFileHeader. Also, the deleteWmf parameter can be used to delete the handle when the metafile is deleted.
Public methodMetafile(IntPtr, Rectangle, MetafileFrameUnit)Initializes a new instance of the Metafile class from the specified device context, bounded by the specified rectangle that uses the supplied unit of measure.
Public methodMetafile(IntPtr, RectangleF, MetafileFrameUnit)Initializes a new instance of the Metafile class from the specified device context, bounded by the specified rectangle that uses the supplied unit of measure.
Public methodMetafile(Stream, IntPtr, EmfType)Initializes a new instance of the Metafile class from the specified data stream, a Windows handle to a device context, and an EmfType enumeration that specifies the format of the Metafile.
Public methodMetafile(Stream, IntPtr, Rectangle)Initializes a new instance of the Metafile class from the specified data stream, a Windows handle to a device context, and a Rectangle structure that represents the rectangle that bounds the new Metafile.
Public methodMetafile(Stream, IntPtr, RectangleF)Initializes a new instance of the Metafile class from the specified data stream, a Windows handle to a device context, and a RectangleF structure that represents the rectangle that bounds the new Metafile.
Public methodMetafile(String, IntPtr, EmfType)Initializes a new instance of the Metafile class with the specified file name, a Windows handle to a device context, and an EmfType enumeration that specifies the format of the Metafile.
Public methodMetafile(String, IntPtr, Rectangle)Initializes a new instance of the Metafile class with the specified file name, a Windows handle to a device context, and a Rectangle structure that represents the rectangle that bounds the new Metafile.
Public methodMetafile(String, IntPtr, RectangleF)Initializes a new instance of the Metafile class with the specified file name, a Windows handle to a device context, and a RectangleF structure that represents the rectangle that bounds the new Metafile.
Public methodMetafile(IntPtr, Rectangle, MetafileFrameUnit, EmfType)Initializes a new instance of the Metafile class from the specified device context, bounded by the specified rectangle that uses the supplied unit of measure, and an EmfType enumeration that specifies the format of the Metafile.
Public methodMetafile(IntPtr, RectangleF, MetafileFrameUnit, EmfType)Initializes a new instance of the Metafile class from the specified device context, bounded by the specified rectangle that uses the supplied unit of measure, and an EmfType enumeration that specifies the format of the Metafile.
Public methodMetafile(Stream, IntPtr, EmfType, String)Initializes a new instance of the Metafile class from the specified data stream, a Windows handle to a device context, and an EmfType enumeration that specifies the format of the Metafile. Also, a string that contains a descriptive name for the new Metafile can be added.
Public methodMetafile(Stream, IntPtr, Rectangle, MetafileFrameUnit)Initializes a new instance of the Metafile class from the specified data stream, a Windows handle to a device context, a Rectangle structure that represents the rectangle that bounds the new Metafile, and the supplied unit of measure.
Public methodMetafile(Stream, IntPtr, RectangleF, MetafileFrameUnit)Initializes a new instance of the Metafile class from the specified data stream, a Windows handle to a device context, a RectangleF structure that represents the rectangle that bounds the new Metafile, and the supplied unit of measure.
Public methodMetafile(String, IntPtr, EmfType, String)Initializes a new instance of the Metafile class with the specified file name, a Windows handle to a device context, and an EmfType enumeration that specifies the format of the Metafile. A descriptive string can be added, as well.
Public methodMetafile(String, IntPtr, Rectangle, MetafileFrameUnit)Initializes a new instance of the Metafile class with the specified file name, a Windows handle to a device context, a Rectangle structure that represents the rectangle that bounds the new Metafile, and the supplied unit of measure.
Public methodMetafile(String, IntPtr, RectangleF, MetafileFrameUnit)Initializes a new instance of the Metafile class with the specified file name, a Windows handle to a device context, a RectangleF structure that represents the rectangle that bounds the new Metafile, and the supplied unit of measure.
Public methodMetafile(IntPtr, Rectangle, MetafileFrameUnit, EmfType, String)Initializes a new instance of the Metafile class from the specified device context, bounded by the specified rectangle that uses the supplied unit of measure, and an EmfType enumeration that specifies the format of the Metafile. A string can be provided to name the file.
Public methodMetafile(IntPtr, RectangleF, MetafileFrameUnit, EmfType, String)Initializes a new instance of the Metafile class from the specified device context, bounded by the specified rectangle that uses the supplied unit of measure, and an EmfType enumeration that specifies the format of the Metafile. A string can be provided to name the file.
Public methodMetafile(Stream, IntPtr, Rectangle, MetafileFrameUnit, EmfType)Initializes a new instance of the Metafile class from the specified data stream, a Windows handle to a device context, a Rectangle structure that represents the rectangle that bounds the new Metafile, the supplied unit of measure, and an EmfType enumeration that specifies the format of the Metafile.
Public methodMetafile(Stream, IntPtr, RectangleF, MetafileFrameUnit, EmfType)Initializes a new instance of the Metafile class from the specified data stream, a Windows handle to a device context, a RectangleF structure that represents the rectangle that bounds the new Metafile, the supplied unit of measure, and an EmfType enumeration that specifies the format of the Metafile.
Public methodMetafile(String, IntPtr, Rectangle, MetafileFrameUnit, EmfType)Initializes a new instance of the Metafile class with the specified file name, a Windows handle to a device context, a Rectangle structure that represents the rectangle that bounds the new Metafile, the supplied unit of measure, and an EmfType enumeration that specifies the format of the Metafile.
Public methodMetafile(String, IntPtr, Rectangle, MetafileFrameUnit, String)Initializes a new instance of the Metafile class with the specified file name, a Windows handle to a device context, a Rectangle structure that represents the rectangle that bounds the new Metafile, and the supplied unit of measure. A descriptive string can also be added.
Public methodMetafile(String, IntPtr, RectangleF, MetafileFrameUnit, EmfType)Initializes a new instance of the Metafile class with the specified file name, a Windows handle to a device context, a RectangleF structure that represents the rectangle that bounds the new Metafile, the supplied unit of measure, and an EmfType enumeration that specifies the format of the Metafile.
Public methodMetafile(String, IntPtr, RectangleF, MetafileFrameUnit, String)Initializes a new instance of the Metafile class with the specified file name, a Windows handle to a device context, a RectangleF structure that represents the rectangle that bounds the new Metafile, and the supplied unit of measure. A descriptive string can also be added.
Public methodMetafile(Stream, IntPtr, Rectangle, MetafileFrameUnit, EmfType, String)Initializes a new instance of the Metafile class from the specified data stream, a Windows handle to a device context, a Rectangle structure that represents the rectangle that bounds the new Metafile, the supplied unit of measure, and an EmfType enumeration that specifies the format of the Metafile. A string that contains a descriptive name for the new Metafile can be added.
Public methodMetafile(Stream, IntPtr, RectangleF, MetafileFrameUnit, EmfType, String)Initializes a new instance of the Metafile class from the specified data stream, a Windows handle to a device context, a RectangleF structure that represents the rectangle that bounds the new Metafile, the supplied unit of measure, and an EmfType enumeration that specifies the format of the Metafile. A string that contains a descriptive name for the new Metafile can be added.
Public methodMetafile(String, IntPtr, Rectangle, MetafileFrameUnit, EmfType, String)Initializes a new instance of the Metafile class with the specified file name, a Windows handle to a device context, a Rectangle structure that represents the rectangle that bounds the new Metafile, the supplied unit of measure, and an EmfType enumeration that specifies the format of the Metafile. A descriptive string can also be added.
Public methodMetafile(String, IntPtr, RectangleF, MetafileFrameUnit, EmfType, String)Initializes a new instance of the Metafile class with the specified file name, a Windows handle to a device context, a RectangleF structure that represents the rectangle that bounds the new Metafile, the supplied unit of measure, and an EmfType enumeration that specifies the format of the Metafile. A descriptive string can also be added.
Top

  NameDescription
Public propertyFlagsGets attribute flags for the pixel data of this Image. (Inherited from Image.)
Public propertyFrameDimensionsListGets an array of GUIDs that represent the dimensions of frames within this Image. (Inherited from Image.)
Public propertyHeightGets the height, in pixels, of this Image. (Inherited from Image.)
Public propertyHorizontalResolutionGets the horizontal resolution, in pixels per inch, of this Image. (Inherited from Image.)
Public propertyPaletteGets or sets the color palette used for this Image. (Inherited from Image.)
Public propertyPhysicalDimensionGets the width and height of this image. (Inherited from Image.)
Public propertyPixelFormatGets the pixel format for this Image. (Inherited from Image.)
Public propertyPropertyIdListGets IDs of the property items stored in this Image. (Inherited from Image.)
Public propertyPropertyItemsGets all the property items (pieces of metadata) stored in this Image. (Inherited from Image.)
Public propertyRawFormatGets the file format of this Image. (Inherited from Image.)
Public propertySizeGets the width and height, in pixels, of this image. (Inherited from Image.)
Public propertyTagGets or sets an object that provides additional data about the image. (Inherited from Image.)
Public propertyVerticalResolutionGets the vertical resolution, in pixels per inch, of this Image. (Inherited from Image.)
Public propertyWidthGets the width, in pixels, of this Image. (Inherited from Image.)
Top

  NameDescription
Public methodCloneCreates an exact copy of this Image. (Inherited from Image.)
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodDispose()Releases all resources used by this Image. (Inherited from Image.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetBoundsGets the bounds of the image in the specified unit. (Inherited from Image.)
Public methodGetEncoderParameterListReturns information about the parameters supported by the specified image encoder. (Inherited from Image.)
Public methodGetFrameCountReturns the number of frames of the specified dimension. (Inherited from Image.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetHenhmetafileReturns a Windows handle to an enhanced Metafile.
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodGetMetafileHeader()Returns the MetafileHeader associated with this Metafile.
Public methodStatic memberGetMetafileHeader(IntPtr)Returns the MetafileHeader associated with the specified Metafile.
Public methodStatic memberGetMetafileHeader(Stream)Returns the MetafileHeader associated with the specified Metafile.
Public methodStatic memberGetMetafileHeader(String)Returns the MetafileHeader associated with the specified Metafile.
Public methodStatic memberGetMetafileHeader(IntPtr, WmfPlaceableFileHeader)Returns the MetafileHeader associated with the specified Metafile.
Public methodGetPropertyItemGets the specified property item from this Image. (Inherited from Image.)
Public methodGetThumbnailImageReturns a thumbnail for this Image. (Inherited from Image.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodPlayRecordPlays an individual metafile record.
Public methodRemovePropertyItemRemoves the specified property item from this Image. (Inherited from Image.)
Public methodRotateFlipRotates, flips, or rotates and flips the Image. (Inherited from Image.)
Public methodSave(String)Saves this Image to the specified file or stream. (Inherited from Image.)
Public methodSave(Stream, ImageFormat)Saves this image to the specified stream in the specified format. (Inherited from Image.)
Public methodSave(String, ImageFormat)Saves this Image to the specified file in the specified format. (Inherited from Image.)
Public methodSave(Stream, ImageCodecInfo, EncoderParameters)Saves this image to the specified stream, with the specified encoder and image encoder parameters. (Inherited from Image.)
Public methodSave(String, ImageCodecInfo, EncoderParameters)Saves this Image to the specified file, with the specified encoder and image-encoder parameters. (Inherited from Image.)
Public methodSaveAdd(EncoderParameters)Adds a frame to the file or stream specified in a previous call to the Save method. Use this method to save selected frames from a multiple-frame image to another multiple-frame image. (Inherited from Image.)
Public methodSaveAdd(Image, EncoderParameters)Adds a frame to the file or stream specified in a previous call to the Save method. (Inherited from Image.)
Public methodSelectActiveFrameSelects the frame specified by the dimension and index. (Inherited from Image.)
Public methodSetPropertyItemStores a property item (piece of metadata) in this Image. (Inherited from Image.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate methodISerializable.GetObjectDataPopulates a SerializationInfo with the data needed to serialize the target object. (Inherited from Image.)
Top

When you use the Save method to save a graphic image as a Windows Metafile Format (WMF) or Enhanced Metafile Format (EMF) file, the resulting file is saved as a Portable Network Graphics (PNG) file instead. This behavior occurs because the GDI+ component of the .NET Framework does not have an encoder that you can use to save files as .wmf or .emf files.

The following code example demonstrates how to create a Metafile and use the PlayRecord method.


using System;
using System.Drawing;
using System.Drawing.Imaging;
using System.Windows.Forms;

// for Marshal.Copy 
using System.Runtime.InteropServices; 

public class Form1 : Form
{
    private Metafile metafile1;
    private Graphics.EnumerateMetafileProc metafileDelegate;
    private Point destPoint;
    public Form1()
    {
        metafile1 = new Metafile(@"C:\Test.wmf");
        metafileDelegate = new Graphics.EnumerateMetafileProc(MetafileCallback);
        destPoint = new Point(20, 10);
    }
    protected override void OnPaint(PaintEventArgs e)
    {
        e.Graphics.EnumerateMetafile(metafile1, destPoint, metafileDelegate);
    }
    private bool MetafileCallback(
       EmfPlusRecordType recordType,
       int flags,
       int dataSize,
       IntPtr data,
       PlayRecordCallback callbackData)
    {
        byte[] dataArray = null;
        if (data != IntPtr.Zero)
        {
            // Copy the unmanaged record to a managed byte buffer  
            // that can be used by PlayRecord.
            dataArray = new byte[dataSize];
            Marshal.Copy(data, dataArray, 0, dataSize);
        }

        metafile1.PlayRecord(recordType, flags, dataSize, dataArray);

        return true;
    }

    static void Main()
    {
        Application.Run(new Form1());
    }
}

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft