DataViewHierarchyAccessor.ActivateDocumentIfOpen Method (String)

Activates a document with the specified moniker, if the document is open.

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

Syntax

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

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

returnValue = instance.ActivateDocumentIfOpen(documentMoniker)

public bool ActivateDocumentIfOpen(
    string documentMoniker
)

public:
bool ActivateDocumentIfOpen(
    String^ documentMoniker
)

public function ActivateDocumentIfOpen(
    documentMoniker : String
) : boolean

Parameters

documentMoniker
Type: System.String

Moniker for the document to activate.

Return Value

Type: System.Boolean
Returns true if the 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.