LEADTOOLS Image Processing (Leadtools.ImageProcessing.Effects assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
AddMessageCommand Constructor(String,String,String,LeadPoint)
See Also  Example
Leadtools.ImageProcessing.Effects Namespace > AddMessageCommand Class > AddMessageCommand Constructor : AddMessageCommand Constructor(String,String,String,LeadPoint)



message
String that will be added to the image. If you want to add a file, set this parameter to null.
password
String that contains the password that will be used when adding the message to the image. To use the default password set this parameter to null. The default password is, "LEAD Technologies".
fileName
String that contains the name of the file that will be added to the image. When adding a file to the image this string contains the name of the file that will be added, and the message parameter must be set to null, otherwise this parameter has no effect.
start
LeadPoint at which the message will be added to the image.
Initializes a new AddMessageCommand class object with explicit parameters.

Syntax

Visual Basic (Declaration) 
Public Function New( _
   ByVal message As String, _
   ByVal password As String, _
   ByVal fileName As String, _
   ByVal start As LeadPoint _
)
Visual Basic (Usage)Copy Code
Dim message As String
Dim password As String
Dim fileName As String
Dim start As LeadPoint
 
Dim instance As New AddMessageCommand(message, password, fileName, start)
C# 
public AddMessageCommand( 
   string message,
   string password,
   string fileName,
   LeadPoint start
)
C++/CLI 
public:
AddMessageCommand( 
   String^ message,
   String^ password,
   String^ fileName,
   LeadPoint start
)

Parameters

message
String that will be added to the image. If you want to add a file, set this parameter to null.
password
String that contains the password that will be used when adding the message to the image. To use the default password set this parameter to null. The default password is, "LEAD Technologies".
fileName
String that contains the name of the file that will be added to the image. When adding a file to the image this string contains the name of the file that will be added, and the message parameter must be set to null, otherwise this parameter has no effect.
start
LeadPoint at which the message will be added to the image.

Example

Run the AddMessageCommand on an image.

Visual BasicCopy Code
Public Sub AddMessageConstructorExample()
   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 AddMessageCommand
   command = New AddMessageCommand("This is The Message", Nothing, Nothing, New LeadPoint(0, 0))
   ' Run the commnad.
   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
C#Copy Code
public void AddMessageConstructorExample()
   {
      // Load an image
      RasterCodecs codecs = new RasterCodecs();
      codecs.ThrowExceptionsOnInvalidImages = true;

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

      // Prepare the command
      AddMessageCommand command = new AddMessageCommand("This is The Message", null, null, new LeadPoint(0, 0));
      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";
}
SilverlightCSharpCopy Code


SilverlightVBCopy Code



            
            
            
Requirements
Target Platforms: Silverlight 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only) 

            
            
See Also