WFDescInfo Class

Use this property to acquire the workflow static information provider interface.

Inheritance Hierarchy

Namespace: Kofax.OmniPageCSDK.IproPlus
Assembly: Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0

Syntax

public class WFDescInfo : IproPlusClass, IDisposable

Public Class WFDescInfo
	Inherits IproPlusClass
	Implements IDisposable

public ref class WFDescInfo : public IproPlusClass, 
	IDisposable

The WFDescInfo type exposes the following members.

Properties

	Name	Description
	AvailableWFStepCLSIDs	This API is preliminary and subject to change.
	BarcodeCompatible	This property returns true if the workflow is barcode-compatible (that is, it can scan or load a barcode, then save it at the end of the process).
	FileName	This property is used to check the full file name of the given workflow.
	FriendlyName	This property is used to get or set the friendly name of a given workflow.
	Origin	This property returns the origin of the given workflow as a member of the WFORIGIN enumeration.
	StepCount	This property returns the number of steps in the given workflow.

Methods

	Name	Description
	AddWFObject	This API is preliminary and subject to change.
	AddWFStep	This API is preliminary and subject to change.
	Dispose	Releases all resources used by the WFDescInfo
	GetMetaData	Using this property, you can check and customise metadata values.
	GetWFInfoTags	Use this method to regulate how the workflow steps communicate with the user during processing.
	GetWFObjects	Use this method to return the object collection of a specific workflow.
	GetWFSteps	Use this method to return the step collection of a specific workflow.
	PageInWF	This property is used to check if a specified page is part of the workflow processing.
	PageInWFByID	This property returns true if the specified page is in the workflow.
	PrintBarcode	This method is used to print the barcode if the BarcodeCompatible property is True.
	QueryInfoTagsSeverity	This method is used to return the highest severity event that happened during the workflow processing - as a member of the WFSEVERITY enumeration.
	QueryStepInfo	This method is used to query information about a specific workflow step.
	QueryWFParam	This method is used to query the value of the named parameter.
	Save	This API is preliminary and subject to change.
	SaveBarcode	This method is used to save the barcode to a file.
	SetMetaData	Using this property, you can check and customise metadata values.