LEADTOOLS Image Processing (Leadtools.ImageProcessing.SpecialEffects assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
CanvasCommand Constructor(RasterImage,Int32,Int32,Int32,Int32,Int32,CanvasCommandFlags)
See Also  Example
Leadtools.ImageProcessing.SpecialEffects Namespace > CanvasCommand Class > CanvasCommand Constructor : CanvasCommand Constructor(RasterImage,Int32,Int32,Int32,Int32,Int32,CanvasCommandFlags)



canvasImage
References the canvas image.
transparency
The transparency amount between the image and the canvas. Valid range is from 0 to 100. When set to 0, only the canvas image displays, and when set to 100, the canvas image is barely visible.
emboss
Apparent depth of the canvas image. Valid range is from 0 to 200. When Transparency is at 100, and Emboss is 0 only the image displays. Increasing Emboss increases the apparent depth of the canvas image.
xOffset
The X distance between the canvas origin point and the image origin point (in pixels). Valid range is from -Canvas image width to +Canvas image width.
yOffset
The Y distance between the canvas origin point and the image origin point (in pixels). Valid range is from -Canvas image height to +Canvas image height.
tileOffset
The amount to shift every row of the canvas image from the origin. This parameter is not used when Flags is set to CanvasCommandFlags.TileFit.
flags
Flags that identify how to distribute the canvas image with respect to the image and how to handle resizing.
Initializes a new Leadtools.ImageProcessing.SpecialEffects.CanvasCommand class object with explicit parameters.

Syntax

Visual Basic (Declaration) 
Public Function New( _
   ByVal canvasImage As RasterImage, _
   ByVal transparency As Integer, _
   ByVal emboss As Integer, _
   ByVal xOffset As Integer, _
   ByVal yOffset As Integer, _
   ByVal tileOffset As Integer, _
   ByVal flags As CanvasCommandFlags _
)
Visual Basic (Usage)Copy Code
Dim canvasImage As RasterImage
Dim transparency As Integer
Dim emboss As Integer
Dim xOffset As Integer
Dim yOffset As Integer
Dim tileOffset As Integer
Dim flags As CanvasCommandFlags
 
Dim instance As New CanvasCommand(canvasImage, transparency, emboss, xOffset, yOffset, tileOffset, flags)
C# 
public CanvasCommand( 
   RasterImage canvasImage,
   int transparency,
   int emboss,
   int xOffset,
   int yOffset,
   int tileOffset,
   CanvasCommandFlags flags
)
C++/CLI 
public:
CanvasCommand( 
   RasterImage^ canvasImage,
   int transparency,
   int emboss,
   int xOffset,
   int yOffset,
   int tileOffset,
   CanvasCommandFlags flags
)

Parameters

canvasImage
References the canvas image.
transparency
The transparency amount between the image and the canvas. Valid range is from 0 to 100. When set to 0, only the canvas image displays, and when set to 100, the canvas image is barely visible.
emboss
Apparent depth of the canvas image. Valid range is from 0 to 200. When Transparency is at 100, and Emboss is 0 only the image displays. Increasing Emboss increases the apparent depth of the canvas image.
xOffset
The X distance between the canvas origin point and the image origin point (in pixels). Valid range is from -Canvas image width to +Canvas image width.
yOffset
The Y distance between the canvas origin point and the image origin point (in pixels). Valid range is from -Canvas image height to +Canvas image height.
tileOffset
The amount to shift every row of the canvas image from the origin. This parameter is not used when Flags is set to CanvasCommandFlags.TileFit.
flags
Flags that identify how to distribute the canvas image with respect to the image and how to handle resizing.

Example

This procedure run a Leadtools.ImageProcessing.SpecialEffects.CanvasCommand of the image using canvasImage.

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

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

   ' Prepare the command
   Dim canvasCommand As CanvasCommand = New CanvasCommand(canvasImage, 100, 100, 10, 10, 20, CanvasCommandFlags.TileFit)
   canvasCommand.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
C#Copy Code
public void CanvasConstructorExample_S2()
   {
      // Load an image
      RasterCodecs codecs = new RasterCodecs();
      codecs.ThrowExceptionsOnInvalidImages = true;

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

      // Prepaire the command
      CanvasCommand canvasCommand = new CanvasCommand(canvasImage, 100, 100, 10, 10, 20, CanvasCommandFlags.TileFit);

      // Apply the command.
      canvasCommand.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";
}

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also