ScriptEditorControl.GetFrameCaption Method

Gets the caption of the window based on the full path name of a file that is being edited in the window.

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

Syntax

'Declaration
Public Function GetFrameCaption ( _
    strFullFilePath As String _
) As String
'Usage
Dim instance As ScriptEditorControl
Dim strFullFilePath As String
Dim returnValue As String

returnValue = instance.GetFrameCaption(strFullFilePath)
public string GetFrameCaption(
    string strFullFilePath
)
public:
virtual String^ GetFrameCaption(
    String^ strFullFilePath
) sealed
abstract GetFrameCaption : 
        strFullFilePath:string -> string 
override GetFrameCaption : 
        strFullFilePath:string -> string 
public final function GetFrameCaption(
    strFullFilePath : String
) : String

Parameters

Return Value

Type: System.String
A string value that contains the caption of the window.

Implements

IDocWindowPane.GetFrameCaption(String)