JobName Property

Summary

Optional job name.

Syntax

C++/CLI

Java

Python

public string JobName { get; set; }

public:  
   property String^ JobName 
   { 
      String^ get() 
      void set(String^ value) 
   }

public String getJobName() 
public void setJobName(String value)

JobName # get and set (DocumentConverterJobData)

Property Value

The optional job name.

Remarks

If tracing is enabled with DocumentConverterDiagnostics.EnableTrace, then the engine will use this value in the trace messages. If this member is a null reference, then the trace will show the generic [Untitled] name next to the trace messages.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Document.Writer; 
using Leadtools.Svg; 
using LeadtoolsExamples.Common; 
using Leadtools.Document; 
using Leadtools.Caching; 
using Leadtools.Annotations.Engine; 
using Leadtools.Ocr; 
using Leadtools.Document.Converter; 
using Leadtools.Annotations.Rendering; 
 
public void DocumentConverterJobsRunJobExample() 
{ 
   using (DocumentConverter documentConverter = new DocumentConverter()) 
   { 
      var inFile = Path.Combine(ImagesPath.Path, @"Leadtools.doc"); 
      var outFile = Path.Combine(ImagesPath.Path, @"output.tif"); 
      var format = RasterImageFormat.Tif; 
      var jobData = DocumentConverterJobs.CreateJobData(inFile, outFile, format); 
      jobData.JobName = "conversion job"; 
 
      var job = documentConverter.Jobs.CreateJob(jobData); 
      documentConverter.Jobs.RunJob(job); 
 
      if (job.Status == DocumentConverterJobStatus.Success) 
      { 
         Console.WriteLine("Success"); 
      } 
      else 
      { 
         Console.WriteLine("{0} Errors", job.Status); 
         foreach (var error in job.Errors) 
         { 
            Console.WriteLine("  {0} at {1}: {2}", error.Operation, error.InputDocumentPageNumber, error.Error.Message); 
         } 
      } 
   } 
}

Requirements

Target Platforms

Reference

DocumentConverterJobData Class

DocumentConverterJobData Members

Leadtools.Document.Converter Namespace

Using LEADTOOLS Document Converter

Download our FREE evaluation

Help Version 22.0.2023.5.10

Leadtools.Document.Converter Assembly

Introduction

Getting Started

Namespaces

Leadtools.Document.Converter Namespace

Assemblies