IVsStatusbar.SetColorText(String, UInt32, UInt32) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

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.