SanitizeOptions Class

The base class for classes that contain options for document sanitization.

Declaration

public abstract class SanitizeOptions extends JavaObject

Remarks

The SanitizeOptions class includes options that specify the content and metadata that the API removes from a document. Derived classes add options for content types specific to a document format.

Inherited Members

com.devexpress.system.JavaObject.clone()

com.devexpress.system.JavaObject.equals(java.lang.Object)

com.devexpress.system.JavaObject.hashCode()

com.devexpress.system.JavaObject.initFields()

com.devexpress.system.JavaObject.memberwiseClone()

com.devexpress.system.JavaObject.toString()

java.lang.Object.finalize()

java.lang.Object.getClass()

java.lang.Object.notify()

java.lang.Object.notifyAll()

java.lang.Object.wait()

java.lang.Object.wait(long)

java.lang.Object.wait(long,int)

Inheritance

Object

com.devexpress.system.JavaObject

SanitizeOptions

Methods

getMetadata() Method

Returns whether sanitize options include metadata categories removal.

Declaration

public MetadataRemovalScope getMetadata()

Returns

Type	Description
MetadataRemovalScope	Metadata categories to remove.

getRemoveActiveXContent() Method

Returns whether sanitize options include ActiveX content removal.

Declaration

public boolean getRemoveActiveXContent()

Returns

Type	Description
boolean	true if sanitize options include ActiveX content removal; otherwise, false.

getRemoveComments() Method

Returns whether sanitize options include comment removal.

Declaration

public boolean getRemoveComments()

Returns

Type	Description
boolean	true sanitize options include comment removal; otherwise, false.

getRemoveCustomXmlParts() Method

Returns whether sanitize options include custom XML part removal.

Declaration

public boolean getRemoveCustomXmlParts()

Returns

Type	Description
boolean	true if sanitize options include custom XML part removal; otherwise, false.

getRemoveMacros() Method

Returns whether sanitize options include macro removal.

Declaration

public boolean getRemoveMacros()

Returns

Type	Description
boolean	true if sanitize options include macro removal; otherwise, false.

getRemoveOleObjects() Method

Returns whether sanitize options include OLE object removal.

Declaration

public boolean getRemoveOleObjects()

Returns

Type	Description
boolean	true if sanitize options include OLE object removal; otherwise, false.

setMetadata(MetadataRemovalScope value) Method

Sets metadata categories to remove.

Declaration

public void setMetadata(MetadataRemovalScope value)

Parameters

Name	Type	Description
value	MetadataRemovalScope	Metadata categories to remove.

setRemoveActiveXContent(boolean value) Method

Sets whether to remove ActiveX content.

Declaration

public void setRemoveActiveXContent(boolean value)

Parameters

Name	Type	Description
value	boolean	true to remove ActiveX content; otherwise, false.

setRemoveComments(boolean value) Method

Sets whether to remove comments.

Declaration

public void setRemoveComments(boolean value)

Parameters

Name	Type	Description
value	boolean	true to remove comments; otherwise, false.

setRemoveCustomXmlParts(boolean value) Method

Sets whether to remove custom XML parts.

Declaration

public void setRemoveCustomXmlParts(boolean value)

Parameters

Name	Type	Description
value	boolean	true to remove custom XML parts; otherwise, false.

setRemoveMacros(boolean value) Method

Sets whether to remove macros.

Declaration

public void setRemoveMacros(boolean value)

Parameters

Name	Type	Description
value	boolean	true to remove macros; otherwise, false.

setRemoveOleObjects(boolean value) Method

Sets whether to remove OLE objects.

Declaration

public void setRemoveOleObjects(boolean value)

Parameters

Name	Type	Description
value	boolean	true to remove OLE objects; otherwise, false.