←Select platform

ExtractMessageCommand Class

Summary

Extracts a message (text or file) from the image, if the image has an embedded message. This command is available in the Document/Medical Toolkits.

Syntax

WinRT C#

C++

public class ExtractMessageCommand : RasterCommand

Public Class ExtractMessageCommand  
   Inherits Leadtools.Imageprocessing.Leadtools.ImageProcessing.RasterCommand 
   Implements Leadtools.Imageprocessing.Leadtools.ImageProcessing.IRasterCommand

public sealed class ExtractMessageCommand : Leadtools.Imageprocessing.Leadtools.ImageProcessing.IRasterCommand

function Leadtools.ImageProcessing.Effects.ExtractMessageCommand()

public ref class ExtractMessageCommand : public Leadtools.Imageprocessing.Leadtools.ImageProcessing.RasterCommand, Leadtools.Imageprocessing.Leadtools.ImageProcessing.IRasterCommand

Remarks

This command is used to extract the message that was added to the image by the AddMessageCommand.
Before calling this command, set the password, the starting point, and the directory using the same information used for these when the message was added.
This command can extract a message from any type of lossless image format such as bmp, tiff, lossless jpeg, and so forth. If used with lossy format types the message may be corrupted or lost.
This method supports 24-bit and 48-bits images, and 8-bit and 16-bits grayscale images.
Support for 16-bit grayscale and 48-bit color images is available only in the Document/Medical toolkits.
This command does not support 32-bit grayscale images.

Example

Run the ExtractMessageCommand on an image by loading an image that has an embedded message and extracts the message from it.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.Effects; 
 
public void ExtractMessageCommandExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Result.jpg")); 
 
   // Prepare the command 
   AddMessageCommand addmessageCommand = new AddMessageCommand(); 
   addmessageCommand.Password = null; 
   addmessageCommand.Start = new LeadPoint(0, 0); 
   addmessageCommand.Message = "LEAD Technologies, Inc."; 
   // Add the above message to image in the default position and with the default password. 
   addmessageCommand.Run(image); 
 
   // Prepare the command 
   ExtractMessageCommand command = new ExtractMessageCommand(); 
 
   // set password and start properties values same as AddMessageCommand values. 
   command.Password = null; 
   command.Start = new LeadPoint(0, 0); 
   command.Directory = Path.Combine(LEAD_VARS.ImagesDir, ""); 
 
   // Extract the message from the image in the default position and with the default password. 
   command.Run(image); 
   codecs.Save(image, Path.Combine(LEAD_VARS.ImagesDir, "Result.jpg"), RasterImageFormat.Jpeg, 24); 
 
   if (command.Message != null && command.Message.Length != 0) 
      MessageBox.Show(command.Message, "Extracted Message"); 
   else if (command.FileName != null && command.FileName.Length != 0) 
      MessageBox.Show(command.FileName, "Extracted File"); 
 
 
} 
 
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 ExtractMessageCommandExample() 
   Dim codecs As New RasterCodecs() 
   codecs.ThrowExceptionsOnInvalidImages = True 
 
   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "IMAGE1.CMP")) 
 
   Dim addmessagecommand As AddMessageCommand = New AddMessageCommand 
   addmessagecommand.Message = "LEAD Technologies, Inc." 
   ' Add the above message to image in the default position and with the default password. 
   addmessagecommand.Run(leadImage) 
   ' Prepare the command 
 
   Dim command As ExtractMessageCommand = New ExtractMessageCommand 
 
   ' set password and start properties values same as AddMessageCommand values. 
   command.Password = Nothing 
   command.Start = New LeadPoint(0, 0) 
   command.Directory = LEAD_VARS.ImagesDir 
 
   ' Extract the message from the image in the default position and with the default password. 
   command.Run(leadImage) 
   codecs.Save(leadImage, Path.Combine(LEAD_VARS.ImagesDir, "Result.jpg"), RasterImageFormat.Jpeg, 24) 
 
 
   If (Not (IsNothing(command.Message))) Then 
      MessageBox.Show(command.Message, "Extracted Message") 
   ElseIf (Not (IsNothing(command.FileName))) Then 
      MessageBox.Show(command.FileName, "Extracted File") 
   End If 
 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

Requirements

Target Platforms

Reference

ExtractMessageCommand Members

Leadtools.ImageProcessing.Effects Namespace

AddMessageCommand Class

Help Version 19.0.2017.10.27

Leadtools.ImageProcessing.Effects Assembly

Introduction

Getting Started

Namespaces

Leadtools.ImageProcessing.Effects Namespace

Assemblies