ClearCommand Class

C#
Visual Basic
WinRT C#
Java
Objective-C
WinRT JavaScript
C++

public class ClearCommand : RasterCommand, IRasterCommand

'Declaration

Public Class ClearCommand 
   Inherits RasterCommand
   Implements IRasterCommand

'Usage

Dim instance As ClearCommand

public sealed class ClearCommand : IRasterCommand

@interface LTClearCommand : LTRasterCommand

public class ClearCommand extends RasterCommand

function Leadtools.ImageProcessing.ClearCommand()

public ref class ClearCommand : public RasterCommand, IRasterCommand

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.

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

C#
Visual Basic
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

Imports Leadtools
Imports Leadtools.Codecs
Imports Leadtools.ImageProcessing

      
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

using Leadtools;
using Leadtools.Codecs;
using Leadtools.ImageProcessing;

      
public void ClearCommandExample()
{
   RasterCodecs codecs = new RasterCodecs();
   string srcFileName = Path.Combine(ImagesPath.Path, "Image1.cmp");
   string destFileName = Path.Combine(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();
   codecs.Dispose();
}

RasterCommandExamples.prototype.ClearCommandExample = function () {
    Tools.SetLicense();
    with (Leadtools) {
        with (Leadtools.Codecs) {
            with (Leadtools.ImageProcessing) {

                var codecs = new RasterCodecs();

                var srcFileName = "Assets\\Image1.cmp";
                var destFileName = "Image1_clear.bmp";
                var image;
                // Load the source image from disk
                return Tools.AppInstallFolder().getFileAsync(srcFileName)
                .then(function (loadFile) {
                    return codecs.loadAsync(LeadStreamFactory.create(loadFile))
                })
                .then(function (img) {
                    image = img;

                    // Clear the image
                    var cmd = new ClearCommand();
                    cmd.run(image);

                    // Save the image to disk
                    return Tools.AppLocalFolder().createFileAsync(destFileName)
                })
                .then(function (saveFile) {
                    return codecs.saveAsync(image, LeadStreamFactory.create(saveFile), RasterImageFormat.bmp, 24)
                })
                .then(function () {
                    // Clean up
                    image.close();
                    codecs.close();
                });
            }
        }
    }
}

using Leadtools;
using Leadtools.Codecs;
using Leadtools.ImageProcessing;

      
public async Task ClearCommandExample()
{
   RasterCodecs codecs = new RasterCodecs();
   string srcFileName = @"Assets\Image1.cmp";
   string destFileName = @"Image1_clear.bmp";

   // Load the source image from disk
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName);
   RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile));

   // Clear the image
   ClearCommand cmd = new ClearCommand();
   cmd.Run(image);

   // Save the image to disk
   StorageFile saveFile = await Tools.AppLocalFolder.CreateFileAsync(destFileName);
   await codecs.SaveAsync(image, LeadStreamFactory.Create(saveFile), RasterImageFormat.Bmp, 24);

   // Clean up
   image.Dispose();
}

using Leadtools;
using Leadtools.Codecs;
using Leadtools.Examples;
using Leadtools.ImageProcessing;
using Leadtools.Windows.Media;

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();
}

Imports Leadtools
Imports Leadtools.Codecs
Imports Leadtools.ImageProcessing
Imports Leadtools.Windows.Media

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

Target Platforms

Reference

ClearCommand Members
Leadtools.ImageProcessing Namespace