IVsWebPreview.PreviewURLEx Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides the information for the preview. Extension of PreviewURL(IVsWebPreviewAction, String). Use ActivatePreview() to display the preview.

public:
 int PreviewURLEx(Microsoft::VisualStudio::Shell::Interop::IVsWebPreviewAction ^ pAction, System::String ^ lpszURL, System::UInt32 opt, int cx, int cy);

public:
 int PreviewURLEx(Microsoft::VisualStudio::Shell::Interop::IVsWebPreviewAction ^ pAction, Platform::String ^ lpszURL, unsigned int opt, int cx, int cy);

int PreviewURLEx(Microsoft::VisualStudio::Shell::Interop::IVsWebPreviewAction const & pAction, std::wstring const & lpszURL, unsigned int opt, int cx, int cy);

public int PreviewURLEx (Microsoft.VisualStudio.Shell.Interop.IVsWebPreviewAction pAction, string lpszURL, uint opt, int cx, int cy);

abstract member PreviewURLEx : Microsoft.VisualStudio.Shell.Interop.IVsWebPreviewAction * string * uint32 * int * int -> int

Public Function PreviewURLEx (pAction As IVsWebPreviewAction, lpszURL As String, opt As UInteger, cx As Integer, cy As Integer) As Integer

Parameters

pAction: IVsWebPreviewAction

[in] [in] Pointer to an IVsWebPreviewAction interface providing callbacks for the preview process. May be null.

lpszURL: String

[in] Pointer to a string containing the URL to be previewed.

opt: UInt32

[in] Integer. Options for displaying the preview window. A value from the __VSWBPREVIEWOPTIONS enumeration.

cx: Int32

[in] Integer. Horizontal position of upper left corner of preview. Can be zero (0), the default.

cy: Int32

[in] Integer. Vertical position of upper left corner of preview. Can be zero (0), the default.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsbrowse.idl:

HRESULT IVsWebPreview::PreviewURLEx(  
   [in] IVsWebPreviewAction* pAction,   
   [in] LPCOLESTR lpszURL,   
   [in] VSWBPREVIEWOPTIONS opt,   
   [in] int cx  
);

Applies to

Share via