Class PdfSecurity

Información

Representa el componente Documentize.PdfSecurity. Se usa para Encriptar, Desencriptar, Firmar, Sanitizar documentos PDF.

public static class PdfSecurity
#### Herencia

[object](https://learn.microsoft.com/dotnet/api/system.object) ←  
[PdfSecurity](Documentize.PdfSecurity.md)

#### Miembros heredados

- [object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
- [object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
- [object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring),
- [object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)),
- [object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)),
- [object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
- [object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode)

## Métodos

### <a id="Documentize_PdfSecurity_Decrypt_Documentize_DecryptOptions_"></a> Decrypt\(DecryptOptions\)

Desencripta un documento PDF.

```csharp
public static ResultContainer Decrypt(DecryptOptions options)

Parámetros

  • options DecryptOptions: Un objeto de opciones que contiene las instrucciones para la operación.

Devuelve

ResultContainer : Un objeto que contiene el resultado de la operación.

Ejemplos

El ejemplo muestra cómo Decrypt (desencriptar) un documento PDF.

// Crear objeto DecryptOptions para establecer instrucciones
var options = new DecryptOptions("123456");
// Añadir ruta del archivo de entrada
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Establecer ruta del archivo de salida
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Ejecutar el proceso
PdfSecurity.Decrypt(options);

Excepciones

ArgumentException
Si las opciones no están configuradas.

Encrypt(EncryptOptions)

Encripta un documento PDF.

public static ResultContainer Encrypt(EncryptOptions options)

Parámetros

  • options EncryptOptions: Un objeto de opciones que contiene las instrucciones para la operación.

Devuelve

ResultContainer : Un objeto que contiene el resultado de la operación.

Ejemplos

El ejemplo muestra cómo Encrypt (encriptar) un documento PDF.

// Crear objeto EncryptOptions para establecer instrucciones
var options = new EncryptOptions("123456", "qwerty");
// Añadir ruta del archivo de entrada
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Establecer ruta del archivo de salida
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Ejecutar el proceso
PdfSecurity.Encrypt(options);

Excepciones

ArgumentException
Si las opciones no están configuradas.

Sanitize(SanitizeOptions)

Sanitiza datos ocultos de un documento PDF, asegurando que la información sensible o innecesaria como metadatos, adjuntos, anotaciones, JavaScripts, formularios, capas, índice de búsqueda o contenido privado se elimine o transforme.

public static ResultContainer Sanitize(SanitizeOptions options)

Parámetros

  • options SanitizeOptions: Un objeto de opciones que contiene las instrucciones para la operación.

Devuelve

ResultContainer : Un objeto que contiene el resultado de la operación.

Ejemplos

El ejemplo muestra cómo Sanitize (sanitizar) un documento PDF.

// Crear objeto SanitizeOptions para establecer archivos de entrada y salida
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
// Ejecutar el proceso
PdfSecurity.Sanitize(options);

El ejemplo muestra cómo Sanitize un PDF de flujo a flujo.

// Preparar flujos de entrada y salida
using var inputStream = File.OpenRead("path_to_your_pdf_file.pdf");
using var outputStream = new MemoryStream();
// Crear objeto SanitizeOptions para establecer flujos de entrada y salida
var options = new SanitizeOptions(inputStream, outputStream);
// Ejecutar el proceso
PdfSecurity.Sanitize(options);

El ejemplo muestra cómo Sanitize un PDF de archivo a flujo.

// Preparar flujo de salida
using var outputStream = new MemoryStream();
// Crear objeto SanitizeOptions para establecer archivo de entrada y flujo de salida
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", outputStream);
// Ejecutar el proceso
PdfSecurity.Sanitize(options);

El ejemplo muestra cómo Sanitize un PDF de archivo a flujo con configuración manual de las propiedades de entrada y salida.

// Preparar flujo de salida
using var outputStream = new MemoryStream();
// Crear objeto SanitizeOptions
var options = new SanitizeOptions();
//Establecer archivo de entrada
options.Input = new FileData("path_to_your_pdf_file.pdf");
//Establecer flujo de salida
options.Output = new StreamData(outputStream);
// Ejecutar el proceso
PdfSecurity.Sanitize(options);

El ejemplo muestra cómo Sanitize un PDF sin eliminar los metadatos.

// Crear objeto SanitizeOptions para establecer archivos de entrada y salida
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
options.RemoveMetadata = false;
// Ejecutar el proceso
PdfSecurity.Sanitize(options);

El ejemplo muestra cómo Sanitize un PDF sin eliminar los adjuntos.

// Crear objeto SanitizeOptions para establecer archivos de entrada y salida
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
options.RemoveAttachments = false;
// Ejecutar el proceso
PdfSecurity.Sanitize(options);

El ejemplo muestra cómo Sanitize un PDF convirtiendo todas sus páginas a imágenes y estableciendo DPI del resultado.

// Crear objeto SanitizeOptions para establecer archivos de entrada y salida
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
// Activar conversión y establecer DPI
options.ConvertPagesToImages = true;
options.ImageDpi = 200;
// Ejecutar el proceso
PdfSecurity.Sanitize(options);

El ejemplo muestra cómo Sanitize un PDF sin eliminar JavaScripts y acciones.

// Crear objeto SanitizeOptions para establecer archivos de entrada y salida
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
options.RemoveJavaScriptsAndActions = false;
// Ejecutar el proceso
PdfSecurity.Sanitize(options);

El ejemplo muestra cómo Sanitize un archivo PDF en el estilo más breve posible.

PdfSecurity.Sanitize(new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf"));

Excepciones

ArgumentException
Si las opciones no están configuradas.

Sign(SignOptions)

Firma un documento PDF mediante firma digital.

public static ResultContainer Sign(SignOptions options)

Parámetros

  • options SignOptions: Un objeto de opciones que contiene las instrucciones para la operación.

Devuelve

ResultContainer : Un objeto que contiene el resultado de la operación.

Ejemplos

El ejemplo muestra cómo Sign (firmar) un documento PDF.

// Crear objeto SignOptions para establecer instrucciones
var options = new SignOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf", "path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Ejecutar el proceso
PdfSecurity.Sign(options);

El ejemplo muestra cómo Sign un documento PDF usando flujos.

// Preparar flujos
using var pdfStreamInput = File.OpenRead(@"path_to_your_pdf_file.pdf");
using var pfxStreamInput = File.OpenRead(@"path_to_your_pfx_file.pfx");
using var pdfStreamOutput = new MemoryStream();
// Crear objeto SignOptions para establecer instrucciones
var options = new SignOptions(pdfStreamInput, pdfStreamOutput, pfxStreamInput, "password_of_your_pfx_file");
// Ejecutar el proceso
PdfSecurity.Sign(options);

El ejemplo muestra cómo firmar un PDF y establecer los parámetros de entrada y salida por separado.

// Crear objeto SignOptions para establecer instrucciones
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Establecer rutas de archivo de entrada y salida
options.Input = new FileData("path_to_your_pdf_file.pdf");
options.Output = new FileData("path_to_result_pdf_file.pdf");
// Ejecutar el proceso
PdfSecurity.Sign(options);

El ejemplo muestra cómo Sign un documento PDF con un flujo de archivo PFX.

using var pfxStream = File.OpenRead(@"path_to_your_pfx_file.pfx");
var options = new SignOptions(pfxStream, "password_of_your_pfx_file");
// Establecer rutas de archivo de entrada y salida
options.Input = new FileData("path_to_your_pdf_file.pdf");
options.Output = new FileData("path_to_result_pdf_file.pdf");
// Ejecutar el proceso
PdfSecurity.Sign(options);

El ejemplo muestra cómo Sign un documento PDF con firma invisible.

// Crear objeto SignOptions para establecer instrucciones
var options = new SignOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf", "path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Configurar firma invisible
options.Visible = false;
// Ejecutar el proceso
PdfSecurity.Sign(options);

El ejemplo muestra cómo Sign un documento PDF con opciones adicionales.

// Crear objeto SignOptions para establecer instrucciones
var options = new SignOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf","path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Parámetros opcionales
options.Reason = "my Reason";
options.Contact = "my Contact";
options.Location = "my Location";
options.PageNumber = 3;
// Ejecutar el proceso
PdfSecurity.Sign(options);

El ejemplo muestra cómo Sign un archivo PDF en el estilo más breve posible.

PdfSecurity.Sign(new SignOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf", "path_to_your_pfx_file.pfx", "password_of_your_pfx_file"));

El ejemplo muestra cómo Sign un documento PDF con Timestamp.

// Crear objeto SignOptions para establecer Timestamp
var options = new SignOptions(new TimestampOptions("server_url"));
// Establecer rutas de archivo de entrada y salida
options.Input = new FileData("path_to_your_pdf_file.pdf");
options.Output = new FileData("path_to_result_pdf_file.pdf");
// Ejecutar el proceso
PdfSecurity.Sign(options);

Excepciones

ArgumentException
Si las opciones no están configuradas.

Namespace: Documentize
Assembly: Documentize.dll

 Español