C# Class _3PA.Npp.Marker

Represents a margin marker in a Scintilla control.

Public Methods

Method	Description
DefineRgbaImage ( Bitmap image ) : void	Sets the marker symbol to a custom image. Calling this method will also update the Symbol property to MarkerSymbol.RgbaImage.
Marker ( int index ) : System	Initializes a new instance of the Marker class There are 32 markers, numbered 0 to MARKER_MAX (31) Marker numbers 0 to 24 have no pre-defined function; you can use them to mark syntax errors and so on..
MarkerDeleteAll ( int marker ) : void	Removes the specified marker from all lines.
SetAlpha ( int alpha ) : void	Sets the foreground alpha transparency for markers that are drawn in the content area. See the remarks on the SetBackColor method for a full explanation of when a marker can be drawn in the content area.
SetBackColor ( Color color ) : void	Sets the background color of the marker. The background color of the whole line will be drawn in the color specified when the marker is not visible because it is hidden by a Margin.Mask or the Margin.Width is zero.
SetBackSelectedColor ( Color color ) : void	This message sets the highlight background colour of a marker number when its folding block is selected. The default colour is #FF0000
SetForeColor ( Color color ) : void	Sets the foreground color of the marker.

Method Details

DefineRgbaImage() public method

Sets the marker symbol to a custom image.

Calling this method will also update the Symbol property to MarkerSymbol.RgbaImage.

public DefineRgbaImage ( Bitmap image ) : void
image	System.Drawing.Bitmap	The Bitmap to use as a marker symbol.
return	void

Marker() public method

Initializes a new instance of the Marker class There are 32 markers, numbered 0 to MARKER_MAX (31) Marker numbers 0 to 24 have no pre-defined function; you can use them to mark syntax errors and so on..

public Marker ( int index ) : System
index	int	The index of this style within the MarkerCollection that created it.
return	System

MarkerDeleteAll() public static method

Removes the specified marker from all lines.

public static MarkerDeleteAll ( int marker ) : void
marker	int	The zero-based Marker index to remove from all lines, or -1 to remove all markers from all lines.
return	void

SetAlpha() public method

Sets the foreground alpha transparency for markers that are drawn in the content area.

See the remarks on the SetBackColor method for a full explanation of when a marker can be drawn in the content area.

public SetAlpha ( int alpha ) : void
alpha	int	The alpha transparency ranging from 0 (completely transparent) to 255 (no transparency).
return	void

SetBackColor() public method

Sets the background color of the marker.

The background color of the whole line will be drawn in the color specified when the marker is not visible because it is hidden by a Margin.Mask or the Margin.Width is zero.

public SetBackColor ( Color color ) : void
color	Color	The Marker background Color. The default is White.
return	void

SetBackSelectedColor() public method

This message sets the highlight background colour of a marker number when its folding block is selected. The default colour is #FF0000

public SetBackSelectedColor ( Color color ) : void
color	Color
return	void

SetForeColor() public method

Sets the foreground color of the marker.

public SetForeColor ( Color color ) : void
color	Color	The Marker foreground Color. The default is Black.
return	void