Read and edit metadata with GroupDocs.Metadata Leave feedback
On this page
GroupDocs.Metadata reads and edits the metadata inside a document — authors, timestamps, EXIF and XMP tags, ID3 audio tags — without touching its visible content. Stripping metadata before a document leaves your organisation is the most common reason to reach for it.
Each example below is ready to copy into a project once you have installed the package.
getDocumentInfo gives you the basics without loading the whole metadata tree.
import { Metadata } from '@groupdocs/groupdocs.total';
const metadata = new Metadata('contract.docx');
const info = metadata.getDocumentInfo();
console.log('File format: ' + info.getFileType().getFileFormat());
console.log('Extension: ' + info.getFileType().getExtension());
console.log('MIME type: ' + info.getFileType().getMimeType());
console.log('Pages: ' + info.getPageCount());
console.log('Size: ' + info.getSize() + ' bytes');
console.log('Encrypted: ' + info.isEncrypted());
metadata.close();
contract.docx is the sample file used in this example. Click here to download it.
File format: WordProcessing
Extension: .docx
MIME type: application/vnd.openxmlformats-officedocument.wordprocessingml.document
Pages: 3
Size: 15096 bytes
Encrypted: false
Properties are searched with a specification rather than by name, because the same idea is spelled differently in every format. Tags describe what a property means, so Tags.getPerson().getCreator() finds the author whether the file calls it Author, Creator or dc:creator.
import { Metadata } from '@groupdocs/groupdocs.total';
import java from 'java';
const ContainsTagSpecification = java.import(
'com.groupdocs.metadata.search.ContainsTagSpecification'
);
const Tags = java.import('com.groupdocs.metadata.tagging.Tags');
const metadata = new Metadata('contract.docx');
// Every property tagged as identifying the person who created the document
const properties = metadata.findProperties(
new ContainsTagSpecification(Tags.getPerson().getCreator())
);
for (let i = 0; i < properties.getCount(); i++) {
const property = properties.get_Item(i);
console.log(property.getName() + ' = ' + property.getValue());
}
metadata.close();
contract.docx is the sample file used in this example. Click here to download it.
Author = Dana Whitfield
dc:creator = Dana Whitfield
sanitize removes every metadata property the format allows to be removed. This is the sanitising step to run before publishing a document externally.
import { Metadata } from '@groupdocs/groupdocs.total';
const metadata = new Metadata('contract.docx');
const removed = metadata.sanitize();
console.log('Properties removed: ' + removed);
metadata.save('metadata-sanitize.docx');
metadata.close();
contract.docx is the sample file used in this example. Click here to download it.
Binary file (DOCX, 14 KB)
GroupDocs.Metadata also adds and updates properties, removes only the properties matching a specification, and works with format-specific standards — EXIF, XMP and IPTC in images, ID3 and APE in audio, and the built-in and custom property sets of Office documents.
- GroupDocs.Metadata for Node.js via Java documentation — the full product guide
- Supported file formats
- API reference
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
