ScriptAndResultsEditorControl ScriptAndResultsEditorControl ScriptAndResultsEditorControl Class

Definition

Base class for all editors that have a script, a splitter below it, and a control below the splitter.

public ref class ScriptAndResultsEditorControl abstract : Microsoft::SqlServer::Management::UI::VSIntegration::Editors::ScriptEditorControl, Microsoft::SqlServer::Management::UI::VSIntegration::Editors::ISqlScriptWindowWithConnection, Microsoft::VisualStudio::Shell::Interop::IVsWindowFrameNotify3
public abstract class ScriptAndResultsEditorControl : Microsoft.SqlServer.Management.UI.VSIntegration.Editors.ScriptEditorControl, Microsoft.SqlServer.Management.UI.VSIntegration.Editors.ISqlScriptWindowWithConnection, Microsoft.VisualStudio.Shell.Interop.IVsWindowFrameNotify3
Public MustInherit Class ScriptAndResultsEditorControl
Inherits ScriptEditorControl
Implements ISqlScriptWindowWithConnection, IVsWindowFrameNotify3
Inheritance
Derived
Implements

Remarks

This class defines splitter member as well as set of protected methods that should be used for manipulation with the splitter and controls above/below it.

Fields

buildAction buildAction buildAction Inherited from ScriptEditorControl
fedRootName fedRootName fedRootName

Specifies the name of the root federation.

initialFocus initialFocus initialFocus Inherited from ScriptEditorControl
isCloudDatabase isCloudDatabase isCloudDatabase

Determines whether SQL Server Management Studio is currently connected to a SQL Azure server.

isClrProjectFile isClrProjectFile isClrProjectFile Inherited from ScriptEditorControl
isDacProjectFile isDacProjectFile isDacProjectFile Inherited from ScriptEditorControl
isFedMemAttrChecked isFedMemAttrChecked isFedMemAttrChecked

A Boolean value that indicates whether the federation member attribute is checked.

isProjectDebugging isProjectDebugging isProjectDebugging

A Boolean value that indicates whether the project is debugging.

menuCommands menuCommands menuCommands Inherited from ShellWindowPaneUserControl
m_connection m_connection m_connection

Cached connection that is associated with the window.

m_connectionInfoList m_connectionInfoList m_connectionInfoList

Cached connection info that is used in communication with the connection dialog box.

m_connectionToUse m_connectionToUse m_connectionToUse

Specifies a connection information that should be applied to the window after it is fully initialized, unless it is stamped with another connection.

m_dtExecBegan m_dtExecBegan m_dtExecBegan

Specifies a member to store at the beginning of script execution.

m_Editor m_Editor m_Editor Inherited from ScriptEditorControl
m_scriptSplitter m_scriptSplitter m_scriptSplitter

Splitter to horizontally separate script and other elements.

m_serviceProvider m_serviceProvider m_serviceProvider Inherited from ScriptEditorControl
m_sp m_sp m_sp Inherited from ShellWindowPaneUserControl
m_strOrigMoniker m_strOrigMoniker m_strOrigMoniker Inherited from ScriptEditorControl
m_timeElapsedTimer m_timeElapsedTimer m_timeElapsedTimer

Timer for updating properties window with elapsed time during query execution.

projectNode projectNode projectNode Inherited from ScriptEditorControl
selectionServiceForProperties selectionServiceForProperties selectionServiceForProperties Inherited from ShellWindowPaneUserControl
shardName shardName shardName

Specifies the shard name.

statusBar statusBar statusBar

Status bar.

statusBarManager statusBarManager statusBarManager Inherited from ScriptEditorControl
sysShardName sysShardName sysShardName

Specifies the system shard name.

Properties

BuildAction BuildAction BuildAction Inherited from ScriptEditorControl
CmdUIGuid CmdUIGuid CmdUIGuid Inherited from ScriptEditorControl
Connection Connection Connection

Returns parameters in the case where script editor has a current connection.

ConnectionInfoList ConnectionInfoList ConnectionInfoList

Gets connection context for the editor.

CurrentDB CurrentDB CurrentDB

Gets or sets the logical database that is current for the script.

DefaultHelpContext DefaultHelpContext DefaultHelpContext Inherited from ScriptEditorControl
DocData DocData DocData Inherited from ScriptEditorControl
EditorText EditorText EditorText Inherited from ScriptEditorControl
InitialFocus InitialFocus InitialFocus Inherited from ScriptEditorControl
IsAFedMember IsAFedMember IsAFedMember

