Share via

LaunchUIInteraction Complex Type

Defines an interaction used to launch a related UI application that is external to the MSDT wizard.

<xs:complexType name="LaunchUIInteraction">
    <xs:sequence>
        <xs:element name="Parameters"
            type="dcmPS:Parameters"
            minOccurs="0"
            maxOccurs="1"
        >
            <xs:unique name="No_cmdline_parameters_may_have_the_same_name">
                <xs:selector
                    xpath="Parameter"
                 />
                <xs:field
                    xpath="Name"
                 />
            </xs:unique>
        </xs:element>
        <xs:element name="CommandLine"
            type="xs:string"
            minOccurs="1"
            maxOccurs="1"
         />
        <xs:element name="ID"
            type="dcmPS:ID"
            minOccurs="1"
            maxOccurs="1"
         />
        <xs:element name="DisplayInformation"
            type="dcmPS:DisplayInformation"
            minOccurs="1"
            maxOccurs="1"
         />
        <xs:element name="ContextParameters"
            type="dcmPS:Parameters"
            minOccurs="1"
            maxOccurs="1"
         />
        <xs:element name="ExtensionPoint"
            type="dcmPS:ExtensionPoint"
            minOccurs="1"
            maxOccurs="1"
         />
    </xs:sequence>
</xs:complexType>

Child elements

Element Type Description
CommandLine xs:string The command line used to launch the Windows application. The application will appear in the foreground. The command line can include substitution strings.
ContextParameters [dcmPS:Parameters](package-parameters-complextype.md) Some extension points can contain substitution strings (for example, %param%). Each substitution string in the extension point is replaced with the value of the same named parameter specified in this list.
DisplayInformation [dcmPS:DisplayInformation](package-displayinformation-complextype.md) The name and description of this interaction. The name is used as a prompt and describes the task that the application performs.
ExtensionPoint [dcmPS:ExtensionPoint](package-extensionpoint-complextype.md) An extension point that extends this interaction. Each extension is a child element of ExtensionPoint. The extension points are MSDT specific and are not supported by the command-line client using the [Invoke-TroubleshootingPack](invoke-troubleshootingpack-cmdlet.md) cmdlet. You can specify one or more of the following extensions (but only one of each).
Extension Description
ButtonText Changes the default button text for the launch button. The button text is limited to 50 characters. The default text is "Begin this action".
The value of the ButtonText node can be a literal string or a localized resource string (for example, "@diag.dll,-123" or "@diag.dll,RESOURCE.RTF")
Link Creates a link to the specified URL. The link is placed at the bottom of the interaction window. You must use this extension point in conjunction with the LinkText extension point.
The URL can contain substitution strings (for example, %param%) that are specified in the ContextParameters element.
The URL must begin with http, https, or mshelp.
LinkText The text to use for a link. The contents of the LinkText element is the resource identifier of the localized string. You must use this extension point in conjunction with the Link extension point.
The link text can contain substitution strings (for example, %param%) that are specified in the ContextParameters element.
NoCache By default, the answer to an interaction is cached. When running in MSDT, if the interaction is called more than one time, the interaction is shown the first time and the cached answer is used thereafter (without displaying the interaction). Use this extension point to force the interaction to display on subsequent requests and to not get the answer from the cache. This extension's usage is NoCache/.
NoUI Suppresses the interaction. Gets the responses to the interaction from the answer file rather than from the user. For details on using an answer file, see the [Get-TroubleshootingPack](get-troubleshootingpack-cmdlet.md) and [Invoke-TroubleshootingPack](invoke-troubleshootingpack-cmdlet.md) cmdlets. This extension's usage is NoUI/.
RTFDescription A rich text format string that replaces the Description element of [DisplayInformation](package-displayinformation-complextype.md). If the client does not support rich text, the description string is used.
The RTF string can contain substitution strings (for example, %param%) that are specified in the ContextParameters element.
The RTFDescription element can contain an RTF string or a localized resource string (for example, "@diag.dll,-123" or "@diag.dll,RESOURCE.RTF")

ID [dcmPS:ID](package-id-simpletype.md)

An identifier that identifies this interaction.
Parameters [dcmPS:Parameters](package-parameters-complextype.md)

Specifies the substitution strings that you can use in your command line.

Requirements
Minimum supported client
 Windows 7 [desktop apps only]
Minimum supported server
 Windows Server 2008 R2 [desktop apps only]

See also

LaunchUIInteraction (LaunchUIInteractions) Element

LaunchUIInteractions Complex Type