←Select platform

DeleteComment(String,Int32,RasterCommentMetadataType) Method

Summary

Deletes a comment field from a file.

Syntax

WinRT C#

C++

public void DeleteComment(  
   string fileName, 
   int pageNumber, 
   Leadtools.RasterCommentMetadataType type 
)

Public Overloads Sub DeleteComment( _ 
   ByVal fileName As String, _ 
   ByVal pageNumber As Integer, _ 
   ByVal type As Leadtools.RasterCommentMetadataType _ 
)

public void DeleteComment(  
   string fileName, 
   int pageNumber, 
   Leadtools.RasterCommentMetadataType type 
)

 function Leadtools.Codecs.RasterCodecs.DeleteComment(String,Int32,RasterCommentMetadataType)(  
   fileName , 
   pageNumber , 
   type  
)

public: 
void DeleteComment(  
   String^ fileName, 
   int pageNumber, 
   Leadtools.RasterCommentMetadataType type 
)

Parameters

fileName
A String containing the input file name.

pageNumber
1-based index of the page from which to read the comment.

type
The type of comment. Refer to Types of File Comments.

Remarks

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.

Example

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