• Article

ColorableItem.GetDefaultColors Method

Defines the default background and foreground colors for a custom ColorableItem object.

Namespace:  RadLangSvc
Assembly:  RadLangSvc.VS (in RadLangSvc.VS.dll)

Syntax

'Declaration
Public Function GetDefaultColors ( _
    piForeground As COLORINDEX(), _
    piBackground As COLORINDEX() _
) As Integer
'Usage
Dim instance As ColorableItem
Dim piForeground As COLORINDEX()
Dim piBackground As COLORINDEX()
Dim returnValue As Integer

returnValue = instance.GetDefaultColors(piForeground, _
    piBackground)

public int GetDefaultColors(
    COLORINDEX[] piForeground,
    COLORINDEX[] piBackground
)

public:
virtual int GetDefaultColors(
    array<COLORINDEX>^ piForeground, 
    array<COLORINDEX>^ piBackground
) sealed

abstract GetDefaultColors : 
        piForeground:COLORINDEX[] * 
        piBackground:COLORINDEX[] -> int 
override GetDefaultColors : 
        piForeground:COLORINDEX[] * 
        piBackground:COLORINDEX[] -> int 

public final function GetDefaultColors(
    piForeground : COLORINDEX[], 
    piBackground : COLORINDEX[]
) : int

Parameters

  • piForeground
    Type: array<COLORINDEX[]
    A array<COLORINDEX[] array that returns the foreground color.
  • piBackground
    Type: array<COLORINDEX[]
    A array<COLORINDEX[] array that returns the background color.

Return Value

Type: System.Int32
An integer value that specifies a defined result. If the method succeeds, it returns S_OK. If it fails, it throws an appropriate exception.

Implements

IVsColorableItemGetDefaultColors(array<COLORINDEX[], array<COLORINDEX[])