Locked Property (Column)

In This Topic

Gets or sets whether cells in this column are marked as locked.

Syntax

Visual Basic
C#

'Declaration
 
Public Property Locked As Boolean

'Usage
 
Dim instance As Column
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 from editing; false otherwise

Remarks

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 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 multiple Column object and adjusts the alignment of the text in the column. The height of the rows are changed so that the alignment changes can be easily seen. The contents of the cells in the column are locked to prevent editing.

C#
Visual Basic

FpSpread1.ActiveSheetView.ColumnCount=10;
FpSpread1.ActiveSheetView.PageSize=20;
FpSpread1.ActiveSheetView.RowCount=20;
FarPoint.Web.Spread.Column mycol;
mycol=FpSpread1.ActiveSheetView.Columns[1,3];
mycol.HorizontalAlign=HorizontalAlign.Right;
mycol.VerticalAlign=VerticalAlign.Top;
mycol.Locked=true;
for(int i=0;i<FpSpread1.ActiveSheetView.RowCount;i++)
{
FpSpread1.ActiveSheetView.SetValue(i,1,"Alignment");
FpSpread1.ActiveSheetView.Rows[i].Height=80;
}

TextBox1.Text=Convert.ToString(mycol.Index2);

FpSpread1.ActiveSheetView.ColumnCount=10
FpSpread1.ActiveSheetView.PageSize=20
FpSpread1.ActiveSheetView.RowCount=20
Dim mycol As FarPoint.Web.Spread.Column
Dim i As Integer
mycol=FpSpread1.ActiveSheetView.Columns(1,3)
mycol.HorizontalAlign=HorizontalAlign.Right
mycol.VerticalAlign=VerticalAlign.Top
mycol.Locked=True
For i=0 To FpSpread1.ActiveSheetView.RowCount-1
FpSpread1.ActiveSheetView.SetValue(i,1,"Alignment")
FpSpread1.ActiveSheetView.Rows(i).Height=80
Next i

Reference

Column Class
Column Members
Protect Property

User-Task Documentation

Locking a Cell