Spread ASP.NET 14
FarPoint.Web.Spread Assembly / FarPoint.Web.Spread Namespace / FpSpread Class / SaveOrLoadSheetState Event
Example


In This Topic
    SaveOrLoadSheetState Event
    In This Topic
    Occurs when the user saves or loads a view state of a sheet.
    Syntax
    'Declaration
     
    Public Event SaveOrLoadSheetState As SheetViewStateEventHandler
    'Usage
     
    Dim instance As FpSpread
    Dim handler As SheetViewStateEventHandler
     
    AddHandler instance.SaveOrLoadSheetState, handler
    public event SheetViewStateEventHandler SaveOrLoadSheetState
    Event Data

    The event handler receives an argument of type SheetViewStateEventArgs containing data related to this event. The following SheetViewStateEventArgs properties provide information specific to this event.

    PropertyDescription
    Gets or sets whether the event has been handled.  
    Gets the index of the collection that contains the sheet.  
    Gets whether the state of the sheet is saved.  
    Gets the sheet whose state is to be loaded or to be saved.  
    Remarks
    When the SaveViewStateToSession property is true, spread saves its view state to the Session object. If you do not want to save the spread view state to the Session object, you should set this property to false. The default value is true.
    Example
    This example illustrates the use of the event.
    private void FpSpread1SaveOrLoadSheetState(object sender, FarPoint.Web.Spread.SheetViewStateEventArgs e)  
    {
        if (e.IsSave)
        { 
            Session["SheetName" + e.Index] = e.SheetView.SaveViewState();
        } 
        else
        { 
            e.SheetView.LoadViewState(Session["SheetName" + e.Index]); 
        }
        e.Handled = true; 
    }
    
    Private Sub FpSpread1SaveOrLoadSheetState(ByVal sender As Object, ByVal e As FarPoint.Web.Spread.SheetViewStateEventArgs)
    Handles FpSpread1.SaveOrLoadSheetState 
        If (e.IsSave) Then 
            Session("SheetName" & e.Index) = e.SheetView.SaveViewState() 
        Else 
            e.SheetView.LoadViewState(Session("SheetName" & e.Index)) 
        End If 
        e.Handled = True 
    End Sub 
    See Also