DkmScriptDocument.Create Method

Definition

Namespace:

Microsoft.VisualStudio.Debugger.Script

Assembly:

Microsoft.VisualStudio.Debugger.Engine.dll

Package:

Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

Overloads

Create(DkmRuntimeInstance, DkmScriptDocumentTreeNode, String, DkmModule, String, String, DkmScriptDocumentFlags, DkmScriptSourceProjectItem, DkmDataItem)	Create a new DkmScriptDocument object instance. This method will send a ScriptDocumentTreeNodeCreate event. Location constraint: API must be called from a Monitor component (component level < 100,000).
Create(DkmRuntimeInstance, DkmScriptDocumentTreeNode, String, DkmModule, String, String, DkmScriptDocumentFlags, DkmScriptDocumentContentType, DkmScriptEmbeddedDocumentKind, DkmScriptSourceProjectItem, DkmScriptDocumentJmcState, DkmDataItem)	Create a new DkmScriptDocument object instance. This method will send a ScriptDocumentTreeNodeCreate event. Location constraint: API must be called from a Monitor component (component level < 100,000). This API was introduced in Visual Studio 12 RTM (DkmApiVersion.VS12RTM).

Create(DkmRuntimeInstance, DkmScriptDocumentTreeNode, String, DkmModule, String, String, DkmScriptDocumentFlags, DkmScriptSourceProjectItem, DkmDataItem)

Create a new DkmScriptDocument object instance.

This method will send a ScriptDocumentTreeNodeCreate event.

Location constraint: API must be called from a Monitor component (component level < 100,000).

public:
 static Microsoft::VisualStudio::Debugger::Script::DkmScriptDocument ^ Create(Microsoft::VisualStudio::Debugger::DkmRuntimeInstance ^ RuntimeInstance, Microsoft::VisualStudio::Debugger::Script::DkmScriptDocumentTreeNode ^ Parent, System::String ^ Title, Microsoft::VisualStudio::Debugger::Symbols::DkmModule ^ Module, System::String ^ Url, System::String ^ FilePath, Microsoft::VisualStudio::Debugger::Script::DkmScriptDocumentFlags Flags, Microsoft::VisualStudio::Debugger::Script::DkmScriptSourceProjectItem ^ SourceProjectItem, Microsoft::VisualStudio::Debugger::DkmDataItem ^ DataItem);

public static Microsoft.VisualStudio.Debugger.Script.DkmScriptDocument Create (Microsoft.VisualStudio.Debugger.DkmRuntimeInstance RuntimeInstance, Microsoft.VisualStudio.Debugger.Script.DkmScriptDocumentTreeNode? Parent, string Title, Microsoft.VisualStudio.Debugger.Symbols.DkmModule Module, string? Url, string? FilePath, Microsoft.VisualStudio.Debugger.Script.DkmScriptDocumentFlags Flags, Microsoft.VisualStudio.Debugger.Script.DkmScriptSourceProjectItem? SourceProjectItem, Microsoft.VisualStudio.Debugger.DkmDataItem? DataItem);

static member Create : Microsoft.VisualStudio.Debugger.DkmRuntimeInstance * Microsoft.VisualStudio.Debugger.Script.DkmScriptDocumentTreeNode * string * Microsoft.VisualStudio.Debugger.Symbols.DkmModule * string * string * Microsoft.VisualStudio.Debugger.Script.DkmScriptDocumentFlags * Microsoft.VisualStudio.Debugger.Script.DkmScriptSourceProjectItem * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.Script.DkmScriptDocument

Public Shared Function Create (RuntimeInstance As DkmRuntimeInstance, Parent As DkmScriptDocumentTreeNode, Title As String, Module As DkmModule, Url As String, FilePath As String, Flags As DkmScriptDocumentFlags, SourceProjectItem As DkmScriptSourceProjectItem, DataItem As DkmDataItem) As DkmScriptDocument

Parameters

RuntimeInstance

DkmRuntimeInstance

[In] The runtime which produced this container.

Parent

DkmScriptDocumentTreeNode

[In,Optional] Parent in the script document tree. This will be null for the root application container.

Title

String

[In] Title of the node.

Module

DkmModule

[In] The symbol container which owns this document.

Url

String

[In,Optional] URL of the script document. This may be null if the document has no URL.

FilePath

String

[In,Optional] File path (ex: c:\myfolder\file.js) of the script document. This will be null if the document has no URL, or has a non-'file://' URL.

Flags

DkmScriptDocumentFlags

[In] Flag properties of a script document.

SourceProjectItem

DkmScriptSourceProjectItem

[In,Optional] The project item which matches this document.

DataItem

DkmDataItem

[In,Optional] Data object to add to the new DkmScriptDocument instance. Pass 'null' in the case that the caller doesn't need to add a data item.

Returns

DkmScriptDocument

[Out] Result of this method call.

Create(DkmRuntimeInstance, DkmScriptDocumentTreeNode, String, DkmModule, String, String, DkmScriptDocumentFlags, DkmScriptDocumentContentType, DkmScriptEmbeddedDocumentKind, DkmScriptSourceProjectItem, DkmScriptDocumentJmcState, DkmDataItem)

Create a new DkmScriptDocument object instance.

