XLSior's API

All XLSior's features can be accessed programatically in VBA. The procedures are listed below. Their descriptions are also available through the Object Browser in the usual way. To use them in your own project, you should add XLSior to its references.

Preferences

Procedure	Menu command	Description
Public Sub XlsShowPreferences([wb As Workbook])	XLSior > Preferences...	Shows the preferences screen for workbook wb. If no workbook is specified, the active workbook is used.

Testing

Procedure	Menu command	Description
Public Sub XlsRunTests([wb As Workbook])	XLSior > Test > Run tests	Runs the tests in workbook wb. If no workbook is specified, the active workbook is used.
Public Sub XlsAddTestSet([ws As Worksheet])	XLSior > Test > Add test set	Adds a test set to worksheet ws. If no worksheet is specified, the active sheet is used. If the active sheet is not a test sheet (one whose name begins with X~Test) no test set will be added.
Public Sub XlsAddTestSheet([wb As Workbook])	XLSior > Test > Add test sheet	Adds a test sheet to workbook wb. If no workbook is specified, the active workbook is used.

Automated Documentation

Procedure	Menu command	Description
Public Sub XlsUpdateLists([wb As Workbook])	XLSior > AutoDocument > Update Lists	Updates the existing Autodocumentation sheets for workbook wb. If no workbook is specified, the active workbook is used.
Public Sub XlsListSheets([wb As Workbook])	XLSior > AutoDocument > List Sheets	Updates the list of sheets in workbook wb if the list exists, or adds it if it does not. If no workbook is specified, the active workbook is used.
Public Sub XlsListNames([wb As Workbook])	XLSior > AutoDocument > List Names	Updates the list of Names in workbook wb if the list exists, or adds it if it does not. If no workbook is specified, the active workbook is used.
Public Sub XlsListComments([wb As Workbook])	XLSior > AutoDocument > List cell Comments	Updates the list of cell comments in workbook wb if the list exists, or adds it if it does not. If no workbook is specified, the active workbook is used.
Public Sub XlsListLinks([wb As Workbook])	XLSior > AutoDocument > List external Links	Updates the list of external links in workbook wb if the list exists, or adds it if it does not. If no workbook is specified, the active workbook is used.
Public Sub XlsListTechniques([wb As Workbook])	XLSior > AutoDocument > List advanced Techniques	Updates the list of advanced techqniques on each worksheet in workbook wb if the list exists, or adds it if it does not. If no workbook is specified, the active workbook is used.
Public Sub XlsListAll([wb As Workbook])	XLSior > AutoDocument > List All	Updates any of Autodocumentation lists that exist in workbook wb, and adds those that do not. If no workbook is specified, the active workbook is used.
Public Sub XlsAddSummarySheet([wb As Workbook])	XLSior > AutoDocument > Add Summary sheet	Adds an Autodocumentation summary sheet to workbook wb if it does not already exist. If no workbook is specified, the active workbook is used.

Formatting

Procedure	Menu command	Description
Public Sub XlsFormatInputRange([rg As Range])	XLSior > Format > Format range as Input range	Format range rg as an input range. If no range is specified, the current selection is used.
Public Sub XlsFormatHeadingRange([rg As Range])	XLSior > Format > Format range as Heading range	Format range rg as a heading range. If no range is specified, the current selection is used.
Public Sub XlsFormatCheckRange([rg As Range])	XLSior > Format > Format range as Check range	Format range rg as a check range. If no range is specified, the current selection is used.
Public Sub XlsFormatWarningRange([rg As Range])	XLSior > Format > Format range as Warning range	Format range rg as a warning range. If no range is specified, the current selection is used.
Public Sub XlsFormatManualRange([rg As Range])	XLSior > Format > Format range as Manual range	Format range rg as a manual range. If no range is specified, the current selection is used.

Documentation

