OfficeWriter Documentation
.
ExcelWriter v8 Docs
Space Shortcuts
Page tree
ConfigureSpace tools

Versions Compared

Old Version 17

changes.mady.by.user Alison Bird [softartisans]

Saved on

compared with

New Version 18

changes.mady.by.user Anonymous

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

...

Wiki Markup
{introducedin: 8.6.1

...

Description

Excerpt

A SheetProtection object contains sheet level protection properties that control what users can interact with when a worksheet is protected. To access SheetProtection, use Worksheet.SheetProtection.


{remarks}
{example}{code:csharp|title=C#}

          //--- Open existing spreadsheet
          ExcelApplication xla = new ExcelApplication();
          Workbook wb = xla.Open(@"C:\MySpreadsheet.xlsx");

          //--- Get SheetProtection
          SheetProtection protection = wb[0].SheetProtection;

          //--- Set Properties
          protection.AllowFormatCells = true;
          protection.AllowSort = false;

        
{code}
{code:vbnet|title=vb.net
}

          '--- Open existing spreadsheet
          Dim xla As New ExcelApplication()
          Dim wb As Workbook = xla.Open("C:\MySpreadsheet.xlsx")

          '--- Get SheetProtection
          Dim protection As SheetProtection = wb(0).SheetProtection

          '--- Set Properties
          protection.AllowFormatCells = true;
          protection.AllowSort = false;
Signature
C#C#
}{description}
{excerpt}A {{SheetProtection}} object contains sheet level protection properties that control what users can interact with when a worksheet is protected. To access {{SheetProtection}}, use [Worksheet.SheetProtection].{excerpt}
{signature:C#}
 public sealed class SheetProtection
Signature
{signature}{signature:vb.net
vb.net
}
Public NotInheritable Class SheetProtection
Remarks

In a new workbook, AllowSelectLockedCells and AllowSelectUnlockedCells default to true. The rest of the properties default to false.

The SheetProtection properties will only take effect if the worksheet is protected. Worksheets can be protected with 
{signature}
{remarks}
In a new workbook, [AllowSelectLockedCells|SheetProtection.AllowSelectLockedCells] and [AllowSelectUnlockedCells|SheetProtection.AllowSelectUnlockedCells] default to {{true}}. The rest of the properties default to {{false}}.

The {{SheetProtection}} properties will only take effect if the worksheet is protected. Worksheets can be protected with [EW8:Worksheet.Protect(String)]. If the worksheet is not protected, the values of the properties will persist, but will not have an effect.
Example
Code Block
csharpcsharp
titleC#
Code Block
vbnetvbnettitle
Properties

...

Name

...

Description

...

AllowSelectLockedCells

...

AllowSelectUnlockedCells

...

AllowFormatCells

...

AllowFormatRows

...

AllowFormatColumns

...

AllowInsertColumns

...

AllowInsertRows

...

AllowInsertHyperlinks

...

AllowDeleteColumns

...

AllowDeleteRows

...

AllowSort

...

AllowUseAutoFilter

...

AllowUsePivotTableReports

...

{code}

{example}
{properties}
|| Name || Description ||
| [AllowSelectLockedCells|SheetProtection.AllowSelectLockedCells] | {excerpt-include:SheetProtection.AllowSelectLockedCells|nopanel=true} |
| [AllowSelectUnlockedCells|SheetProtection.AllowSelectUnlockedCells] | {excerpt-include:SheetProtection.AllowSelectUnlockedCells|nopanel=true} |
| [AllowFormatCells|SheetProtection.AllowFormatCells] | {excerpt-include:SheetProtection.AllowFormatCells|nopanel=true} |
| [AllowFormatRows|SheetProtection.AllowFormatRows] | {excerpt-include:SheetProtection.AllowFormatRows|nopanel=true} |
| [AllowFormatColumns|SheetProtection.AllowFormatColumns] | {excerpt-include:SheetProtection.AllowFormatColumns|nopanel=true} |
| [AllowInsertColumns|SheetProtection.AllowInsertColumns] | {excerpt-include:SheetProtection.AllowInsertColumns|nopanel=true} |
| [AllowInsertRows|SheetProtection.AllowInsertRows] | {excerpt-include:SheetProtection.AllowInsertRows|nopanel=true} |
| [AllowInsertHyperlinks|SheetProtection.AllowInsertHyperlinks] | {excerpt-include:SheetProtection.AllowInsertHyperlinks|nopanel=true} |
| [AllowDeleteColumns|SheetProtection.AllowDeleteColumns] | {excerpt-include:SheetProtection.AllowDeleteColumns|nopanel=true} |
| [AllowDeleteRows|SheetProtection.AllowDeleteRows] | {excerpt-include:SheetProtection.AllowDeleteRows|nopanel=true} |
| [AllowSort|SheetProtection.AllowSort] | {excerpt-include:SheetProtection.AllowSort|nopanel=true} |
| [AllowUseAutoFilter|SheetProtection.AllowUseAutoFilter] | {excerpt-include:SheetProtection.AllowUseAutoFilter|nopanel=true} |
| [AllowUsePivotTableReports|SheetProtection.AllowUsePivotTableReports] | {excerpt-include:SheetProtection.AllowUsePivotTableReports|nopanel=true} |