This method will send a ScriptDocumentTreeNodeCreate event.

Location constraint: API must be called from a Monitor component (component level < 100,000).

This API was introduced in Visual Studio 12 RTM (DkmApiVersion.VS12RTM).

public:
 static Microsoft::VisualStudio::Debugger::Script::DkmScriptDocument ^ Create(Microsoft::VisualStudio::Debugger::DkmRuntimeInstance ^ RuntimeInstance, Microsoft::VisualStudio::Debugger::Script::DkmScriptDocumentTreeNode ^ Parent, System::String ^ Title, Microsoft::VisualStudio::Debugger::Symbols::DkmModule ^ Module, System::String ^ Url, System::String ^ FilePath, Microsoft::VisualStudio::Debugger::Script::DkmScriptDocumentFlags Flags, Microsoft::VisualStudio::Debugger::Script::DkmScriptDocumentContentType ContentType, Microsoft::VisualStudio::Debugger::Script::DkmScriptEmbeddedDocumentKind EmbeddedDocumentKind, Microsoft::VisualStudio::Debugger::Script::DkmScriptSourceProjectItem ^ SourceProjectItem, Microsoft::VisualStudio::Debugger::Script::DkmScriptDocumentJmcState JmcState, Microsoft::VisualStudio::Debugger::DkmDataItem ^ DataItem);

public static Microsoft.VisualStudio.Debugger.Script.DkmScriptDocument Create (Microsoft.VisualStudio.Debugger.DkmRuntimeInstance RuntimeInstance, Microsoft.VisualStudio.Debugger.Script.DkmScriptDocumentTreeNode? Parent, string Title, Microsoft.VisualStudio.Debugger.Symbols.DkmModule Module, string? Url, string? FilePath, Microsoft.VisualStudio.Debugger.Script.DkmScriptDocumentFlags Flags, Microsoft.VisualStudio.Debugger.Script.DkmScriptDocumentContentType ContentType, Microsoft.VisualStudio.Debugger.Script.DkmScriptEmbeddedDocumentKind EmbeddedDocumentKind, Microsoft.VisualStudio.Debugger.Script.DkmScriptSourceProjectItem? SourceProjectItem, Microsoft.VisualStudio.Debugger.Script.DkmScriptDocumentJmcState JmcState, Microsoft.VisualStudio.Debugger.DkmDataItem? DataItem);

static member Create : Microsoft.VisualStudio.Debugger.DkmRuntimeInstance * Microsoft.VisualStudio.Debugger.Script.DkmScriptDocumentTreeNode * string * Microsoft.VisualStudio.Debugger.Symbols.DkmModule * string * string * Microsoft.VisualStudio.Debugger.Script.DkmScriptDocumentFlags * Microsoft.VisualStudio.Debugger.Script.DkmScriptDocumentContentType * Microsoft.VisualStudio.Debugger.Script.DkmScriptEmbeddedDocumentKind * Microsoft.VisualStudio.Debugger.Script.DkmScriptSourceProjectItem * Microsoft.VisualStudio.Debugger.Script.DkmScriptDocumentJmcState * Microsoft.VisualStudio.Debugger.DkmDataItem -> Microsoft.VisualStudio.Debugger.Script.DkmScriptDocument

Public Shared Function Create (RuntimeInstance As DkmRuntimeInstance, Parent As DkmScriptDocumentTreeNode, Title As String, Module As DkmModule, Url As String, FilePath As String, Flags As DkmScriptDocumentFlags, ContentType As DkmScriptDocumentContentType, EmbeddedDocumentKind As DkmScriptEmbeddedDocumentKind, SourceProjectItem As DkmScriptSourceProjectItem, JmcState As DkmScriptDocumentJmcState, DataItem As DkmDataItem) As DkmScriptDocument

Parameters

RuntimeInstance

DkmRuntimeInstance

[In] The runtime which produced this container.

Parent

DkmScriptDocumentTreeNode

[In,Optional] Parent in the script document tree. This will be null for the root application container.

Title

String

[In] Title of the node.

Module

DkmModule

[In] The symbol container which owns this document.

Url

String

[In,Optional] URL of the script document. This may be null if the document has no URL.

FilePath

String

[In,Optional] File path (ex: c:\myfolder\file.js) of the script document. This will be null if the document has no URL, or has a non-'file://' URL.

Flags

DkmScriptDocumentFlags

[In] Flag properties of a script document.

ContentType

DkmScriptDocumentContentType

[In] Indicates the content type of the underlying script document.

EmbeddedDocumentKind

DkmScriptEmbeddedDocumentKind

[In] Indicates the kind of embedded document (or none if not an embedded document). The type can be eval code, function code, or script block.

SourceProjectItem

DkmScriptSourceProjectItem

[In,Optional] The project item which matches this document.

JmcState

DkmScriptDocumentJmcState

[In] The Just-My-Code state of the document. To update the value of this variable, call DkmScriptDocument.SetJmcState.

DataItem

DkmDataItem

[In,Optional] Data object to add to the new DkmScriptDocument instance. Pass 'null' in the case that the caller doesn't need to add a data item.

Returns

DkmScriptDocument

[Out] Result of this method call.