DkmScriptDocumentTreeNode Class

Definition

Represents a node in the 'Script Documents' virtual tree within solution explorer. Nodes may either be a virtual container, or they can be a document. In the latter case, they will be a DkmScriptDocument.

Derived classes: DkmScriptDocument

public ref class DkmScriptDocumentTreeNode : Microsoft::VisualStudio::Debugger::DkmDataContainer
[System.Runtime.InteropServices.Guid("df65fb73-d375-49e7-06f9-0e5613dba3f3")]
public class DkmScriptDocumentTreeNode : Microsoft.VisualStudio.Debugger.DkmDataContainer
[<System.Runtime.InteropServices.Guid("df65fb73-d375-49e7-06f9-0e5613dba3f3")>]
type DkmScriptDocumentTreeNode = class
    inherit DkmDataContainer
Public Class DkmScriptDocumentTreeNode
Inherits DkmDataContainer
Inheritance
DkmScriptDocumentTreeNode
Derived
Attributes

Properties

IsUnloaded

Returns true if a 'unloaded' event has been raised for this object (example: DkmThread::Unload is called) or if the object has been closed. Note that care must be used when checking this status as, without synchronization, the returned status may no longer be accurate the instruction after it is read.

(Inherited from DkmDataContainer)
Parent

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

Process

DkmProcess represents a target process which is being debugged. The debugger debugs processes, so this is the basic unit of debugging. A DkmProcess can represent a system process or a virtual process such as minidumps.

RuntimeInstance

The runtime which produced this container.

Title

Title of the node.

UniqueId

Guid which uniquely identifies this script document folder object.

Methods

Create(DkmRuntimeInstance, DkmScriptDocumentTreeNode, String, DkmDataItem)

Create a new DkmScriptDocumentTreeNode object instance.

This method will send a ScriptDocumentTreeNodeCreate event.

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

GetDataItem<T>()

Gets the instance of 'T' which has been added to this container instance. If this container does not contain a 'T', this function will return null.

(Inherited from DkmDataContainer)
RemoveDataItem<T>()

Remove the instance of 'T' from this container. It is usually unnecessary to call this method as a data container will automatically be emptied when the object is closed.

(Inherited from DkmDataContainer)
SetDataItem<T>(DkmDataCreationDisposition, T)

Place a new item in the data container.

(Inherited from DkmDataContainer)
Unload()

Invoked by a script document provide to fire a ScriptDocumentTreeNodeUnload event.

This method may only be called by the component which created the object.

Applies to