SmartTag.PersistTag メソッド () (2007 System)

[アーティクル]
08/22/2008

更新 : 2007 年 11 月

スマートタグに関する情報を格納します。

名前空間 : Microsoft.Office.Tools.Excel
アセンブリ : Microsoft.Office.Tools.Excel.v9.0 (Microsoft.Office.Tools.Excel.v9.0.dll 内)

構文

'宣言
Protected Sub PersistTag ( _
    propertyBag As ISmartTagProperties _
)
'使用
Dim propertyBag As ISmartTagProperties

Me.PersistTag(propertyBag)

protected void PersistTag(
    ISmartTagProperties propertyBag
)

パラメータ

propertyBag
型 : ISmartTagProperties

トークンのキーと値の組み合わせを格納しているプロパティバッグです。nullnull 参照 (Visual Basic では Nothing) の場合があります。

例外

例外	条件
InvalidOperationException	PersistTag が、Recognize から呼び出されませんでした。

解説

PersistTag は、認識されるタグをコミットします。スマートタグがテキスト内で見つかったことを示すには、これを Recognize メソッドから呼び出します。スマートタグ用の任意のカスタムプロパティをコミットするには、propertyBag パラメータを使用します。これらのプロパティを使用すると、スマートタグのショートカットメニューで項目の 1 つを選択した場合のアクションをカスタマイズできます。

例

Microsoft.Office.Tools.Excel.SmartTag から派生するクラス内で Recognize メソッドをオーバーライドする方法のコード例を次に示します。この Recognize の実装例では、各スマートタグ項目とセルの内容とを比較します。このコードでは、セル内でスマートタグ項目が見つかると、カスタムスマートタグプロパティを追加し、PersistTag(ISmartTagProperties) メソッドを使用してスマートタグを認識します。この例は、[参照の追加] ダイアログボックスの [COM] タブで、Microsoft Smart Tags 2.0 Type Library への参照が追加してあると仮定しています。次のコード例は、SmartTag クラス用の、より大きなコード例の一部です。

Protected Overrides Sub Recognize(ByVal text As String, _
    ByVal site As ISmartTagRecognizerSite, _
    ByVal tokenList As ISmartTagTokenList)

    ' Determine whether each smart tag term exists in 
    ' the document text.
    Dim Term As String
    For Each Term In Me.Terms

        ' Search the cell text for the first instance of 
        ' the current smart tag term.
        Dim index As Integer = Me.CellText.IndexOf(Term, 0)

        If (index >= 0) Then

            ' Create a smart tag token and a property bag for the 
            ' recognized term.
            Dim propertyBag As ISmartTagProperties = _
                site.GetNewPropertyBag()

            ' Write a new property value.
            Dim key As String = "Key1"
            propertyBag.Write(key, DateTime.Now)

            ' Attach the smart tag to the term in the document
            Me.PersistTag(propertyBag)

            ' This implementation only finds the first instance
            ' of a smart tag term in the cell. 
            Exit For
        End If
    Next
End Sub

protected override void Recognize(string text, 
    ISmartTagRecognizerSite site, ISmartTagTokenList tokenList)
{
    // Determine whether each smart tag term exists in 
    // the document text.
    foreach (string term in this.Terms)
    {
        // Search the cell text for the first instance of 
        // the current smart tag term.
        int index = this.CellText.IndexOf(term, 0);

        if (index >= 0)
        {
            // Create a smart tag token and a property bag for the 
            // recognized term.
            ISmartTagProperties propertyBag = 
                site.GetNewPropertyBag();

            // Write a new property value.                 
            string key = "Key1";
            propertyBag.Write(key, DateTime.Now.ToString());

            // Attach the smart tag to the term in the document
            this.PersistTag(propertyBag);

            // This implementation only finds the first instance
            // of a smart tag term in the cell. 
            break;
        }
    }
}