Gets or sets a value that indicates whether the current database is a federation member.

IsConnected IsConnected IsConnected

Gets or sets whether the editor control is connected.

IsControlUnderSplitterVisible IsControlUnderSplitterVisible IsControlUnderSplitterVisible

Gets a Boolean value that specifies how the window will be resized.

IsDebugging IsDebugging IsDebugging

Gets or sets whether the script is being executed.

IsExecuting IsExecuting IsExecuting

Gets or sets whether the script is being executed.

IsFrameActive IsFrameActive IsFrameActive Inherited from ScriptEditorControl
IsScriptEditorActive IsScriptEditorActive IsScriptEditorActive

Gets a Boolean value that specifies whether the code editor is currently active.

IsSqlCmdMode IsSqlCmdMode IsSqlCmdMode

Gets or sets the flag that specifies whether SQLCMD mode is set.

IsWithNumberOfRowsOnStatusBar IsWithNumberOfRowsOnStatusBar IsWithNumberOfRowsOnStatusBar

Gets a Boolean value that specifies whether the status bar contains a panel for number of fetched rows.

LanguageServiceGUID LanguageServiceGUID LanguageServiceGUID Inherited from ScriptEditorControl
NameInPropWindow NameInPropWindow NameInPropWindow Inherited from ShellWindowPaneUserControl
ScriptEditorContextMenuID ScriptEditorContextMenuID ScriptEditorContextMenuID Inherited from ScriptEditorControl
ShowCurrentResultsBelowSplitter ShowCurrentResultsBelowSplitter ShowCurrentResultsBelowSplitter

Gets or sets a Boolean value that specifies whether the results show below splitter or start from the second tab.

SqlCmdVars SqlCmdVars SqlCmdVars

Gets or sets a dictionary containing all the variables and their values from sqlcmdvars file in Database projects in Visual Studio.

StatusBarManager StatusBarManager StatusBarManager Inherited from ScriptEditorControl
VsUserContext VsUserContext VsUserContext Inherited from ScriptEditorControl

Methods

ChangeConnection() ChangeConnection() ChangeConnection()

Called when user wants to reconnect to another server while connected.

ClearCachedValues() ClearCachedValues() ClearCachedValues()

Clears cache values from previous shard operations.

ClosePane() ClosePane() ClosePane() Inherited from ShellWindowPaneUserControl
Connect() Connect() Connect()

Establishes a new LIVE connection for the query window.

CreatePaneWindow(IntPtr, Int32, Int32, Int32, Int32, IntPtr) CreatePaneWindow(IntPtr, Int32, Int32, Int32, Int32, IntPtr) CreatePaneWindow(IntPtr, Int32, Int32, Int32, Int32, IntPtr) Inherited from ShellWindowPaneUserControl
Disconnect() Disconnect() Disconnect()

Disconnects from server.

DisconnectAll(IWin32Window, Boolean) DisconnectAll(IWin32Window, Boolean) DisconnectAll(IWin32Window, Boolean)

Disconnect all windows.

Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

Closes the connections and cleans up any resources being used.

Exec(Guid, UInt32, UInt32, IntPtr, IntPtr) Exec(Guid, UInt32, UInt32, IntPtr, IntPtr) Exec(Guid, UInt32, UInt32, IntPtr, IntPtr) Inherited from ShellWindowPaneUserControl
FillMenuCommands() FillMenuCommands() FillMenuCommands()

Support menu commands.

GetDefaultSize(SIZE[]) GetDefaultSize(SIZE[]) GetDefaultSize(SIZE[]) Inherited from ShellWindowPaneUserControl
GetFrameCaption(String) GetFrameCaption(String) GetFrameCaption(String) Inherited from ScriptEditorControl
GetService(Guid) GetService(Guid) GetService(Guid) Inherited from ShellWindowPaneUserControl
GetService(Type) GetService(Type) GetService(Type) Inherited from ShellWindowPaneUserControl
InitializeSplitter() InitializeSplitter() InitializeSplitter()

Does all splitter-related initialization.

InitializeStatusBar() InitializeStatusBar() InitializeStatusBar()

Performs status-bar related initialization. Derived classes should override it to add more status bar panels and adjust it.

