WordProcessingInspectionPackage

Inheritance: java.lang.Object, com.groupdocs.metadata.core.MetadataPackage, com.groupdocs.metadata.core.CustomPackage

public final class WordProcessingInspectionPackage extends CustomPackage

Contains information about document parts that can be considered as metadata in some cases.

Learn more

Methods

Method Description
getComments() Gets an array of the user comments.
getFields() Gets an array of document fields.
getHiddenText() Gets an array of hidden text fragments extracted from the document.
getDigitalSignatures() Gets an array of digital signatures presented in the document.
getRevisions() Gets an array of digital signatures presented in the document.
removeProperties(Specification specification) Removes metadata properties satisfying a specification.
clearComments() Removes all detected user comments from the document.
clearFields() Removes all detected fields from the document.
clearHiddenText() Removes all hidden text fragments from the document.
acceptAllRevisions() Accepts all detected revisions in the document.
rejectAllRevisions() Rejects all detected revisions in the document.
sanitize() Removes writable metadata properties from the package.

getComments()

public final WordProcessingComment[] getComments()

Gets an array of the user comments.

Returns: com.groupdocs.metadata.core.WordProcessingComment[] - The user comments.

getFields()

public final WordProcessingField[] getFields()

Gets an array of document fields.

Returns: com.groupdocs.metadata.core.WordProcessingField[] - An array of document fields.

getHiddenText()

public final String[] getHiddenText()

Gets an array of hidden text fragments extracted from the document.

Returns: java.lang.String[] - An array of hidden text fragments extracted from the document.

getDigitalSignatures()

public final DigitalSignature[] getDigitalSignatures()

Gets an array of digital signatures presented in the document.

Returns: com.groupdocs.metadata.core.DigitalSignature[] - The digital signatures.

getRevisions()

public final WordProcessingRevision[] getRevisions()

Gets an array of digital signatures presented in the document.

Returns: com.groupdocs.metadata.core.WordProcessingRevision[] - The digital signatures.

removeProperties(Specification specification)

public int removeProperties(Specification specification)

Removes metadata properties satisfying a specification.

Parameters:

Parameter Type Description
specification Specification A specification to test each metadata property for a condition.

Returns: int - The number of affected properties.

clearComments()

public final void clearComments()

Removes all detected user comments from the document.

clearFields()

public final void clearFields()

Removes all detected fields from the document.

clearHiddenText()

public final void clearHiddenText()

Removes all hidden text fragments from the document.

acceptAllRevisions()

public final void acceptAllRevisions()

Accepts all detected revisions in the document.

rejectAllRevisions()

public final void rejectAllRevisions()

Rejects all detected revisions in the document.

sanitize()

public int sanitize()

Removes writable metadata properties from the package. The operation is recursive so it affects all nested packages as well.

Returns: int - The number of affected properties.