IVsPackageDefinedTextMarkerType::GetDefaultLineStyle Method (array<COLORINDEX>^, array<LINESTYLE>^)

Visual Studio 2015

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

C++

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

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:

C++

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 T:Microsoft.Office.Interop.Excel.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.