ColorableItem.GetDefaultColors Method

Article
2013-02-04

Returns the foreground and background color for this colorable item.

Namespace: Microsoft.VisualStudio.Package
Assemblies:   Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)
  Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)

Syntax

'Declaration
Public Overridable Function GetDefaultColors ( _
    foreColor As COLORINDEX(), _
    backColor As COLORINDEX() _
) As Integer

public virtual int GetDefaultColors(
    COLORINDEX[] foreColor,
    COLORINDEX[] backColor
)

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

abstract GetDefaultColors : 
        foreColor:COLORINDEX[] * 
        backColor:COLORINDEX[] -> int 
override GetDefaultColors : 
        foreColor:COLORINDEX[] * 
        backColor:COLORINDEX[] -> int

public function GetDefaultColors(
    foreColor : COLORINDEX[], 
    backColor : COLORINDEX[]
) : int

Parameters

foreColor
Type: array<Microsoft.VisualStudio.TextManager.Interop.COLORINDEX[]
[in, out] If not nulla null reference (Nothing in Visual Basic), 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 nulla null reference (Nothing in Visual Basic), 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.

.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