This topic has not yet been rated - Rate this topic

BitmapEncoder.Frames Property

.NET Framework 4

Gets or sets the individual frames within an image.

Namespace: System.Windows.Media.Imaging
Assembly: PresentationCore (in PresentationCore.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation

Syntax

C++

Copy

public virtual IList<BitmapFrame> Frames { get; set; }

XAML

Copy

You cannot use this property in Extensible Application Markup Language (XAML).

Property Value

Type: System.Collections.Generic.IList<BitmapFrame>
A collection of BitmapFrame objects within the image.

Exceptions

Exception	Condition
ArgumentNullException	The BitmapFrame value that is passed to the encoder is null.

Remarks

Only Tagged Image File Format (TIFF), Graphics Interchange Format (GIF), and Microsoft Windows Media Photo images support more than one frame. Attempts to add additional frames to formats that do not support them will result in only the first frame being encoded.

Examples

The following example shows how to add a frame to an encoder.

Copy


FileStream stream = new FileStream("empty.tif", FileMode.Create);
TiffBitmapEncoder encoder = new TiffBitmapEncoder();
TextBlock myTextBlock = new TextBlock();
myTextBlock.Text = "Codec Author is: " + encoder.CodecInfo.Author.ToString();
encoder.Frames.Add(BitmapFrame.Create(image));
MessageBox.Show(myPalette.Colors.Count.ToString());
encoder.Save(stream);

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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

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

Reference

BitmapEncoder Class

System.Windows.Media.Imaging Namespace

BitmapFrame

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