Class WorksheetProtectionOptions

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

Inheritance
System.Object
WorksheetProtectionOptions
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.Model.Protection
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class WorksheetProtectionOptions

Constructors

WorksheetProtectionOptions(Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean)

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

Declaration
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
System.Boolean allowDeleteRows

The allow delete rows.
System.Boolean allowInsertRows

The allow insert rows.
System.Boolean allowDeleteColumns

The allow delete columns.
System.Boolean allowInsertColumns

The allow insert columns.
System.Boolean allowFormatCells

The allow format cells.
System.Boolean allowFormatColumns

The allow format columns.
System.Boolean allowFormatRows

The allow format rows.
System.Boolean allowFiltering

The allow use autofilter.
System.Boolean allowSorting

The allow sorting.

Fields

Default

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

Declaration
public static readonly WorksheetProtectionOptions Default
Field Value
WorksheetProtectionOptions

Properties

AllowDeleteColumns

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

Declaration
public bool AllowDeleteColumns { get; }
Property Value
System.Boolean

The allow delete columns.

AllowDeleteRows

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

Declaration
public bool AllowDeleteRows { get; }
Property Value
System.Boolean

The allow delete rows.

AllowFiltering

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

Declaration
public bool AllowFiltering { get; }
Property Value
System.Boolean

The allow filtering.

AllowFormatCells

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

Declaration
public bool AllowFormatCells { get; }
Property Value
System.Boolean

The allow format cells.

AllowFormatColumns

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

Declaration
public bool AllowFormatColumns { get; }
Property Value
System.Boolean

The allow format columns.

AllowFormatRows

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

Declaration
public bool AllowFormatRows { get; }
Property Value
System.Boolean

The allow format rows.

AllowInsertColumns

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

Declaration
public bool AllowInsertColumns { get; }
Property Value
System.Boolean

The allow insert columns.

AllowInsertRows

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

Declaration
public bool AllowInsertRows { get; }
Property Value
System.Boolean

The allow insert rows.

AllowSorting

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

Declaration
public bool AllowSorting { get; }
Property Value
System.Boolean

The allow sorting.

Methods

Clone()

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

Declaration
public WorksheetProtectionOptions Clone()
Returns
WorksheetProtectionOptions

The cloned instance.

Equals(Object)

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

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

The System.Object to compare with the current System.Object.
Returns
System.Boolean

True if the specified System.Object is equal to the current System.Object; otherwise, false.
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Computes a hash code from all permission flags.

Declaration
public override int GetHashCode()
Returns
System.Int32

A hash code for the current System.Object.
Overrides
System.Object.GetHashCode()

Extension Methods