LEADTOOLS Image Processing (Leadtools.ImageProcessing.Effects assembly)
LEAD Technologies, Inc

FileName Property (AddMessageCommand)

Example 





Gets or sets a string that contains the name of the file that will be added to the image. .NET support WinRT support
Syntax
public string FileName {get; set;}
'Declaration
 
Public Property FileName As String
'Usage
 
Dim instance As AddMessageCommand
Dim value As String
 
instance.FileName = value
 
value = instance.FileName
public string FileName {get; set;}
 get_FileName();
set_FileName(value);
public:
property String^ FileName {
   String^ get();
   void set (    String^ value);
}

Property Value

String that contains the name of the file that will be added to the image. When adding a message to the image this string contains the name of the file that will be added, and the message property must be set to null, otherwise this parameter has no effect.
Example
 
Public Sub FileNamePropertyExample()
   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 = New AddMessageCommand
   ' Assign the file name.
   command.FileName = Path.Combine(LEAD_VARS.ImagesDir, "Message.txt")
   ' You must set this property to null.
   command.Message = Nothing
   ' Assign the password.
   command.Password = "LEAD Technologies"
   ' The starting point.
   command.Start = 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
public void FileNamePropertyExample()
   {
      // 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();
      // Assign the file name.
      command.FileName = Path.Combine(LEAD_VARS.ImagesDir, "image1.txt");
      // You must set this property to null.
      command.Message = null;
      // Assign the password.
      command.Password = "LEAD Technologies";
      // The starting point.
      command.Start = new LeadPoint(0, 0);
      // Run the commnad.
      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";
}
Requirements

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

See Also

Reference

AddMessageCommand Class
AddMessageCommand Members

 

 


Products | Support | Contact Us | Copyright Notices

© 2006-2012 All Rights Reserved. LEAD Technologies, Inc.