Comments Property

Summary

The collection of comment data used when reading and writing certain file formats (including GIF).

Syntax

WinRT C#

C++

public IVector<RasterCommentMetadata> Comments {get;}

Public ReadOnly Property Comments As IVector(Of RasterCommentMetadata)

public IVector<RasterCommentMetadata> Comments {get;}

 get_Comments();

public: 
property IVector<RasterCommentMetadata^>^ Comments { 
   IVector<RasterCommentMetadata^>^ get(); 
}

Property Value

A collection of RasterCommentMetadata used when reading and writing certain file formats (including GIF).

Remarks

Several formats allow you to store non-image data such as comments, tags, and markers.

You can manipulate the comments of an image by adding/removing RasterCommentMetadata objects to this collection.

By setting the CodecsSaveOptions.Comments property to true before calling RasterCodecs.Save, you can save the comments in this collection when the image is saved into a file.

By setting the CodecsLoadOptions.Markers property to true before calling RasterCodecs.Load, you can load all the markers (if any) into this collection when an image is loaded from a file.

You can use the RasterCodecs.WriteMarkers method to save the markers directly to an existing file.

For more information, refer to Non Image Data and Types of File Comments.

Requirements

Target Platforms