ScriptFactory.CreateNewScript Method (String, UIConnectionInfo, 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 (in SQLEditors.dll)

Syntax

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

returnValue = instance.CreateNewScript(strFullPathToScript, _
    ci, liveCon, fileRoot)

public Object CreateNewScript(
    string strFullPathToScript,
    UIConnectionInfo ci,
    IDbConnection liveCon,
    string fileRoot
)

public:
virtual Object^ CreateNewScript(
    String^ strFullPathToScript, 
    UIConnectionInfo^ ci, 
    IDbConnection^ liveCon, 
    String^ fileRoot
) sealed

abstract CreateNewScript : 
        strFullPathToScript:string * 
        ci:UIConnectionInfo * 
        liveCon:IDbConnection * 
        fileRoot:string -> Object  
override CreateNewScript : 
        strFullPathToScript:string * 
        ci:UIConnectionInfo * 
        liveCon:IDbConnection * 
        fileRoot:string -> Object

public final function CreateNewScript(
    strFullPathToScript : String, 
    ci : UIConnectionInfo, 
    liveCon : IDbConnection, 
    fileRoot : String
) : Object

Parameters

• strFullPathToScript
  Type: System.String
  A string value that specifies the full path to the script.

• ci
  Type: Microsoft.SqlServer.Management.Smo.RegSvrEnum.UIConnectionInfo
  A UIConnectionInfo that can be passed in to the new editor. If null, then new editor doesn't have any connection associated with it.

• 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.

See Also

Reference

ScriptFactory Class

CreateNewScript Overload

Microsoft.SqlServer.Management.UI.VSIntegration.Editors Namespace