VSTO開發指南（VB版）第二章 Office解決方案介紹

時間 2020-02-10

標籤 vsto 開發指南第二 office 解決方案介紹欄目 Visual Basic 简体版

原文原文鏈接

實例2.1 經過控制檯實現對Excel的自動化處理書本第32頁數組

注：添加兩個引用：框架

第一個：程序集—框架—「System.Windows.Forms 4.0.0.0」
第二個：程序集—擴展—「Microsoft.Office.Interop.Excel 14.0.0.0」dom

程序清單2.1經過控制檯程序對Excel自動化處理ui

Imports Excel = Microsoft.Office.Interop.Excel

Module Module1

  Private exitXL As Boolean = False
  Dim WithEvents myExcelApp As Excel.Application

  Sub Main()

    myExcelApp = New Excel.Application
    myExcelApp.Visible = True
    myExcelApp.StatusBar = "Hello World"
    myExcelApp.Workbooks.Add()

    While exitXL = False
      System.Windows.Forms.Application.DoEvents()
    End While

  End Sub

  Private Sub myExcelApp_SheetBeforeDoubleClick(ByVal sheet _
    As Object, ByVal target As Excel.Range, ByRef cancel _
    As Boolean) Handles myExcelApp.SheetBeforeDoubleClick

    exitXL = True

  End Sub

End Module

實例代碼：this

Imports Excel = Microsoft.Office.Interop.Excel
Module Module1

    Private exitXL As Boolean = False
    Dim WithEvents myExcelApp As Excel.Application '有這句需添加引用「Microsoft.Office.Interop.Excel 14.0.0.0」
    Sub Main()
        myExcelApp = New Excel.Application
        myExcelApp.Visible = True
        myExcelApp.StatusBar = "Hello World"
        myExcelApp.Workbooks.Add()
        While exitXL = False
            System.Windows.Forms.Application.DoEvents() '有這句需添加引用「System.Windows.Forms 4.0.0.0」
        End While
    End Sub

    Private Sub myExcelApp_SheetBeforeDoubleClick(ByVal sheet _
      As Object, ByVal target As Excel.Range, ByRef cancel _
      As Boolean) Handles myExcelApp.SheetBeforeDoubleClick
        exitXL = True
    End Sub
End Module
'**************************************************************************
'*雙擊單元格Office控制權會轉回到自動化程序事件處理中，
'*若沒有System.Windows.Forms.Application.DoEvents()，控制檯窗口將自動關閉，
'*System.Windows.Forms.Application.DoEvents()方法能夠使窗體處理其餘事件，
'*因此窗體可以進行重繪。不至於出現假死現象。
'**************************************************************************

實例效果：編碼

實例2.2 wiki文本表示形式書本第33頁spa

程序清單2.2 表2.1的wiki文本表示形式code

||Property or Method||Name||Return Type||
||Property||Application||Application||
||Property||Autoload||Boolean||
||Property||Compiled||Boolean||
||Property||Creator||Int32||
||Method||Delete||Void||
||Property||Index||Int32||
||Property||Installed||Boolean||
||Property||Name||String||
||Property||Parent||Object||
||Property||Path||String||

實例2.3 將文本文件中的wiki形式的文本以表格的形式輸出到Word中書本37頁orm

程序清單2.3 完整的WordWiki實現對象

Imports System.Collections.Generic
Imports System.Text
Imports System.IO
Imports Office = Microsoft.Office.Core
Imports Word = Microsoft.Office.Interop.Word

