com.groupdocs.redaction.redactions

Class EraseMetadataRedaction

java.lang.Object

com.groupdocs.redaction.Redaction

com.groupdocs.redaction.redactions.MetadataRedaction

com.groupdocs.redaction.redactions.EraseMetadataRedaction

public class EraseMetadataRedaction
extends MetadataRedaction

Represents a metadata redaction that erases all metadata or metadata matching specific MetadataFilters from the document.

Learn more

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

The following example demonstrates how to erase (set equal to empty values) all or specific metadata.

try (Redactor redactor = new Redactor("C:\\sample.docx"))
 {
    // Erase Author, Manager and Company
    redactor.apply(new EraseMetadataRedaction(MetadataFilters.Author | MetadataFilters.Manager | MetadataFilters.Company));
    // Erase all metadata
    redactor.apply(new EraseMetadataRedaction(MetadataFilters.All));
    redactor.save();
 }
  

Constructor Summary

Constructors

Constructor and Description
EraseMetadataRedaction() Initializes a new instance of EraseMetadataRedaction class, erasing all metadata.
EraseMetadataRedaction(int filter) Initializes a new instance of EraseMetadataRedaction class, erasing metadata, matching specific combination of MetadataFilters.

Method Summary

Modifier and Type	Method and Description
protected RedactorLogEntry	applyTo(MetadataItem item, IMetadataAccess metadata) Applies the redaction to a given metadata item.
String	getDescription() Returns a string, describing the redaction and its parameters.
protected boolean	isApplicableTo(MetadataItem item) Checks if this redaction could be applied to a given metadata item.

Methods inherited from class com.groupdocs.redaction.redactions.MetadataRedaction

applyFilter, applyTo, getFilter, setFilter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EraseMetadataRedaction

public EraseMetadataRedaction()

Initializes a new instance of EraseMetadataRedaction class, erasing all metadata.

EraseMetadataRedaction

public EraseMetadataRedaction(int filter)

Initializes a new instance of EraseMetadataRedaction class, erasing metadata, matching specific combination of MetadataFilters.

Parameters:

filter - Filter for metadata to erase

Method Detail

applyTo

protected RedactorLogEntry applyTo(MetadataItem item,
                                   IMetadataAccess metadata)

Applies the redaction to a given metadata item.

Specified by:

applyTo in class MetadataRedaction

Parameters:

item - Metadata item

metadata - Metadata access

Returns:

Redaction result

getDescription

public String getDescription()

Returns a string, describing the redaction and its parameters.

Overrides:

getDescription in class Redaction

Returns:

Text, containing redaction name and parameters.

isApplicableTo

protected boolean isApplicableTo(MetadataItem item)

Checks if this redaction could be applied to a given metadata item.

Specified by:

isApplicableTo in class MetadataRedaction

Parameters:

item - Metadata item

Returns:

True if redaction can be applied