IVsStatusbar.SetColorText(String, UInt32, UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

Sets the status bar text with foreground and background colors.

public:
 int SetColorText(System::String ^ pszText, System::UInt32 crForeColor, System::UInt32 crBackColor);

public:
 int SetColorText(Platform::String ^ pszText, unsigned int crForeColor, unsigned int crBackColor);

int SetColorText(std::wstring const & pszText, unsigned int crForeColor, unsigned int crBackColor);

public int SetColorText (string pszText, uint crForeColor, uint crBackColor);

abstract member SetColorText : string * uint32 * uint32 -> int

Public Function SetColorText (pszText As String, crForeColor As UInteger, crBackColor As UInteger) As Integer

Parameters

pszText: String

[in] The text to display in the status text area.

crForeColor: UInt32

[in] The foreground color of pszText.

crBackColor: UInt32

[in] The background color of pszText.

Returns

Int32

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

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsStatusbar::SetColorText(  
   [in]LPCOLESTR pszText,  
   [in] COLORREF crForeColor,  
   [in] COLORREF crBackColor  
);

The method ignores the values of crForeColor and crBackColor and always sets the foreground color to white and the background color to dark blue.

Applies to