ExpansionProvider.GetExpansionFunction Method
Include Protected Members
Include Inherited Members
Returns an ExpansionFunction object based on the contents of a particular node in the XML template file for the snippet.
This member is overloaded. For complete information about this member, including syntax, usage, and examples, click a name in the overload list.
Overload List
| Name | Description | |
|---|---|---|
.gif "Public method") |
GetExpansionFunction(XmlElement, String) | Returns an IVsExpansionFunction object representing the expansion function described in the given XML template node. |
|
GetExpansionFunction(IXMLDOMNode, String, IVsExpansionFunction%) | Returns a IVsExpansionFunction object representing the expansion function described in the given XML template node (COM implementation). |
Top
Remarks
An expansion function is associated with a substitution variable (also known as a field) in a template. Whenever that variable is substituted in the template, the expansion function is invoked to provide a value for the substitution. The expansion function is defined as a name that takes zero or more parameters. This name is associated with an actual code function that does the work required to produce the value. The IXMLDOMNode parses the expansion function and creates an ExpansionFunction object that returns the required values. This ExpansionFunction object is then called upon to return the appropriate value for the variable each time the variable is substituted in the template.