Visual Basic (Declaration) | |
---|---|
Public Event SavePage As EventHandler(Of CodecsPageEventArgs) |
Visual Basic (Usage) | Copy Code |
---|---|
Dim instance As RasterCodecs Dim handler As EventHandler(Of CodecsPageEventArgs) AddHandler instance.SavePage, handler |
C# | |
---|---|
public event EventHandler<CodecsPageEventArgs> SavePage |
C++/CLI | |
---|---|
public: event EventHandler<CodecsPageEventArgs^>^ SavePage |
The event handler receives an argument of type CodecsPageEventArgs containing data related to this event. The following CodecsPageEventArgs properties provide information specific to this event.
Property | Description |
---|---|
Command | Gets or sets a value indicating how the load or save process should continue. |
FileName | Gets the name of the file being loaded or saved. |
Image | Gets the object being loaded from the image file page or the image that is being saved. |
Page | Gets the page number of the image being loaded or saved. |
PageCount | Gets the number of pages being loaded or saved. |
State | Gets the state of the load or save process. |
This example will use the SavePage event to skip a certain page when saving a multipage file
Visual Basic | Copy Code |
---|---|
Public Sub SavePageExample() Dim codecs As RasterCodecs = New RasterCodecs() Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Eye.gif") Dim destFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Eye_SavePage.gif") ' Load all the pages in the file Dim image As RasterImage = codecs.Load(srcFileName) Console.WriteLine("Original image has {0} pages", image.PageCount) ' Add a handler to the SavePage event AddHandler codecs.SavePage, AddressOf codecs_SavePage ' Save all the pages of this file codecs.Save(image, destFileName, RasterImageFormat.Gif, 0, 1, image.PageCount, 1, CodecsSavePageMode.Overwrite) RemoveHandler codecs.SavePage, AddressOf codecs_SavePage ' Check if we saved all pages but 1 Dim info As CodecsImageInfo = codecs.GetInformation(destFileName, True) Console.WriteLine("Info reports {0} pages saved to the file", info.TotalPages) Debug.Assert(info.TotalPages = (image.PageCount - 1)) image.Dispose() ' Clean up codecs.Dispose() End Sub Private Sub codecs_SavePage(ByVal sender As Object, ByVal e As CodecsPageEventArgs) If e.State = CodecsPageEventState.Before AndAlso e.Page = 1 Then ' Before saving the first page, show the save operation information Console.WriteLine("Saving {0} pages to {1}. Image size is {2} by {3}", e.PageCount - 1, e.FileName, e.Image.Width, e.Image.Height) End If If e.State = CodecsPageEventState.After Then Console.WriteLine("{0} saving page {1}:{2}", "After", e.Page, e.PageCount) Else Console.WriteLine("{0} saving page {1}:{2}", "Before", e.Page, e.PageCount) End If ' If this is the 2nd page, ignore it If e.Page = 2 AndAlso e.State = CodecsPageEventState.Before Then e.Command = CodecsPageEventCommand.Skip Console.WriteLine("--- Skipping this page, there should be no 'After' for this one") End If End Sub Public NotInheritable Class LEAD_VARS Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" End Class |
C# | Copy Code |
---|---|
public void SavePageExample() { RasterCodecs codecs = new RasterCodecs(); string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Eye.gif"); string destFileName = Path.Combine(LEAD_VARS.ImagesDir, "Eye_SavePage.gif"); // Load all the pages in the file RasterImage image = codecs.Load(srcFileName); Console.WriteLine("Original image has {0} pages", image.PageCount); // Add a handler to the SavePage event codecs.SavePage += new EventHandler<CodecsPageEventArgs>(codecs_SavePage); // Save all the pages of this file codecs.Save(image, destFileName, RasterImageFormat.Gif, 0, 1, image.PageCount, 1, CodecsSavePageMode.Overwrite); codecs.SavePage -= new EventHandler<CodecsPageEventArgs>(codecs_SavePage); // Check if we saved all pages but 1 CodecsImageInfo info = codecs.GetInformation(destFileName, true); Console.WriteLine("Info reports {0} pages saved to the file", info.TotalPages); Debug.Assert(info.TotalPages == (image.PageCount - 1)); image.Dispose(); // Clean up codecs.Dispose(); } void codecs_SavePage(object sender, CodecsPageEventArgs e) { if(e.State == CodecsPageEventState.Before && e.Page == 1) { // Before saving the first page, show the save operation information Console.WriteLine( "Saving {0} pages to {1}. Image size is {2} by {3}", e.PageCount - 1, e.FileName, e.Image.Width, e.Image.Height); } Console.WriteLine("{0} saving page {1}:{2}", e.State == CodecsPageEventState.After ? "After" : "Before", e.Page, e.PageCount); // If this is the 2nd page, ignore it if(e.Page == 2 && e.State == CodecsPageEventState.Before) { e.Command = CodecsPageEventCommand.Skip; Console.WriteLine("--- Skipping this page, there should be no 'After' for this one"); } } static class LEAD_VARS { public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; } |
SilverlightCSharp | Copy Code |
---|---|
public void SavePageExample(Stream inStreamGif, Stream outStreamGif) { RasterCodecs codecs = new RasterCodecs(); // Load all the pages in the file RasterImage image = codecs.Load(inStreamGif); Debug.WriteLine("Original image has {0} pages", image.PageCount); // Add a handler to the SavePage event codecs.SavePage += new EventHandler<CodecsPageEventArgs>(codecs_SavePage); // Save all the pages of this file codecs.Save(image, outStreamGif, RasterImageFormat.Gif, 0, 1, image.PageCount, 1, CodecsSavePageMode.Overwrite); codecs.SavePage -= new EventHandler<CodecsPageEventArgs>(codecs_SavePage); // Check if we saved all pages but 1 CodecsImageInfo info = codecs.GetInformation(outStreamGif, true); Debug.WriteLine("Info reports {0} pages saved to the file", info.TotalPages); Debug.Assert(info.TotalPages == (image.PageCount - 1)); image.Dispose(); } void codecs_SavePage(object sender, CodecsPageEventArgs e) { if(e.State == CodecsPageEventState.Before && e.Page == 1) { // Before saving the first page, show the save operation information Debug.WriteLine( "Saving {0} pages to {1}. Image size is {2} by {3}", e.PageCount - 1, e.FileName, e.Image.Width, e.Image.Height); } Debug.WriteLine("{0} saving page {1}:{2}", e.State == CodecsPageEventState.After ? "After" : "Before", e.Page, e.PageCount); // If this is the 2nd page, ignore it if(e.Page == 2 && e.State == CodecsPageEventState.Before) { e.Command = CodecsPageEventCommand.Skip; Debug.WriteLine("--- Skipping this page, there should be no 'After' for this one"); } } |
SilverlightVB | Copy Code |
---|---|
Public Sub SavePageExample(ByVal inStreamGif As Stream, ByVal outStreamGif As Stream) Dim codecs As RasterCodecs = New RasterCodecs() ' Load all the pages in the file Dim image As RasterImage = codecs.Load(inStreamGif) Debug.WriteLine("Original image has {0} pages", image.PageCount) ' Add a handler to the SavePage event AddHandler codecs.SavePage, AddressOf codecs_SavePage ' Save all the pages of this file codecs.Save(image, outStreamGif, RasterImageFormat.Gif, 0, 1, image.PageCount, 1, CodecsSavePageMode.Overwrite) RemoveHandler codecs.SavePage, AddressOf codecs_SavePage ' Check if we saved all pages but 1 Dim info As CodecsImageInfo = codecs.GetInformation(outStreamGif, True) Debug.WriteLine("Info reports {0} pages saved to the file", info.TotalPages) Debug.Assert(info.TotalPages = (image.PageCount - 1)) image.Dispose() End Sub Private Sub codecs_SavePage(ByVal sender As Object, ByVal e As CodecsPageEventArgs) If e.State = CodecsPageEventState.Before AndAlso e.Page = 1 Then ' Before saving the first page, show the save operation information Debug.WriteLine("Saving {0} pages to {1}. Image size is {2} by {3}", e.PageCount - 1, e.FileName, e.Image.Width, e.Image.Height) End If If e.State = CodecsPageEventState.After Then Debug.WriteLine("{0} saving page {1}:{2}","After", e.Page, e.PageCount) Else Debug.WriteLine("{0} saving page {1}:{2}","Before", e.Page, e.PageCount) End If ' If this is the 2nd page, ignore it If e.Page = 2 AndAlso e.State = CodecsPageEventState.Before Then e.Command = CodecsPageEventCommand.Skip Debug.WriteLine("--- Skipping this page, there should be no 'After' for this one") End If End Sub |
This event will fire once for each page save with any of the Save(RasterImage,String,RasterImageFormat,Int32) methods. You can use this event to get information about the image pages being saved or to skip saving certain pages.
Target Platforms: Silverlight, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)