Class PdfSecurity

Информация

Представляет компонент Documentize.PdfSecurity. Используется для шифрования, дешифрования, подписи, очистки PDF‑документов.

public static class PdfSecurity

Inheritance

object ← PdfSecurity

Inherited Members

Методы

Decrypt(DecryptOptions)

Дешифровать PDF‑документ.

public static ResultContainer Decrypt(DecryptOptions options)

Параметры

  • options DecryptOptions: Объект опций, содержащий инструкции для операции.

Возвращаемое значение

ResultContainer : Объект, содержащий результат операции.

Примеры

Пример демонстрирует, как дешифровать PDF‑документ.

// Create DecryptOptions object to set instructions
var options = new DecryptOptions("123456");
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfSecurity.Decrypt(options);

Исключения

ArgumentException

Если параметры не заданы.

Encrypt(EncryptOptions)

Шифровать PDF‑документ.

public static ResultContainer Encrypt(EncryptOptions options)

Параметры

  • options EncryptOptions: Объект опций, содержащий инструкции для операции.

Возвращаемое значение

ResultContainer : Объект, содержащий результат операции.

Примеры

Пример демонстрирует, как зашифровать PDF‑документ.

// Create EncryptOptions object to set instructions
var options = new EncryptOptions("123456", "qwerty");
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfSecurity.Encrypt(options);

Исключения

ArgumentException

Если параметры не заданы.

Sanitize(SanitizeOptions)

Очистить скрытые данные в PDF‑документе, гарантируя удаление или преобразование конфиденциальной или ненужной информации, такой как метаданные, аннотации, JavaScript или приватное содержимое.

public static ResultContainer Sanitize(SanitizeOptions options)

Параметры

  • options SanitizeOptions: Объект опций, содержащий инструкции для операции.

Возвращаемое значение

ResultContainer : Объект, содержащий результат операции.

Примеры

Пример демонстрирует, как очистить PDF‑документ.

// Create SanitizeOptions object to set input and output files
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
// Perform the process
PdfSecurity.Sanitize(options);

Пример демонстрирует, как очистить PDF из потока в поток.

// Prepare input and output streams
using var inputStream = File.OpenRead("path_to_your_pdf_file.pdf");
using var outputStream = new MemoryStream();
// Create SanitizeOptions object to set input and output streams
var options = new SanitizeOptions(inputStream, outputStream);
// Perform the process
PdfSecurity.Sanitize(options);

Пример демонстрирует, как очистить PDF из файла в поток.

// Prepare output stream
using var outputStream = new MemoryStream();
// Create SanitizeOptions object to set input and output streams
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", outputStream);
// Perform the process
PdfSecurity.Sanitize(options);

Пример демонстрирует, как очистить PDF из файла в поток с ручной установкой свойств ввода и вывода.

// Create SanitizeOptions object
var options = new SanitizeOptions();
//Set Input file
options.Input = new FileData("path_to_your_pdf_file.pdf");
//Set Output file
options.Output = new FileData("path_to_result_pdf_file.pdf");
// Perform the process
PdfSecurity.Sanitize(options);

Пример демонстрирует, как очистить PDF без удаления метаданных.

// Create SanitizeOptions object to set input and output files
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
options.RemoveMetadata = false;
// Perform the process
PdfSecurity.Sanitize(options);

Пример демонстрирует, как очистить PDF без удаления вложений.

// Create SanitizeOptions object to set input and output files
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
options.RemoveAttachments = false;
// Perform the process
PdfSecurity.Sanitize(options);

Пример демонстрирует, как очистить PDF с конвертацией всех страниц в изображения и установкой DPI результата.

// Create SanitizeOptions object to set input and output files
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
// Turn on conversion and set dpi
options.ConvertPagesToImages = true;
options.ImageDpi = 200;
// Perform the process
PdfSecurity.Sanitize(options);

Пример демонстрирует, как очистить PDF без удаления JavaScript‑ов и действий.

// Create SanitizeOptions object to set input and output files
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
options.RemoveJavaScriptsAndActions = false;
// Perform the process
PdfSecurity.Sanitize(options);

Пример демонстрирует, как очистить PDF‑файл в максимально коротком стиле.

// Perform the process
PdfSecurity.Sanitize(new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf"));

Исключения

ArgumentException

Если параметры не заданы.

Sign(SignOptions)

Подписать PDF‑документ цифровой подписью.

public static ResultContainer Sign(SignOptions options)

Параметры

  • options SignOptions: Объект опций, содержащий инструкции для операции.

Возвращаемое значение

ResultContainer : Объект, содержащий результат операции.

Примеры

Пример демонстрирует, как подписать PDF‑документ.

// Create SignOptions object to set instructions
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfSecurity.Sign(options);

Пример демонстрирует, как подписать PDF‑документ с помощью потока PFX‑файла.

using var pfxStream = File.OpenRead(@"path_to_your_pfx_file.pfx");
var options = new SignOptions(pfxStream, "password_of_your_pfx_file");
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfSecurity.Sign(options);

Пример демонстрирует, как подписать PDF‑документ невидимой подписью.

var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Configure invisible signature
signOptions.Visible = false;
// Perform the process
PdfSecurity.Sign(options);

Пример демонстрирует, как подписать PDF‑документ с дополнительными опциями.

// Create SignOptions object to set instructions
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Optional parameters
options.Reason = "my Reason";
options.Contact = "my Contact";
options.Location = "my Location";
options.PageNumber = 3;
// Perform the process
PdfSecurity.Sign(options);

Пример демонстрирует, как подписать PDF‑документ с отметкой времени.

// Create SignOptions object to set instructions
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_for_your_pfx_file");
options.TimestampOptions = new TimestampOptions("server_url");
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfSecurity.Sign(options);

Исключения

ArgumentException

Если параметры не заданы.

Namespace: Documentize Assembly: Documentize.dll

 Русский