EasyXLS

How to set header and footer in VBScript

'=====================================================================
' Tutorial 08
'
' This tutorial shows how to create an Excel file in VBScript (1)
' having multiple sheets (2). The first sheet is filled with data (3)
' and the cells are formatted (4) and locked (5).
' The column header has comments (6).
' The first worksheet has header & footer (7).
'=====================================================================

' Constants declaration
Dim DATATYPE_STRING
DATATYPE_STRING = "string"

Dim ALIGNMENT_CENTER, ALIGNMENT_BOTTOM, ALIGNMENT_LEFT
ALIGNMENT_CENTER = "center"
ALIGNMENT_BOTTOM = "bottom"
ALIGNMENT_LEFT = "left"

Dim Black, Gray, Yellow, DarkGray, Blue
Black = &hff000000
Gray = &hff808080
Yellow = &hff00ffff
DarkGray = &hffa9a9a9
Blue = &hffff0000

Dim BORDER_MEDIUM
BORDER_MEDIUM = 2

Dim HEADER_POSITION_CENTER, HEADER_POSITION_RIGHT
HEADER_POSITION_CENTER = "C"
HEADER_POSITION_RIGHT = "R"

Dim FOOTER_POSITION_CENTER
FOOTER_POSITION_CENTER = "C"

WScript.StdOut.WriteLine("Tutorial 08" & vbcrlf & "----------" & vbcrlf)

' Create an instance of the class that exports Excel files (1)
Set workbook = CreateObject("EasyXLS.ExcelDocument")

' Create two sheets (2)
workbook.easy_addWorksheet_2("First tab")
workbook.easy_addWorksheet_2("Second tab")

' Protect first sheet
workbook.easy_getSheetAt(0).setSheetProtected(True)

' Get the table of data for the first worksheet (3)
Set xlsFirstTable = workbook.easy_getSheetAt(0).easy_getExcelTable()

' Create the formatting style for the header
Set xlsStyleHeader = CreateObject("EasyXLS.ExcelStyle")
xlsStyleHeader.setFont("Verdana")
xlsStyleHeader.setFontSize(8)
xlsStyleHeader.setItalic(True)
xlsStyleHeader.setBold(True)
xlsStyleHeader.setForeground(CLng(YELLOW))
xlsStyleHeader.setBackground(CLng(BLACK))
xlsStyleHeader.setBorderColors CLng(GRAY), CLng(GRAY), CLng(GRAY), CLng(GRAY)
xlsStyleHeader.setBorderStyles BORDER_MEDIUM, BORDER_MEDIUM, BORDER_MEDIUM, BORDER_MEDIUM
xlsStyleHeader.setHorizontalAlignment(ALIGNMENT_CENTER)
xlsStyleHeader.setVerticalAlignment(ALIGNMENT_BOTTOM)
xlsStyleHeader.setWrap(True)
xlsStyleHeader.setDataType(DATATYPE_STRING)

' Add data in cells for report header
For column = 0 To 4
    xlsFirstTable.easy_getCell(0,column).setValue("Column " & (column + 1))
    xlsFirstTable.easy_getCell(0,column).setStyle(xlsStyleHeader)

    ' Add comment for report header cells (6)
    xlsFirstTable.easy_getCell(0, column).setComment_2("This is column no " & (column + 1))
Next
xlsFirstTable.easy_getRowAt(0).setHeight(30)

' Create a formatting style for cells (4)
Set xlsStyleData = CreateObject("EasyXLS.ExcelStyle")
xlsStyleData.setHorizontalAlignment(ALIGNMENT_LEFT)
xlsStyleData.setForeground(CLng(DARKGRAY))
xlsStyleData.setWrap(False)
'  Protect cells (5)
xlsStyleData.setLocked(True)
xlsStyleData.setDataType(DATATYPE_STRING)

' Add data in cells for report values
For row = 0 To 99
    For column = 0 To 4
        xlsFirstTable.easy_getCell(row+1,column).setValue("Data " & (row + 1) & ", " & (column + 1))
        xlsFirstTable.easy_getCell(row+1,column).setStyle(xlsStyleData)
    Next
Next

' Set column widths
xlsFirstTable.setColumnWidth_2 0, 70
xlsFirstTable.setColumnWidth_2 1, 100
xlsFirstTable.setColumnWidth_2 2, 70
xlsFirstTable.setColumnWidth_2 3, 100
xlsFirstTable.setColumnWidth_2 4, 70

' Add header on center section (7)
Set xlsFirstTab = workbook.easy_getSheetAt(0)
xlsFirstTab.easy_getHeaderAt_2(HEADER_POSITION_CENTER).InsertSingleUnderline()
xlsFirstTab.easy_getHeaderAt_2(HEADER_POSITION_CENTER).InsertFile()
xlsFirstTab.easy_getHeaderAt_2(HEADER_POSITION_CENTER).InsertValue(" - How to create header and footer")

' Add header on right section
xlsFirstTab.easy_getHeaderAt_2(HEADER_POSITION_RIGHT).InsertDate()
xlsFirstTab.easy_getHeaderAt_2(HEADER_POSITION_RIGHT).InsertValue(" ")
xlsFirstTab.easy_getHeaderAt_2(HEADER_POSITION_RIGHT).InsertTime()

' Add footer on center section
xlsFirstTab.easy_getFooterAt_2(FOOTER_POSITION_CENTER).InsertPage()
xlsFirstTab.easy_getFooterAt_2(FOOTER_POSITION_CENTER).InsertValue(" of ")
xlsFirstTab.easy_getFooterAt_2(FOOTER_POSITION_CENTER).InsertPages()

' Export Excel file
WScript.StdOut.WriteLine("Writing file C:\Samples\Tutorial08.xlsx")
workbook.easy_WriteXLSXFile ("C:\Samples\Tutorial08.xlsx")

' Confirm export of Excel file
Dim sError
sError = workbook.easy_getError()
If sError = "" Then
    WScript.StdOut.Write(vbcrlf & "File successfully created.")
Else
    WScript.StdOut.Write(vbcrlf & "Error: " & sError)
End If

' Dispose memory
workbook.Dispose

Wscript.StdOut.Write(vbcrlf & "Press Enter to exit ...")
WScript.StdIn.ReadLine()

How to run VBScript tutorial
In order to run the tutorial create a file named Tutorial08.vbs containing previous code, open Command Prompt, change the directory to tutorial location using cd command and type:
>    cscript Tutorial08.vbs.

Overloaded methods
For methods with same name but different parameters, only the first method overload retains the original name. Subsequent overloads are uniquely renamed by appending to the method name '_2', '_3', etc (method, method_2, method_3), an integer that corresponds to the order of declaration that can be found in EasyXLS.h, a file that comes with EasyXLS installation.

EasyXLS Excel components:

.NET
Excel Library for VBScript
full COM+ version to import, export or convert Excel files
Excel Writer for VBScript
COM+ version to create and export Excel files
Download EasyXLS™ Excel Component for VBScript

File formats:

MS Excel 97 - 2003
MS Excel 2007 - 2010
MS Excel 2013
MS Excel 2016
MS Excel 2019
XLSX XLSM XLSB XLS
XML HTML CSV TXT