IVsPackageDefinedTextMarkerType.GetDefaultLineStyle Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns the default line attributes for a custom marker type.

public:
 int GetDefaultLineStyle(cli::array <Microsoft::VisualStudio::TextManager::Interop::COLORINDEX> ^ piLineColor, cli::array <Microsoft::VisualStudio::TextManager::Interop::LINESTYLE> ^ piLineIndex);

public:
 int GetDefaultLineStyle(Platform::Array <Microsoft::VisualStudio::TextManager::Interop::COLORINDEX> ^ piLineColor, Platform::Array <Microsoft::VisualStudio::TextManager::Interop::LINESTYLE> ^ piLineIndex);

int GetDefaultLineStyle(std::Array <Microsoft::VisualStudio::TextManager::Interop::COLORINDEX> const & piLineColor, std::Array <Microsoft::VisualStudio::TextManager::Interop::LINESTYLE> const & piLineIndex);

public int GetDefaultLineStyle (Microsoft.VisualStudio.TextManager.Interop.COLORINDEX[] piLineColor, Microsoft.VisualStudio.TextManager.Interop.LINESTYLE[] piLineIndex);

abstract member GetDefaultLineStyle : Microsoft.VisualStudio.TextManager.Interop.COLORINDEX[] * Microsoft.VisualStudio.TextManager.Interop.LINESTYLE[] -> int

Public Function GetDefaultLineStyle (piLineColor As COLORINDEX(), piLineIndex As LINESTYLE()) As Integer

Parameters

piLineColor: COLORINDEX[]

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

piLineIndex: LINESTYLE[]

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

Returns

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.

Applies to