Leadtools.Codecs Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
WriteMarker(String,Int32,RasterMarkerMetadata) Method
See Also  Example
Leadtools.Codecs Namespace > RasterCodecs Class > WriteMarker Method : WriteMarker(String,Int32,RasterMarkerMetadata) Method



fileName
A String that contains the file name.
pageNumber
1-based index of the page at which to write the marker.
marker
A RasterMarkerMetadata object that contains the marker data.
Writes a marker to an existing file.

Syntax

Visual Basic (Declaration) 
Public Overloads Sub WriteMarker( _
   ByVal fileName As String, _
   ByVal pageNumber As Integer, _
   ByVal marker As RasterMarkerMetadata _
) 
Visual Basic (Usage)Copy Code
Dim instance As RasterCodecs
Dim fileName As String
Dim pageNumber As Integer
Dim marker As RasterMarkerMetadata
 
instance.WriteMarker(fileName, pageNumber, marker)
C# 
public void WriteMarker( 
   string fileName,
   int pageNumber,
   RasterMarkerMetadata marker
)
C++/CLI 
public:
void WriteMarker( 
   String^ fileName,
   int pageNumber,
   RasterMarkerMetadata marker
) 

Parameters

fileName
A String that contains the file name.
pageNumber
1-based index of the page at which to write the marker.
marker
A RasterMarkerMetadata object that contains the marker data.

Example

This example read the markers from a source file and saving them to a destination file

Visual BasicCopy Code
Private Sub MarkersExample(ByVal srcFileName As String, ByVal destFileName As String)
   RasterCodecs.Startup()
   Dim codecs As RasterCodecs = New RasterCodecs()
   ' Load the source image with markers
   Console.WriteLine("Loading the source image with all markers")
   codecs.Options.Load.Markers = True
   Dim srcImage As RasterImage = codecs.Load(srcFileName)

   ' Show the markers loaded
   Console.WriteLine("These markers were loaded:")
   For Each marker As RasterMarkerMetadata In srcImage.Markers
      Dim data As Byte() = marker.GetData()
      Console.WriteLine(" {0}, DataSize:{1}", marker.Id, data.Length)
   Next marker

   ' Create the destination image
   Dim destImage As RasterImage = New RasterImage(RasterMemoryFlags.Conventional, 320, 20, 24, RasterByteOrder.Bgr, RasterViewPerspective.TopLeft, Nothing, IntPtr.Zero, 0)

   ' Save this as JPEG
   codecs.Save(destImage, destFileName, RasterImageFormat.Jpeg, 24)

   ' Write the markers from the source image to this destination image
   Console.WriteLine("Writing the markers to the destination file")
   codecs.WriteMarkers(destFileName, 1, srcImage.Markers)

   srcImage.Dispose()
   destImage.Dispose()

   ' Re-load the destination image with markers
   Console.WriteLine("Loading the destination image with all markers")
   codecs.Options.Load.Markers = True
   destImage = codecs.Load(destFileName)

   ' Show the markers loaded
   Console.WriteLine("These markers were loaded:")
   For Each marker As RasterMarkerMetadata In destImage.Markers
      Dim data As Byte() = marker.GetData()
      Console.WriteLine(" {0}, DataSize:{1}", marker.Id, data.Length)
   Next marker

   destImage.Dispose()

   ' Clean up
   codecs.Dispose()
   RasterCodecs.Shutdown()
End Sub
C#Copy Code
void MarkersExample(string srcFileName, string destFileName) 

   RasterCodecs.Startup(); 
   RasterCodecs codecs = new RasterCodecs(); 
   // Load the source image with markers 
   Console.WriteLine("Loading the source image with all markers"); 
   codecs.Options.Load.Markers = true; 
   RasterImage srcImage = codecs.Load(srcFileName); 
 
   // Show the markers loaded 
   Console.WriteLine("These markers were loaded:"); 
   foreach(RasterMarkerMetadata marker in srcImage.Markers) 
   { 
      byte[] data = marker.GetData(); 
      Console.WriteLine(" {0}, DataSize:{1}", marker.Id, data.Length); 
   } 
 
   // Create the destination image 
   RasterImage destImage = new RasterImage( 
      RasterMemoryFlags.Conventional, 
      320, 
      20, 
      24, 
      RasterByteOrder.Bgr, 
      RasterViewPerspective.TopLeft, 
      null, 
      IntPtr.Zero, 
      0); 
 
   // Save this as JPEG 
   codecs.Save(destImage, destFileName, RasterImageFormat.Jpeg, 24); 
 
   // Write the markers from the source image to this destination image 
   Console.WriteLine("Writing the markers to the destination file"); 
   codecs.WriteMarkers(destFileName, 1, srcImage.Markers); 
 
   srcImage.Dispose(); 
   destImage.Dispose(); 
 
   // Re-load the destination image with markers 
   Console.WriteLine("Loading the destination image with all markers"); 
   codecs.Options.Load.Markers = true; 
   destImage = codecs.Load(destFileName); 
 
   // Show the markers loaded 
   Console.WriteLine("These markers were loaded:"); 
   foreach(RasterMarkerMetadata marker in destImage.Markers) 
   { 
      byte[] data = marker.GetData(); 
      Console.WriteLine(" {0}, DataSize:{1}", marker.Id, data.Length); 
   } 
 
   destImage.Dispose(); 
 
   // Clean up 
   codecs.Dispose(); 
   RasterCodecs.Shutdown(); 
}

Remarks

For Exif files, this metadata collection will contain all the Exif and GPS comments, stored in APP1. It will also contain the audio information stored in APP2.

When you add or remove tags, the tags array at the end of the file is re-written. When you modify existing tags, the new tag value is added to the file and the IFD is modified as necessary. In all of these cases, there is no image recompression.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also