SpreadsheetGear 2012
GetWorkbook(String) Method
Example 






SpreadsheetGear Namespace > Factory Class > GetWorkbook Method : GetWorkbook(String) Method
Opens an existing workbook in a newly created instance of IWorkbook in a new instance of IWorkbookSet.
Syntax
'Declaration
 

Public Overloads Shared Function GetWorkbook( _
   ByVal filename As System.String _
) As IWorkbook
'Usage
 

Dim filename As System.String
Dim value As IWorkbook
 
value = Factory.GetWorkbook(filename)
public static IWorkbook GetWorkbook( 
   System.string filename
)
public function GetWorkbook( 
    filename: System.String
): IWorkbook; static; 
public static function GetWorkbook( 
   filename : System.String
) : IWorkbook;
public: static IWorkbook* GetWorkbook( 
   System.string* filename
) 
public:
static IWorkbook^ GetWorkbook( 
   System.String^ filename
)

Parameters

filename

Return Value

A new instance of IWorkbook in a new instance of IWorkbookSet.
Remarks

This method is thread safe.

The workbook set containing the new workbook will use the US English CultureInfo. To open a workbook in a workbook set with a specific culture, use GetWorkbook(String,CultureInfo).

Example
class Program
{
    static void Main(string[] args)
    {
        // Open MyData.xls.
        SpreadsheetGear.IWorkbook workbook = SpreadsheetGear.Factory.GetWorkbook(@"C:\MyData.xls");
        // Get a reference to the first worksheet.
        SpreadsheetGear.IWorksheet worksheet = workbook.Worksheets["Sheet1"];
        // Get a reference to the top left cell of Sheet1.
        SpreadsheetGear.IRange a1 = worksheet.Cells["A1"];
        // Output the value of A1.
        System.Console.WriteLine("[MyData.xls]Sheet1!A1 contains " + a1.Value.ToString() + ".");
    }
}
Module Program
    Sub Main()
        ' Open MyData.xls. 
        Dim workbook As SpreadsheetGear.IWorkbook = SpreadsheetGear.Factory.GetWorkbook("C:\\MyData.xls")
        ' Get a reference to the first worksheet. 
        Dim worksheet As SpreadsheetGear.IWorksheet = workbook.Worksheets("Sheet1")
        ' Get a reference to the top left cell of Sheet1. 
        Dim a1 As SpreadsheetGear.IRange = worksheet.Cells("A1")
        ' Output the value of A1. 
        Console.WriteLine(("[MyData.xls]Sheet1!A1 contains " + a1.Value.ToString() + "."))
    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

Factory Class
Factory Members
Overload List
IWorkbookSet
IWorkbook
GetWorkbook Method
GetWorkbookSet Method
GetWorkbook(CultureInfo) Method
GetWorkbook(String,CultureInfo) Method
GetWorkbookSet(CultureInfo) Method
Open(String) Method
Open(String,String) Method
OpenFromMemory(Byte[]) Method
OpenFromMemory(Byte[],String) Method
OpenFromStream(Stream) Method
OpenFromStream(Stream,String) Method

Send Feedback