Loading Excel Documents

The process for loading Excel documents with ImageGear is very similar to that of other document formats. The following steps will enable you to view the first page of a worksheet in an Excel document.

Step 1

Add the Excel format to the list of file format filters ImageGear will use to detect formats of loaded content.

// Add support for Excel files
ImGearFileFormats.Filters.Add(ImGearOffice.CreateExcelFormat());

' Add support for Excel files
ImGearFileFormats.Filters.Add(ImGearOffice.CreateExcelFormat())

Step 2

Once the desired Excel file has been opened into a System.IO.Stream, the document can be loaded with the LoadDocument method. The startPageNumber and count parameters of the LoadDocument method can be used to load a select few or all of the sheets in the Excel document. The example below will load all available sheets.

The GetPageCount method can be used to get the number of sheets in a Stream that contains a valid Excel document.

ImageGear only supports the popular worksheet sheet type currently. For any other sheet type encountered, like chartsheet and dialogsheet, a blank 8.5” x 11” page will be returned.

ImGearDocument imGearDocument = ImGearFileFormats.LoadDocument(fileContent, 0, -1);

Dim imGearDocument As ImGearDocument = ImGearFileFormats.LoadDocument(fileContent, 0, -1)

Step 3

Once the document is loaded, the top-level ImGearExcelBookDocument will contain pages, with each one representing an entire sheet. Retrieve one of the pages to access a sheet in the Excel document that can be displayed or printed as a single page or paginated further with a different page size. The following example paginates the worksheet into pages whose size is determined by that which is defined in the original Excel document. Alternatively, a custom size can be defined for the new pages simply by setting the width and height parameters of the Repaginate method accordingly.

Use caution when displaying or printing a sheet as a single page. Because of the large sizes that are possible with Excel sheets, it’s possible that the memory necessary to render the page will exceed the resources of the system. In general, sheets with less than 20,000 cells are safe for rendering as a single page on a modern system. Though keep in mind, the larger the sheet the more time that will be needed to render the page. It is recommended that the paginated ImGearExcelSheetPage objects be used for displaying or printing by default unless the size of the worksheets are known.

if (imGearDocument is ImGearExcelBookDocument)
{
    if (imGearExcelBookDocument.Pages.Count > 0)
    {
        currSheetNumber = 0;
        ImGearExcelBookPage imGearBookPage = (ImGearExcelBookPage)imGearExcelBookDocument.Pages[currSheetNumber];
        imGearDocument = imGearBookPage.Repaginate(0, 0);
    }
}

If (TypeOf imGearDocument Is ImGearExcelBookDocument) Then
    If imGearExcelBookDocument.Pages.Count > 0 Then
        currSheetNumber = 0
        Dim imGearBookPage As ImGearExcelBookPage = DirectCast(imGearExcelBookDocument.Pages(Me.currSheetNumber), ImGearExcelBookPage)
        imGearDocument = imGearBookPage.Repaginate(0, 0)
    End If
End If

Step 4

Displaying the first one of the pages you created for the sheet is easy using ImageGear’s PageView control. Simply create the control and set the Page property to that of the Excel page. Refer to the Displaying Images topic for more information on displaying images with ImageGear.

imGearPageView.Page = imGearDocument.Pages[0];
imGearPageView.Update();

imGearPageView.Page = imGearDocument.Pages(0)
imGearPageView.Update()

©2017. Accusoft Corporation. All Rights Reserved.