LEADTOOLS (Leadtools assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
ClearCommand Class
See Also  Members  
Leadtools.ImageProcessing Namespace : ClearCommand Class



Sets all bits to 0 in the specified image, making it a black image. Supported in Silverlight, Windows Phone 7

Object Model

ClearCommand Class

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 BasicCopy Code
Public Sub ClearCommandExample()
      Dim codecs As RasterCodecs = New RasterCodecs()

      Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp")
      Dim destFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "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()
   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 ClearCommandExample()
   {
      RasterCodecs codecs = new RasterCodecs();

      string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp");
      string destFileName = Path.Combine(LEAD_VARS.ImagesDir,"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();
   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}
SilverlightCSharpCopy Code
public void ClearCommandExample(RasterImage image, Stream destStream)
{
   RasterCodecs codecs = new RasterCodecs();
   // Clear the image
   ClearCommand cmd = new ClearCommand();
   cmd.Run(image);

   // Save the image to disk
   codecs.Save(
      image,
      destStream,
      RasterImageFormat.Bmp,
      24);

   // Clean up
   image.Dispose();
}
SilverlightVBCopy Code
Public Sub ClearCommandExample(ByVal image As RasterImage, ByVal destStream As Stream)
   Dim codecs As RasterCodecs = New RasterCodecs()
   ' Clear the image
   Dim cmd As ClearCommand = New ClearCommand()
   cmd.Run(image)

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

   ' Clean up
   image.Dispose()
End Sub

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: Silverlight, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only), Windows Phone 7

See Also