Поделиться через


Factory.CreateSmartTag Method

Creates a SmartTag object that represents a smart tag on a document.

Namespace:  Microsoft.Office.Tools.Word
Assembly:  Microsoft.Office.Tools.Word (in Microsoft.Office.Tools.Word.dll)

Syntax

'Declaration
Function CreateSmartTag ( _
    smartTagType As String, _
    caption As String, _
    extension As ISmartTagExtension _
) As SmartTag
SmartTag CreateSmartTag(
    string smartTagType,
    string caption,
    ISmartTagExtension extension
)

Parameters

  • smartTagType
    Type: System.String
    A unique identifier for the smart tag, composed of a namespace URI and a tag type name separated by a number sign (#).
  • caption
    Type: System.String
    The name of the smart tag, which is displayed on the smart tag menu.

Return Value

Type: Microsoft.Office.Tools.Word.SmartTag
The new smart tag.

Exceptions

Exception Condition
ArgumentException

smartTagType or caption is either nulla null reference (Nothing in Visual Basic) or empty, or smartTagType is not valid.

Remarks

An example of a valid string for the smartTagType parameter is http://smarttags.contoso.com#TagName. A well-formed smart tag type string does not contain white space, and it starts with a letter (a-z, A-Z), an underscore (_) or a colon (:).

For more information about smart tags, see Smart Tags Overview and Smart Tags Architecture.

Important

Smart tags are deprecated in Excel 2010 and Word 2010. You can still use the related APIs, but there is no smart tag functionality after Excel 2007 and Word 2007.

Examples

The following code example demonstrates how to create a smart tag and an action in a Word document project. To use this example, run the code from the ThisDocument class.

Dim simpleSmartTag As Microsoft.Office.Tools.Word.SmartTag =
    Globals.Factory.CreateSmartTag(
        "www.microsoft.com/Demo#DemoSmartTag",
        "Test Smart Tag")
Dim simpleAction As Microsoft.Office.Tools.Word.Action =
    Globals.Factory.CreateAction("Test Action")

simpleSmartTag.Terms.Add("blue")
simpleSmartTag.Actions = New Microsoft.Office.Tools.Word.Action() { _
    simpleAction}
Me.VstoSmartTags.Add(simpleSmartTag)
Microsoft.Office.Tools.Word.SmartTag simpleSmartTag =
    Globals.Factory.CreateSmartTag(
    "www.microsoft.com/Demo#DemoSmartTag",
    "Test Smart Tag");
Microsoft.Office.Tools.Word.Action simpleAction =
    Globals.Factory.CreateAction("Test Action");

simpleSmartTag.Terms.Add("blue");
simpleSmartTag.Actions = new Microsoft.Office.Tools.Word.Action[] { 
    simpleAction };
this.VstoSmartTags.Add(simpleSmartTag);

.NET Framework Security

See Also

Reference

Factory Interface

Microsoft.Office.Tools.Word Namespace