←Select platform

FileName Property

Summary

Gets or sets a string that contains the name of the file that will be added to the image.

Syntax

WinRT C#

C++

public string FileName { get; set; }

Public Property FileName As String

public string FileName {get; set;}

 <br/>get_FileName();<br/>set_FileName(value);<br/>Object.defineProperty('FileName');

public: 
property String^ FileName { 
   String^ get(); 
   void set (    String^ ); 
}

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

Run the AddMessageCommand on an image.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.Effects; 
 
public void FileNamePropertyExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "IMAGE1.CMP")); 
 
   // 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"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing.Effects 
      Leadtools.Examples.Support.SetLicense() 
 
Public Sub FileNamePropertyExample() 
   Dim codecs As New RasterCodecs() 
   codecs.ThrowExceptionsOnInvalidImages = True 
 
   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "IMAGE1.CMP")) 
 
   ' 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

Requirements

Target Platforms

Reference

AddMessageCommand Class

AddMessageCommand Members

Help Version 19.0.2017.10.27

Leadtools.ImageProcessing.Effects Assembly

Introduction

Getting Started

Namespaces

Leadtools.ImageProcessing.Effects Namespace

Assemblies