Stops the editing of a cell.
Syntax
Visual Basic (Declaration) | |
---|
Function StopEditing() As Boolean |
Visual Basic (Usage) | Copy Code |
---|
Dim instance As IEditor
Dim value As Boolean
value = instance.StopEditing() |
Return Value
true if successful; false otherwise
Example
This example subclasses the IEditor class and uses a check box as the cell editor to illustrate the use of the methods and events.
C# | Copy Code |
---|
public static CheckBox ck = new CheckBox();
class myEditor : FarPoint.Win.Spread.CellType.IEditor
{
public event EventHandler EditingCanceled;
public event EventHandler EditingStopped;
public bool StopEditing()
{
if (EditingStopped != null)
{
EditingStopped(ck, EventArgs.Empty);
base.FireEditingStopped();
return true;
}
else
{
return false;
}
}
public void CancelEditing()
{
EditingCanceled(ck, EventArgs.Empty);
base.FireEditingCanceled();
}
public bool IsReservedKey(KeyEventArgs e)
{
return false;
}
public bool IsValid(Object value)
{
return true;
}
public Size GetPreferredSize(System.Windows.Forms.Control editor)
{
return editor.Size;
}
public Cursor GetReservedCursor(object o)
{
return null;
}
public Control GetEditorControl(FarPoint.Win.Spread.Appearance appr, float zoom)
{
return ck;
}
public object GetEditorValue()
{
return ck.CheckState;
}
public void SetEditorValue(object value)
{
}
public object IsReservedLocation(Graphics g, int x, int y, Rectangle r, FarPoint.Win.Spread.Appearance appr, object value,
float zoom)
{
return null;
}
public void StartEditing(EventArgs e, bool selectAll)
{
selectAll = true;
}
public void ShowSubEditor()
{
this.ShowSubEditor();
}
}
private void Form1_Load(object sender, System.EventArgs e)
{
fpSpread1.ActiveSheet.Cells[0, 0].Editor = new myEditor();
} |
Visual Basic | Copy Code |
---|
Shared ck As New CheckBox()
Public Class myEditor
Implements FarPoint.Win.Spread.CellType.IEditor
Public Event EditingStopped(ByVal sender As Object, ByVal e As EventArgs) Implements FarPoint.Win.Spread.CellType.IEditor.EditingStopped
Public Event EditingCancelled(ByVal sender As Object, ByVal e As EventArgs) Implements FarPoint.Win.Spread.CellType.IEditor.EditingCanceled
Public Function StopEditing() As Boolean Implements FarPoint.Win.Spread.CellType.IEditor.StopEditing
RaiseEvent EditingStopped(ck, EventArgs.Empty)
MyBase.FireEditingStopped()
Return True
End Function
Public Sub CancelEditing() Implements FarPoint.Win.Spread.CellType.IEditor.CancelEditing
RaiseEvent EditingCancelled(ck, EventArgs.Empty)
MyBase.FireEditingCanceled()
End Sub
Public Function IsReservedKey(ByVal e As KeyEventArgs) As Boolean Implements FarPoint.Win.Spread.CellType.IEditor.IsReservedKey
Return False
End Function
Public Function IsValid(ByVal value As Object) As Boolean Implements FarPoint.Win.Spread.CellType.IEditor.IsValid
Return True
End Function
Public Function GetReservedCursor(ByVal o As Object) As Cursor Implements FarPoint.Win.Spread.CellType.IEditor.GetReservedCursor
Return Nothing
End Function
Public Function GetEditorControl(ByVal appr As FarPoint.Win.Spread.Appearance, ByVal zoom As Single) As Control Implements
FarPoint.Win.Spread.CellType.IEditor.GetEditorControl
Return ck
End Function
Public Function GetEditorValue() As Object Implements FarPoint.Win.Spread.CellType.IEditor.GetEditorValue
Return ck.CheckState
End Function
Public Function GetPreferredSize(ByVal editor As System.Windows.Forms.Control) As Size Implements FarPoint.Win.Spread.CellType.IEditor.GetPreferredSize
Return editor.Size
End Function
Public Sub SetEditorValue(ByVal value As Object) Implements FarPoint.Win.Spread.CellType.IEditor.SetEditorValue
ck.CheckState = CheckState.Checked
End Sub
Public Function IsReservedLocation(ByVal g As Graphics, ByVal x As Integer, ByVal y As Integer, ByVal r As Rectangle,
ByVal appr As FarPoint.Win.Spread.Appearance, ByVal value As Object, ByVal zoom As Single) As Object Implements FarPoint.Win.Spread.CellType.IEditor.IsReservedLocation
Return Nothing
End Function
Public Sub StartEditing(ByVal e As EventArgs, ByVal selectAll As Boolean) Implements FarPoint.Win.Spread.CellType.IEditor.StartEditing
selectAll = True
End Sub
Public Sub ShowSubEditor() Implements FarPoint.Win.Spread.CellType.IEditor.ShowSubEditor
Me.ShowSubEditor()
End Sub
End Class
Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
FpSpread1.ActiveSheet.Cells(0, 0).Editor = New myEditor()
End Sub
|
Requirements
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
See Also