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

Creates and opens new blank script of specified template file that is implemented by the assembly. The editor for this script should be implemented by this assembly. The new script is added to the miscellaneous project.

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

Syntax

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

returnValue = instance.CreateNewScript(strFullPathToScript, _
    connectionInfoList, liveCon, fileRoot)
public Object CreateNewScript(
    string strFullPathToScript,
    UIConnectionGroupInfo connectionInfoList,
    IDbConnection liveCon,
    string fileRoot
)
public:
virtual Object^ CreateNewScript(
    String^ strFullPathToScript, 
    UIConnectionGroupInfo^ connectionInfoList, 
    IDbConnection^ liveCon, 
    String^ fileRoot
) sealed
abstract CreateNewScript : 
        strFullPathToScript:string * 
        connectionInfoList:UIConnectionGroupInfo * 
        liveCon:IDbConnection * 
        fileRoot:string -> Object 
override CreateNewScript : 
        strFullPathToScript:string * 
        connectionInfoList:UIConnectionGroupInfo * 
        liveCon:IDbConnection * 
        fileRoot:string -> Object 
public final function CreateNewScript(
    strFullPathToScript : String, 
    connectionInfoList : UIConnectionGroupInfo, 
    liveCon : IDbConnection, 
    fileRoot : String
) : Object

Parameters

  • strFullPathToScript
    Type: System.String
    A string value that specifies the full path to the script.
  • 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.
  • fileRoot
    Type: System.String
    A string value that specifies the root of the path to the script.

Return Value

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