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



Gets or sets a value that indicate whether any comment fields found in the file should be automatically loaded.

Syntax

Visual Basic (Declaration) 
Public Property Comments As Boolean
Visual Basic (Usage)Copy Code
Dim instance As CodecsLoadOptions
Dim value As Boolean
 
instance.Comments = value
 
value = instance.Comments
C# 
public bool Comments {get; set;}
C++/CLI 
public:
property bool Comments {
   bool get();
   void set (    bool value);
}

Property Value

true to automatically load any comment fields found in the file; otherwise it is false.

Example

For an example, refer to Tags.

Remarks

When the value of the Comments property is set to true, any subsequent load operation performed by this RasterCodecs object will automatically try to load all the comment fields found in the file and store them in the RasterImage.Comments collection of the result image.

Internally, the RasterCodecs object will call RasterCodecs.CommentsSupported on the image and only try to load the comments if the value returned is true.

When loading more than one page from a multi-page file, only the comments found in the first page will be automatically loaded when the value of this property is set to true. To manually load all the comments in any page, use RasterCodecs.ReadComments.

You must set the value of the Markers property to false to enable automatic loading the comments. If the value of both Markers and Comments is set to true, the markers will take take precedence and no comments will be loaded.

Note that any load method that uses tiles, offset or resizing will not load any file metadata automatically regardless of the value of this property.

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