VintaSoft Imaging .NET SDK 15.1: Documentation for .NET developer
Vintasoft.Imaging.ImageProcessing Namespace / CompositeCommand Class
Members Object Syntax Example Hierarchy Requirements SeeAlso
In This Topic
CompositeCommand Class
In This Topic
Image processing command which executes a group of commands on an image.
Object Model
ProcessingCommandBase ProcessingCommandResults CompositeCommand
Syntax
'Declaration

Public Class CompositeCommand
   Inherits ProcessingCommandBase

public class CompositeCommand : ProcessingCommandBase

Example

This C#/VB.NET code shows how to load an image from disk, apply 'Blur' filter and drop shadow effect to the image and save the result to a new image file.


Class CompositeCommandExample
    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("Flower.jpg")
            Try
                ' create an array of commands, which should be applied to an image
                Dim commands As Vintasoft.Imaging.ImageProcessing.ProcessingCommandBase() = New Vintasoft.Imaging.ImageProcessing.ProcessingCommandBase() {New Vintasoft.Imaging.ImageProcessing.Filters.BlurCommand(), New Vintasoft.Imaging.ImageProcessing.Effects.DropShadowCommand()}
                ' create the image processing command
                Dim command As New Vintasoft.Imaging.ImageProcessing.CompositeCommand(commands)

                ' 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)
                    Next
                Catch ex As Vintasoft.Imaging.ImageProcessing.ImageProcessingException
                    ' show error message
                    System.Windows.Forms.MessageBox.Show(ex.Message)
                    Return
                End Try

                ' save the processed image collection to a new TIFF file
                images.SaveSync("processed-image.tif")
            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 CompositeCommandExample
{
    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("Flower.jpg");
            try
            {
                // create an array of commands, which should be applied to an image
                Vintasoft.Imaging.ImageProcessing.ProcessingCommandBase[] commands =
                     new Vintasoft.Imaging.ImageProcessing.ProcessingCommandBase[] {
                     new Vintasoft.Imaging.ImageProcessing.Filters.BlurCommand(),
                     new Vintasoft.Imaging.ImageProcessing.Effects.DropShadowCommand()
                };
                // create the image processing command
                Vintasoft.Imaging.ImageProcessing.CompositeCommand command =
                    new Vintasoft.Imaging.ImageProcessing.CompositeCommand(commands);

                // 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);
                    }
                }
                catch (Vintasoft.Imaging.ImageProcessing.ImageProcessingException ex)
                {
                    // show error message
                    System.Windows.Forms.MessageBox.Show(ex.Message);
                    return;
                }

                // save the processed image collection to a new TIFF file
                images.SaveSync("processed-image.tif");
            }
            finally
            {
                images.ClearAndDisposeItems();
            }
        }
    }

    private 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.CompositeCommand
         Vintasoft.Imaging.ImageProcessing.Document.OcrPreprocessingCommand

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