Laserfiche.Repository.Api.Client.V2  1.0.2
Properties | List of all members
ExportEntryRequestImageOptions Class Reference

Represents the options when exporting the image part of an entry. More...

Properties

bool ConvertPdfAnnotations = true [get, set]
 Indicates if the annotations on the image need to be converted to PDF annotations when exporting to PDF format. The default value is true. This option is only applicable when exporting to PDF format and IncludeAnnotations is true. More...
 
ExportEntryRequestImageFormat Format = Laserfiche.Repository.Api.Client.ExportEntryRequestImageFormat.MultiPageTIFF [get, set]
 The image format to export as. Options include: MultiPageTIFF, SinglePageTIFF, PNG, PDF and JPEG. The default value is MultiPageTIFF. MultiPageTIFF format is a single multi-page TIFF file. SinglePageTIFF format is multiple single-page TIFF files (in a single zip file). More...
 
bool IncludeAnnotations = true [get, set]
 Indicates if the annotations need to be included. The default value is true. More...
 
bool IncludeRedactions = true [get, set]
 Indicates if redactions are included. The default value is true. More...
 
int JPEGCompressionLevel = 70 [get, set]
 The quality level for JPEG compression when exporting images. The value must be between 0 and 100 (inclusive). The default value is 70. More...
 
string PagePrefix = ", Page " [get, set]
 The page prefix of the individual files, when exporting to multi-file format (e.g.zip). The value must have a length of at most 10 characters and only valid characters that can be included in file names are allowed. The default value is ", Page ". More...
 
ExportEntryRequestWatermark Watermark [get, set]
 The watermark element added to each image. No watermark will be added by default. More...
 

Detailed Description

Represents the options when exporting the image part of an entry.

Property Documentation

◆ ConvertPdfAnnotations

bool ConvertPdfAnnotations = true
getset

Indicates if the annotations on the image need to be converted to PDF annotations when exporting to PDF format. The default value is true. This option is only applicable when exporting to PDF format and IncludeAnnotations is true.

◆ Format

ExportEntryRequestImageFormat Format = Laserfiche.Repository.Api.Client.ExportEntryRequestImageFormat.MultiPageTIFF
getset

The image format to export as. Options include: MultiPageTIFF, SinglePageTIFF, PNG, PDF and JPEG. The default value is MultiPageTIFF. MultiPageTIFF format is a single multi-page TIFF file. SinglePageTIFF format is multiple single-page TIFF files (in a single zip file).

◆ IncludeAnnotations

bool IncludeAnnotations = true
getset

Indicates if the annotations need to be included. The default value is true.

◆ IncludeRedactions

bool IncludeRedactions = true
getset

Indicates if redactions are included. The default value is true.

◆ JPEGCompressionLevel

int JPEGCompressionLevel = 70
getset

The quality level for JPEG compression when exporting images. The value must be between 0 and 100 (inclusive). The default value is 70.

◆ PagePrefix

string PagePrefix = ", Page "
getset

The page prefix of the individual files, when exporting to multi-file format (e.g.zip). The value must have a length of at most 10 characters and only valid characters that can be included in file names are allowed. The default value is ", Page ".

◆ Watermark

ExportEntryRequestWatermark Watermark
getset

The watermark element added to each image. No watermark will be added by default.

The documentation for this class was generated from the following file: