VintaSoft Imaging .NET SDK 15.1: Documentation for .NET developer
Vintasoft.Imaging.ImageProcessing.Info Namespace / IsImageBlankCommand Class
Members Object Syntax Remarks Example Hierarchy Requirements SeeAlso
In This Topic
IsImageBlankCommand Class
In This Topic
Checks whether an image is blank.
Object Model
ProcessingCommandResults IsImageBlankCommand
Syntax
'Declaration

Public Class IsImageBlankCommand
   Inherits Vintasoft.Imaging.ImageProcessing.ProcessingCommandBase

public class IsImageBlankCommand : Vintasoft.Imaging.ImageProcessing.ProcessingCommandBase

Remarks

Command analyzes the image pixels and collects information about colors used in image.

Example

This C#/VB.NET code shows how to load an image from disk and checks whether the image is blank.


Class IsImageBlankCommandExample
    Public Sub ProcessImage()
        ' [ do not forget to set your image file path here! ]
        ' create an image collection
        Using images As New Vintasoft.Imaging.ImageCollection()
            ' add image to the image collection
            images.Add("Deskew.tif")
            Try
                ' create the image processing command
                Dim command As New Vintasoft.Imaging.ImageProcessing.Info.IsImageBlankCommand()

                ' subscribe to progress event of image processing command
                AddHandler command.Progress, New System.EventHandler(Of Vintasoft.Imaging.ImageProcessing.ImageProcessingProgressEventArgs)(AddressOf command_Progress)

                Try
                    ' for each image in image collection
                    For Each image As Vintasoft.Imaging.VintasoftImage In images
                        ' apply the image processing command to the image
                        command.ExecuteInPlace(image)

                        ' show result
                        System.Windows.Forms.MessageBox.Show(String.Format("Permitted noise level is {0}%, current noise level is {1}%", command.MaxNoiseLevel, command.NoiseLevel))

                        If command.Result Then
                            System.Windows.Forms.MessageBox.Show("Image is blank.")
                        Else
                            System.Windows.Forms.MessageBox.Show("Image is not blank.")
                        End If
                    Next
                Catch ex As Vintasoft.Imaging.ImageProcessing.ImageProcessingException
                    ' show error message
                    System.Windows.Forms.MessageBox.Show(ex.Message)
                    Return
                End Try
            Finally
                images.ClearAndDisposeItems()
            End Try
        End Using
    End Sub

    Private Sub command_Progress(sender As Object, e As Vintasoft.Imaging.ImageProcessing.ImageProcessingProgressEventArgs)
        ' update progress info using e.Progress property
        ' ...

        ' cancel execution of command using e.Cancel property if necessary
        ' ...
    End Sub

End Class


class IsImageBlankCommandExample
{
    public void ProcessImage()
    {
        // [ do not forget to set your image file path here! ]
        // create an image collection
        using (Vintasoft.Imaging.ImageCollection images = new Vintasoft.Imaging.ImageCollection())
        {
            // add image to the image collection
            images.Add("Deskew.tif");
            try
            {
                // create the image processing command
                Vintasoft.Imaging.ImageProcessing.Info.IsImageBlankCommand command =
                    new Vintasoft.Imaging.ImageProcessing.Info.IsImageBlankCommand();

                // subscribe to progress event of image processing command
                command.Progress +=
                    new System.EventHandler<Vintasoft.Imaging.ImageProcessing.ImageProcessingProgressEventArgs>(command_Progress);

                try
                {
                    // for each image in image collection
                    foreach (Vintasoft.Imaging.VintasoftImage image in images)
                    {
                        // apply the image processing command to the image
                        command.ExecuteInPlace(image);

                        // show result
                        System.Windows.Forms.MessageBox.Show(string.Format("Permitted noise level is {0}%, current noise level is {1}%", command.MaxNoiseLevel, command.NoiseLevel));

                        if (command.Result)
                            System.Windows.Forms.MessageBox.Show("Image is blank.");
                        else
                            System.Windows.Forms.MessageBox.Show("Image is not blank.");
                    }
                }
                catch (Vintasoft.Imaging.ImageProcessing.ImageProcessingException ex)
                {
                    // show error message
                    System.Windows.Forms.MessageBox.Show(ex.Message);
                    return;
                }
            }
            finally
            {
                images.ClearAndDisposeItems();
            }
        }
    }
    
    void command_Progress(object sender, Vintasoft.Imaging.ImageProcessing.ImageProcessingProgressEventArgs e)
    {
        // update progress info using e.Progress property
        // ...

        // cancel execution of command using e.Cancel property if necessary
        // ...
    }

}

Inheritance Hierarchy

System.Object
   Vintasoft.Imaging.ImageProcessing.ProcessingCommandBase
      Vintasoft.Imaging.ImageProcessing.Info.IsImageBlankCommand

Requirements

Target Platforms: .NET 10; .NET 9; .NET 8; .NET 7; .NET 6; .NET Framework 4.8, 4.7, 4.6, 4.5, 4.0, 3.5

See Also