C# Class _3PA.Npp.Indicator

Represents an indicator in a Scintilla control.

Public Methods

Method	Description
Add ( int start, int end ) : void	Adds the indicator and IndicatorValue value to the specified range of text.
Clear ( int start, int end ) : void	Clears the indicator and IndicatorValue value from the specified range of text.
DefinedAt ( int pos ) : bool	Returns true if the indicator is present at the given position
End ( int position ) : int	Find the end of an indicator range from a position Can be used to iterate through the document to discover all the indicator positions. Specifying a position which is not filled with this indicator will cause this method to return the end position of the range where this indicator is not in use (the negative space). If this indicator is not in use anywhere within the document the return value will be 0.
FindRanges ( ) : List	List of points(start, end) that represents the range were the given indicator has been found
Indicator ( int index ) : System	Initializes a new instance of the Indicator class.
IndicatorAllOnFor ( int position ) : uint	Returns a bitmap representing the 32 indicators in use at the specified position.
IndicatorClearRange ( int position, int length ) : void	Removes the IndicatorCurrent indicator (and user-defined value) from the specified range of text.
IndicatorFillRange ( int position, int length ) : void	Adds the IndicatorCurrent indicator and IndicatorValue value to the specified range of text.
Start ( int position ) : int	Find the start of an indicator range from a position Can be used to iterate through the document to discover all the indicator positions. Specifying a position which is not filled with this indicator will cause this method to return the start position of the range where this indicator is not in use (the negative space). If this indicator is not in use anywhere within the document the return value will be 0.
ValueAt ( int position ) : int	Returns the user-defined value for the indicator at the specified position.

Method Details

Add() public method

Adds the indicator and IndicatorValue value to the specified range of text.

public Add ( int start, int end ) : void
start	int
end	int
return	void

Clear() public method

Clears the indicator and IndicatorValue value from the specified range of text.

public Clear ( int start, int end ) : void
start	int
end	int
return	void

DefinedAt() public method

Returns true if the indicator is present at the given position

public DefinedAt ( int pos ) : bool
pos	int
return	bool

End() public method

Find the end of an indicator range from a position Can be used to iterate through the document to discover all the indicator positions.

Specifying a position which is not filled with this indicator will cause this method to return the end position of the range where this indicator is not in use (the negative space). If this indicator is not in use anywhere within the document the return value will be 0.

public End ( int position ) : int
position	int	A zero-based document position using this indicator.
return	int

FindRanges() public method

List of points(start, end) that represents the range were the given indicator has been found

public FindRanges ( ) : List
return	List

Indicator() public method

Initializes a new instance of the Indicator class.

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

IndicatorAllOnFor() public static method

Returns a bitmap representing the 32 indicators in use at the specified position.

public static IndicatorAllOnFor ( int position ) : uint
position	int	The zero-based character position within the document to test.
return	uint

IndicatorClearRange() public static method

Removes the IndicatorCurrent indicator (and user-defined value) from the specified range of text.

public static IndicatorClearRange ( int position, int length ) : void
position	int	The zero-based character position within the document to start clearing.
length	int	The number of characters to clear.
return	void

IndicatorFillRange() public static method

Adds the IndicatorCurrent indicator and IndicatorValue value to the specified range of text.

public static IndicatorFillRange ( int position, int length ) : void
position	int	The zero-based character position within the document to start filling.
length	int	The number of characters to fill.
return	void

Start() public method

Find the start of an indicator range from a position Can be used to iterate through the document to discover all the indicator positions.

Specifying a position which is not filled with this indicator will cause this method to return the start position of the range where this indicator is not in use (the negative space). If this indicator is not in use anywhere within the document the return value will be 0.

public Start ( int position ) : int
position	int	A zero-based document position using this indicator.
return	int

ValueAt() public method

Returns the user-defined value for the indicator at the specified position.

public ValueAt ( int position ) : int
position	int	The zero-based document position to get the indicator value for.
return	int