Class AddTimestampOptions

public class AddTimestampOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← AddTimestampOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

AddTimestampOptions(Stream, string, string, string)

Initializes new instance of the Documentize.AddTimestampOptions object with default options.

public AddTimestampOptions(Stream pfx, string password, string serverUrl, string serverBasicAuthCredentials = "")

Parameters

• pfx Stream: The path to the pfx file.
• password string: The password to the pfx file.
• serverUrl string: The timestamp server url.
• serverBasicAuthCredentials string: The basic authentication credentials, username and password are combined into a string “username:password”. (Optional).

AddTimestampOptions(string, string, string, string)

Initializes new instance of the Documentize.AddTimestampOptions object with default options.

public AddTimestampOptions(string pfx, string password, string serverUrl, string serverBasicAuthCredentials = "")

Parameters

• pfx string: The path to the pfx file.
• password string: The password to the pfx file.
• serverUrl string: The timestamp server url.
• serverBasicAuthCredentials string: The basic authentication credentials, username and password are combined into a string “username:password”. (Optional).

Class CompressOptions

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← CompressOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

CompressOptions()

Initializes new instance of the Documentize.CompressOptions object with default options.

public CompressOptions()

Class DecryptionOptions

public class DecryptionOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← DecryptionOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

DecryptionOptions(string)

Initializes new instance of the Documentize.DecryptionOptions object with default options.

public DecryptionOptions(string ownerPassword)

Parameters

• ownerPassword string: Owner password.

Properties

OwnerPassword

Owner password.

public string OwnerPassword { get; set; }

Property Value

string

Class DirectoryDataSource

public sealed class DirectoryDataSource : IDataSource

Inheritance

object ← DirectoryDataSource

Implements

• IDataSource

Inherited Members

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

DirectoryDataSource(string)

Initializes new directory data with the specified path.

public DirectoryDataSource(string path)

Parameters

• path string: A string representing the path to the directory.

Properties

DataType

Type of data source.

public DataType DataType { get; }

Property Value

DataType

Path

Gets the path to the directory of the current data.

public string Path { get; }

Property Value

string

Class DocConverter

public sealed class DocConverter

Inheritance

object ← DocConverter

Inherited Members

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Examples

The example demonstrates how to convert PDF document to Doc format.

// create DocConverter
var plugin = new DocConverter();
// create PdfToDocOptions object to set instructions
var opt = new PdfToDocOptions();
// add input file path
opt.AddInput(new FileDataSource(inputPath));
// set output file path
opt.AddOutput(new FileDataSource(outputPath));
// perform the process
plugin.Process(opt);

Constructors

DocConverter()

public DocConverter()

Methods

Dispose()

Implementation of IDisposable.

public void Dispose()

Process(PdfToDocOptions)

Starts the Documentize.DocConverter processing with the specified parameters.

public ResultContainer Process(PdfToDocOptions options)

Parameters

• options PdfToDocOptions: An options object containing instructions for the Documentize.DocConverter.

Returns

ResultContainer : An Documentize.ResultContainer object containing the result of the operation.

Class EncryptionOptions

public class EncryptionOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← EncryptionOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

EncryptionOptions(string, string)

Initializes new instance of the Documentize.EncryptionOptions object with default options.

public EncryptionOptions(string ownerPassword, string userPassword)

Parameters

• ownerPassword string: Owner password.
• userPassword string: User password.

Properties

OwnerPassword

Owner password.

public string OwnerPassword { get; set; }

Property Value

string

UserPassword

User password.

public string UserPassword { get; set; }

Property Value

string

Class FileDataSource

public sealed class FileDataSource : IDataSource

Inheritance

object ← FileDataSource

Implements

• IDataSource

Inherited Members

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

FileDataSource(string)

Initializes new file data source with the specified path.

public FileDataSource(string path)

Parameters

• path string: A string representing the path to the source file.

Properties

DataType

Type of data source.

public DataType DataType { get; }

Property Value

DataType

Path

Gets the path to the file of the current data.

public string Path { get; }

Property Value

string

Class FileResult

public sealed class FileResult : IOperationResult

Inheritance

object ← FileResult

Implements

• IOperationResult

Inherited Members

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Properties

Data

Gets raw data.

public object Data { get; }

Property Value

object

IsFile

Indicates whether the result is a path to an output file.

public bool IsFile { get; }

Property Value

bool

IsStream

Indicates whether the result is an output stream.

public bool IsStream { get; }

Property Value

bool

IsString

Indicates whether the result is a text string.

public bool IsString { get; }

Property Value

bool

Methods

ToFile()

Tries to convert the result to a file.

public string ToFile()

Returns

string : A string representing the path to the output file if the result is file; otherwise null.

ToStream()

Tries to convert the result to a stream object.

public Stream ToStream()

Returns

Stream : A stream object representing the output data if the result is stream; otherwise null.

Class HtmlConverter

public sealed class HtmlConverter : IDisposable

Inheritance

object ← HtmlConverter

Implements

• IDisposable

Inherited Members

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Examples

The example demonstrates how to convert PDF to HTML document.

// create HtmlConverter
var plugin = new HtmlConverter();
// create PdfToHtmlOptions object to set output data type as file with embedded resources
var opt = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// add input file path
opt.AddInput(new FileDataSource(inputPath));
// set output file path
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);

The example demonstrates how to convert HTML to PDF document.

// create HtmlConverter
var plugin = new HtmlConverter();
// create HtmlToPdfOptions
var opt = new HtmlToPdfOptions();
// add input file path
opt.AddInput(new FileDataSource(inputPath));
// set output file path
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);

Constructors

HtmlConverter()

public HtmlConverter()

Methods

Dispose()

Implementation of IDisposable.

public void Dispose()

Process(IPluginOptions)

Starts the Documentize.HtmlConverter processing with the specified parameters.

