Comments Property (original) (raw)
Summary
The collection of comment data used when reading and writing certain file formats (including GIF).
Syntax
C#
Objective-C
C++/CLI
Java
Python
@property (nonatomic, assign, readonly, nullable) NSMutableArray<LTRasterCommentMetadata *> *comments
public:
property ObservableCollection<RasterCommentMetadata^>^ Comments {
ObservableCollection<RasterCommentMetadata^>^ get();
}
Property Value
A collection of RasterCommentMetadata used when reading and writing certain file formats (including GIF).
Example
using Leadtools;
using Leadtools.Codecs;
using Leadtools.ImageProcessing;
using Leadtools.ImageProcessing.Core;
using Leadtools.ImageProcessing.Color;
using Leadtools.Dicom;
using Leadtools.Drawing;
using Leadtools.Controls;
using Leadtools.Svg;
private void DisplayComment(RasterCommentMetadata comment)
{
switch (comment.DataType)
{
case RasterCommentMetadataDataType.Ascii:
Console.WriteLine("Comment of type " + comment.Type.ToString() + " = " + comment.ToAscii());
break;
}
}
public void CommentsExample()
{
RasterCodecs codecs = new RasterCodecs();
RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "IMAGE1.CMP"));
//Ascii
RasterCommentMetadata commentDataAscii = new RasterCommentMetadata();
// set the artist comment
commentDataAscii.Type = RasterCommentMetadataType.Artist;
commentDataAscii.FromAscii("Test String");
image.Comments.Add(commentDataAscii);
codecs.Options.Save.Comments = true;
codecs.Save(image, Path.Combine(LEAD_VARS.ImagesDir, "IMAGE1_COMMENTS.TIF"), RasterImageFormat.Tif, 0);
// load the comment together with the image
RasterCommentMetadata comment = codecs.ReadComment(Path.Combine(LEAD_VARS.ImagesDir, "IMAGE1_COMMENTS.TIF"), 1, RasterCommentMetadataType.Artist);
DisplayComment(comment);
codecs.Dispose();
}
static class LEAD_VARS
{
public const string ImagesDir = @"C:\LEADTOOLS22\Resources\Images";
}
import java.io.File;
import java.io.IOException;
import java.time.LocalDateTime;
import org.junit.*;
import org.junit.Test;
import org.junit.runner.JUnitCore;
import org.junit.runner.Result;
import org.junit.runner.notification.Failure;
import static org.junit.Assert.*;
import leadtools.*;
import leadtools.barcode.*;
import leadtools.codecs.*;
public void CommentsExample()
{
RasterCodecs codecs = new RasterCodecs();
RasterImage image = codecs.load(combine(LEAD_VARS.ImagesDir, "IMAGE1.CMP"));
//Ascii
RasterCommentMetadata commentDataAscii = new RasterCommentMetadata();
// set the artist comment
commentDataAscii.setType(RasterCommentMetadataType.ARTIST);
commentDataAscii.fromAscii("Test String");
image.getComments().add(commentDataAscii);
codecs.getOptions().getSave().setComments(true);
codecs.save(image, combine(LEAD_VARS.ImagesDir, "IMAGE_TEST_COMMENTS.TIF"), RasterImageFormat.TIF, 0);
// load the comment together with the image
RasterCommentMetadata comment = codecs.readComment(combine(LEAD_VARS.ImagesDir, "IMAGE_TEST_COMMENTS.TIF"), 1, RasterCommentMetadataType.ARTIST);
displayComment(comment);
assertTrue("Comment Meta Data is ASCII",comment.getDataType() == RasterCommentMetadataDataType.ASCII);
codecs.dispose();
}
private void displayComment(RasterCommentMetadata comment)
{
switch (comment.getDataType())
{
case ASCII:
System.out.println("Comment of type " + comment.getDataType().toString() + " = " + comment.toAscii());
break;
case BYTE:
case INT_16:
case RATIONAL:
case URATIONAL:
default:
break;
}
}
public class LEAD_VARS
{
public final static String ImagesDir = "C:\LEADTOOLS22\Resources\Images";
}
Leadtools Assembly