Expand Property (ExpandEventArgs)

Gets whether the row is going to be expanded.

Syntax

Visual Basic
C#

'Declaration
 
Public ReadOnly Property Expand As Boolean

'Usage
 
Dim instance As ExpandEventArgs
Dim value As Boolean
 
value = instance.Expand

public bool Expand {get;}

Property Value

Boolean: true if the hierarchy was collapsed before this event (and is to be expanded); false if already expanded when event occurs

Remarks

This property (which might better be named IsGoingToBeExpanded) determines if the hierarchy is going to be expanded on the next click. When the user clicks to expand a collapsed hierarchy, this value is false since it is already expanded so will not be expanded. When the user clicks on an expanded hierarchy and collapses it, the value is true because it can be expanded.

Example

private void fpSpread1_Expand(object sender, FarPoint.Win.Spread.ExpandEventArgs e)
{
    if (e.Expand == true)
    {
    e.View.Sheets[0].Cells[e.Row, 0, e.Row, fpSpread1.ActiveSheet.ColumnCount - 1].BackColor = Color.Yellow;
    }
}

Visual Basic

Private Sub FpSpread1_Expand(ByVal sender As Object, ByVal e As FarPoint.Win.Spread.ExpandEventArgs) Handles FpSpread1.Expand
    If e.Expand = True Then
        e.View.Sheets(0).Cells(e.Row, 0, e.Row, FpSpread1.ActiveSheet.ColumnCount - 1).BackColor = Color.Yellow
    End If
End Sub

Requirements

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

Reference

ExpandEventArgs Class
ExpandEventArgs Members