kCura.Relativity.DataReaderClient.ImageSettings

ImageSettings

public class ImageSettings : ImportSettingsBase

Provides settings for imaging files.

Documentation

public int ArtifactTypeId { get; set; }

TODO: Remove. Only here for the NUnit project.

public bool AutoNumberImages { get; set; }

Determines whether a page number is automatically appended to a page-level identifier.

public string BatesNumberField { get; set; }

Defines a column name in the SourceData, which maps to a field used as a unique identifier. If property is not set, default column name "BatesNumber" is used.

public int BeginBatesFieldArtifactID { get; set; }

Gets or sets the initial integer to be used in Bates Numbering.

public bool? DisableImageLocationValidation { get; set; }

Enables or disables validation of image location for the current job.

public bool? DisableImageTypeValidation { get; set; }

Enables or disables validation of the image type for the current job.

public string DocumentIdentifierField { get; set; }

Name of the field in the SourceData corresponding to the DocumentIdentifier field. If property is not set, default column name "DocumentIdentifier" is used.

public string FileLocationField { get; set; }

Indicates the column name in the SourceData that maps to the FileLocation field in Relativity. If property is not set, default column name "FileLocation" is used.

public string FileNameField { get; set; }

Indicates the column name in the SourceData that maps to the FileName field in Relativity. If property is not set, default column name "FileName" is used.

public string FolderPathSourceFieldName { get; set; }

Indicates the Field name that contains the subfolder used for document imports.

public bool ForProduction { get; set; }

To load images into a production, set this property to True.

public string ImageFilePathSourceFieldName { get; set; }

Field name that contains the full path to and filename of an image file.

public int ProductionArtifactID { get; set; }

Indicates a valid ArtifactID for a production set. Used in conjunction with the ForProduction property.

public string SelectedCasePath { get; set; }

Indicates the Case's File Repository where the Images will be saved.