public ResultContainer Process(IPluginOptions options)

Parameters

• options IPluginOptions: An options object containing instructions for the Documentize.HtmlConverter.

Returns

ResultContainer : An Documentize.ResultContainer object containing the result of the operation.

Class HtmlToPdfOptions

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← HtmlToPdfOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

HtmlToPdfOptions()

Initializes new instance of the Documentize.HtmlToPdfOptions object.

public HtmlToPdfOptions()

Properties

BasePath

The base path/url for the html file.

public string BasePath { get; set; }

Property Value

string

HtmlMediaType

Gets or sets possible media types used during rendering.

public HtmlMediaType HtmlMediaType { get; set; }

Property Value

HtmlMediaType

IsRenderToSinglePage

Gets or sets rendering all document to single page.

public bool IsRenderToSinglePage { get; set; }

Property Value

bool

PageInfo

Gets or sets document page info.

public PageInfo PageInfo { get; set; }

Property Value

PageInfo

PageLayoutOption

Gets or sets layout option.

public HtmlPageLayoutOption PageLayoutOption { get; set; }

Property Value

HtmlPageLayoutOption

Class ImageExtractor

public class ImageExtractor : PdfExtractor, IDisposable

Inheritance

object ← PdfExtractor ← ImageExtractor

Implements

• IDisposable

Inherited Members

• PdfExtractor.Process(IPluginOptions),
• PdfExtractor.Dispose(),
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Examples

The example demonstrates how to extract images from PDF document.

// create ImageExtractor object to extract images
using (var plugin = new ImageExtractor())
{
    // create ImageExtractorOptions
    var opt = new ImageExtractorOptions();

    // add input file path
    opt.AddInput(new FileDataSource(inputPath));
    // set output directory
    opt.AddInput(new FileDataSource("D:\\"));

    // perform extraction process
    var resultContainer = plugin.Process(opt);

    // get the image from the ResultContainer object
    var imageExtracted = resultContainer.ResultCollection[0].ToFile();
}

Constructors

ImageExtractor()

public ImageExtractor()

Class ImageExtractorOptions

public sealed class ImageExtractorOptions : PdfExtractorOptions, IPluginOptions

Inheritance

object ← PdfExtractorOptions ← ImageExtractorOptions

Implements

• IPluginOptions

Inherited Members

• PdfExtractorOptions.AddInput(IDataSource),
• PdfExtractorOptions.Inputs,
• PdfExtractorOptions.OperationName,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Remarks

It inherits functions to add data (files, streams) representing input PDF documents.

Constructors

ImageExtractorOptions()

Initializes a new instance of the Documentize.ImageExtractorOptions object.

public ImageExtractorOptions()

Properties

OperationName

Returns name of the operation.

public override string OperationName { get; }

Property Value

string

Class Info

public static class Info

Inheritance

object ← Info

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Fields

• AssemblyVersion Assembly Version.

Field Value

string

Product

Product Name.

public const string Product = "Documentize"

Field Value

string

Class JpegConverter

public sealed class JpegConverter

Inheritance

object ← JpegConverter

Inherited Members

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Examples

The example demonstrates how to convert PDF document into JPEG format.

// create JpegConverter
var plugin = new JpegConverter();
// create PdfToJpegOptions object to set instructions
var opt = new PdfToJpegOptions();
// add input file path
opt.AddInput(new FileDataSource(inputPath));
// set output file path
opt.AddOutput(new DirectoryDataSource(outputPath));
// perform the process
plugin.Process(opt);

Constructors

JpegConverter()

public JpegConverter()

Methods

Process(PdfToJpegOptions)

Starts the Documentize.JpegConverter processing with the specified parameters.

public ResultContainer Process(PdfToJpegOptions options)

Parameters

• options PdfToJpegOptions: An options object containg instructions for the Documentize.JpegConverter.

Returns

ResultContainer : An ResultContainer object containg the result of the operation.

Class License

public static class License

Inheritance

object ← License

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Examples

Shows how to activate a license.

// Set License
License.Set("PathToLicense.lic");

Methods

Set(string)

Licenses the component.

public static void Set(string licenseName)

Parameters

• licenseName string: Can be a full or short file name. Use an empty string to switch to evaluation mode.

Class MergeOptions

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← MergeOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

MergeOptions()

Initializes new instance of the Documentize.MergeOptions object with default options.

public MergeOptions()

Class Merger

public sealed class Merger

Inheritance

object ← Merger

Inherited Members

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Examples

The example demonstrates how to merge two PDF documents.

// create Merger
var plugin = new Merger();
// create MergeOptions object to set instructions
var opt = new MergeOptions();
// add input file paths
opt.AddInput(new FileDataSource(inputPath1));
opt.AddInput(new FileDataSource(inputPath2));
// set output file path
opt.AddOutput(new FileDataSource(outputPath));
// perform the process
plugin.Process(opt);

Constructors

Merger()

public Merger()

Methods

Process(MergeOptions)

Starts the Documentize.Merger processing with the specified parameters.

public ResultContainer Process(MergeOptions options)

Parameters

• options MergeOptions: An options object containg instructions for the operation.

Returns

ResultContainer : An Documentize.ResultContainer object containing the result of the operation.

Class Message

public class Message

Inheritance

object ← Message

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

Message()

public Message()

Properties

Content

The contents of the message.

[JsonProperty("content")]
public string Content { get; set; }

Property Value

string

Role

Sets or gets the role of the author of this message.

[JsonProperty("role")]
[JsonConverter(typeof(StringEnumConverter), new object[] { true })]
public Role Role { get; set; }

Property Value

Role

Class ObjectResult

public sealed class ObjectResult : IOperationResult

Inheritance

object ← ObjectResult

Implements

• IOperationResult

Inherited Members

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Properties

Data

Gets raw data.