Module Module1
  Sub Main(ByVal args As String())

    Dim theApplication As New Word.Application
    theApplication.Visible = True
    Dim theDocument As Word.Document
    theDocument = theApplication.Documents.Add()

    Dim reader As TextReader
    reader = New System.IO.StreamReader(args(0))

    Dim separators(1) As String
    separators(0) = "||"
    Dim rowCount As Integer = 0
    Dim columnCount As Integer = 0

    ' Read rows and calculate number of rows and columns
    Dim rowList As New System.Collections.Generic.List(Of String)
    Dim row As String = reader.ReadLine()
    While row IsNot Nothing
      rowCount += 1
      rowList.Add(row)

      ' If this is the first row,
      ' calculate the number of columns
      If rowCount = 1 Then
        Dim splitHeaderRow As String() = _
          row.Split(separators, StringSplitOptions.None)

        ' Ignore the first and last separator
        columnCount = splitHeaderRow.Length - 2
      End If

      row = reader.ReadLine()
    End While

    ' Create a table
    Dim range As Word.Range = theDocument.Range()
    Dim table As Word.Table = range.Tables.Add(range, _
      rowCount, columnCount)

    ' Populate table
    Dim columnIndex As Integer = 1
    Dim rowIndex As Integer = 1

    For Each r As String In rowList
      Dim splitRow As String() = r.Split(separators, _
        StringSplitOptions.None)

      For columnIndex = 1 To columnCount
        Dim cell As Word.Cell = table.Cell(rowIndex, columnIndex)
        cell.Range.Text = splitRow(columnIndex)
      Next
      rowIndex += 1
    Next

    ' Format table
    table.Rows(1).Range.Bold = 1
    table.AutoFitBehavior( _
      Word.WdAutoFitBehavior.wdAutoFitContent)

    ' Wait for input from the command line before exiting
    System.Console.WriteLine("Table complete.")
    System.Console.ReadLine()

    ' Quit without saving changes
    theApplication.Quit(False)
  End Sub
End Module

實例代碼：

Imports System.Collections.Generic '默認
Imports System.Text  '默認
Imports System.IO '默認
Imports Office = Microsoft.Office.Core '添加引用「Microsoft Office 14.0 Object Library 2.5
Imports Word = Microsoft.Office.Interop.Word '添加引用"Microsoft.Office.Interop.word 14.0.0.0"

Module Module1
    Sub Main(ByVal args As String())

        Dim theApplication As New Word.Application '定義word程序
        theApplication.Visible = True '使word程序可視
        Dim theDocument As Word.Document '定義word文檔
        theDocument = theApplication.Documents.Add() '爲程序添加word文檔

        Dim reader As TextReader  '定義Txt文本讀取器
        reader = New System.IO.StreamReader(My.Application.Info.DirectoryPath & "/test.txt") '實例化讀取文本接口,My.Application.Info.DirectoryPath指的是本程序的\bin\Debug目錄

        Dim separators(1) As String  '定義分隔符字符串
        separators(0) = "||"  '爲分隔符變量賦值
        Dim rowCount As Integer = 0     '定義行數
        Dim columnCount As Integer = 0  '定義列數

        ' 讀取行並計算行數和列數
        Dim rowList As New System.Collections.Generic.List(Of String) '定義字符串型的列表集對象
        Dim row As String = reader.ReadLine() '讀取文本存儲器中的一行
        While row IsNot Nothing  '讀取行沒有到結尾
            rowCount += 1        '讀取下一行
            rowList.Add(row)    '將所讀取的一行文本存儲在列表集對象中

            ' 若是這是第一行，就計算列數
            If rowCount = 1 Then
                Dim splitHeaderRow As String() = row.Split(separators, StringSplitOptions.None) 'StringSplitOptions.None，就是分開的數組元素包括空元素
                columnCount = splitHeaderRow.Length - 2   ' 忽略第一和最後一個分隔符，因爲第一個和最後一個沒有起到分隔做用，因此5個元素減去2個分隔符元素就是所需的列數3，
            End If
            row = reader.ReadLine()'自帶逐行讀取的功能 End While

        ' 在word中建立一個表
        Dim range As Word.Range = theDocument.Range() '定義文檔單元格
        Dim table As Word.Table = range.Tables.Add(range, rowCount, columnCount) '建立一個rowCount行columnCount列的表格

        ' 操做word中所建立的表
        Dim columnIndex As Integer = 1
        Dim rowIndex As Integer = 1

        For Each r As String In rowList
            Dim splitRow As String() = r.Split(separators, StringSplitOptions.None)  'StringSplitOptions.None，就是分開的數組元素包括空元素
            For columnIndex = 1 To columnCount
                Dim cell As Word.Cell = table.Cell(rowIndex, columnIndex) '\bin\Debug目錄中test.txt文件中的結尾不能有多餘的空行，否則會提示超出索引範圍而出現錯誤
                cell.Range.Text = splitRow(columnIndex)
            Next
            rowIndex += 1
        Next

        ' 格式化表格
        table.Rows(1).Range.Bold = 1
        table.AutoFitBehavior(Word.WdAutoFitBehavior.wdAutoFitContent) 'AutoFitBehavior()方法的做用就是以某種方法調整表格，ord.WdAutoFitBehavior.wdAutoFitContent表示表格根據內容來調節

        ' 退出前等待命令輸入
        System.Console.WriteLine("Table complete.")
        System.Console.ReadLine()

        ' 沒有保存更改而退出
        theApplication.Quit(False)
    End Sub
