SpreadsheetGear 2017
OpenFromStream(Stream) Method
Example 






SpreadsheetGear Namespace > IWorkbooks Interface > OpenFromStream Method : OpenFromStream(Stream) Method
The stream containing the workbook to open.
Open an existing workbook in a newly created instance of IWorkbook.
Syntax
'Declaration
 
Overloads Function OpenFromStream( _
   ByVal stream As System.IO.Stream _
) As IWorkbook
'Usage
 
Dim instance As IWorkbooks
Dim stream As System.IO.Stream
Dim value As IWorkbook
 
value = instance.OpenFromStream(stream)
IWorkbook OpenFromStream( 
   System.IO.Stream stream
)
function OpenFromStream( 
    stream: System.IO.Stream
): IWorkbook; 
function OpenFromStream( 
   stream : System.IO.Stream
) : IWorkbook;
IWorkbook* OpenFromStream( 
   System.IO.Stream* stream
) 
IWorkbook^ OpenFromStream( 
   System.IO.Stream^ stream
) 

Parameters

stream
The stream containing the workbook to open.

Return Value

The opened workbook.
Remarks

The stream must consist solely of a file which SpreadsheetGear is able to read. If the stream is not seekable, this method will copy the stream to a MemoryStream and read the workbook from the MemoryStream.

The various workbook settings which make a workbook read-only in an end user workbookSet have no affect at this level. These settings are available as IWorkbook properties.

Example
class Program
{
    static void Main(string[] args)
    {
        // Create a simple workbook.
        SpreadsheetGear.IWorkbook workbook = SpreadsheetGear.Factory.GetWorkbook();
        workbook.Worksheets["Sheet1"].Cells["A1"].Value = "Hello World!";
 
        // Save the workbook to a memory stream.
        System.IO.MemoryStream memoryStream = new System.IO.MemoryStream();
        workbook.SaveToStream(memoryStream, SpreadsheetGear.FileFormat.OpenXMLWorkbook);
 
        // Close the workbook.
        workbook.Close();
 
        // Create another workbook from the memory stream.
        workbook = SpreadsheetGear.Factory.GetWorkbookSet().Workbooks.OpenFromStream(memoryStream);
        Console.WriteLine("Sheet1!A1='{0}'", workbook.Worksheets["Sheet1"].Cells["A1"].Value);
    }
}
Module Program
    Sub Main()
        ' Create a simple workbook. 
        Dim workbook As SpreadsheetGear.IWorkbook = SpreadsheetGear.Factory.GetWorkbook()
        workbook.Worksheets("Sheet1").Cells("A1").Value = "Hello World!"
 
        ' Save the workbook to a memory stream. 
        Dim memoryStream As New System.IO.MemoryStream()
        workbook.SaveToStream(memoryStream, SpreadsheetGear.FileFormat.OpenXMLWorkbook)
 
        ' Close the workbook. 
        workbook.Close()
 
        ' Create another workbook from the memory stream. 
        workbook = SpreadsheetGear.Factory.GetWorkbookSet().Workbooks.OpenFromStream(memoryStream)
        Console.WriteLine("Sheet1!A1='{0}'", workbook.Worksheets("Sheet1").Cells("A1").Value)
    End Sub
End Module
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

Reference

IWorkbooks Interface
IWorkbooks Members
Overload List
OpenFromStream(Stream,String) Method
Save Method
SaveAs(String,FileFormat) Method
SaveToMemory(FileFormat) Method
SaveToStream(Stream,FileFormat) Method
Open(String) Method
OpenFromMemory(Byte[]) Method