public object Data { get; }

Property Value

object

IsFile

Indicates whether the result is a path to an output file.

public bool IsFile { get; }

Property Value

bool

IsObject

Indicates whether the result is an object.

public bool IsObject { get; }

Property Value

bool

IsStream

Indicates whether the result is a path to an output file.

public bool IsStream { get; }

Property Value

bool

IsString

Indicates whether the result is a string.

public bool IsString { get; }

Property Value

bool

Text

Returns string representation of the result.

public string Text { get; }

Property Value

string

Methods

ToFile()

Tries to convert the result to a file.

public string ToFile()

Returns

string : A string representing the path to the output file if the result is file; otherwise null.

ToStream()

Tries to convert the result to a stream object.

public Stream ToStream()

Returns

Stream : A stream object representing the output data if the result is stream; otherwise null.

ToString()

Tries to convert the result to a string.

public override string ToString()

Returns

string : A string representing the text content if the result is string; otherwise returns base.ToString().

Class OptimizeOptions

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← OptimizeOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

OptimizeOptions()

Initializes new instance of the Documentize.OptimizeOptions object with default options. Linearize the document in order to

• open the first page as quickly as possible;
• display next page or follow by link to the next page as quickly as possible;
• display the page incrementally as it arrives when data for a page is delivered over a slow channel (display the most useful data first);
• permit user interaction, such as following a link, to be performed even before the entire page has been received and displayed.

public OptimizeOptions()

Class Optimizer

public sealed class Optimizer

Inheritance

object ← Optimizer

Inherited Members

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Examples

The example demonstrates how to optimize PDF document.

// create Optimizer
var plugin = new Optimizer();
// create OptimizeOptions object to set instructions
var opt = new OptimizeOptions();
// add input file path
opt.AddInput(new FileDataSource(inputPath));
// set output file path
opt.AddOutput(new FileDataSource(outputPath));
// perform the process
plugin.Process(opt);

Constructors

Optimizer()

public Optimizer()

Methods

Process(OptimizeOptions)

Starts the Documentize.Optimizer processing with the specified parameters.

public ResultContainer Process(OptimizeOptions options)

Parameters

• options OptimizeOptions: An options object containg instructions for the Documentize.OptimizeOptions.

Returns

ResultContainer : An ResultContainer object containg the result of the operation.

Process(RotateOptions)

Starts the Documentize.Optimizer processing with the specified parameters.

public ResultContainer Process(RotateOptions options)

Parameters

• options RotateOptions: An options object containg instructions for the Documentize.RotateOptions.

Returns

ResultContainer : An ResultContainer object containg the result of the operation.

Process(ResizeOptions)

Starts the Documentize.Optimizer processing with the specified parameters.

public ResultContainer Process(ResizeOptions options)

Parameters

• options ResizeOptions: An options object containg instructions for the Documentize.ResizeOptions.

Returns

ResultContainer : An ResultContainer object containg the result of the operation.

Process(CompressOptions)

Starts the Documentize.Optimizer processing with the specified parameters.

public ResultContainer Process(CompressOptions options)

Parameters

• options CompressOptions: An options object containg instructions for the Documentize.CompressOptions.

Returns

ResultContainer : An ResultContainer object containg the result of the operation.

Class PageInfo

public class PageInfo : PageSize

Inheritance

object ← PageSize ← PageInfo

Inherited Members

• PageSize.Width,
• PageSize.Height,
• PageSize.IsLandscape,
• PageSize.A0,
• PageSize.A1,
• PageSize.A2,
• PageSize.A3,
• PageSize.A4,
• PageSize.A5,
• PageSize.A6,
• PageSize.B5,
• PageSize.PageLetter,
• PageSize.PageLegal,
• PageSize.PageLedger,
• PageSize.P11x17,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

PageInfo()

Constructor of Documentize.PageInfo.

public PageInfo()

PageInfo(double, double)

Constructor of Documentize.PageInfo.

public PageInfo(double width, double height)

Parameters

• width double: Width of page.
• height double: Height of page.

Properties

MarginBottom

Gets or sets a value that indicates the bottom margin.

public double MarginBottom { get; set; }

Property Value

double

MarginLeft

Gets or sets a value that indicates the left margin.

public double MarginLeft { get; set; }

Property Value

double

MarginRight

Gets or sets a value that indicates the right margin.

public double MarginRight { get; set; }

Property Value

double

MarginTop

Gets or sets a value that indicates the top margin.

public double MarginTop { get; set; }

Property Value

double

Class PageSize

public class PageSize

Inheritance

object ← PageSize

Derived

• PageInfo

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

PageSize()

Constructor of Documentize.PageSize. A4 sizes by default.

public PageSize()

PageSize(double, double)

Constructor of Documentize.PageSize.

public PageSize(double width, double height)

Parameters

• width double: Width of the page.
• height double: Height of the page.

Properties

A0

A0 size (1189x840 mm).

public static PageSize A0 { get; }

Property Value

PageSize

A1

A1 size (840x594 mm).

public static PageSize A1 { get; }

Property Value

PageSize

A2

A2 size (594x420 mm).

public static PageSize A2 { get; }

Property Value

PageSize

A3

A3 size (420x297 mm).

public static PageSize A3 { get; }

Property Value

PageSize

A4

A4 size (297x210 mm).

public static PageSize A4 { get; }

Property Value

PageSize

A5

A5 size (210x148 mm).

public static PageSize A5 { get; }

Property Value

PageSize

A6

A6 size (148x105 mm).

public static PageSize A6 { get; }

Property Value

PageSize

B5

B5 size (250x176 mm).

public static PageSize B5 { get; }

Property Value

PageSize

Height

Gets or sets page height.

public double Height { get; set; }

Property Value

double

IsLandscape

Gets page orientation. Returns true of this is landscape orientation and false if this is portrait.

