This documentation is archived and is not being maintained.

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)

SmartTag CreateSmartTag(
	string smartTagType,
	string caption,
	ISmartTagExtension extension


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 (#).
Type: System.String
The name of the smart tag, which is displayed on the smart tag menu.
Type: Microsoft.Office.Tools.Word.ISmartTagExtension
Optional. An extension object that defines a custom recognizer for the smart tag.

Return Value

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


smartTagType or caption is either null or empty, or smartTagType is not valid.

An example of a valid string for the smartTagType parameter is 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 noteImportant

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.

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.

Microsoft.Office.Tools.Word.SmartTag simpleSmartTag =
    "Test Smart Tag");
Microsoft.Office.Tools.Word.Action simpleAction =
    Globals.Factory.CreateAction("Test Action");

simpleSmartTag.Actions = new Microsoft.Office.Tools.Word.Action[] { 
    simpleAction };