OffsetCommand Class

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public class OffsetCommand : Leadtools.ImageProcessing.RasterCommand, Leadtools.ImageProcessing.IRasterCommand

'Declaration
 
Public Class OffsetCommand 
   Inherits Leadtools.ImageProcessing.RasterCommand
   Implements Leadtools.ImageProcessing.IRasterCommand

'Usage
 
Dim instance As OffsetCommand

public sealed class OffsetCommand : Leadtools.ImageProcessing.IRasterCommand

function Leadtools.ImageProcessing.Effects.OffsetCommand()

public ref class OffsetCommand : public Leadtools.ImageProcessing.RasterCommand, Leadtools.ImageProcessing.IRasterCommand

This command supports 12 and 16-bit grayscale and 48 and 64-bit color images. Support for 12 and 16-bit grayscale and 48 and 64-bit color images is available only in the Document/Medical toolkits.
This command does not support signed data images.
This command does not support 32-bit grayscale images.

For more information, refer to Applying Artistic Effects.

In Silverlight and Windows Phone versions of LEADTOOLS, this image processing command will fail if the image data for the RasterImage object is stored internally using a Silverlight WriteableBitmap object. For more information, refer to Image Processing Command Limitations in Silverlight.

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

Public Sub OffsetCommandExample()
   Dim codecs As New RasterCodecs()
   codecs.ThrowExceptionsOnInvalidImages = True

   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Master.jpg"))

   ' Prepare the command
   Dim command As OffsetCommand = New OffsetCommand
   command.HorizontalShift = leadImage.Width \ 2
   command.VerticalShift = leadImage.Height \ 2
   command.BackColor = New RasterColor(128, 128, 128)
   command.Type = OffsetCommandType.Color
   'Apply offset on the image.
   command.Run(leadImage)
   codecs.Save(leadImage, Path.Combine(LEAD_VARS.ImagesDir, "Result.jpg"), RasterImageFormat.Jpeg, 24)

End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class

public void OffsetCommandExample()
   {
      // Load an image
      RasterCodecs codecs = new RasterCodecs();
      codecs.ThrowExceptionsOnInvalidImages = true;

      RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Master.jpg"));

      // Prepare the command
      OffsetCommand command = new OffsetCommand();
      command.HorizontalShift = image.Width / 2;
      command.VerticalShift = image.Height / 2;
      command.BackColor = new RasterColor(128, 128, 128);
      command.Type = OffsetCommandType.Color;
      //Apply offset on the image.
      command.Run(image);
      codecs.Save(image, Path.Combine(LEAD_VARS.ImagesDir, "Result.jpg"), RasterImageFormat.Jpeg, 24);

   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

[TestMethod]
public async Task OffsetCommandExample()
{
   // Load an image
   RasterCodecs codecs = new RasterCodecs();
   codecs.ThrowExceptionsOnInvalidImages = true;
   // Load the image
   string srcFileName = @"Assets\Image1.cmp";
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName);
   RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile));

   // Prepare the command
   OffsetCommand command = new OffsetCommand();
   command.HorizontalShift = image.Width / 2;
   command.VerticalShift = image.Height / 2;
   command.BackColor = RasterColorHelper.Create(128, 128, 128);
   command.Type = OffsetCommandType.Color;
   //Apply offset on the image.
   command.Run(image);
   //Save as BMP
   string destFileName = @"result.bmp";
   StorageFile saveFile = await Tools.AppLocalFolder.CreateFileAsync(destFileName);
   await codecs.SaveAsync(image, LeadStreamFactory.Create(saveFile), RasterImageFormat.Bmp, 24);

}

public void OffsetCommandExample(RasterImage image, Stream outStream)
{
   // Prepare the command
   OffsetCommand command = new OffsetCommand();
   command.HorizontalShift = image.Width / 2;
   command.VerticalShift = image.Height / 2;
   command.BackColor = new RasterColor(128, 128, 128);
   command.Type = OffsetCommandType.Color;
   //Apply offset on the image.
   command.Run(image);
   // Save result image
   RasterCodecs codecs = new RasterCodecs();
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24);
   image.Dispose();
}

Public Sub OffsetCommandExample(ByVal image As RasterImage, ByVal outStream As Stream)
   ' Prepare the command
   Dim command As OffsetCommand = New OffsetCommand()
   command.HorizontalShift = image.Width / 2
   command.VerticalShift = image.Height / 2
   command.BackColor = New RasterColor(128, 128, 128)
   command.Type = OffsetCommandType.Color
   'Apply offset on the image.
   command.Run(image)
   ' Save result image
   Dim codecs As RasterCodecs = New RasterCodecs()
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24)
   image.Dispose()
End Sub

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference