Format Method

Summary
Formats the specified log entry.
Syntax
C#
C++/CLI
public virtual string Format( 
   ILogEntry logEntry 
) 
public: 
virtual String^ Format(  
   ILogEntry^ logEntry 
)  

Parameters

logEntry
The log entry.

Return Value

An XML serialized string that represents the log entry.

Example
C#
using Leadtools; 
using Leadtools.Logging; 
using Leadtools.Logging.LoggingChannel; 
 
 
 
public class TextBoxLoggingChannel : LoggingChannel 
{ 
   private TextBox _TextBox; 
 
   public TextBoxLoggingChannel(TextBox textbox) 
   { 
      _TextBox = textbox; 
   } 
 
   public override void WriteLog(ILogEntry logEntry) 
   { 
      string xml = Format(logEntry); 
 
      _TextBox.Text += xml + "\r\n\r\n"; 
   } 
} 
 
private void TestLogger(TextBox logTextBox) 
{ 
   TextBoxLoggingChannel channel = new TextBoxLoggingChannel(logTextBox); 
 
   // 
   // Add Channel to global logger 
   // 
 
   Logger.Global.LoggingChannels.Add(channel); 
 
   // 
   //Send Log Messages to Logger. 
   // 
 
   Logger.Global.Info("TestSource", "Info Message"); 
   Logger.Global.Debug("TestSource", "Debug Message"); 
   Logger.Global.Error("TestSource", "Error Message"); 
   Logger.Global.Warning("TestSource", "Warning Message"); 
 
   ArgumentException e = new ArgumentException(); 
 
   Logger.Global.Exception("TestSource", e); 
} 
Requirements

Target Platforms

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Logging Assembly
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.