GrapeCity.Documents.Pdf.RedactOptions

Class RedactOptions

Namespace

GrapeCity.Documents.Pdf

Assembly

GcDocs.Pdf.dll

Represents additional options to use when a document is being redacted.

public class RedactOptions

Inheritance

object

RedactOptions

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

RedactOptions()

public RedactOptions()

Properties

CopyImagesOnRedact

Gets or sets a value indicating whether images within the redacted area that also appear in other locations will be copied before applying the redact. If this property is true, only the appearance of the redacted area will be affected. If this property is false, if an image within the redacted area also appears in other locations, all these locations will be affected. The default is false.

public bool CopyImagesOnRedact { get; set; }

Property Value

bool

IgnoreUnreadableObjects

Gets or sets a value indicating whether to completely remove objects that need to be partially redacted but which are unreadable or unknown to GcPdf.

If true (the default), such objects will be silently removed. Otherwise an exception will be thrown.

public bool IgnoreUnreadableObjects { get; set; }

Property Value

bool

Precision

Gets or sets the maximum distance (in points) between a PDF object's boundary that is outside a redact area, and the redact area's edge, at which the object is still considered to be inside the redact.

The default value is 2 points.

public float Precision { get; set; }

Property Value

float

RenderOptions

Gets or sets a RedactOptions.RenderOptionsDef object that specifies additional options used when a redact action requires that some PDF content is rendered as an image.

public RedactOptions.RenderOptionsDef RenderOptions { get; set; }

Property Value

RedactOptions.RenderOptionsDef