SmartTagBase.Actions Property (2007 System)

  • Article

Gets or sets an array of actions that are exposed by the smart tag.

Namespace:  Microsoft.Office.Tools
Assembly:  Microsoft.Office.Tools.Common.v9.0 (in Microsoft.Office.Tools.Common.v9.0.dll)

Syntax

'Declaration
Public Property Actions As ActionBase()

'Usage
Dim instance As SmartTagBase 
Dim value As ActionBase()

value = instance.Actions

instance.Actions = value

public ActionBase[] Actions { get; set; }

public:
property array<ActionBase^>^ Actions {
    array<ActionBase^>^ get ();
    void set (array<ActionBase^>^ value);
}

public function get Actions () : ActionBase[]
public function set Actions (value : ActionBase[])

Property Value

Type: array<Microsoft.Office.Tools.ActionBase[]
An array of actions that are exposed by the smart tag.

Exceptions

Exception Condition
InvalidOperationException

This property is set after the smart tag was added to a SmartTagCollection.

Remarks

The size of the array must be predetermined, because dynamically adding actions to the smart tag would cause all the smart tags in the document to reload.

Examples

The following code example creates a Microsoft.Office.Tools.Excel.SmartTag and then adds an action to the Actions property. This code example is part of a larger example provided for the Microsoft.Office.Tools.Excel.Action class.

This example is for a document-level customization.

WithEvents displayAddress As Microsoft.Office.Tools.Excel.Action

Private Sub AddSmartTag()
    Dim smartTagDemo As New  _
        Microsoft.Office.Tools.Excel.SmartTag( _
        "www.microsoft.com/Demo#DemoSmartTag", _
        "Demonstration Smart Tag")

    ' Specify a term and an expression to recognize.
    smartTagDemo.Terms.Add("sale")
    smartTagDemo.Expressions.Add( _
        New System.Text.RegularExpressions.Regex( _
        "[I|i]ssue\s\d{5,6}"))

    ' Create the action.
    displayAddress = New Microsoft.Office.Tools.Excel.Action( _
        "To be replaced")

    ' Add the action to the smart tag.
    smartTagDemo.Actions = New Microsoft.Office.Tools.Excel.Action() { _
            displayAddress}

    ' Add the smart tag. 
    Me.VstoSmartTags.Add(smartTagDemo)
End Sub

private Microsoft.Office.Tools.Excel.Action displayAddress;

private void AddSmartTag()
{
    Microsoft.Office.Tools.Excel.SmartTag smartTagDemo =
        new Microsoft.Office.Tools.Excel.SmartTag(
        "www.microsoft.com/Demo#DemoSmartTag",
        "Demonstration Smart Tag");

    // Specify a term and an expression to recognize.
    smartTagDemo.Terms.Add("sale");
    smartTagDemo.Expressions.Add(
        new System.Text.RegularExpressions.Regex(
        @"[I|i]ssue\s\d{5,6}"));

    // Create the action.
    displayAddress = new Microsoft.Office.Tools.Excel.Action(
        "To be replaced");

    // Add the action to the smart tag.
    smartTagDemo.Actions = new Microsoft.Office.Tools.Excel.Action[] { 
        displayAddress };

    // Add the smart tag. 
    this.VstoSmartTags.Add(smartTagDemo);

    displayAddress.BeforeCaptionShow += new 
        Microsoft.Office.Tools.Excel.BeforeCaptionShowEventHandler(
        DisplayAddress_BeforeCaptionShow);

    displayAddress.Click += new 
        Microsoft.Office.Tools.Excel.ActionClickEventHandler(
        DisplayAddress_Click);
}

.NET Framework Security

See Also

Reference

SmartTagBase Class

SmartTagBase Members

Microsoft.Office.Tools Namespace