Deletes a comment field from a file.
public void DeleteComment(
Stream stream,
int pageNumber,
RasterCommentMetadataType type
)
Public Overloads Sub DeleteComment( _
ByVal stream As Stream, _
ByVal pageNumber As Integer, _
ByVal type As RasterCommentMetadataType _
)
public:
void DeleteComment(
Stream^ stream,
int pageNumber,
RasterCommentMetadataType type
)
stream
A Stream containing the input file data.
pageNumber
1-based index of the page from which to read the comment.
type
The type of comment. Refer to Types of File Comments.
This function only applies to TIF, EXIF, JPEG or JPEG 2000 files.
You can use CommentsSupported to determine whether a certain file format supports comments.
using Leadtools;
using Leadtools.Codecs;
using Leadtools.ImageProcessing;
using Leadtools.ImageProcessing.Color;
using Leadtools.Svg;
using LeadtoolsExamples.Common;
public void DeleteCommentExample()
{
RasterCodecs codecs = new RasterCodecs();
string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Test.jpg");
RasterCommentMetadataType commentType = RasterCommentMetadataType.IptcKeywords;
RasterCommentMetadata comment = codecs.ReadComment(srcFileName, 1, commentType);
if (comment == null)
Debug.WriteLine("comment is already missing!");
else
{
codecs.DeleteComment(srcFileName, 1, commentType);
comment = codecs.ReadComment(srcFileName, 1, commentType);
if (comment != null)
Debug.WriteLine("comment is still there!");
}
// Clean up
codecs.Dispose();
}
static class LEAD_VARS
{
public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}
Imports Leadtools
Imports Leadtools.Codecs
Imports Leadtools.ImageProcessing
Imports Leadtools.ImageProcessing.Color
Imports Leadtools.Drawing
Imports Leadtools.Svg
Public Sub DeleteCommentExample()
Dim codecs As New RasterCodecs()
Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Test.jpg")
Dim commentType As RasterCommentMetadataType = RasterCommentMetadataType.IptcKeywords
Dim comment As RasterCommentMetadata = codecs.ReadComment(srcFileName, 1, commentType)
If (comment Is Nothing) Then
Debug.WriteLine("comment is already missing!")
Else
codecs.DeleteComment(srcFileName, 1, commentType)
comment = codecs.ReadComment(srcFileName, 1, commentType)
If (Not comment Is Nothing) Then
Debug.WriteLine("comment is still there!")
End If
End If
' Clean up
codecs.Dispose()
End Sub
Public NotInheritable Class LEAD_VARS
Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class
Help Collections
Raster .NET | C API | C++ Class Library | HTML5 JavaScript
Document .NET | C API | C++ Class Library | HTML5 JavaScript
Medical .NET | C API | C++ Class Library | HTML5 JavaScript
Medical Web Viewer .NET
Multimedia
Direct Show .NET | C API | Filters
Media Foundation .NET | C API | Transforms
Supported Platforms
.NET, Java, Android, and iOS/macOS Assemblies
Imaging, Medical, and Document
C API/C++ Class Libraries
Imaging, Medical, and Document
HTML5 JavaScript Libraries
Imaging, Medical, and Document