public bool IsLandscape { get; }

Property Value

bool

P11x17

11x17 inches format.

public static PageSize P11x17 { get; }

Property Value

PageSize

PageLedger

Ledger size (432x279 mm).

public static PageSize PageLedger { get; }

Property Value

PageSize

PageLegal

Legal size (356x216 mm).

public static PageSize PageLegal { get; }

Property Value

PageSize

PageLetter

Letter size (279x216 mm).

public static PageSize PageLetter { get; }

Property Value

PageSize

Width

Gets or sets page width.

public double Width { get; set; }

Property Value

double

Class PdfAConverter

public sealed class PdfAConverter

Inheritance

object ← PdfAConverter

Inherited Members

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Examples

The example demonstrates how to validate the PDF document conformance to PDF/A format (PDF/A-1a in this case):

// Create the options class to set up the validation process
var options = new PdfAValidateOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_1A
};

// Add one or more files to be validated
options.AddInput(new FileDataSource("path_to_your_first_pdf_file.pdf")); // replace with your actual file path
options.AddInput(new FileDataSource("path_to_your_second_pdf_file.pdf"));
// add more files as needed

// Create the plugin instance
var plugin = new PdfAConverter();

// Run the validation and get results
var resultContainer = plugin.Process(options);

// Check the resultContainer.ResultCollection property for validation results for each file:
for (var i = 0; i < resultContainer.ResultCollection.Count; i++)
{
    var result = resultContainer.ResultCollection[i];
    var validationResult = (PdfAValidationResult) result.Data;
    var isValid = validationResult.IsValid; // Validation result for the i-th document
}

The example demonstrates how to convert the PDF document in a PDF/A format (PDF/A-3b in this case):

// Create the options class to set up the conversion process
var options = new PdfAConvertOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_3B
};

// Add the source file
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf")); // replace with your actual file path

// Add the path to save the converted file
options.AddOutput(new FileDataSource("path_to_the_converted_file.pdf"));

// Create the plugin instance
var plugin = new PdfAConverter();

// Run the conversion
plugin.Process(options);

Constructors

PdfAConverter()

public PdfAConverter()

Methods

Process(IPluginOptions)

Begins a PDF/A conversion or validation process with given options.

public ResultContainer Process(IPluginOptions options)

Parameters

• options IPluginOptions: An options object containing instructions for the plugin. Must be an instance of the Documentize.PdfAConvertOptions: or the Documentize.PdfAValidateOptions class.

Returns

ResultContainer : A Documentize.ResultContainer object containing the result of the processing.

Class PdfAConvertOptions

public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions

Inheritance

object ← PdfAOptionsBase ← PdfAConvertOptions

Implements

• IPluginOptions

Inherited Members

• PdfAOptionsBase.AddInput(IDataSource),
• PdfAOptionsBase.Inputs,
• PdfAOptionsBase.PdfAVersion,
• PdfAOptionsBase.IsLowMemoryMode,
• PdfAOptionsBase.LogOutputSource,
• PdfAOptionsBase.ErrorAction,
• PdfAOptionsBase.SoftMaskAction,
• PdfAOptionsBase.CheckDifferentNamesInFontDictionaries,
• PdfAOptionsBase.AlignText,
• PdfAOptionsBase.OptimizeFileSize,
• PdfAOptionsBase.IccProfileFileName,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

PdfAConvertOptions()

public PdfAConvertOptions()

Properties

Outputs

Gets the collection of added targets (file or stream data sources) for saving operation results.

public List<idatasource> Outputs { get; }

Property Value

List<IDataSource&gt;

Methods

AddOutput(IDataSource)

Adds new result save target.

public void AddOutput(IDataSource dataSource)

Parameters

• dataSource IDataSource: Target (file or stream data source) for saving operation results. :

Class PdfAOptionsBase

Represents the base class for the Documentize.PdfAConverter plugin options. This class provides properties and methods for configuring the PDF/A conversion and validation process.

public abstract class PdfAOptionsBase : IPluginOptions

Inheritance

object ← PdfAOptionsBase

Derived

• PdfAConvertOptions,
• PdfAValidateOptions

Implements

• IPluginOptions

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

PdfAOptionsBase()

protected PdfAOptionsBase()

Properties

AlignText

Gets or sets a value indicating whether additional means are necessary to preserve text alignment during the PDF/A conversion process.

public bool AlignText { get; set; }

Property Value

bool

Remarks

When set to true, the conversion process will attempt to restore the original text segment bounds. For the most of the documents there is no need to change this property from the default false value, as the text alignment doesn’t change during the default conversion process.

CheckDifferentNamesInFontDictionaries

Gets the flags that control the PDF/A conversion for cases when the source PDF document doesn’t correspond to the PDF specification.

public bool CheckDifferentNamesInFontDictionaries { get; set; }

Property Value

bool

ErrorAction

Gets or sets the action to be taken for objects that cannot be converted.

public ConvertErrorAction ErrorAction { get; set; }

Property Value

ConvertErrorAction

IccProfileFileName

Gets or sets the filename of the ICC (International Color Consortium) profile to be used for the PDF/A conversion in place of the default one.

public string IccProfileFileName { get; set; }

Property Value

string

Inputs

Gets collection of data sources

public List<idatasource> Inputs { get; }

Property Value

List<IDataSource&gt;

IsLowMemoryMode

Gets or sets a value indicating whether the low memory mode is enabled during the PDF/A conversion process.

public bool IsLowMemoryMode { get; set; }

Property Value

bool

LogOutputSource

Gets or sets the data source for the log output.

public IDataSource LogOutputSource { get; set; }

Property Value

IDataSource

OptimizeFileSize

Gets or sets a value indicating whether to try to reduce the file size during the PDF/A conversion process.

public bool OptimizeFileSize { get; set; }

