com.groupdocs.redaction.configuration

Class DocumentFormatConfiguration

java.lang.Object

com.groupdocs.redaction.configuration.DocumentFormatConfiguration

public class DocumentFormatConfiguration
extends Object

Represents a type reference for DocumentFormatInstance-derived class and supported file extensions list for faster format detection.

Learn more

• More details about GroupDocs.Redaction configuration: Extend supported extensions list
• More details about implementing custom formats: Create custom format handler

The following example demonstrates how to set properties for a custom format configuration.

DocumentFormatConfiguration adobePhotoshopSettings = new DocumentFormatConfiguration();
 adobePhotoshopSettings.setExtensionFilter(".psd");
 adobePhotoshopSettings.setDocumentType(MyAdobePhotoshopFormatInstance.class);
  

Constructor Summary

Constructors

Constructor and Description
DocumentFormatConfiguration() Initializes a new instance of DocumentFormatConfiguration class.

Method Summary

Modifier and Type	Method and Description
Class	getDocumentType() Gets or sets the type of a class, inheriting from DocumentFormatInstance.
String	getExtensionFilter() Gets or sets a comma (",") delimited list of file extensions (for example ".pdf"), case insensitive.
com.aspose.ms.System.Collections.Generic.Dictionary<String,String>	getInitializationData() Gets or sets data, required for DocumentFormatInstance initialization.
void	setDocumentType(Class value) Gets or sets the type of a class, inheriting from DocumentFormatInstance.
void	setExtensionFilter(String value) Gets or sets a comma (",") delimited list of file extensions (for example ".pdf"), case insensitive.
void	setInitializationData(com.aspose.ms.System.Collections.Generic.Dictionary<String,String> value) Gets or sets data, required for DocumentFormatInstance initialization.
boolean	supportsExtension(String fileExtension) Checks if a given file extension can be handled as DocumentType.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentFormatConfiguration

public DocumentFormatConfiguration()

Initializes a new instance of DocumentFormatConfiguration class.

Method Detail

getDocumentType

public final Class getDocumentType()

Gets or sets the type of a class, inheriting from DocumentFormatInstance.

getExtensionFilter

public final String getExtensionFilter()

Gets or sets a comma (",") delimited list of file extensions (for example ".pdf"), case insensitive.

getInitializationData

public final com.aspose.ms.System.Collections.Generic.Dictionary<String,String> getInitializationData()

Gets or sets data, required for DocumentFormatInstance initialization.

setDocumentType

public final void setDocumentType(Class value)

Gets or sets the type of a class, inheriting from DocumentFormatInstance.

setExtensionFilter

public final void setExtensionFilter(String value)

Gets or sets a comma (",") delimited list of file extensions (for example ".pdf"), case insensitive.

setInitializationData

public final void setInitializationData(com.aspose.ms.System.Collections.Generic.Dictionary<String,String> value)

Gets or sets data, required for DocumentFormatInstance initialization.

supportsExtension

public final boolean supportsExtension(String fileExtension)

Checks if a given file extension can be handled as DocumentType.

Parameters:

fileExtension - File extension, format is ".ext"

Returns:

True if the extension is listed in ExtensionFilter