MetadataSearchRedaction Class - GroupDocs.Redaction for .NET

MetadataSearchRedaction Class

Represents a metadata redaction that searches and redacts metadata using regular expressions, matching keys and/or values.

Inheritance Hierarchy

SystemObject
  GroupDocs.RedactionRedaction
    GroupDocs.Redaction.RedactionsMetadataRedaction
      GroupDocs.Redaction.RedactionsMetadataSearchRedaction

Namespace: GroupDocs.Redaction.Redactions
Assembly: GroupDocs.Redaction (in GroupDocs.Redaction.dll) Version: 20.11

Syntax

C++

public class MetadataSearchRedaction : MetadataRedaction

Public Class MetadataSearchRedaction
	Inherits MetadataRedaction

public ref class MetadataSearchRedaction : public MetadataRedaction

type MetadataSearchRedaction =  
    class
        inherit MetadataRedaction
    end

The MetadataSearchRedaction type exposes the following members.

Constructors

	Name	Description
	MetadataSearchRedaction(String, String)	Initializes a new instance of MetadataSearchRedaction class, using value to match redacted items.
	MetadataSearchRedaction(Regex, String)	Initializes a new instance of MetadataSearchRedaction class, using value to match redacted items.
	MetadataSearchRedaction(String, String, String)	Initializes a new instance of MetadataSearchRedaction class, using item name and value to match redacted items.
	MetadataSearchRedaction(Regex, String, Regex)	Initializes a new instance of MetadataSearchRedaction class, using item name and value to match redacted items.

Properties

	Name	Description
	Description	Returns a string, describing the redaction and its parameters. (Overrides RedactionDescription.)
	Filter	Gets or sets the filter, which is used to select all or specific metadata, e.g. Author or Company. (Inherited from MetadataRedaction.)
	KeyExpression	Gets the regular expression to match name (key) of metadata item.
	Replacement	Gets the textual replacement value.
	ValueExpression	Gets the regular expression to match value text of a metadata item.

Methods

	Name	Description
	ApplyFilter	Applies the current Filter value to a given metadata dictionary. (Inherited from MetadataRedaction.)
	ApplyTo(DocumentFormatInstance)	Applies the redaction to a given format instance. (Inherited from MetadataRedaction.)
	ApplyTo(MetadataItem, IMetadataAccess)	Applies the redaction to a given metadata item. (Overrides MetadataRedactionApplyTo(MetadataItem, IMetadataAccess).)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	IsApplicableTo	Checks if this redaction could be applied to a given metadata item. (Overrides MetadataRedactionIsApplicableTo(MetadataItem).)
	MemberwiseClone	(Inherited from Object.)
	ToString	(Inherited from Object.)

Remarks

Learn more

More details about applying redactions: Redaction basics
More details about document metadata redactions: Metadata redactions

Examples

The following example demonstrates how to search and redact certain text in specific metadata.

using (Redactor redactor = new Redactor(@"C:\sample.docx"))
{
   MetadataSearchRedaction redaction = new MetadataSearchRedaction("Company Ltd.", "--company--");
   // If not set, applies to all metadata items
   redaction.Filter = MetadataFilters.Company;
   redactor.Apply(redaction);
   redactor.Save();
}

Reference

GroupDocs.Redaction.Redactions Namespace