IsSqlClrProjectFile(IVsTextView) IsSqlClrProjectFile(IVsTextView) IsSqlClrProjectFile(IVsTextView) Inherited from ScriptEditorControl
LoadViewState(IStream) LoadViewState(IStream) LoadViewState(IStream) Inherited from ScriptEditorControl
OnDockableChange(Int32) OnDockableChange(Int32) OnDockableChange(Int32) Inherited from ShellWindowPaneUserControl
OnExec(Guid, UInt32, UInt32, IntPtr, IntPtr) OnExec(Guid, UInt32, UInt32, IntPtr, IntPtr) OnExec(Guid, UInt32, UInt32, IntPtr, IntPtr) Inherited from ShellWindowPaneUserControl
OnHosted() OnHosted() OnHosted()

Called when sited by Visual Studio. At this time, service providers have already been stored in internal variables, so it is safe to call GetService.

OnMove() OnMove() OnMove() Inherited from ShellWindowPaneUserControl
OnQueryStatus(Guid, UInt32, OLECMD[], IntPtr) OnQueryStatus(Guid, UInt32, OLECMD[], IntPtr) OnQueryStatus(Guid, UInt32, OLECMD[], IntPtr) Inherited from ShellWindowPaneUserControl
OnResize(EventArgs) OnResize(EventArgs) OnResize(EventArgs)

Overrides the WinForms Control base class.

OnShow(Int32) OnShow(Int32) OnShow(Int32) Inherited from ScriptEditorControl
OnSize() OnSize() OnSize() Inherited from ShellWindowPaneUserControl
OnWindowPaneClose() OnWindowPaneClose() OnWindowPaneClose() Inherited from ShellWindowPaneUserControl
OnWindowPaneCreate() OnWindowPaneCreate() OnWindowPaneCreate() Inherited from ShellWindowPaneUserControl
QueryStatus(Guid, UInt32, OLECMD[], IntPtr) QueryStatus(Guid, UInt32, OLECMD[], IntPtr) QueryStatus(Guid, UInt32, OLECMD[], IntPtr) Inherited from ShellWindowPaneUserControl
SaveViewState(IStream) SaveViewState(IStream) SaveViewState(IStream) Inherited from ScriptEditorControl
SetConnection(UIConnectionGroupInfo) SetConnection(UIConnectionGroupInfo) SetConnection(UIConnectionGroupInfo)

Associates a connection context with the script editor.

SetConnection(UIConnectionGroupInfo, IDbConnection) SetConnection(UIConnectionGroupInfo, IDbConnection) SetConnection(UIConnectionGroupInfo, IDbConnection)

Enables stamp with live connection.

SetConnection(UIConnectionInfo) SetConnection(UIConnectionInfo) SetConnection(UIConnectionInfo)

Associate a connection with the script.

SetConnection(UIConnectionInfo, IDbConnection) SetConnection(UIConnectionInfo, IDbConnection) SetConnection(UIConnectionInfo, IDbConnection)

Enables stamp used with live connection

SetSite(IServiceProvider) SetSite(IServiceProvider) SetSite(IServiceProvider) Inherited from ScriptEditorControl
ShouldSubscribeToChildrenFocusEvent(Control) ShouldSubscribeToChildrenFocusEvent(Control) ShouldSubscribeToChildrenFocusEvent(Control) Inherited from ScriptEditorControl
ShouldTryToReconnectWithCachedCI(UIConnectionInfo) ShouldTryToReconnectWithCachedCI(UIConnectionInfo) ShouldTryToReconnectWithCachedCI(UIConnectionInfo)

Determines whether to try to reconnect automatically with the given connection information or to popup a pre-populated connection dialog box without automatically trying to connect.

ShowMessage(String, String, MessageBoxButtons, MessageBoxIcon) ShowMessage(String, String, MessageBoxButtons, MessageBoxIcon) ShowMessage(String, String, MessageBoxButtons, MessageBoxIcon) Inherited from ScriptEditorControl
ToggleResultsControl(Boolean) ToggleResultsControl(Boolean) ToggleResultsControl(Boolean)

Shows or hides the query results control.

TranslateAccelerator(MSG[]) TranslateAccelerator(MSG[]) TranslateAccelerator(MSG[]) Inherited from ShellWindowPaneUserControl
UpdateMenuCommandsStatus(MenuCommand) UpdateMenuCommandsStatus(MenuCommand) UpdateMenuCommandsStatus(MenuCommand)

Called by the base class to update command status.

UpdatePropWindow(Object) UpdatePropWindow(Object) UpdatePropWindow(Object) Inherited from ShellWindowPaneUserControl

Events

NewConnectionForScript NewConnectionForScript NewConnectionForScript