Procedure	Menu command	Description
Public Sub XlsAddNotesSheet([wb As Workbook])	XLSior > Documentation > Add Notes Sheet	Adds a notes sheet to workbook wb. If no workbook is specified, the active workbook is used.
Public Sub XlsAddCommentsBox([ws As Worksheet])	XLSior > Documentation > Add Comments box	Adds a comments box to worksheet wb. If no worksheet is specified, the active sheet is used.
Public Sub XlsFormatCommentsBox([rg As Range])	XLSior > Documentation > Format Comments box or XLSior > Format > Format Comments box	Format range rg as a comments box. If no range is specified, the current selection is used.
Public Sub XlsAddFunctionality([wb As Workbook])	XLSior > Documentation > Add XLSior functionality	Adds XLSior functionality to workbook wb. If no workbook is specified, the active workbook is used.
Public Sub XlsAddFooter([sh As Object])	XLSior > Documentation > Add Footer	Adds the standard XLSior footer to sheet sh. If no sheet is specified, the active sheet is used.
Public Sub XlsRemoveFooter([sh As Object])	XLSior > Documentation > Remove Footer	Removes the footer from sheet sh. If no sheet is specified, the active sheet is used.
Public Sub XlsUpdateTimestamps([wb As Workbook])	XLSior > Documentation > Update All timestamps	Updates all the timestamps in workbook wb. If no workbook is specified, the active workbook is used.
Public Sub XlsUpdateTimestamp([sh As Worksheet])	XLSior > Documentation > Update timestamp on This sheet	Updates the timestamp (if one exists) on worksheet sh. If no worksheet is specified, the active worksheet is used.
Public Sub XlsAddTimestampName([rg As Range])	XLSior > Documentation > Set timestamp Range or XLSior > Format > Set timestamp Range	Sets up the top left cell in range rg as a timestamp. If no range is specified, the current selection is used.

Operating on sheets

Procedure	Menu command	Description
Public Sub XlsProtectSheets([wb As Workbook])	XLSior > Operate on Sheets > Protect Sheets...	Shows the screen for protecting and unprotecting sheets in workbook wb. If no workbook is specified, the active workbook is used.
Public Sub XlsHideSheets([wb As Workbook])	XLSior > Operate on Sheets > Hide Sheets...	Shows the screen for hiding and unhiding sheets in workbook wb. If no workbook is specified, the active workbook is used.
Public Sub XlsHideSheets([wb As Workbook])	XLSior > Operate on Sheets > ReOrder Sheets...	Shows the screen for choosing the order in which the sheets in workbook wb should appear. If no workbook is specified, the active workbook is used.

Saving versions and releases

Procedure	Menu command	Description
Public Sub XlsSaveVersion([wb As Workbook])	XLSior > Save > Save Version	Saves a version of workbook wb. If no workbook is specified, the active workbook is used.
Public Sub XlsSaveRelease([wb As Workbook])	XLSior > Save > Save Release	Saves a release of workbook wb. If no workbook is specified, the active workbook is used.

Automated importing

Procedure	Menu command	Description
Public Sub XlsAddImportSheet([wb As Workbook])	XLSior > Import > Add Import Sheet	Adds a new import sheet to workbook wb. If no workbook is specified, the active workbook is used.
Public Sub XlsAddImportSheets([wb As Workbook], [SheetCount as Integer])	XLSior > Import > Add Import Sheets	Adds new import sheets to workbook wb. If no workbook is specified, the active workbook is used. If SheetCount is not specified, the user is asked to specify the number of sheets interactively.
Public Sub XlsImportAllSheets([wb As Workbook])	XLSior > Import > Update all Import Sheets	Updates all import sheets in workbook wb. If no workbook is specified, the active workbook is used.
Public Sub XlsImportThisSheet([ws As Worksheet])	XLSior > Import > Update this Import Sheet	Updates import sheet ws. If no worksheet is specified, the active sheet is used.

Help

Procedure	Menu command	Description
Public Sub XlsShowHelp()	XLSior > Help	Shows the XLSior online help.
Public Sub XlsShowAbout()	XLSior > About XLSior	Shows the XLSior about screen.