IVsUIShell2.CreateGradient(UInt32, IVsGradient) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

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.

Returns an IVsGradient object on which to draw a gradient of a specified type.

public:
 int CreateGradient(System::UInt32 GRADIENTTYPE, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsGradient ^ % pGradient);

public:
 int CreateGradient(unsigned int GRADIENTTYPE, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsGradient ^ &  pGradient);

int CreateGradient(unsigned int GRADIENTTYPE, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsGradient const & & pGradient);

public int CreateGradient (uint GRADIENTTYPE, out Microsoft.VisualStudio.Shell.Interop.IVsGradient pGradient);

abstract member CreateGradient : uint32 * IVsGradient -> int

Public Function CreateGradient (GRADIENTTYPE As UInteger, ByRef pGradient As IVsGradient) As Integer

Parameters

GRADIENTTYPE: UInt32

[in] The type of gradient to be painted, specified by a value from the __GRADIENTTYPE enumeration.

pGradient: IVsGradient

[out] An IVsGradient object whose member functions can draw the specified gradient type.

Returns

Int32

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

Remarks

COM Signature

From vsshell80.idl:

HRESULT IVsUIShell2::CreateGradient(  
   [in]  GRADIENTTYPE   gradientType,  
   [out] IVsGradient ** pGradient  
);

Unmanaged VSPackages are responsible for releasing the IVsGradient Interface.

For a full discussion on best practices for choosing the correct types of gradients when designing a user interface see The Visual Studio UI Guidelines document.

Applies to