PromptDefinition Class
Autodesk.DataManagement.Client.Framework.Forms›Autodesk.DataManagement.Client.Framework.Forms.Currency
Contains properties and methods that describe the nature of a prompt such as the permissable responses, the text to display to the user, default settings, etc.
Syntax
public class PromptDefinition Public Class PromptDefinition Constructors
| Name | Description |
|---|---|
| PromptDefinition | Constructs a new PromptDefinition. |
Properties
| Name | Description |
|---|---|
| Command | Gets the prompt context that is displayed to the users. |
| DefaultAnswer | Gets the the default answer to the prompt question, which is also the button that will be highlighted if a prompt is displayed. |
| DefaultInstruction | Gets or sets the default instruction for this prompt. This determines when this prompt should be displayed to the user. |
| EscapeAnswer | Gets or sets the answer that is returned when the Escape key is hit during a prompt or when the top-right close button of the prompt dialog is clicked. |
| PromptId | Gets the unique identifier for this prompt. |
| Restrictions | Gets the list of restricted answer and instruction combinations for this prompt. |
| Style | Gets the style of this prompt. This determines the type of "Answer Buttons" that will be available to the user when a prompt is displayed. For example (Yes/No or OK/Cancel). |
| SupportCancel | Gets whether or not this prompt supports a true cancel operation. |
| Text | Gets the prompt text that is displayed to users. |
| Title | Gets the caption of the dialog box that displays the prompt to the user. If not set, this will defualt to using the application name. |
Methods
| Name | Description |
|---|---|
| AddRestriction | Adds the specified PromptRestriction to this prompt definition. |
| ValidateAnswer | Checks to make sure that the specified answer is compatable with the corresponding prompt style. |
Returned By
Where you get a PromptDefinition — members that return one.
- IPromptService.GetPromptDefinitions
- Prompts.DownloadConfirmReplaceCheckedOut
- Prompts.DownloadConfirmReplaceLocalEdits
- Prompts.DownloadForceOverwrite
- Prompts.GetRootFolderWarning
- Prompts.SyncWithRemoteSite
Inheritance Hierarchy
- System.Object
- Autodesk.DataManagement.Client.Framework.Forms.Currency.PromptDefinition