Share via


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
public bool ActivateDocumentIfOpen(
    string documentMoniker
)
public:
bool ActivateDocumentIfOpen(
    String^ documentMoniker
)
member ActivateDocumentIfOpen : 
        documentMoniker:string -> bool
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

See Also

Reference

DataViewHierarchyAccessor Class

ActivateDocumentIfOpen Overload

Microsoft.VisualStudio.Data Namespace