Locked Property (Cell)

In This Topic

Gets or sets whether a cell is marked as locked from editing.

Syntax

Visual Basic
C#

'Declaration
 
Public Property Locked As Boolean

'Usage
 
Dim instance As Cell
Dim value As Boolean
 
instance.Locked = value
 
value = instance.Locked

public bool Locked {get; set;}

Property Value

Boolean: true if cells are marked as locked; false otherwise

Remarks

This property is available at run time only.

You can specify that certain cells are locked; that is, the user cannot edit them. You mark cells as locked using this property. Cells are not locked until the SheetView object's SheetView.Protect property is set to true for the sheet. Because the Protect property's default value is true, unless you have changed the value of the Protect property, when you mark a cell as locked, it is locked and the user cannot edit it.

Note that when the Protect property is false, the user can still interact with cells marked as locked.

The setting for this property can be overridden if a named style is assigned to the cell using the StyleName property, and that named style sets the locked status.

Example

This example creates a Cell object and locks the cell to prevent the user from editing the contents of the cell. It assumes that the SheetView's Protect property is set to its default value of True.

C#
Visual Basic

FarPoint.Web.Spread.Cell mycell;
mycell=FpSpread1.Cells[0,0];
mycell.Value="Locked";
mycell.HorizontalAlign=HorizontalAlign.Right;
mycell.VerticalAlign=VerticalAlign.Top;
mycell.Locked=true;

Dim mycell As FarPoint.Web.Spread.Cell
mycell=FpSpread1.Cells(0,0)
mycell.Value="Locked"
mycell.HorizontalAlign=HorizontalAlign.Right
mycell.VerticalAlign=VerticalAlign.Top
mycell.Locked=True

Reference

Cell Class
Cell Members
StyleName Property
Protect Property

User-Task Documentation

Locking a Cell