C# Class ThoughtWorks.VisualStudio.GeneralCommentView

Interaction logic for TransitionCommentView.xaml
显示文件 Open project: ThoughtWorksStudios/vs-connector Class Usage Examples

Public Methods

Method Description
GeneralCommentView ( ) : System.ComponentModel

Displays a dialog to collect a comment from a user.

GeneralCommentView ( string windowHeading, string requiredAdmonition, string windowTitle ) : System.ComponentModel

Use this class to display a general purpose text/comment collection UI.

If the user does not supply data and tries to close this window then a warning dialog is shown with the requiredAdmonition message. A Yes response cancels the OnWindowClosing event giving the user another opportunity to enter a comment. A No response allows the OnWindowClosing event to proceed and the window closes. It is up to you to collect the resulting Comment from the Comment property and do with it what you will.

Private Methods

Method Description
OnWindowClosing ( object sender, CancelEventArgs e ) : void

Method Details

GeneralCommentView() public method

Displays a dialog to collect a comment from a user.
public GeneralCommentView ( ) : System.ComponentModel
return System.ComponentModel

GeneralCommentView() public method

Use this class to display a general purpose text/comment collection UI.
If the user does not supply data and tries to close this window then a warning dialog is shown with the requiredAdmonition message. A Yes response cancels the OnWindowClosing event giving the user another opportunity to enter a comment. A No response allows the OnWindowClosing event to proceed and the window closes. It is up to you to collect the resulting Comment from the Comment property and do with it what you will.
public GeneralCommentView ( string windowHeading, string requiredAdmonition, string windowTitle ) : System.ComponentModel
windowHeading string A message displayed at the top of the form. This this to tell your user what to do.
requiredAdmonition string This is the message displayed in a yes/no MessageBox if the user closes the window without supplying any data.
windowTitle string The title of the window.
return System.ComponentModel