Property Value

bool

Remarks

When set to true, the conversion process will attempt to minimize the resulting file size. This might affect the conversion process performance.

PdfAVersion

Gets or sets the version of the PDF/A standard to be used for validation or conversion.

public PdfAStandardVersion PdfAVersion { get; set; }

Property Value

PdfAStandardVersion

Remarks

The PDF/A standard version is used to determine the compliance level for PDF/A validation and conversion. If the version is set to Documentize.PdfAStandardVersion.Auto, the system will automatically determine the appropriate PDF/A standard version for validation based on the document metadata. For the PDF/A conversion process the Documentize.PdfAStandardVersion.Auto defaults to the PDF/A-1b standard version.

SoftMaskAction

Gets or sets the action to be taken during the conversion of images with soft masks.

public ConvertSoftMaskAction SoftMaskAction { get; set; }

Property Value

ConvertSoftMaskAction

Methods

AddInput(IDataSource)

Adds new data source to the collection

public void AddInput(IDataSource dataSource)

Parameters

• dataSource IDataSource:

Class PdfAValidateOptions

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

Inheritance

object ← PdfAOptionsBase ← PdfAValidateOptions

Implements

• IPluginOptions

Inherited Members

• PdfAOptionsBase.AddInput(IDataSource),
• PdfAOptionsBase.Inputs,
• PdfAOptionsBase.PdfAVersion,
• PdfAOptionsBase.IsLowMemoryMode,
• PdfAOptionsBase.LogOutputSource,
• PdfAOptionsBase.ErrorAction,
• PdfAOptionsBase.SoftMaskAction,
• PdfAOptionsBase.CheckDifferentNamesInFontDictionaries,
• PdfAOptionsBase.AlignText,
• PdfAOptionsBase.OptimizeFileSize,
• PdfAOptionsBase.IccProfileFileName,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

PdfAValidateOptions()

public PdfAValidateOptions()

Class PdfAValidationResult

public sealed class PdfAValidationResult

Inheritance

object ← PdfAValidationResult

Inherited Members

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Fields

• DataSource Gets the data source that was validated.

Field Value

IDataSource

IsValid

Gets a value indicating whether the validation was successful.

public readonly bool IsValid

Field Value

bool

StandardVersion

Gets the PDF/A standard version used for validation.

public readonly PdfAStandardVersion StandardVersion

Field Value

PdfAStandardVersion

Class PdfChatGpt

public sealed class PdfChatGpt : IDisposable

Inheritance

object ← PdfChatGpt

Implements

• IDisposable

Inherited Members

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Examples

The example demonstrates how to use PdfChatGpt plugin by adding messages to the request.

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Add the output file path.
    options.ApiKey = "Your API key."; // You need to provide the key to access the API.
    options.MaxTokens = 1000; // The maximum number of tokens to generate in the chat completion.

    // Add the request messages.
    options.Messages.Add(new Message
    {
        Content = "You are a helpful assistant.",
        Role = Role.System
    });
    options.Messages.Add(new Message
    {
        Content = "What is the biggest pizza diameter ever made?",
        Role = Role.User
    });

    // Process the request.
    var result = await plugin.ProcessAsync(options);

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // The ChatGPT API chat completion object.
}

The example demonstrates how to use PdfChatGpt plugin by adding one message to the request.

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Add the output file path.
    options.ApiKey = "Your API key."; // You need to provide the key to access the API.
    options.MaxTokens = 1000; // The maximum number of tokens to generate in the chat completion.

    // Add the request message.
    // In this case, the system message with Content = "You are a helpful assistant." is added by default.
    // The role of the query message is "user" by default.
    options.Query = "What is the lowest temperature recorded on the Earth?";

    // Process the request.
    var result = await plugin.ProcessAsync(options);

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // The ChatGPT API chat completion object.
}

The example demonstrates how to use PdfChatGpt plugin by adding file(s) as the message source(s).

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Add the output file path.

    // Add the PDF text source.
    // In case of multiple sources, the text from each document will be added to the request message collection
    // as a separate message with the role "user".
    options.AddInput(new FileDataSource("TextSource.pdf"));

    options.ApiKey = "Your API key."; // You need to provide the key to access the API.
    options.MaxTokens = 1000; // The maximum number of tokens to generate in the chat completion.

    // Add the request message.
    // In this case, the system message with Content = "You are a helpful assistant." is added by default.
    // The role of the query message is "user" by default.
    options.Query = "How many letters in the provided text?";

    // Process the request.
    var result = await plugin.ProcessAsync(options);

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // The ChatGPT API chat completion object.
}

Remarks

The Documentize.PdfChatGpt object is used to send requests to ChatGPT directly or by adding PDF file sources and save the reply to the output source.

Constructors

PdfChatGpt()

Initializes a new instance of the Documentize.PdfChatGpt object.

public PdfChatGpt()

Methods

Dispose()

Implementation of IDisposable. In fact, it is not necessary for PdfChatGpt.

public void Dispose()

Process(IPluginOptions)

The method has no synchronous version. Use the ProcessAsync method instead.

public ResultContainer Process(IPluginOptions options)

Parameters

• options IPluginOptions: An options object containing instructions for the PdfChatGpt.

Returns

ResultContainer : #### Exceptions

NotImplementedException

ProcessAsync(IPluginOptions)

Starts the PdfChatGpt processing with the specified parameters.

public Task<resultcontainer> ProcessAsync(IPluginOptions options)

Parameters

• options IPluginOptions: An options object containing instructions for the PdfChatGpt.

Returns

Task<ResultContainer&gt;

The task object representing the asynchronous operation.

Exceptions

ArgumentException : InvalidOperationException

SetCancellationToken(CancellationToken)

Sets the cancellation token.

public void SetCancellationToken(CancellationToken cancellationToken)

Parameters

