WorkbookSanitizeOptions Class

Specifies options for workbook content sanitization.

Namespace: DevExpress.Spreadsheet

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

Declaration

C#

public sealed class WorkbookSanitizeOptions :
    SanitizeOptions

VB.NET

Public NotInheritable Class WorkbookSanitizeOptions
    Inherits SanitizeOptions

Related API Members

The following members return WorkbookSanitizeOptions objects:

• WorkbookInspectResult.CreateSanitizeOptions()
• WorkbookSanitizeOptions.FromInspectResult(WorkbookInspectResult)

Example

How to: Sanitize a Spreadsheet Document

The following code snippet sanitizes hidden sheets and comments from a spreadsheet:

C#

using DevExpress.Office;
using DevExpress.Spreadsheet;

using (Workbook workbook = new Workbook())
{
    workbook.LoadDocument("Documents\\Sample.xlsx");

    WorkbookSanitizeOptions sanitizeOptions = new WorkbookSanitizeOptions
    {
        RemoveThreadedComments = true,
        HiddenSheets = HiddenContentSanitizeMode.MakeVisible
    };

    var results = workbook.Sanitize(sanitizeOptions);

    foreach (var result in results)
    {
        Console.WriteLine($"Content type: {result.Type}, Action taken: {result.Action}");
    }
}

VB.NET

Imports DevExpress.Office
Imports DevExpress.Spreadsheet

Using workbook As New Workbook()
    workbook.LoadDocument("Documents\Sample.xlsx")

    Dim sanitizeOptions As New WorkbookSanitizeOptions With {
        .RemoveThreadedComments = True,
        .HiddenSheets = HiddenContentSanitizeMode.MakeVisible
    }

    Dim results = workbook.Sanitize(sanitizeOptions)

    For Each result In results
        Console.WriteLine($"Content type: {result.Type}, Action taken: {result.Action}")
    Next
End Using

Inheritance

Object

SanitizeOptions

WorkbookSanitizeOptions