Class CKWordPipeline

Represents a pipeline for processing Word documents using a collection of pipeline processes.

Inheritance
object
CKWordPipeline
Implements
Inherited Members
Namespace: CoverageKiller2.Pipeline
Assembly: CoverageKiller2.dll
Syntax
public class CKWordPipeline : ICollection<CKWordPipelineProcess>, IEnumerable<CKWordPipelineProcess>, IEnumerable

Constructors

CKWordPipeline(CKDocument)

Initializes a new instance of the CKWordPipeline class with the specified document.

Declaration
public CKWordPipeline(CKDocument ckDoc)
Parameters
Type Name Description
CKDocument ckDoc

The CKDocument to be processed.

CKWordPipeline(Dictionary<string, object>)

Declaration
public CKWordPipeline(Dictionary<string, object> initVars)
Parameters
Type Name Description
Dictionary<string, object> initVars

Properties

Count

Gets the number of items in the pipeline.

Declaration
public int Count { get; }
Property Value
Type Description
int

Document

Gets the document associated with the pipeline.

Declaration
public CKDocument Document { get; }
Property Value
Type Description
CKDocument

IsReadOnly

Gets a value indicating whether the pipeline is read-only.

Declaration
public bool IsReadOnly { get; }
Property Value
Type Description
bool

ProcessorConfig

Declaration
public ProcessorConfig ProcessorConfig { get; }
Property Value
Type Description
ProcessorConfig

Template

Declaration
public CKDocument Template { get; }
Property Value
Type Description
CKDocument

Methods

Add(CKWordPipelineProcess)

Adds a process to the pipeline and assigns the document to the process.

Declaration
public void Add(CKWordPipelineProcess item)
Parameters
Type Name Description
CKWordPipelineProcess item

The pipeline process to add.

Clear()

Clears all processes from the pipeline.

Declaration
public void Clear()

Contains(CKWordPipelineProcess)

Determines whether the pipeline contains a specific process.

Declaration
public bool Contains(CKWordPipelineProcess item)
Parameters
Type Name Description
CKWordPipelineProcess item

The process to locate in the pipeline.
Returns
Type Description
bool

true if the process is found; otherwise, false.

CopyTo(CKWordPipelineProcess[], int)

Copies the elements of the pipeline to an array, starting at the specified index.

Declaration
public void CopyTo(CKWordPipelineProcess[] array, int arrayIndex)
Parameters
Type Name Description
CKWordPipelineProcess[] array

The array to copy the pipeline elements into.
int arrayIndex

The zero-based index in the array where copying begins.

GetEnumerator()

Returns an enumerator that iterates through the pipeline processes.

Declaration
public IEnumerator<CKWordPipelineProcess> GetEnumerator()
Returns
Type Description
IEnumerator<CKWordPipelineProcess>

An enumerator for the pipeline processes.

Remove(CKWordPipelineProcess)

Removes a specific process from the pipeline.

Declaration
public bool Remove(CKWordPipelineProcess item)
Parameters
Type Name Description
CKWordPipelineProcess item

The process to remove.
Returns
Type Description
bool

true if the process was successfully removed; otherwise, false.

Implements

Extension Methods