Leadtools Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
ClearCommand Class
See Also  Members   Example 
Leadtools.ImageProcessing Namespace : ClearCommand Class



Sets all bits to 0 in the specified image, making it a black image.

Syntax

Visual Basic (Declaration)  
Public Class ClearCommand 
   Inherits RasterCommand
   Implements IRasterCommand 
Visual Basic (Usage) Copy Code
Dim instance As ClearCommand
C#  
public class ClearCommand : RasterCommand, IRasterCommand 
C++/CLI  
public ref class ClearCommand : public RasterCommand, IRasterCommand 

Example

This example will clear an image before saving it back to disk.

Visual Basic Copy Code
Public Sub ClearCommandExample()
   RasterCodecs.Startup()
   Dim codecs As RasterCodecs = New RasterCodecs()

   Dim srcFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "Image1.cmp"
   Dim destFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "Image1_clear.bmp"

   ' Load the source image from disk
   Dim image As RasterImage = codecs.Load(srcFileName)

   ' Clear the image
   Dim cmd As ClearCommand = New ClearCommand()
   cmd.Run(image)

   ' Save the image to disk
   codecs.Save(image, destFileName, RasterImageFormat.Bmp, 24)

   ' Clean up
   image.Dispose()
   RasterCodecs.Shutdown()
End Sub
C# Copy Code
public void ClearCommandExample() 
{ 
   RasterCodecs.Startup(); 
   RasterCodecs codecs = new RasterCodecs(); 
 
   string srcFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Image1.cmp"; 
   string destFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Image1_clear.bmp"; 
 
   // Load the source image from disk 
   RasterImage image = codecs.Load(srcFileName); 
 
   // Clear the image 
   ClearCommand cmd = new ClearCommand(); 
   cmd.Run(image); 
 
   // Save the image to disk 
   codecs.Save( 
      image, 
      destFileName, 
      RasterImageFormat.Bmp, 
      24); 
 
   // Clean up 
   image.Dispose(); 
   RasterCodecs.Shutdown(); 
}

Remarks

Sets all bits to 0, in the specified image. If the image has a palette, all pixels will be the color of the first palette entry.

For more information, refer to Introduction to Image Processing With LEADTOOLS.

Inheritance Hierarchy

System.Object
   Leadtools.ImageProcessing.RasterCommand
      Leadtools.ImageProcessing.ClearCommand

Requirements

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

See Also