VsShellUtilities.GetProvisionalViewingStatus Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Shell
Assembly:
Microsoft.VisualStudio.Shell.14.0.dll
Assembly:
Microsoft.VisualStudio.Shell.15.0.dll

Overloads

GetProvisionalViewingStatus(String)

Gets the provisional viewing status for a file.
GetProvisionalViewingStatus(IVsHierarchy, UInt32)

Gets the provisional viewing status for an item in a project hierarchy.

GetProvisionalViewingStatus(String)

Gets the provisional viewing status for a file.

public:
 static System::UInt32 GetProvisionalViewingStatus(System::String ^ documentMoniker);
public:
 static unsigned int GetProvisionalViewingStatus(Platform::String ^ documentMoniker);
 static unsigned int GetProvisionalViewingStatus(std::wstring const & documentMoniker);
public static uint GetProvisionalViewingStatus (string documentMoniker);
static member GetProvisionalViewingStatus : string -> uint32
Public Shared Function GetProvisionalViewingStatus (documentMoniker As String) As UInteger
Public Function GetProvisionalViewingStatus (documentMoniker As String) As UInteger

Parameters

documentMoniker
String

The document moniker which identifies the file.

Returns

UInt32

A member of the __VSPROVISIONALVIEWINGSTATUS enumeration that describes how the file can be opened in the preview tab.

Remarks

This method considers the IVsHierarchy property VSHPROPID_ProvisionalViewingStatus, if the document moniker is included in a project. If the IVsHierarchy does not implement that property, or if the file is not part of a project, then this method uses IVsUIShellOpenDocument3.GetProvisionalViewingStatusForFile.

Applies to

GetProvisionalViewingStatus(IVsHierarchy, UInt32)

Gets the provisional viewing status for an item in a project hierarchy.

public:
 static System::UInt32 GetProvisionalViewingStatus(Microsoft::VisualStudio::Shell::Interop::IVsHierarchy ^ hierarchy, System::UInt32 itemid);
public:
 static unsigned int GetProvisionalViewingStatus(Microsoft::VisualStudio::Shell::Interop::IVsHierarchy ^ hierarchy, unsigned int itemid);
 static unsigned int GetProvisionalViewingStatus(Microsoft::VisualStudio::Shell::Interop::IVsHierarchy const & hierarchy, unsigned int itemid);
public static uint GetProvisionalViewingStatus (Microsoft.VisualStudio.Shell.Interop.IVsHierarchy hierarchy, uint itemid);
static member GetProvisionalViewingStatus : Microsoft.VisualStudio.Shell.Interop.IVsHierarchy * uint32 -> uint32
Public Shared Function GetProvisionalViewingStatus (hierarchy As IVsHierarchy, itemid As UInteger) As UInteger
Public Function GetProvisionalViewingStatus (hierarchy As IVsHierarchy, itemid As UInteger) As UInteger

Parameters

hierarchy
IVsHierarchy

The hierarchy containing the item.

itemid
UInt32

The item within the hierarchy.

Returns

UInt32

A member of the __VSPROVISIONALVIEWINGSTATUS enumeration that describes how the item can be opened in the preview tab.

Remarks

This method considers the IVsHierarchy property VSHPROPID_ProvisionalViewingStatus. If the IVsHierarchy does not implement that property, then this method uses IVsUIShellOpenDocument3.GetProvisionalViewingStatusForFile on the document moniker for the item.

Applies to