Xceed Logo
Shop
Xceed Workbooks for .NET v3.0 Documentation
Xceed.Workbooks.NET Assembly / Xceed.Workbooks.NET Namespace / WorksheetProtection Class
Example


In This Topic
    WorksheetProtection Class
    In This Topic
    Represents the actions that can be carried out on a Worksheet when it is protected.
    Syntax
    'Declaration
 

    Public Class WorksheetProtection 
   Inherits ProtectionBase
   Implements IReadonlyWorksheetProtection 
    'Usage
 

    Dim instance As WorksheetProtection
    public class WorksheetProtection : ProtectionBase, IReadonlyWorksheetProtection
    Example
    using( var workbook = Workbook.Create( "AddProtection.xlsx" ) ) 
  { 
    // Gets the first Worksheet; a Workbook always contains at least 1 Worksheet. 
    var worksheet = workbook.Worksheets[ 0 ]; 

    // Sets the Worksheet protection : only formatting Cells and inserting Rows/Columns will be allowed. 
    var protection = new WorksheetProtection() { AllowFormatCells = true, AllowInsertRows = true, AllowInsertColumns = true }; 

    // Protects the 1st Worksheet with a password. 
    worksheet.Protect( protection, "xceed" ); 

    // Saves Workbook to disk; 
    workbook.Save(); 
  }
    Inheritance Hierarchy

    System.Object
       Xceed.Workbooks.NET.ProtectionBase
          Xceed.Workbooks.NET.WorksheetProtection

    Public Constructors
     NameDescription
    Public ConstructorWorksheetProtection Constructor  
    Top
    Public Properties
     NameDescription
    Public PropertyAllowDeleteColumnsGets or sets if deleting Columns is allowed when a Worksheet is protected. The default value is false.  
    Public PropertyAllowDeleteRowsGets or sets if deleting Rows is allowed when a Worksheet is protected. The default value is false.  
    Public PropertyAllowEditObjectsGets or sets if editing objects like Pictures, Notes or Comments is allowed when a Worksheet is protected. The default value is false.  
    Public PropertyAllowFormatCellsGets or sets if modifying the formatting of Cells is allowed when a Worksheet is protected. The default value is false.  
    Public PropertyAllowFormatColumnsGets or sets if modifying the formatting of Columns  is allowed when a Worksheet is protected. The default value is false.  
    Public PropertyAllowFormatRowsGets or sets if modifying the formatting of Rows is allowed when a Worksheet is protected. The default value is false.  
    Public PropertyAllowInsertColumnsGets or sets if inserting Columns is allowed when a Worksheet is protected. The default value is false.  
    Public PropertyAllowInsertHyperlinksGets or sets if inserting Hyperlinks is allowed when a Worksheet is protected. The default value is false.  
    Public PropertyAllowInsertRowsGets or sets if inserting Rows is allowed when a Worksheet is protected. The default value is false.  
    Public PropertyAllowSelectLockedCellsGets or sets if selecting locked Cells is allowed when a Worksheet is protected. The default value is true.  
    Public PropertyAllowSelectUnlockedCellsGets or sets if selecting unlocked Cells is allowed when a Worksheet is protected. The default value is true.  
    Public PropertyAllowUseAutoFilterGets or sets if using AutoFilter is allowed when a Worksheet is protected. The default value is false.  
    Top
    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Framework: net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also

    Reference

    WorksheetProtection Members
    Xceed.Workbooks.NET Namespace

    Send Feedback