• cancellationToken CancellationToken: The cancellation token. :

Class PdfChatGptOptions

public class PdfChatGptOptions : IPluginOptions

Inheritance

object ← PdfChatGptOptions

Derived

• PdfChatGptRequestOptions

Implements

• IPluginOptions

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

PdfChatGptOptions()

Initializes a new instance of the Documentize.PdfChatGptOptions object.

public PdfChatGptOptions()

Properties

Inputs

public List<idatasource> Inputs { get; }

Property Value

List<IDataSource&gt;

Outputs

public List<idatasource> Outputs { get; }

Property Value

List<IDataSource&gt;

Methods

AddInput(IDataSource)

Adds new data source to the PdfChatGpt plugin data collection.

public void AddInput(IDataSource dataSource)

Parameters

• dataSource IDataSource: Data source (file or stream) to add.

AddOutput(IDataSource)

Adds new save data source to the PdfChatGpt plugin data collection.

public void AddOutput(IDataSource saveDataSource)

Parameters

• saveDataSource IDataSource: Data source (file or stream) for saving operation results. :

Class PdfChatGptRequestOptions

public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions

Inheritance

object ← PdfChatGptOptions ← PdfChatGptRequestOptions

Implements

• IPluginOptions

Inherited Members

• PdfChatGptOptions.AddInput(IDataSource),
• PdfChatGptOptions.AddOutput(IDataSource),
• PdfChatGptOptions.Inputs,
• PdfChatGptOptions.Outputs,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

PdfChatGptRequestOptions()

Initializes new instance of the Documentize.PdfChatGptRequestOptions object with default options.

public PdfChatGptRequestOptions()

PdfChatGptRequestOptions(string, string, string, string)

Initializes a new instance of the Documentize.PdfChatGptRequestOptions object with options.

public PdfChatGptRequestOptions(string apiKey, string model, string apiUrl, string query)

Parameters

• apiKey string: The key to access to the ChatGPT API.
• model string: The name of ChatGPT model. The Default model is: gpt-3.5-turbo-1106:
• apiUrl string: The ChatGPT API URL. Default URL is: https://api.openai.com/v1/chat/completions.
• query string: The string request to ChatGPT.

Properties

ApiKey

Gets or sets the key to access to the ChatGPT API.

public string ApiKey { get; set; }

Property Value

string

ApiUrl

Gets or sets the ChatGPT API URL.

public string ApiUrl { get; set; }

Property Value

string

MaxTokens

Maximum number of tokens in the response. Default value is null, means infinity.

public int? MaxTokens { get; set; }

Property Value

int?

Messages

Gets or sets a collection of the Documentize.Message objects.

public List<message> Messages { get; set; }

Property Value

List<Message&gt;

Model

Sets or gets ID of the model to use.

public string Model { get; set; }

Property Value

string

NumberOfChoices

How many chat completion choices to generate for each input message.

public int NumberOfChoices { get; set; }

Property Value

int

Query

Gets or sets the string request to ChatGPT. If not empty, this is the first message in the collection, that will be sent in the request.

public string Query { get; set; }

Property Value

string

Temperature

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. Default value is 1.

public double Temperature { get; set; }

Property Value

double

Class PdfConverterOptions

public abstract class PdfConverterOptions : IPluginOptions

Inheritance

object ← PdfConverterOptions

Derived

• PdfToDocOptions,
• PdfToHtmlOptions,
• PdfToXlsOptions

Implements

• IPluginOptions

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Properties

Inputs

Returns PdfConverterOptions plugin data collection.

public List<idatasource> Inputs { get; }

Property Value

List<IDataSource&gt;

Outputs

Gets collection of added targets for saving operation results.

public List<idatasource> Outputs { get; }

Property Value

List<IDataSource&gt;

Methods

AddInput(IDataSource)

Adds new data source to the PdfConverter plugin data collection.

public void AddInput(IDataSource dataSource)

Parameters

• dataSource IDataSource: Data source to add.

AddOutput(IDataSource)

Adds new data source to the PdfToXLSXConverterOptions plugin data collection.

public void AddOutput(IDataSource saveDataSource)

Parameters

• saveDataSource IDataSource: Data source (file or stream) for saving operation results.

Exceptions

NotImplementedException

Class PdfExtractor

public abstract class PdfExtractor : IDisposable

Inheritance

object ← PdfExtractor

Derived

• ImageExtractor,
• TextExtractor

Implements

• IDisposable

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Examples

The example demonstrates how to extract text content of PDF document.

// create TextExtractor object to extract PDF contents
using (TextExtractor extractor = new TextExtractor())
{
    // create TextExtractorOptions object to set instructions
    textExtractorOptions = new TextExtractorOptions();

    // add input file path
    textExtractorOptions.AddInput(new FileDataSource(inputPath));

    // perform extraction process
    ResultContainer resultContainer = extractor.Process(textExtractorOptions);

    // get the extracted text from the ResultContainer object
    string textExtracted = resultContainer.ResultCollection[0].ToString();
}

Remarks

The Documentize.TextExtractor object is used to extract text, or Documentize.ImageExtractor to extract images.

Constructors

PdfExtractor()

protected PdfExtractor()

Methods

Dispose()

Implementation of IDisposable. Actually, it is not necessary for PdfExtractor.

public void Dispose()

Process(IPluginOptions)

Starts PdfExtractor processing with the specified parameters.

public ResultContainer Process(IPluginOptions pdfExtractorOptions)

Parameters

• pdfExtractorOptions IPluginOptions: An options object containing instructions for the PdfExtractor.

Returns

ResultContainer : A ResultContainer object containing the result of the extraction.

Class PdfExtractorOptions

public abstract class PdfExtractorOptions : IPluginOptions

Inheritance

object ← PdfExtractorOptions

Derived

• ImageExtractorOptions,
• TextExtractorOptions

