RichEditDocumentServer.Sanitize(WordProcessingSanitizeOptions) Method
Sanitizes the document content according to the specified options.
Namespace: DevExpress.XtraRichEdit
Assembly: DevExpress.RichEdit.v26.1.Core.dll
Declaration
public IReadOnlyList<WordProcessingSanitizeResult> Sanitize(
WordProcessingSanitizeOptions options
)Parameters
| Name | Type | Description |
|---|---|---|
| options | WordProcessingSanitizeOptions | The options that specify the content to sanitize and the action to perform with it. |
Returns
| Type | Description |
|---|---|
| IReadOnlyList<WordProcessingSanitizeResult> | A list of results that contain information about the sanitized content. |
Remarks
Call RichEditDocumentServer.Sanitize(WordProcessingSanitizeOptions) to remove personal data and internal organizational information from loaded documents before sharing, publishing, or archiving them. The method accepts a WordProcessingSanitizeOptions object that specifies which content categories to sanitize.
The method returns a list of WordProcessingSanitizeResult objects. Each object records the detected content type and action taken. Together, these objects provide a structured record of sanitization operations in the document.
Example
How to: Sanitize Document Content
The following code snippet sanitizes metadata and revision history from a document:
using DevExpress.XtraRichEdit;
var wordProcessor = new RichEditDocumentServer();
wordProcessor.LoadDocument("submission.docx");
WordProcessingSanitizeOptions sanitizeOptions = new WordProcessingSanitizeOptions() {
Metadata = MetadataRemovalScope.All,
TrackedChanges = TrackedChangesSanitizeMode.Accept,
};
IList<WordProcessingSanitizeResult> findings = wordProcessor.Sanitize(sanitizeOptions);
Console.WriteLine($"{findings.Count} finding(s) removed.");
wordProcessor.SaveDocument("submission_clean.docx", DocumentFormat.OpenXml);