←Select platform

Run Method

Summary

Applies the action logic to the document, given the results of the document analysis.

Syntax
C#
VB
C++
public abstract void Run( 
   LEADDocument document, 
   IList<ElementSetResult> results 
) 
Public MustOverride Sub Run( 
   ByVal document As LEADDocument, 
   ByVal results As IList(Of ElementSetResult 
)) 
public:  
   virtual void Run( 
      LEADDocument^ document, 
      IList<ElementSetResult^>^ results 
   ) abstract 

Parameters

document

Document to be edited.

results

Results of the document analysis.

Example

This example shows how to define and run a custom action.

C#
using Leadtools; 
using Leadtools.Document.Analytics; 
using Leadtools.Document; 
using Leadtools.Document.Unstructured; 
 
 
public class RedactAction : ActionElement 
{ 
   public RedactAction() 
   { 
      Id = "REDACT_DOCUMENT"; 
   } 
 
   public override void Run(LEADDocument document, IList<ElementSetResult> results) 
   { 
      //process(document, results.Items); 
      //save(document); 
   }          
} 
 
public void Sample() 
{ 
   var leadDoc = DocumentFactory.LoadFromFile(@"c:\test.docx", new LoadDocumentOptions()); 
   var analyzer = new DocumentAnalyzer(); 
   var elem = new UnstructuredElementSet() { Name = "Test", Element = CreateElement() }; 
   var actions = new ActionElementSet(); 
   actions.ActionElements.Add(new RedactAction()); 
 
   var runOptions = new DocumentAnalyzerRunOptions() 
   { 
      ElementSet = new List<IElementSet>() { elem } 
      Actions = actions 
   }; 
 
   analyzer.Run(leadDoc, runOptions); 
} 
 
private static GroupElement CreateElement() 
{ 
   GroupElement mainGroup = new GroupElement(); 
   mainGroup.Id = "ALL"; 
   mainGroup.Settings.SetValue(SettingsManager.Name, "all"); 
   mainGroup.Settings.SetValue(SettingsManager.ReportInElementResult, "true"); 
   mainGroup.Settings.SetValue(SettingsManager.Description, "Rules"); 
   mainGroup.Settings.SetValue(SettingsManager.Languages, "en"); 
                   
   return mainGroup; 
} 
Requirements

Target Platforms

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

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