This topic has not yet been rated - Rate this topic

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.

  Name Description
Public method Metafile(Stream) Initializes a new instance of the Metafile class from the specified data stream.
Public method Metafile(String) Initializes a new instance of the Metafile class from the specified file name.
Public method Metafile(IntPtr, Boolean) Initializes a new instance of the Metafile class from the specified handle.
Public method Metafile(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 method Metafile(IntPtr, WmfPlaceableFileHeader) Initializes a new instance of the Metafile class from the specified handle and a WmfPlaceableFileHeader.
Public method Metafile(IntPtr, Rectangle) Initializes a new instance of the Metafile class from the specified device context, bounded by the specified rectangle.
Public method Metafile(IntPtr, RectangleF) Initializes a new instance of the Metafile class from the specified device context, bounded by the specified rectangle.
Public method Metafile(Stream, IntPtr) Initializes a new instance of the Metafile class from the specified data stream.
Public method Metafile(String, IntPtr) Initializes a new instance of the Metafile class with the specified file name.
Public method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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 method Metafile(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
  Name Description
Public property Flags Gets attribute flags for the pixel data of this Image. (Inherited from Image.)
Public property FrameDimensionsList Gets an array of GUIDs that represent the dimensions of frames within this Image. (Inherited from Image.)
Public property Height Gets the height, in pixels, of this Image. (Inherited from Image.)
Public property HorizontalResolution Gets the horizontal resolution, in pixels per inch, of this Image. (Inherited from Image.)
Public property Palette Gets or sets the color palette used for this Image. (Inherited from Image.)
Public property PhysicalDimension Gets the width and height of this image. (Inherited from Image.)
Public property PixelFormat Gets the pixel format for this Image. (Inherited from Image.)
Public property PropertyIdList Gets IDs of the property items stored in this Image. (Inherited from Image.)
Public property PropertyItems Gets all the property items (pieces of metadata) stored in this Image. (Inherited from Image.)
Public property RawFormat Gets the file format of this Image. (Inherited from Image.)
Public property Size Gets the width and height, in pixels, of this image. (Inherited from Image.)
Public property Tag Gets or sets an object that provides additional data about the image. (Inherited from Image.)
Public property VerticalResolution Gets the vertical resolution, in pixels per inch, of this Image. (Inherited from Image.)
Public property Width Gets the width, in pixels, of this Image. (Inherited from Image.)
Top
  Name Description
Public method Clone Creates an exact copy of this Image. (Inherited from Image.)
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public method Dispose() Releases all resources used by this Image. (Inherited from Image.)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the Image and optionally releases the managed resources. (Inherited from Image.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Image.)
Public method GetBounds Gets the bounds of the image in the specified unit. (Inherited from Image.)
Public method GetEncoderParameterList Returns information about the parameters supported by the specified image encoder. (Inherited from Image.)
Public method GetFrameCount Returns the number of frames of the specified dimension. (Inherited from Image.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetHenhmetafile Returns a Windows handle to an enhanced Metafile.
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public method GetMetafileHeader() Returns the MetafileHeader associated with this Metafile.
Public method Static member GetMetafileHeader(IntPtr) Returns the MetafileHeader associated with the specified Metafile.
Public method Static member GetMetafileHeader(Stream) Returns the MetafileHeader associated with the specified Metafile.
Public method Static member GetMetafileHeader(String) Returns the MetafileHeader associated with the specified Metafile.
Public method Static member GetMetafileHeader(IntPtr, WmfPlaceableFileHeader) Returns the MetafileHeader associated with the specified Metafile.
Public method GetPropertyItem Gets the specified property item from this Image. (Inherited from Image.)
Public method GetThumbnailImage Returns a thumbnail for this Image. (Inherited from Image.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method MemberwiseClone() Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Public method PlayRecord Plays an individual metafile record.
Public method RemovePropertyItem Removes the specified property item from this Image. (Inherited from Image.)
Public method RotateFlip Rotates, flips, or rotates and flips the Image. (Inherited from Image.)
Public method Save(String) Saves this Image to the specified file or stream. (Inherited from Image.)
Public method Save(Stream, ImageFormat) Saves this image to the specified stream in the specified format. (Inherited from Image.)
Public method Save(String, ImageFormat) Saves this Image to the specified file in the specified format. (Inherited from Image.)
Public method Save(Stream, ImageCodecInfo, EncoderParameters) Saves this image to the specified stream, with the specified encoder and image encoder parameters. (Inherited from Image.)
Public method Save(String, ImageCodecInfo, EncoderParameters) Saves this Image to the specified file, with the specified encoder and image-encoder parameters. (Inherited from Image.)
Public method SaveAdd(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 method SaveAdd(Image, EncoderParameters) Adds a frame to the file or stream specified in a previous call to the Save method. (Inherited from Image.)
Public method SelectActiveFrame Selects the frame specified by the dimension and index. (Inherited from Image.)
Public method SetPropertyItem Stores a property item (piece of metadata) in this Image. (Inherited from Image.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Explicit interface implemetation Private method ISerializable.GetObjectData Populates 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, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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

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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