DataViewHierarchyAccessor.IsDocumentOpen Method (String)

Retrieves a Boolean value that indicates whether a document with a particular moniker is currently open.

Namespace: Microsoft.VisualStudio.Data
Assembly: Microsoft.VisualStudio.Data (in Microsoft.VisualStudio.Data.dll)

Syntax

'Declaration
Public Function IsDocumentOpen ( _
    documentMoniker As String _
) As Boolean

'Usage
Dim instance As DataViewHierarchyAccessor 
Dim documentMoniker As String 
Dim returnValue As Boolean 

returnValue = instance.IsDocumentOpen(documentMoniker)

public bool IsDocumentOpen(
    string documentMoniker
)

public:
bool IsDocumentOpen(
    String^ documentMoniker
)

public function IsDocumentOpen(
    documentMoniker : String
) : boolean

Parameters

documentMoniker
Type: System.String

A document moniker.

Return Value

Type: System.Boolean
Returns true if the specified document is open; otherwise returns false.

Exceptions

Exception	Condition
ArgumentNullException	The documentMoniker parameter is null.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.