Working with metadata in Presentations Leave feedback

GroupDocs.Metadata for Java provides functionality that allows working with different kinds of presentations such as PPT, PPTX, POTM, POTX, etc. For the full list of supported presentation formats please refer to Supported document formats.

The following sample of code will help you to detect the exact type of a loaded presentation and extract some additional file format information.

1. Load a presentation
2. Extract the root metadata package
3. Use the getPresentationType method to obtain file format information

advanced_usage.managing_metadata_for_specific_formats.document.presentation.PresentationReadFileFormatProperties

try (Metadata metadata = new Metadata(Constants.InputPptx)) {
	PresentationRootPackage root = metadata.getRootPackageGeneric();
	System.out.println(root.getPresentationType().getFileFormat());
	System.out.println(root.getPresentationType().getPresentationFormat());
	System.out.println(root.getPresentationType().getMimeType());
	System.out.println(root.getPresentationType().getExtension());
}

To access built-in metadata of a presentation, please use the getDocumentProperties method defined in the DocumentRootPackage class.

The following code snippet extracts built-in metadata properties and displays them on the screen.

advanced_usage.managing_metadata_for_specific_formats.document.presentation.PresentationReadBuiltInProperties

try (Metadata metadata = new Metadata(Constants.InputPpt)) {
	PresentationRootPackage root = metadata.getRootPackageGeneric();

	System.out.println(root.getDocumentProperties().getAuthor());
	System.out.println(root.getDocumentProperties().getCreatedTime());
	System.out.println(root.getDocumentProperties().getCompany());
	System.out.println(root.getDocumentProperties().getCategory());
	System.out.println(root.getDocumentProperties().getKeywords());
	System.out.println(root.getDocumentProperties().getLastPrintedDate());
	System.out.println(root.getDocumentProperties().getNameOfApplication());

	// ...
}

If you need to extract custom metadata properties of a presentation please follow the code sample below.

advanced_usage.managing_metadata_for_specific_formats.document.presentation.PresentationReadCustomProperties

try (Metadata metadata = new Metadata(Constants.InputPptx)) {
	PresentationRootPackage root = metadata.getRootPackageGeneric();

	IReadOnlyList<MetadataProperty> customProperties = root.getDocumentProperties().findProperties(new ContainsTagSpecification(Tags.getDocument().getBuiltIn()).not());
	for (MetadataProperty property : customProperties) {
		System.out.println(String.format("%s = %s", property.getName(), property.getValue()));
	}
}

As you can see the code sample uses the GroupDocs.Metadata search engine to retrieve all properties that are not marked with the BuiltIn tag. Since we call the findProperties method for a certain metadata package (instance of the PresentationPackage class), the search result will contain only metadata properties that are specific for presentations. 

The inspection feature that is introduced in this section doesn’t work with metadata directly but extracts some useful pieces of information that can be considered as metadata under some circumstances. For example, you may want to obtain information about hidden slides presented in a document or extract user comments from the document content. Please follow the example below to learn how to do that.

1. Load a Presentation document
2. Extract the root metadata package
3. Use the getInspectionPackage method to inspect the document

advanced_usage.managing_metadata_for_specific_formats.document.presentation.PresentationReadInspectionProperties

try (Metadata metadata = new Metadata(Constants.InputPpt)) {
	PresentationRootPackage root = metadata.getRootPackageGeneric();

	if (root.getInspectionPackage().getComments() != null) {
		for (PresentationComment comment : root.getInspectionPackage().getComments()) {
			System.out.println(comment.getAuthor());
			System.out.println(comment.getText());
			System.out.println(comment.getCreatedTime());
			System.out.println(comment.getSlideNumber());
		}
	}

	if (root.getInspectionPackage().getHiddenSlides() != null) {
		for (PresentationSlide slide : root.getInspectionPackage().getHiddenSlides()) {
			System.out.println(slide.getName());
			System.out.println(slide.getNumber());
			System.out.println(slide.getSlideId());
		}
	}
}

Most office applications are able to display simple text statistics for loaded documents. It can be an estimated word count, page count, character count, etc. The GroupDocs.Metadata API provides similar functionality for some document formats. The following code sample demonstrates how to obtain the text statistics for a presentation.

advanced_usage.managing_metadata_for_specific_formats.document.presentation.PresentationReadDocumentStatistics

try (Metadata metadata = new Metadata(Constants.InputPpt)) {
	PresentationRootPackage root = metadata.getRootPackageGeneric();

	System.out.println(root.getDocumentStatistics().getCharacterCount());
	System.out.println(root.getDocumentStatistics().getPageCount());
	System.out.println(root.getDocumentStatistics().getWordCount());
}

Updating any built-in document properties is as simple as getting them. The following code sample demonstrates how to update built-in metadata properties in a presentation.

advanced_usage.managing_metadata_for_specific_formats.document.presentation.PresentationUpdateBuiltInProperties

try (Metadata metadata = new Metadata(Constants.InputPptx)) {
	PresentationRootPackage root = metadata.getRootPackageGeneric();

	root.getDocumentProperties().setAuthor("test author");
	root.getDocumentProperties().setCreatedTime(new Date());
	root.getDocumentProperties().setCompany("GroupDocs");
	root.getDocumentProperties().setCategory("test category");
	root.getDocumentProperties().setKeywords("metadata, built-in, update");

	// ...

	metadata.save(Constants.OutputPptx);
}

The GroupDocs.Metadata API also allows adding and updating custom metadata properties in a presentation. Please check the code sample below.

advanced_usage.managing_metadata_for_specific_formats.document.presentation.PresentationUpdateCustomProperties

try (Metadata metadata = new Metadata(Constants.InputPpt)) {
	PresentationRootPackage root = metadata.getRootPackageGeneric();

	root.getDocumentProperties().set("customProperty1", "some value");
	root.getDocumentProperties().set("customProperty2", 123.1);

	metadata.save(Constants.OutputPpt);
}

When you inspect a document GroupDocs.Metadata for Java forms a metadata package containing the extracted information. The package class also provides some basic methods that allow updating (or removing) the extracted properties. The following code sample demonstrates how to remove the inspection properties from a presentation.

advanced_usage.managing_metadata_for_specific_formats.document.presentation.PresentationUpdateInspectionProperties

try (Metadata metadata = new Metadata(Constants.InputPpt)) {
	PresentationRootPackage root = metadata.getRootPackageGeneric();

	root.getInspectionPackage().clearComments();
	root.getInspectionPackage().clearHiddenSlides();

	metadata.save(Constants.OutputPpt);
}

You may easily run the code above and see the feature in action in our GitHub examples:

• GroupDocs.Metadata for .NET examples

• GroupDocs.Metadata for Java examples

Along with full featured Java library we provide simple, but powerful free Apps.

You are welcome to view and edit metadata of PDF, DOC, DOCX, PPT, PPTX, XLS, XLSX, emails, images and more with our free online Free Online Document Metadata Viewing and Editing App.