IVsPackageDefinedTextMarkerType.GetDefaultLineStyle Method

Article
09/25/2012

Returns the default line attributes for a custom marker type.

Namespace: Microsoft.VisualStudio.TextManager.Interop
Assembly: Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

Syntax

'Declaration
Function GetDefaultLineStyle ( _
    <OutAttribute> piLineColor As COLORINDEX(), _
    <OutAttribute> piLineIndex As LINESTYLE() _
) As Integer

'Usage
Dim instance As IVsPackageDefinedTextMarkerType 
Dim piLineColor As COLORINDEX()
Dim piLineIndex As LINESTYLE()
Dim returnValue As Integer 

returnValue = instance.GetDefaultLineStyle(piLineColor, _
    piLineIndex)

int GetDefaultLineStyle(
    COLORINDEX[] piLineColor,
    LINESTYLE[] piLineIndex
)

int GetDefaultLineStyle(
    [OutAttribute] array<COLORINDEX>^ piLineColor, 
    [OutAttribute] array<LINESTYLE>^ piLineIndex
)

function GetDefaultLineStyle(
    piLineColor : COLORINDEX[], 
    piLineIndex : LINESTYLE[]
) : int

Parameters

piLineColor
Type: array<Microsoft.VisualStudio.TextManager.Interop.COLORINDEX[]

[out] Pointer to the default line color. For a list of piLineColor values, see COLORINDEX.

piLineIndex
Type: array<Microsoft.VisualStudio.TextManager.Interop.LINESTYLE[]

[out] Pointer to the default line style. For a list of piLineIndex values, see LINESTYLE.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From textmgr.idl:

HRESULT IVsPackageDefinedTextMarkerType::GetDefaultLineStyle(
   [out] COLORINDEX *piLineColor, 
   [out] LINESTYLE *piLineIndex
);

The environment only calls this method if you specify a value of MV_LINE or MV_BORDER for your marker type. Use this method to specify the default COLORINDEX and XlLineStyle values you want. The following values are the currently supported line styles:

LI_SOLID — simple, solid line. Currently only supported by MV_BORDER.

LI_SQUIGGLY — jagged line. Currently only supported by MV_LINE.

LI_HATCH — dotted line. Currently only supported by MV_BORDER.

.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