ColorableItem::GetDefaultColors Method (array<COLORINDEX>^, array<COLORINDEX>^)

Visual Studio 2015

Returns the foreground and background color for this colorable item.

Namespace: Microsoft.VisualStudio.Package
Assembly: Microsoft.VisualStudio.Package.LanguageService.14.0 (in Microsoft.VisualStudio.Package.LanguageService.14.0.dll)

Syntax

C++

public:
virtual int GetDefaultColors(
	array<COLORINDEX>^ foreColor,
	array<COLORINDEX>^ backColor
)

Parameters

foreColor: Type: array<Microsoft.VisualStudio.TextManager.Interop::COLORINDEX>^
[in, out] If not null, this is where the COLORINDEX value for the text's foreground color is returned.

backColor: Type: array<Microsoft.VisualStudio.TextManager.Interop::COLORINDEX>^
[in, out] If not null, this is where the COLORINDEX value for the text's background color is returned.

Return Value

Type: System::Int32

If successful, returns S_OK; otherwise, returns an error code.

Implements

IVsColorableItem::GetDefaultColors(array<COLORINDEX>^, array<COLORINDEX>^)

Remarks

The colors returned as the ones passed to the constructor.

The base method always returns S_OK. The base method is tolerant of a null value for foreColor and backColor so only one of the colors can be retrieved as desired.