New to Telerik Document Processing? Start a free 30-day trial

WorksheetProtectionOptions

Class

Defines which operations users can perform on a protected worksheet, controlling row, column, cell, and filtering permissions.

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Model.Protection

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

public class WorksheetProtectionOptions

Inheritance: objectWorksheetProtectionOptions

Constructors

WorksheetProtectionOptions(bool, bool, bool, bool, bool, bool, bool, bool, bool)

Initializes a new WorksheetProtectionOptions with specific permission flags for each operation type.

public WorksheetProtectionOptions(bool allowDeleteRows = false, bool allowInsertRows = false, bool allowDeleteColumns = false, bool allowInsertColumns = false, bool allowFormatCells = false, bool allowFormatColumns = false, bool allowFormatRows = false, bool allowFiltering = false, bool allowSorting = false)

Parameters:allowDeleteRowsbool

The allow delete rows.

allowInsertRowsbool

The allow insert rows.

allowDeleteColumnsbool

The allow delete columns.

allowInsertColumnsbool

The allow insert columns.

allowFormatCellsbool

The allow format cells.

allowFormatColumnsbool

The allow format columns.

allowFormatRowsbool

The allow format rows.

allowFilteringbool

The allow use autofilter.

allowSortingbool

The allow sorting.

Fields

Default

WorksheetProtectionOptions

Default protection options that disallow all modifications (all permission flags set to false).

public static readonly WorksheetProtectionOptions Default

Methods

Clone()

WorksheetProtectionOptions

Creates a copy of this protection options instance with identical permission flags.

public WorksheetProtectionOptions Clone()

Returns:

WorksheetProtectionOptions

The cloned instance.

Equals(object)

bool

Compares all permission flags and returns true if all match the specified object.

public override bool Equals(object obj)

Parameters:objobject

The object to compare with the current object.

Returns:

bool

True if the specified object is equal to the current object; otherwise, false.

Overrides: object.Equals(object)

GetHashCode()

int

Computes a hash code from all permission flags.

public override int GetHashCode()

Returns:

int

A hash code for the current object.

Overrides: object.GetHashCode()

Properties

AllowDeleteColumns

bool

Gets whether users can delete columns when the worksheet is protected.

public bool AllowDeleteColumns { get; }

Property Value:

The allow delete columns.

AllowDeleteRows

bool

Gets whether users can delete rows when the worksheet is protected.

public bool AllowDeleteRows { get; }

Property Value:

The allow delete rows.

AllowFiltering

bool

Gets whether users can apply and modify autofilters when the worksheet is protected.

public bool AllowFiltering { get; }

Property Value:

The allow filtering.

AllowFormatCells

bool

Gets whether users can format cells (fonts, colors, borders) when the worksheet is protected.

public bool AllowFormatCells { get; }

Property Value:

The allow format cells.

AllowFormatColumns

bool

Gets whether users can format columns (width, visibility, styles) when the worksheet is protected.

public bool AllowFormatColumns { get; }

Property Value:

The allow format columns.

AllowFormatRows

bool

Gets whether users can format rows (height, visibility, styles) when the worksheet is protected.

public bool AllowFormatRows { get; }

Property Value:

The allow format rows.

AllowInsertColumns

bool

Gets whether users can insert new columns when the worksheet is protected.

public bool AllowInsertColumns { get; }

Property Value:

The allow insert columns.

AllowInsertRows

bool

Gets whether users can insert new rows when the worksheet is protected.

public bool AllowInsertRows { get; }

Property Value:

The allow insert rows.

AllowSorting

bool

Gets whether users can sort cell ranges when the worksheet is protected.

public bool AllowSorting { get; }

Property Value:

The allow sorting.