Comments Property

Summary

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

Syntax

Objective-C

C++

Java

public bool Comments { get; set; }

Public Property Comments As Boolean

@property (nonatomic, assign) BOOL comments

public boolean getComments() 
public void setComments(boolean value)

public: 
property bool Comments { 
   bool get(); 
   void set (    bool ); 
}

Property Value

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

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 resulting image.

Internally, the RasterCodecs object will call 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 multipage 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 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.

Example

For an example, refer to Tags.

Requirements

Target Platforms