VBA Methods

The IAddInUtilities interface defines properties and functions implemented by the SaveToDB add-in.

You can use these methods with VBA macros and VSTO add-ins.

<ComVisible(True), Guid("CF0170F1-310E-421F-87DF-C177753EEDD5")>
Public Interface IAddInUtilities

    ' Last Error Message

    ReadOnly Property LastResultMessage As String

    ' 8.16 Version

    ReadOnly Property Version As String

    ' Options

    ReadOnly Property Options As IAddInOptions

    ' Ribbon

    Property FullRibbon() As Boolean

    Property RibbonTabVisible(Optional Workbook As Workbook = Nothing) As Boolean

    Function ActivateTab() As Boolean

    ' Execute

    Function ExecuteNonQuery(ConnectionString As String, CommandText As String) As Boolean

    Function ExecuteReader(ConnectionString As String, CommandText As String) As <MarshalAs(UnmanagedType.BStr)> System.Array

    Function RunCmd(Command As String) As Boolean

    ' Insert ListObject

    Function InsertConnectedListObject(TargetRange As Range, ConnectionString As String, QueryObject As String, ObjectType As String) As Boolean

    ' Save

    Function Save(Optional ListObject As ListObject = Nothing) As Boolean

    Function SavePivotTable(PivotTable As PivotTable) As Boolean

    Function SaveByMerge(Optional ListObject As ListObject = Nothing) As Boolean

    Function GetSaveSQL(Optional ListObject As ListObject = Nothing) As String

    Function GetSaveByMergeSQL(Optional ListObject As ListObject = Nothing) As String

    Function SaveByMergeDirect(ListObject As ListObject, ConnectionString As String, QueryObject As String, ObjectType As String) As Boolean

    Function GetSaveByMergeDirectSQL(ListObject As ListObject, ConnectionString As String, QueryObject As String, ObjectType As String) As String

    Function SaveAllSheetTables(Optional Worksheet As Worksheet = Nothing) As Boolean

    Function SaveAllWorkbookTables(Optional Workbook As Workbook = Nothing, Optional UseWizard As Boolean = True) As Boolean

    ' Load

    Function Load(Optional ListObject As ListObject = Nothing,
        Optional ReloadMetadata As Boolean = False, Optional IgnoreChanges As Boolean = False) As Boolean

    Function LoadPivotTable(PivotTable As PivotTable,
        Optional ReloadMetadata As Boolean = False, Optional IgnoreChanges As Boolean = False) As Boolean

    Function LoadAllSheetTables(Optional Worksheet As Worksheet = Nothing,
        Optional ReloadMetadata As Boolean = False, Optional IgnoreChanges As Boolean = False) As Boolean

    Function LoadAllWorkbookTables(Optional Workbook As Workbook = Nothing,
        Optional ReloadMetadata As Boolean = False, Optional IgnoreChanges As Boolean = False, Optional UseWizard As Boolean = True) As Boolean

    Function RebuildCommandTextFromNamedCells(Optional Worksheet As Worksheet = Nothing) As Boolean

    Function ReloadQueryList(Optional ListObject As ListObject = Nothing) As Boolean

    ' 8.8 Save/Load Table Formats

    Function SaveTableFormat(Optional ListObject As ListObject = Nothing) As Boolean

    Function LoadTableFormat(Optional ListObject As ListObject = Nothing) As Boolean

    ' Connection Strings

    Property ExcelConnectionString(Optional ListObject As ListObject = Nothing) As String

    Property ConnectionString(Optional ListObject As ListObject = Nothing) As String

    Property PivotTableExcelConnectionString(Optional PivotTable As PivotTable = Nothing) As String

    Property PivotTableConnectionString(Optional PivotTable As PivotTable = Nothing) As String

    ' 8.16 ChangeAllConnectionStrings

    Function ChangeAllConnectionStrings(ConnectionString As String, Optional Workbook As Workbook = Nothing) As Boolean

    ' 8.17 ReloadAllValidationLists

    Function ReloadAllValidationLists(Optional Workbook As Workbook = Nothing) As Boolean

    ' 8.20 ReloadWorksheetValidationLists

    Function ReloadWorksheetValidationLists(Optional Worksheet As Worksheet = Nothing) As Boolean

    ' Connection String Properties

    Property ProviderName(Optional ListObject As ListObject = Nothing) As String

    Property PivotTableProviderName(Optional PivotTable As PivotTable = Nothing) As String

    ReadOnly Property ConnectionStringIntegratedSecurity(Optional ListObject As ListObject = Nothing) As Boolean

    Property ConnectionStringUserName(Optional ListObject As ListObject = Nothing) As String

    Property ConnectionStringPassword(Optional ListObject As ListObject = Nothing) As String

    ReadOnly Property PivotTableConnectionStringIntegratedSecurity(Optional PivotTable As PivotTable = Nothing) As Boolean

    Property PivotTableConnectionStringUserName(Optional PivotTable As PivotTable = Nothing) As String

    Property PivotTableConnectionStringPassword(Optional PivotTable As PivotTable = Nothing) As String

    ' Protecting Passwords and Usernames

    Function HideConnectionStringPassword(Optional ListObject As ListObject = Nothing) As Boolean

    Function HidePivotTableConnectionStringPassword(Optional PivotTable As PivotTable = Nothing) As Boolean

    Function SetConnectionStringPassword(Password As String, Optional ListObject As ListObject = Nothing) As Boolean

    Function SetPivotTableConnectionStringPassword(Password As String, Optional PivotTable As PivotTable = Nothing) As Boolean

    Function HideConnectionStringUserNameAndPassword(Optional ListObject As ListObject = Nothing) As Boolean

    Function HidePivotTableConnectionStringUserNameAndPassword(Optional PivotTable As PivotTable = Nothing) As Boolean

    Function SetConnectionStringUserNameAndPassword(UserName As String, Password As String, Optional ListObject As ListObject = Nothing, Optional ChangeIntegratedSecurity As Boolean = False) As Boolean

    Function SetPivotTableConnectionStringUserNameAndPassword(UserName As String, Password As String, Optional PivotTable As PivotTable = Nothing, Optional ChangeIntegratedSecurity As Boolean = False) As Boolean

    ' Protecting Passwords and Usernames at Worksheet and Workbook Levels

    Function HideWorksheetConnectionStringPasswords(Optional Worksheet As Worksheet = Nothing, Optional ChangeIntegratedSecurity As Boolean = False) As Boolean

    Function HideWorkbookConnectionStringPasswords(Optional Workbook As Workbook = Nothing, Optional ChangeIntegratedSecurity As Boolean = False) As Boolean

    Function HideWorksheetConnectionStringUserNamesAndPasswords(Optional Worksheet As Worksheet = Nothing, Optional ChangeIntegratedSecurity As Boolean = False) As Boolean

    Function HideWorkbookConnectionStringUserNamesAndPasswords(Optional Workbook As Workbook = Nothing, Optional ChangeIntegratedSecurity As Boolean = False) As Boolean

    Function SetWorksheetConnectionStringPasswords(Password As String, Optional Worksheet As Worksheet = Nothing) As Boolean

    Function SetWorkbookConnectionStringPasswords(Password As String, Optional Workbook As Workbook = Nothing) As Boolean

    Function SetWorksheetConnectionStringUserNamesAndPasswords(UserName As String, Password As String, Optional Worksheet As Worksheet = Nothing, Optional ChangeIntegratedSecurity As Boolean = False) As Boolean

    Function SetWorkbookConnectionStringUserNamesAndPasswords(UserName As String, Password As String, Optional Workbook As Workbook = Nothing, Optional ChangeIntegratedSecurity As Boolean = False) As Boolean

    ' Protecting Workbook Connections

    Function HideWorkbookConnectionPasswords(Optional Workbook As Workbook = Nothing) As Boolean

    Function HideWorkbookConnectionUserNamesAndPasswords(Optional Workbook As Workbook = Nothing) As Boolean

    Function SetWorkbookConnectionPasswords(Password As String, Optional Workbook As Workbook = Nothing) As Boolean

    Function SetWorkbookConnectionUserNamesAndPasswords(UserName As String, Password As String, Optional Workbook As Workbook = Nothing) As Boolean

    ' CommandText and QueryList

    Property CommandText(ListObject As ListObject) As String

    Property QueryObject(ListObject As ListObject) As String

    Property QueryList(ListObject As ListObject) As String

    Property QueryLocked(ListObject As ListObject) As Boolean

    Function GetQueryListItems(ListObject As ListObject) As <MarshalAs(UnmanagedType.BStr)> System.Array

    ' Fields and Parameters

    Function GetFields(ListObject As ListObject) As <MarshalAs(UnmanagedType.BStr)> System.Array

    Function GetParameters(ListObject As ListObject) As <MarshalAs(UnmanagedType.BStr)> System.Array

    Property IsRibbonField(ListObject As ListObject, FieldName As String) As Boolean

    Function HasParameter(ListObject As ListObject, ParameterName As String) As Boolean

    Property ParameterValue(ListObject As ListObject, ParameterName As String) As Object

    Property ParameterRibbonValue(ListObject As ListObject, ParameterName As String) As String

    ' Cursors

    Function AddTableCursor(Optional ListObject As ListObject = Nothing) As Boolean

    Function RemoveTableCursor(Optional ListObject As ListObject = Nothing) As Boolean

    Function DeleteTableCursor(Optional ListObject As ListObject = Nothing) As Boolean

    Function DeleteAllTableCursors(Optional Workbook As Workbook = Nothing) As Boolean

    Function MoveNext(Optional ListObject As ListObject = Nothing) As Boolean
    Function MoveToNext(Optional ListObject As ListObject = Nothing) As Boolean

    Function MovePrevious(Optional ListObject As ListObject = Nothing) As Boolean
    Function MoveToPrevious(Optional ListObject As ListObject = Nothing) As Boolean

    Function MoveFirst(Optional ListObject As ListObject = Nothing) As Boolean
    Function MoveToFirst(Optional ListObject As ListObject = Nothing) As Boolean

    Function MoveLast(Optional ListObject As ListObject = Nothing) As Boolean
    Function MoveToLast(Optional ListObject As ListObject = Nothing) As Boolean

    ' Form Fields

    Function AddFormFields(ListObject As ListObject, TopLeftCell As Range) As Boolean

    Function RemoveFormFields(ListObject As ListObject) As Boolean

    Function GetFormFieldCellName(ListObject As ListObject, ColumnName As String) As String

    ' Add-In Worksheets

    Function InsertAddInSheets(Optional Workbook As Workbook = Nothing) As Boolean

    Function RemoveAddInSheets(Optional Workbook As Workbook = Nothing) As Boolean

    Function DeleteAddInSheets(Optional Workbook As Workbook = Nothing) As Boolean

    Function ShowAddInSheets(Optional Workbook As Workbook = Nothing) As Boolean

    Function HideAddInSheets(Optional Workbook As Workbook = Nothing) As Boolean

    Function CleanAddInSheets(Optional Workbook As Workbook = Nothing) As Boolean

    ' Table Views

    Function ApplyTableView(ListObject As ListObject, name As String) As Boolean

    Function SaveTableView(ListObject As ListObject, name As String) As Boolean

    Function DeleteTableView(ListObject As ListObject, name As String) As Boolean

    Function DeleteTableViews(ListObject As ListObject) As Boolean

    Function DeleteAllTableViews(Workbook As Workbook) As Boolean

    Function GetTableViews(ListObject As ListObject) As <MarshalAs(UnmanagedType.BStr)> System.Array

    Function CopyAndInsertRows(Optional Range As Range = Nothing) As Boolean

    ' 8.4 Parsers

    Function GetWebText(Url As String) As String

    Function ParseJson(Json As String) As Boolean

    ' 8.6 Reports

    Function CreatePDF(Sheet As Object, Optional SheetList As String = Nothing, Optional FileName As String = Nothing) As Boolean

    Function CreateReportWorkbook(ByRef TargetWorkbook As Workbook, Sheet As Object, Optional SheetList As String = Nothing, Optional CopyFormulas As Boolean = True) As Boolean

    Function CreateReportPage(TargetSheet As Worksheet, SourceSheet As Worksheet, Optional CopyFormulas As Boolean = True) As Boolean

    ' 8.6 SaveAs

    Function SaveQueryAsCSV(ListObject As ListObject, FileName As String, CodePage As Integer, Separator As String,
                            Optional DateTimeFormat As String = Nothing, Optional DateFormat As String = Nothing,
                            Optional TimeFormat As String = Nothing, Optional QuoteChar As String = """") As Boolean

    Function SaveQueryAsHTML(ListObject As ListObject, FileName As String, CodePage As Integer) As Boolean

    Function SaveQueryAsInsert(ListObject As ListObject, FileName As String, CodePage As Integer, InsertIdentity As Boolean) As Boolean

    Function SaveTableAsCSV(ListObject As ListObject, FileName As String, CodePage As Integer, Separator As String,
                            Optional DateTimeFormat As String = Nothing, Optional DateFormat As String = Nothing,
                            Optional TimeFormat As String = Nothing, Optional QuoteChar As String = """") As Boolean

    Function SaveTableAsHTML(ListObject As ListObject, FileName As String, CodePage As Integer) As Boolean

    Function SaveTableAsInsert(ListObject As ListObject, FileName As String, CodePage As Integer, InsertIdentity As Boolean) As Boolean

    ' 8.7 md5

    Function md5(value As String) As String

    ' 8.8 Outlook

    Function AddOutlookAppointments(Range As Range) As String

    Function AddOutlookTasks(Range As Range) As String

    Function AddOutlookEmails(Range As Range) As String

    Function AddOutlookAppointment(StartTime As DateTime, EndTime As DateTime, Subject As String,
                            Optional Body As String = Nothing, Optional Attachments As String = Nothing,
                            Optional RequiredAttendees As String = Nothing,
                            Optional Location As String = Nothing, Optional AllDayEvent As Boolean = False,
                            Optional ReminderSet As Boolean = True, Optional BusyStatus As Integer = 0,
                            Optional Categories As String = Nothing) As String

    Function AddOutlookTask(StartDate As DateTime, DueDate As DateTime, Subject As String,
                            Optional Body As String = Nothing, Optional Attachments As String = Nothing,
                            Optional Recipients As String = Nothing,
                            Optional ReminderSet As Boolean = True, Optional Importance As Integer = 1, Optional Status As Integer = 0,
                            Optional Categories As String = Nothing) As String

    Function AddOutlookEmail(Subject As String,
                            Optional Body As String = Nothing, Optional Attachments As String = Nothing,
                            Optional Recipients As String = Nothing,
                            Optional SentOnBehalfOfName As String = Nothing,
                            Optional Categories As String = Nothing) As String

    ' 8.15 Application Workbooks

    Function MakeWorkbook(ConnectionString As String, WorkbookName As String, Template As String) As Boolean

End Interface