Leadtools.ImageProcessing.Effects Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
OffsetCommand Class
See Also  Members   Example 
Leadtools.ImageProcessing.Effects Namespace : OffsetCommand Class



Shifts the image data horizontally and vertically.

Syntax

Visual Basic (Declaration) 
Public Class OffsetCommand 
   Inherits RasterCommand
   Implements IRasterCommand 
Visual Basic (Usage)Copy Code
Dim instance As OffsetCommand
C# 
public class OffsetCommand : RasterCommand, IRasterCommand 
C++/CLI 
public ref class OffsetCommand : public RasterCommand, IRasterCommand 

Example

Run the OffsetCommand on an image.

Visual BasicCopy Code
Public Sub OffsetCommandExample()
   RasterCodecs.Startup()
   Dim codecs As New RasterCodecs()
   codecs.ThrowExceptionsOnInvalidImages = True

   Dim leadImage As RasterImage = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "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, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24)

   RasterCodecs.Shutdown()
End Sub
C#Copy Code
public void OffsetCommandExample() 
{ 
   // Load an image 
   RasterCodecs.Startup(); 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "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, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24); 
 
   RasterCodecs.Shutdown(); 
}

Remarks

  • 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.

Inheritance Hierarchy

System.Object
   Leadtools.ImageProcessing.RasterCommand
      Leadtools.ImageProcessing.Effects.OffsetCommand

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also