• Article

ScriptFactory.CreateNewScript Method (String, , UIConnectionGroupInfo, IDbConnection)

Creates and opens new blank script of specified file and adds it to the specified project.

Namespace:  Microsoft.SqlServer.Management.UI.VSIntegration.Editors
Assembly:  SQLEditors.VS (in SQLEditors.VS.dll)

Syntax

'Declaration
Public Function CreateNewScript ( _
    strFullPathToScript As String, _
    projectToAddScriptTo As IVsProject, _
    connectionInfoList As UIConnectionGroupInfo, _
    liveCon As IDbConnection _
) As Object
'Usage
Dim instance As ScriptFactory
Dim strFullPathToScript As String
Dim projectToAddScriptTo As IVsProject
Dim connectionInfoList As UIConnectionGroupInfo
Dim liveCon As IDbConnection
Dim returnValue As Object

returnValue = instance.CreateNewScript(strFullPathToScript, _
    projectToAddScriptTo, connectionInfoList, _
    liveCon)

public Object CreateNewScript(
    string strFullPathToScript,
    IVsProject projectToAddScriptTo,
    UIConnectionGroupInfo connectionInfoList,
    IDbConnection liveCon
)

public:
Object^ CreateNewScript(
    String^ strFullPathToScript, 
    IVsProject^ projectToAddScriptTo, 
    UIConnectionGroupInfo^ connectionInfoList, 
    IDbConnection^ liveCon
)

member CreateNewScript : 
        strFullPathToScript:string * 
        projectToAddScriptTo:IVsProject * 
        connectionInfoList:UIConnectionGroupInfo * 
        liveCon:IDbConnection -> Object 

public function CreateNewScript(
    strFullPathToScript : String, 
    projectToAddScriptTo : IVsProject, 
    connectionInfoList : UIConnectionGroupInfo, 
    liveCon : IDbConnection
) : Object

Parameters

  • strFullPathToScript
    Type: System.String
    A string value that specifies the full path to the script.
  • projectToAddScriptTo
    Type: IVsProject
    A IVsProject that is currently loaded.
  • liveCon
    Type: System.Data.IDbConnection
    A IDbConnection that can be associated with the new editor. Can be non-null only if connectionInfoList parameter is non-null/non-empty. Should be in sync with connectionInfoList parameter.

Return Value

Type: System.Object
The document view Object for the new script editor.