Implements

• IPluginOptions

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Remarks

The Documentize.PdfExtractorOptions contains base functions to add data (files, streams) representing input PDF documents. Please create Documentize.TextExtractorOptions or ImageExtractorOptions instead of this.

Properties

Inputs

Returns PdfExtractor plugin data collection.

public List<idatasource> Inputs { get; }

Property Value

List<IDataSource&gt;

OperationName

Returns operation name

public virtual string OperationName { get; }

Property Value

string

Methods

AddInput(IDataSource)

Adds new data source to the PdfExtractor plugin data collection.

public void AddInput(IDataSource dataSource)

Parameters

• dataSource IDataSource: Data source to add. :

Class PdfToDocOptions

public sealed class PdfToDocOptions : PdfConverterOptions, IPluginOptions

Inheritance

object ← PdfConverterOptions ← PdfToDocOptions

Implements

• IPluginOptions

Inherited Members

• PdfConverterOptions.AddInput(IDataSource),
• PdfConverterOptions.AddOutput(IDataSource),
• PdfConverterOptions.Inputs,
• PdfConverterOptions.Outputs,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

PdfToDocOptions()

Initializes new instance of the Documentize.PdfToDocOptions object with default options.

public PdfToDocOptions()

Class PdfToHtmlOptions

public sealed class PdfToHtmlOptions : PdfConverterOptions, IPluginOptions

Inheritance

object ← PdfConverterOptions ← PdfToHtmlOptions

Implements

• IPluginOptions

Inherited Members

• PdfConverterOptions.AddInput(IDataSource),
• PdfConverterOptions.AddOutput(IDataSource),
• PdfConverterOptions.Inputs,
• PdfConverterOptions.Outputs,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

PdfToHtmlOptions()

Initializes new instance of the Documentize.PdfToHtmlOptions object with default options.

public PdfToHtmlOptions()

PdfToHtmlOptions(SaveDataType)

Initializes a new instance of the Documentize.PdfToHtmlOptions object for the specified output data type.

public PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType outputDataType)

Parameters

• outputDataType PdfToHtmlOptions.SaveDataType: Output data type.

Properties

OutputDataType

Gets output data type.

public PdfToHtmlOptions.SaveDataType OutputDataType { get; }

Property Value

PdfToHtmlOptions.SaveDataType

Class PdfToJpegOptions

public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← PdfToJpegOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

PdfToJpegOptions()

Initializes a new instance of the Documentize.PdfToJpegOptions object.

public PdfToJpegOptions()

Properties

OutputResolution

Gets or sets the resolution value of the resulting images.

public int OutputResolution { get; set; }

Property Value

int

PageList

Gets or sets a list of pages for the process.

public List<int> PageList { get; set; }

Property Value

List<int&gt;

Quality

Gets and sets output quality.

public int Quality { get; set; }

Property Value

int

Class PdfToPngOptions

public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← PdfToPngOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

PdfToPngOptions()

Initializes a new instance of the Documentize.PdfToPngOptions object.

public PdfToPngOptions()

Properties

OutputResolution

Gets or sets the resolution value of the resulting images.

public int OutputResolution { get; set; }

Property Value

int

PageList

Gets or sets a list of pages for the process.

public List<int> PageList { get; set; }

Property Value

List<int&gt;

Class PdfToTiffOptions

public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← PdfToTiffOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

PdfToTiffOptions()

Initializes a new instance of the Documentize.PdfToTiffOptions object.

public PdfToTiffOptions()

Properties

MultiPage

Gets and sets flag that allows to save all pages in one multi-page tiff.

public bool MultiPage { get; set; }

Property Value

bool

OutputResolution

Gets or sets the resolution value of the resulting images.

public int OutputResolution { get; set; }

Property Value

int

PageList

Gets or sets a list of pages for the process.

public List<int> PageList { get; set; }

Property Value

List<int&gt;

Class PdfToXlsOptions

public sealed class PdfToXlsOptions : PdfConverterOptions, IPluginOptions

Inheritance

object ← PdfConverterOptions ← PdfToXlsOptions

Implements

• IPluginOptions

Inherited Members

• PdfConverterOptions.AddInput(IDataSource),
• PdfConverterOptions.AddOutput(IDataSource),
• PdfConverterOptions.Inputs,
• PdfConverterOptions.Outputs,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

PdfToXlsOptions()

Initializes new instance of the Documentize.PdfToXlsOptions object with default options.

public PdfToXlsOptions()

Properties

Format

Output format.

public PdfToXlsOptions.ExcelFormat Format { get; set; }

Property Value

PdfToXlsOptions.ExcelFormat

InsertBlankColumnAtFirst

Set true if you need inserting of blank column as the first column of worksheet. Default value is false; it means that blank column will not be inserted.

public bool InsertBlankColumnAtFirst { get; set; }

Property Value

bool

MinimizeTheNumberOfWorksheets

Set true if you need to minimize the number of worksheets in resultant workbook. Default value is false; it means save of each PDF page as separated worksheet.

public bool MinimizeTheNumberOfWorksheets { get; set; }

Property Value

bool

Class PluginBaseOptions

public class PluginBaseOptions : IPluginOptions

Inheritance

object ← PluginBaseOptions

Derived

• AddTimestampOptions,
• CompressOptions,
• DecryptionOptions,
• EncryptionOptions,
• HtmlToPdfOptions,
• MergeOptions,
• OptimizeOptions,
• PdfToJpegOptions,
• PdfToPngOptions,
• PdfToTiffOptions,
• ResizeOptions,
• RotateOptions,
• SignOptions,
• SplitOptions,
• TableOptions

Implements

• IPluginOptions

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Properties

CloseInputStreams

Close input streams after operation completed.

public bool CloseInputStreams { get; set; }

Property Value

bool