End Module

test.txt文檔中的內容

||Property or Method||Name||Return Type||
||Property||Application||Application||
||Property||Autoload||Boolean||
||Property||Compiled||Boolean||
||Property||Creator||Int32||
||Method||Delete||Void||
||Property||Index||Int32||
||Property||Installed||Boolean||
||Property||Name||String||
||Property||Parent||Object||
||Property||Path||String||

實例效果：

續：對實例2.3逐步詳細解讀

首先，總的功能就是在讀取文本文檔中的內容並在新建立word中顯示出來

Imports Word = Microsoft.Office.Interop.Word '添加引用"Microsoft.Office.Interop.word 14.0.0.0"

Module Module1
    Sub Main(ByVal args As String())
        Dim App As Word.Application = New Word.Application '建立Word實例程序    *
        Dim myWord As Word.Document = App.Documents.Add()  '建立word文檔       *
        Dim range As Word.Range = myWord.Range() '建立一個存放內容的區域         *
        App.Visible = True '顯示Word程序                                       *

        Dim reader As New System.IO.StreamReader("D:/test.txt") '讀取文本文檔，注：文本文檔不能爲編碼文檔，否則讀過來是亂碼！！
        Dim str As String = reader.ReadLine() '讀取文本文檔中的一行，若要讀取所有reader.ReadToEnd(),從當前位置讀到結尾，
        '若真正將每行讀取，最好使用System.Collections.Generic集合的概念將每行讀取到集合中，用for each遍歷便可

        range.Text = str   '將文本文檔中的內容賦值給Word中
    End Sub
End Module

續2：將文本文檔中的內容讀取，存入集合中

Imports Word = Microsoft.Office.Interop.Word '添加引用"Microsoft.Office.Interop.word 14.0.0.0"

Module Module1
    Sub Main(ByVal args As String())
        Dim App As Word.Application = New Word.Application '建立Word實例程序  *
        Dim myWord As Word.Document = App.Documents.Add()  '建立word文檔      *
        App.Visible = True '顯示Word程序                                      *
        Dim reader As New System.IO.StreamReader("D:/test.txt") '讀取文本文檔，注：文本文檔不能爲編碼文檔，否則讀過來是亂碼！！

        Dim rowList As New System.Collections.Generic.List(Of String) '定義字符串型的列表集對象
        Dim row As String = reader.ReadLine() '讀取文本存儲器中的一行
        While row IsNot Nothing  '讀取行沒有到結尾
            rowList.Add(row)    '將所讀取的一行文本存儲在列表集對象中
            row = reader.ReadLine() '自帶逐行讀取的功能
        End While

        Dim range As Word.Range = myWord.Range() '定義文檔單元格
        Dim table As Word.Table = range.Tables.Add(range, 11, 1) '建立一個11行1列的表格,硬編碼更易理解
        Dim rowIndex As Integer = 1
        For Each r As String In rowList
            Dim cell As Word.Cell = table.Cell(rowIndex, 1) '目錄中test.txt文件中的結尾不能有多餘的空行，否則會提示超出索引範圍而出現錯誤
            cell.Range.Text = r
            rowIndex += 1
        Next

    End Sub
End Module

續3：將內容倒着讀取出來

Imports Word = Microsoft.Office.Interop.Word '添加引用"Microsoft.Office.Interop.word 14.0.0.0"

Module Module1
    Sub Main(ByVal args As String())
        Dim App As Word.Application = New Word.Application '建立Word實例程序  *
        Dim myWord As Word.Document = App.Documents.Add()  '建立word文檔      *
        App.Visible = True '顯示Word程序                                      *
        Dim reader As New System.IO.StreamReader("D:/test.txt") '讀取文本文檔，注：文本文檔不能爲編碼文檔，否則讀過來是亂碼！！

        Dim rowList As New System.Collections.Generic.List(Of String) '定義字符串型的列表集對象
        Dim row As String = reader.ReadLine() '讀取文本存儲器中的一行
        While row IsNot Nothing  '讀取行沒有到結尾
            rowList.Add(row)    '將所讀取的一行文本存儲在列表集對象中
            row = reader.ReadLine() '自帶逐行讀取的功能
        End While

        Dim range As Word.Range = myWord.Range() '定義文檔單元格
        Dim rowIndex As Integer = 1
        For Each r As String In rowList
            range = myWord.Range(0, 0)  'range方法的第一個參數是開頭，第二個參數是結尾，這裏指第幾段，插入值，插入的值是倒着排列的
            range.Text = r & Chr(10) ' 注：chr(10) & chr(13)中，chr(10) 換行符，而 chr(13)回車，那麼chr(10) & chr(13)就是既換行了又回車了
            rowIndex = rowIndex + 1
        Next
    End Sub