Event that is fired when a user specifies a new connection for the script from the connection dialog box.

Explicit Interface Implementations

ICustomTypeDescriptor.GetAttributes() ICustomTypeDescriptor.GetAttributes() ICustomTypeDescriptor.GetAttributes() Inherited from ShellWindowPaneUserControl
ICustomTypeDescriptor.GetClassName() ICustomTypeDescriptor.GetClassName() ICustomTypeDescriptor.GetClassName() Inherited from ShellWindowPaneUserControl
ICustomTypeDescriptor.GetComponentName() ICustomTypeDescriptor.GetComponentName() ICustomTypeDescriptor.GetComponentName() Inherited from ShellWindowPaneUserControl
ICustomTypeDescriptor.GetConverter() ICustomTypeDescriptor.GetConverter() ICustomTypeDescriptor.GetConverter() Inherited from ShellWindowPaneUserControl
ICustomTypeDescriptor.GetDefaultEvent() ICustomTypeDescriptor.GetDefaultEvent() ICustomTypeDescriptor.GetDefaultEvent() Inherited from ShellWindowPaneUserControl
ICustomTypeDescriptor.GetDefaultProperty() ICustomTypeDescriptor.GetDefaultProperty() ICustomTypeDescriptor.GetDefaultProperty() Inherited from ShellWindowPaneUserControl
ICustomTypeDescriptor.GetEditor(Type) ICustomTypeDescriptor.GetEditor(Type) ICustomTypeDescriptor.GetEditor(Type) Inherited from ShellWindowPaneUserControl
ICustomTypeDescriptor.GetEvents() ICustomTypeDescriptor.GetEvents() ICustomTypeDescriptor.GetEvents() Inherited from ShellWindowPaneUserControl
ICustomTypeDescriptor.GetEvents(Attribute[]) ICustomTypeDescriptor.GetEvents(Attribute[]) ICustomTypeDescriptor.GetEvents(Attribute[]) Inherited from ShellWindowPaneUserControl
ICustomTypeDescriptor.GetProperties() ICustomTypeDescriptor.GetProperties() ICustomTypeDescriptor.GetProperties() Inherited from ShellWindowPaneUserControl
ICustomTypeDescriptor.GetProperties(Attribute[]) ICustomTypeDescriptor.GetProperties(Attribute[]) ICustomTypeDescriptor.GetProperties(Attribute[]) Inherited from ShellWindowPaneUserControl
ICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptor) ICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptor) ICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptor) Inherited from ShellWindowPaneUserControl
IVsCodeWindow.Close() IVsCodeWindow.Close() IVsCodeWindow.Close() Inherited from ScriptEditorControl
IVsCodeWindow.GetBuffer(IVsTextLines) IVsCodeWindow.GetBuffer(IVsTextLines) IVsCodeWindow.GetBuffer(IVsTextLines) Inherited from ScriptEditorControl
IVsCodeWindow.GetEditorCaption(READONLYSTATUS, String) IVsCodeWindow.GetEditorCaption(READONLYSTATUS, String) IVsCodeWindow.GetEditorCaption(READONLYSTATUS, String) Inherited from ScriptEditorControl
IVsCodeWindow.GetLastActiveView(IVsTextView) IVsCodeWindow.GetLastActiveView(IVsTextView) IVsCodeWindow.GetLastActiveView(IVsTextView) Inherited from ScriptEditorControl
IVsCodeWindow.GetPrimaryView(IVsTextView) IVsCodeWindow.GetPrimaryView(IVsTextView) IVsCodeWindow.GetPrimaryView(IVsTextView) Inherited from ScriptEditorControl
IVsCodeWindow.GetSecondaryView(IVsTextView) IVsCodeWindow.GetSecondaryView(IVsTextView) IVsCodeWindow.GetSecondaryView(IVsTextView) Inherited from ScriptEditorControl
IVsCodeWindow.GetViewClassID(Guid) IVsCodeWindow.GetViewClassID(Guid) IVsCodeWindow.GetViewClassID(Guid) Inherited from ScriptEditorControl
IVsCodeWindow.SetBaseEditorCaption(String[]) IVsCodeWindow.SetBaseEditorCaption(String[]) IVsCodeWindow.SetBaseEditorCaption(String[]) Inherited from ScriptEditorControl
IVsCodeWindow.SetBuffer(IVsTextLines) IVsCodeWindow.SetBuffer(IVsTextLines) IVsCodeWindow.SetBuffer(IVsTextLines) Inherited from ScriptEditorControl
IVsCodeWindow.SetViewClassID(Guid) IVsCodeWindow.SetViewClassID(Guid) IVsCodeWindow.SetViewClassID(Guid) Inherited from ScriptEditorControl
IVsFindTarget.Find(String, UInt32, Int32, IVsFindHelper, UInt32) IVsFindTarget.Find(String, UInt32, Int32, IVsFindHelper, UInt32) IVsFindTarget.Find(String, UInt32, Int32, IVsFindHelper, UInt32) Inherited from ScriptEditorControl
IVsFindTarget.GetCapabilities(Boolean[], UInt32[]) IVsFindTarget.GetCapabilities(Boolean[], UInt32[]) IVsFindTarget.GetCapabilities(Boolean[], UInt32[]) Inherited from ScriptEditorControl
IVsFindTarget.GetCurrentSpan(TextSpan[]) IVsFindTarget.GetCurrentSpan(TextSpan[]) IVsFindTarget.GetCurrentSpan(TextSpan[]) Inherited from ScriptEditorControl
IVsFindTarget.GetFindState(Object) IVsFindTarget.GetFindState(Object) IVsFindTarget.GetFindState(Object) Inherited from ScriptEditorControl
IVsFindTarget.GetMatchRect(RECT[]) IVsFindTarget.GetMatchRect(RECT[]) IVsFindTarget.GetMatchRect(RECT[]) Inherited from ScriptEditorControl
IVsFindTarget.GetProperty(UInt32, Object) IVsFindTarget.GetProperty(UInt32, Object) IVsFindTarget.GetProperty(UInt32, Object) Inherited from ScriptEditorControl
IVsFindTarget.GetSearchImage(UInt32, IVsTextSpanSet[], IVsTextImage) IVsFindTarget.GetSearchImage(UInt32, IVsTextSpanSet[], IVsTextImage) IVsFindTarget.GetSearchImage(UInt32, IVsTextSpanSet[], IVsTextImage) Inherited from ScriptEditorControl
IVsFindTarget.MarkSpan(TextSpan[]) IVsFindTarget.MarkSpan(TextSpan[]) IVsFindTarget.MarkSpan(TextSpan[]) Inherited from ScriptEditorControl
IVsFindTarget.NavigateTo(TextSpan[]) IVsFindTarget.NavigateTo(TextSpan[]) IVsFindTarget.NavigateTo(TextSpan[]) Inherited from ScriptEditorControl
IVsFindTarget.NotifyFindTarget(UInt32) IVsFindTarget.NotifyFindTarget(UInt32) IVsFindTarget.NotifyFindTarget(UInt32) Inherited from ScriptEditorControl
IVsFindTarget.Replace(String, String, UInt32, Int32, IVsFindHelper, Int32) IVsFindTarget.Replace(String, String, UInt32, Int32, IVsFindHelper, Int32) IVsFindTarget.Replace(String, String, UInt32, Int32, IVsFindHelper, Int32) Inherited from ScriptEditorControl
IVsFindTarget.SetFindState(Object) IVsFindTarget.SetFindState(Object) IVsFindTarget.SetFindState(Object) Inherited from ScriptEditorControl
IVsStatusbarUser.SetInfo() IVsStatusbarUser.SetInfo() IVsStatusbarUser.SetInfo() Inherited from ScriptEditorControl
IVsWindowFrameNotify3.OnClose(UInt32) IVsWindowFrameNotify3.OnClose(UInt32) IVsWindowFrameNotify3.OnClose(UInt32)
IVsWindowFrameNotify3.OnDockableChange(Int32, Int32, Int32, Int32, Int32) IVsWindowFrameNotify3.OnDockableChange(Int32, Int32, Int32, Int32, Int32) IVsWindowFrameNotify3.OnDockableChange(Int32, Int32, Int32, Int32, Int32)
IVsWindowFrameNotify3.OnMove(Int32, Int32, Int32, Int32) IVsWindowFrameNotify3.OnMove(Int32, Int32, Int32, Int32) IVsWindowFrameNotify3.OnMove(Int32, Int32, Int32, Int32)
IVsWindowFrameNotify3.OnSize(Int32, Int32, Int32, Int32) IVsWindowFrameNotify3.OnSize(Int32, Int32, Int32, Int32) IVsWindowFrameNotify3.OnSize(Int32, Int32, Int32, Int32)

Applies to