Class NativeImagingEngineOptions

Represents the options set on an ImagingProfile for use with native imaging jobs.

Inheritance

System.Object

NativeImagingEngineOptions

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Relativity.Testing.Framework.Models

Assembly: Relativity.Testing.Framework.dll

Syntax

public class NativeImagingEngineOptions

Properties

DitheringAlgorithm

Gets or sets the dithering algorithm used when imaging documents.

Declaration

public NativeImagingDitheringAlgorithm? DitheringAlgorithm { get; set; }

Property Value

Type	Description
System.Nullable<NativeImagingDitheringAlgorithm>

Remarks

Corresponds to the Dithering Algorithm option in the Native Imaging Engine Options section. This property is required if ImageFormatType is set to Tiff.

DitheringThreshold

Gets or sets the dithering threshold used to determine how color pixels are converted to black and white. This integer value can range from 0 - 255.

Declaration

public int? DitheringThreshold { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Remarks

Corresponds to the Dithering Threshold option under the Native Imaging Engine Options tab. This property is required if DitheringAlgorithm is set to Threshold.

ImageOutputDpi

Gets or sets the resolution and density of an image in dots per inch (DPI).

Declaration

public int ImageOutputDpi { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Corresponds to the Native Image Output Quality (DPI) option under the Native Imaging Engine Options tab.

LastModifiedDateOnDocument

Gets or sets the NamedArtifact corresponding to the field on a document that stores the last modified date.

Declaration

public NamedArtifact LastModifiedDateOnDocument { get; set; }

Property Value

Type	Description
NamedArtifact

Remarks

Corresponds to the Native Image Date option under the Native Imaging Engine Options section.

MaxPagesPerDoc

Gets or sets the maximum number of document pages imaged per file.

Declaration

public int? MaxPagesPerDoc { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Remarks

Corresponds to the Maximum pages imaged per file option under the Native Imaging Engine Options tab.

NativeImageFormat

Gets or sets the image format for files sent to the native imaging engine. The supported formats include JPEG or TIFF.

Declaration

public ImageFormatType NativeImageFormat { get; set; }

Property Value

Type	Description
ImageFormatType

Remarks

Corresponds to the Native Image Format Drop-down list in the Native Imaging Engine Options section.

RenderColorPagesToJpeg

Gets or sets a boolean value indicating whether to automatically render color pages as JPEG files. This property overrides the NativeImageFormat property if it is set to TIFF.

Declaration

public bool? RenderColorPagesToJpeg { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Remarks

Corresponds to the Automatically detect and render color pages to JPEG option under Native Imaging Engine Options. This property is required if ImageFormatType is set to Tiff.

TimeZoneFieldOnDocument

Gets or sets the date and time information in a document image, which is a NamedArtifact corresponding to the field on a document that stores the time zone.

Declaration

public NamedArtifact TimeZoneFieldOnDocument { get; set; }

Property Value

Type	Description
NamedArtifact

Remarks

Corresponds to the "Native Image Time Zone Emails only." option under Native Imaging Engine Options.