RichEditDocumentServerOptions.SecurityLoadingOptions Property

Gets the security loading options for a document.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v26.1.Core.dll

Declaration

C#

public WordProcessingSecurityLoadingOptions SecurityLoadingOptions { get; }

VB.NET

Public ReadOnly Property SecurityLoadingOptions As WordProcessingSecurityLoadingOptions

Property Value

Type	Description
WordProcessingSecurityLoadingOptions	An object that contains the security loading options for a document.

Property Paths

You can access this nested property as listed below:

Object Type	Path to SecurityLoadingOptions
RichEditDocumentServer	.Options .SecurityLoadingOptions

Remarks

The SecurityLoadingOptions property instructs the API to detect specific threats during a file loading operation. If matching content is located, the RichEditDocumentServer.SecurityLoadingOptionsViolation event fires. Set e.Handled = false in the event handler to remove the detected content, or leave it set to true to retain the content (useful for audit-only modes).

Example

How to: Set Security Loading Options and Handle Violations

The following code snippet sets SecurityLoadingOptions and handles the SecurityLoadingOptionsViolation event:

C#

using DevExpress.XtraRichEdit;

var wordProcessor = new RichEditDocumentServer();
WordProcessingSecurityLoadingOptions securityLoadingOptions = wordProcessor.Options.SecurityLoadingOptions;

securityLoadingOptions.RestrictedHyperlinkRemovalMode = RestrictedHyperlinkRemovalMode.Full;
securityLoadingOptions.RemoveRestrictedLinks = true;
securityLoadingOptions.RemoveExternalImages = true;
securityLoadingOptions.RemoveOleObjects = true;
securityLoadingOptions.RemoveActiveXContent = true;
securityLoadingOptions.RemoveMacros = true;
securityLoadingOptions.RemoveDDEFields = true;
securityLoadingOptions.RemoveIncludePictureFields = true;
securityLoadingOptions.RemoveCustomXMLParts = true;

wordProcessor.SecurityLoadingOptionsViolation += (sender, e) => {
    Console.WriteLine($"Dangerous content found: {e.PropertyName}");
    e.Handled = false; // false = remove the content
};

wordProcessor.LoadDocument("external_submission.docm")

VB.NET

Imports DevExpress.XtraRichEdit

Dim wordProcessor As New RichEditDocumentServer()

Dim securityLoadingOptions As WordProcessingSecurityLoadingOptions = wordProcessor.Options.SecurityLoadingOptions
securityLoadingOptions.RestrictedHyperlinkRemovalMode = RestrictedHyperlinkRemovalMode.Full
securityLoadingOptions.RemoveRestrictedLinks = True
securityLoadingOptions.RemoveExternalImages = True
securityLoadingOptions.RemoveOleObjects = True
securityLoadingOptions.RemoveActiveXContent = True
securityLoadingOptions.RemoveMacros = True
securityLoadingOptions.RemoveDDEFields = True
securityLoadingOptions.RemoveIncludePictureFields = True
securityLoadingOptions.RemoveCustomXMLParts = True

AddHandler wordProcessor.SecurityLoadingOptionsViolation, Sub(sender, e)
    Console.WriteLine($"Dangerous content found: {e.PropertyName}")
    e.Handled = False ' false = remove the content
End Sub

wordProcessor.LoadDocument("external_submission.docm")