IVsUIShell2.CreateGradient Method

Article
2013-03-06

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

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Syntax

'Declaration
Function CreateGradient ( _
    GRADIENTTYPE As UInteger, _
    <OutAttribute> ByRef pGradient As IVsGradient _
) As Integer

int CreateGradient(
    uint GRADIENTTYPE,
    out IVsGradient pGradient
)

int CreateGradient(
    [InAttribute] unsigned int GRADIENTTYPE, 
    [OutAttribute] IVsGradient^% pGradient
)

abstract CreateGradient : 
        GRADIENTTYPE:uint32 * 
        pGradient:IVsGradient byref -> int

function CreateGradient(
    GRADIENTTYPE : uint, 
    pGradient : IVsGradient
) : int

Parameters

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

pGradient
Type: Microsoft.VisualStudio.Shell.Interop.IVsGradient%
[out] An IVsGradient object whose member functions can draw the specified gradient type.

Return Value

Type: System.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.

.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.

Share via