RetainSelectionBlock Property (FpSpread)

Gets or sets whether the selected range of cells remains highlighted when the component loses the focus.

Syntax

Visual Basic
C#

'Declaration
 
Public Property RetainSelectionBlock As Boolean

'Usage
 
Dim instance As FpSpread
Dim value As Boolean
 
instance.RetainSelectionBlock = value
 
value = instance.RetainSelectionBlock

public bool RetainSelectionBlock {get; set;}

Property Value

Boolean: true to keep cell range highlighted; false otherwise

Remarks

The RetainSelectionBlock property applies to cell selections in the grid modes (Normal and ReadOnly) and also applies to cell focus indicators (Normal and RowMode). This property does not apply to row selections in the list modes (RowMode, SingleSelect, MultiSelect, ExtendedSelect). List boxes always show their row selections.

Example

This example specifies whether the selected range (or block) of cells remains highlighted when the component loses the focus.

FarPoint.Win.Spread.FpSpread fpSpread1 = new FarPoint.Win.Spread.FpSpread();
FarPoint.Win.Spread.SheetView shv = new FarPoint.Win.Spread.SheetView();
DialogResult dlg;
textBox1.Visible = true;
fpSpread1.Location = new Point(10, 10);
fpSpread1.Height = 200;
fpSpread1.Width = 400;
Controls.Add(fpSpread1);
fpSpread1.Sheets.Add(shv);
fpSpread1.ActiveSheet.AddSelection(1, 1, 3, 3);
dlg = MessageBox.Show("Do you want to retain the selection??", "RetainSelectionBlock", MessageBoxButtons.YesNo);
if (dlg == DialogResult.Yes)
{
     fpSpread1.RetainSelectionBlock = true;
     textBox1.Focus();
}

Visual Basic

Dim fpSpread1 As New FarPoint.Win.Spread.FpSpread()
Dim shv As New FarPoint.Win.Spread.SheetView()
Dim dlg As DialogResult
TextBox1.Visible = True
fpSpread1.Location = New Point(10, 10)
fpSpread1.Height = 200
fpSpread1.Width = 400
Controls.Add(fpSpread1)
fpSpread1.Sheets.Add(shv)
fpSpread1.ActiveSheet.AddSelection(1, 1, 3, 3)
dlg = MessageBox.Show("Do you want to retain the selection??", "RetainSelectionBlock", MessageBoxButtons.YesNo)
If dlg = DialogResult.Yes Then
     fpSpread1.RetainSelectionBlock = True
     TextBox1.Focus()
End If

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows Server 2012 R2, Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8, Windows 8.1, Windows 10

Reference

FpSpread Class
FpSpread Members

User-Task Documentation

Customizing the Selection