PromptService Class

 Spotfire 14.2 API Reference
Allows the user to be prompted for input to various operations.
Inheritance Hierarchy
SystemObject
  DedicatedThreadAccessible
    DedicatedThreadService
      Spotfire.Dxp.Framework.ApplicationModelPromptService

Namespace:  Spotfire.Dxp.Framework.ApplicationModel
Assembly:  Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 64.0.19329.3263 (64.0.19329.3263)
Syntax
C#
Copy
public sealed class PromptService : DedicatedThreadService

The PromptService type exposes the following members.

Properties
  NameDescription
Public propertyIsPromptingAllowed
Gets whether or not prompting is allowed in the running application instance. If this method returns false, calls to Prompt(Object, Type) will fail by throwing an InvalidOperationException.
Public propertyPromptMode
Gets the mode in which this service currently operates.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodPrompt
Prompts the user for input by showing a modal dialog operating on the specified promptModel. A view of type Form must previously have been registered for the type of the specified promptModel by overriding RegisterViews(AddInViewRegistrar).
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
This service is always available in the application but the calls to Prompt(Object, Type) will throw exceptions if the application is running in a mode in which it is not possible to interact with the user (for example headless mode).
Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference

Spotfire.Dxp.Framework.ApplicationModel Namespace