續4：myWord.Paragraphs.Add().Range()

Imports Word = Microsoft.Office.Interop.Word '添加引用"Microsoft.Office.Interop.word 14.0.0.0"

Module Module1
    Sub Main(ByVal args As String())
        Dim App As Word.Application = New Word.Application '建立Word實例程序  *
        Dim myWord As Word.Document = App.Documents.Add()  '建立word文檔      *
        App.Visible = True '顯示Word程序                                      *
        Dim reader As New System.IO.StreamReader("D:/test.txt") '讀取文本文檔，注：文本文檔不能爲編碼文檔，否則讀過來是亂碼！！

        Dim rowList As New System.Collections.Generic.List(Of String) '定義字符串型的列表集對象
        Dim row As String = reader.ReadLine() '讀取文本存儲器中的一行
        While row IsNot Nothing  '讀取行沒有到結尾
            rowList.Add(row)    '將所讀取的一行文本存儲在列表集對象中
            row = reader.ReadLine() '自帶逐行讀取的功能
        End While

        Dim range As Word.Range = myWord.Paragraphs.Add().Range() '定義文檔單元格
        Dim rowIndex As Integer = 1
        For Each r As String In rowList
            range = myWord.Paragraphs(rowIndex).Range()
            range.Text = r & Chr(10) ' 注：chr(10) & chr(13)中，chr(10) 換行符，而 chr(13)回車，那麼chr(10) & chr(13)就是既換行了又回車了
            rowIndex = rowIndex + 1
        Next
    End Sub

實例2.4 Outlook外接程序書本第40頁

程序清單2.4 Outlook外接程序項目中ThisApplication類的初始化代碼

Public Class ThisApplication

  Private Sub ThisApplication_Startup(ByVal sender As Object, _
    ByVal e As System.EventArgs) Handles Me.Startup

  End Sub

  Private Sub ThisApplication_Shutdown(ByVal sender As Object, _
    ByVal e As System.EventArgs) Handles Me.Shutdown

  End Sub

End Class

實例代碼：

Public Class ThisAddIn

    Private Sub ThisAddIn_Startup() Handles Me.Startup

    End Sub

    Private Sub ThisAddIn_Shutdown() Handles Me.Shutdown

    End Sub

End Class

實例2.5 VSTO Outlook 外接程序書本41頁

注：添加引用」System.Windows.Forms」

程序清單2.5 VSTO Outlook 外接程序，用於處理Item事件和檢查收件人數是否超過25

Imports Outlook = Microsoft.Office.Interop.Outlook

Public Class ThisApplication
  Private Sub ThisApplication_ItemSend(ByVal item As Object, _
    ByRef cancel As Boolean) Handles Me.ItemSend

    Dim myItem As Outlook.MailItem

    If TypeOf item Is Outlook.MailItem Then
      myItem = CType(item, Outlook.MailItem)
      For Each recip As Outlook.Recipient In myItem.Recipients
        If recip.AddressEntry.Members.Count > 25 Then
          ' Ask the user if she really wants to send this e-mail
          Dim message As String
          message = "Send mail to {0} with {1} people?"
          Dim caption As String = "More than 25 recipients"
          Dim buttons As MessageBoxButtons
          buttons = MessageBoxButtons.YesNo
          Dim result As DialogResult

          result = MessageBox.Show(String.Format(message, _
            recip.AddressEntry.Name, _
            recip.AddressEntry.Members.Count), _
            caption, buttons)

          If result = DialogResult.No Then
            cancel = True
            Exit For
          End If
        End If
      Next
    End If

  End Sub
End Class

實例2.6 VSTO Excel工做簿自定義機制書本42頁

程序清單 2.6 VSTO Excel工做簿自定義機制

Imports Excel = Microsoft.Office.Interop.Excel
Imports Office = Microsoft.Office.Core