CloseOutputStreams

Close output streams after operation completed.

public bool CloseOutputStreams { get; set; }

Property Value

bool

Inputs

Returns Inputs data for operation.

public List<idatasource> Inputs { get; }

Property Value

List<IDataSource&gt;

Outputs

Returns Outputs data for operation.

public List<idatasource> Outputs { get; }

Property Value

List<IDataSource&gt;

Methods

AddInput(IDataSource)

Adds new Data to Inputs.

public void AddInput(IDataSource dataSource)

Parameters

• dataSource IDataSource: Data to add.

AddOutput(IDataSource)

Adds new Data to Outputs.

public void AddOutput(IDataSource saveDataSource)

Parameters

• saveDataSource IDataSource: Data to add. :

Class PngConverter

public sealed class PngConverter

Inheritance

object ← PngConverter

Inherited Members

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Examples

The example demonstrates how to convert PDF document into PNG format.

// create PngConverter
var plugin = new PngConverter();
// create PdfToPngOptions object to set instructions
var opt = new PdfToPngOptions();
// add input file path
opt.AddInput(new FileDataSource(inputPath));
// set output file path
opt.AddOutput(new DirectoryDataSource(outputPath));
// perform the process
plugin.Process(opt);

Constructors

PngConverter()

public PngConverter()

Methods

Process(PdfToPngOptions)

Starts the Documentize.PngConverter processing with the specified parameters.

public ResultContainer Process(PdfToPngOptions options)

Parameters

• options PdfToPngOptions: An options object containg instructions for the Documentize.PngConverter.

Returns

ResultContainer : An ResultContainer object containg the result of the operation.

Class Rectangle

public class Rectangle

Inheritance

object ← Rectangle

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

Rectangle(double, double, double, double)

Constructor of Rectangle.

public Rectangle(double llx, double lly, double urx, double ury)

Parameters

• llx double: X of lower left corner.
• lly double: Y of lower left corner.
• urx double: X of upper right corner.
• ury double: Y of upper right corner.

Class ResizeOptions

public sealed class ResizeOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← ResizeOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

ResizeOptions()

Initializes new instance of the Documentize.ResizeOptions object with default options.

public ResizeOptions()

Properties

PageSize

Gets or sets new page size.

public PageSize PageSize { get; set; }

Property Value

PageSize

Class ResultContainer

public class ResultContainer

Inheritance

object ← ResultContainer

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Properties

ResultCollection

Gets collection of the operation results

public List<ioperationresult> ResultCollection { get; }

Property Value

List<IOperationResult&gt;

Class RotateOptions

public sealed class RotateOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← RotateOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

RotateOptions()

Initializes new instance of the Documentize.RotateOptions object with default options.

public RotateOptions()

Properties

Rotation

Gets or sets new pages rotation.

public Rotation Rotation { get; set; }

Property Value

Rotation

Class Security

public sealed class Security

Inheritance

object ← Security

Inherited Members

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Examples

The example demonstrates how to encrypt PDF document.

// create Security 
var plugin = new Security();
// create EncryptionOptions object to set instructions
var opt = new EncryptionOptions("123456", "qwerty");
// add input file path
opt.AddInput(new FileDataSource(inputPath));
// set output file path
opt.AddOutput(new FileDataSource(outputPath));
// perform the process
plugin.Process(opt);

The example demonstrates how to decrypt PDF document.

// create Security 
var plugin = new Security();
// create DecryptionOptions object to set instructions
var opt = new DecryptionOptions("123456"));
// add input file path
opt.AddInput(new FileDataSource(inputPath));
// set output file path
opt.AddOutput(new FileDataSource(outputPath));
// perform the process
plugin.Process(opt);

Constructors

Security()

public Security()

Methods

Process(IPluginOptions)

Starts the Documentize.Security processing with the specified parameters.

public ResultContainer Process(IPluginOptions options)

Parameters

• options IPluginOptions: An options object containg instructions for the Documentize.Security.

Returns

ResultContainer : A ResultContainer object containg the result of the operation.

Exceptions

InvalidOperationException

Class Signature

public sealed class Signature

Inheritance

object ← Signature

Inherited Members

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Examples

The example demonstrates how to sign PDF document.

// create Signature
var plugin = new Signature();
// create SignOptions object to set instructions
var opt = new SignOptions(inputPfx, inputPfxPassword);
// add input file path
opt.AddInput(new FileDataSource(inputPath));
// set output file path
opt.AddOutput(new FileDataSource(outputPath));
// perform the process
plugin.Process(opt);

Constructors

Signature()

public Signature()

Methods

Process(IPluginOptions)

Starts the Documentize.Signature processing with the specified parameters.

public ResultContainer Process(IPluginOptions options)

Parameters

• options IPluginOptions: An options object containg instructions for the Documentize.Signature.

Returns

ResultContainer : An ResultContainer object containg the result of the operation.

Exceptions

InvalidOperationException

Class SignOptions

public sealed class SignOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← SignOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

SignOptions(string, string)

Initializes new instance of the Documentize.SignOptions object with default options.

public SignOptions(string pfx, string password)

Parameters

• pfx string: The path to the pfx file.
• password string: The password to the pfx file.

SignOptions(Stream, string)

Initializes new instance of the Documentize.SignOptions object with default options.

public SignOptions(Stream pfx, string password)

Parameters

• pfx Stream: The stream with the pfx file.
• password string: The password to the pfx file.

Properties

Contact

The contact of signature.

public string Contact { get; set; }

Property Value

string

Location

The location of signature.

public string Location { get; set; }

Property Value

string

Name

The name of existing signature field. Null to create a new field.

public string Name { get; set; }

Property Value

string

PageNumber

The page number on which signature is made.

public int PageNumber { get; set; }

Property Value

int

Reason

The reason of signature.

public string Reason { get; set; }