Interface IVsUIActions
Definition of the user interface actions that are supported in visual studio.
Namespace: CodeFactory.WinVs.UI
Assembly: CodeFactory.WinVs.dll
Syntax
public interface IVsUIActions
Methods
CreateViewAsync<T>()
Creates a new instance of a view that is supported in visual studio by code factory. This will load the IVsActions into the view as well as the logger that supports the view.
Declaration
Task<T> CreateViewAsync<T>() where T : class, IView
Returns
Type | Description |
---|---|
Task<T> | New instance of the target user control. |
Type Parameters
Name | Description |
---|---|
T | The type of visual studio user control to create. |
Exceptions
Type | Condition |
---|---|
VisualStudioException | Raises a visual studio error if there was a problem creating the user control. Review the internal exception for the source of the error. |
ShowDialogWindowAsync(IView)
Displays a dialog window in visual studio that hosts a view. This makes sure the dialog window is thread safe to be used with visual studio.
Declaration
Task<bool?> ShowDialogWindowAsync(IView view)
Parameters
Type | Name | Description |
---|---|---|
IView | view | The view to be loaded into the dialog window. |
Returns
Type | Description |
---|---|
Task<bool?> | Returns the result for the window which returns a true if a close event occurred, a false when a cancel event occurred, or null if neither were triggered. |
ShowDocumentPanelAsync(IView)
Displays a document panel with the target view imbedded in the document panel.
Declaration
Task ShowDocumentPanelAsync(IView view)
Parameters
Type | Name | Description |
---|---|---|
IView | view | The view to be loaded into the document panel. |
Returns
Type | Description |
---|---|
Task |