Public Class Sheet1
  Private Sub Sheet1_Startup(ByVal sender As Object, _
      ByVal e As System.EventArgs) Handles Me.Startup

    ' Initial entry point.
    ' This code gets run first when the code behind is created
    ' The context is implicit in the Sheet1 class
    MsgBox("Code behind the document running.")
    MsgBox(String.Format("{0} is the sheet name.", Me.Name))

  End Sub

End Class

實例代碼：

Imports Excel = Microsoft.Office.Interop.Excel
Imports Office = Microsoft.Office.Core
Public Class Sheet1
    Private Sub Sheet1_Startup(ByVal sender As Object, _
        ByVal e As System.EventArgs) Handles Me.Startup
        ' 初始化入口點
        ' 建立文檔代碼時將首次執行此代碼
        ' 這裏的上下環境是sheet1
        MsgBox("Code behind the document running.")
        MsgBox(String.Format("{0} is the sheet name.", Me.Name))

    End Sub
End Class

實例效果：

實例2.7 VSTO自定義機制：在文檔操做任務面板中添加按鈕控件以及將ListObject控件與DataTable進行數據綁定書本46頁

程序清單 2.7 VSTO自定義機制：在文檔操做任務面板中添加按鈕控件以及將ListObject控件與DataTable進行數據綁定

Imports Excel = Microsoft.Office.Interop.Excel
Imports Office = Microsoft.Office.Core

Public Class Sheet1
  Private WithEvents myButton As New Button
  Private table As DataTable

  Private Sub Sheet1_Startup(ByVal sender As Object, _
      ByVal e As System.EventArgs) Handles Me.Startup

    myButton.Text = "Databind!"
    Globals.ThisWorkbook.ActionsPane.Controls.Add(myButton)

  End Sub

  Private Sub myButton_Click(ByVal sender As Object, _
    ByVal e As EventArgs) Handles myButton.Click

    List1.DataSource = Nothing
    table = New DataTable
    Dim r As New Random

    For i As Integer = 0 To 3
      table.Columns.Add("Col" & i.ToString())
    Next

    For j As Integer = 0 To 19
      table.Rows.Add(r.NextDouble(), r.NextDouble(), _
        r.NextDouble(), r.NextDouble())
    Next

    List1.DataSource = table

  End Sub
End Class

實例代碼：

Imports Excel = Microsoft.Office.Interop.Excel
Imports Office = Microsoft.Office.Core

Public Class Sheet1
    Private WithEvents myButton As New Button 'WithEvents的意思是告知VB編譯器這是一個能夠觸發事件對象 Private table As DataTable   'DataTable是Excel對象的 Private Sub Sheet1_Startup(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Startup
        myButton.Text = "Databind!"
        Globals.ThisWorkbook.ActionsPane.Controls.Add(myButton)'Actionspane.Controls表示右側的文檔操做面板 End Sub

    Private Sub myButton_Click(ByVal sender As Object, ByVal e As EventArgs) Handles myButton.Click
        List1.DataSource = Nothing  '設置數據源爲空
        table = New DataTable   '定義數據表用關鍵字new，實質就是一個實例對象    
        Dim r As New Random   '定義隨機數用new關鍵字，實質就是一實例對象 For i As Integer = 0 To 3
            table.Columns.Add("Col" & i.ToString())
        Next
        For j As Integer = 0 To 19
            table.Rows.Add(r.NextDouble(), r.NextDouble(), r.NextDouble(), r.NextDouble())'NextDouble大於或等於 0且小於 1 的隨機浮點數 Next
        List1.DataSource = table
    End Sub
End Class

代碼另外一種寫法：

Imports Excel = Microsoft.Office.Interop.Excel
Imports Office = Microsoft.Office.Core

Public Class Sheet1
    Private WithEvents myButton As New Button
    Private table As DataTable = New DataTable
    Dim r As New Random

    Private Sub Sheet1_Startup(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Startup
        myButton.Text = "Databind!"
        Globals.ThisWorkbook.ActionsPane.Controls.Add(myButton)
    End Sub

    Private Sub myButton_Click(ByVal sender As Object, ByVal e As EventArgs) Handles myButton.Click
        List1.DataSource = Nothing
        table.Columns.Add() : table.Columns.Add() : table.Columns.Add() : table.Columns.Add() '添加4列,冒號接續
        For j As Integer = 0 To 19
            table.Rows.Add(r.NextDouble(), r.NextDouble(), r.NextDouble(), r.NextDouble()) '生成19行4列的數據
        Next
        List1.DataSource = table '將table中的值做爲數據源