C# Class NppSharp.TextLocation

Represents a character position within the document.

Mostra file Open project: cmrazek/NppSharp Class Usage Examples

Public Properties

Property	Type	Description
Start	TextLocation

Public Methods

Method	Description
Equals ( object obj ) : bool	Compares equality between this object and another TextLocation.
FromByteOffset ( int offset ) : TextLocation	Find the text location for a byte offset. If the offset happens to land in the middle of a multi-byte character, this function will return a text location pointing to the character that begins just prior to the offset. If the offset is before the start of the document (a negative number), then a location pointing to the start of the document will be returned. If the offset is after the end of the document, then a location pointing to the end of the document will be returned.
GetHashCode ( ) : int	Returns a hash code for this object.
TextLocation ( TextLocation c ) : System.Linq	Copies a text location object.
TextLocation ( int line, int charPos ) : System.Linq	Creates a text location object with a specific line and column.
ToString ( ) : string	Returns a string representation of this location.
operator ( ) : TextLocation	Moves the text location by a specified number of characters.
operator ( ) : bool	Compares inequality between two TextLocation objects.

Method Details

Equals() public method

Compares equality between this object and another TextLocation.

public Equals ( object obj ) : bool
obj	object	The object that will be compared.
return	bool

FromByteOffset() public static method

Find the text location for a byte offset.

If the offset happens to land in the middle of a multi-byte character, this function will return a text location pointing to the character that begins just prior to the offset.

If the offset is before the start of the document (a negative number), then a location pointing to the start of the document will be returned.

If the offset is after the end of the document, then a location pointing to the end of the document will be returned.

public static FromByteOffset ( int offset ) : TextLocation
offset	int	The zero-based byte offset to find.
return	TextLocation

GetHashCode() public method

Returns a hash code for this object.

public GetHashCode ( ) : int
return	int

TextLocation() public method

Copies a text location object.

public TextLocation ( TextLocation c ) : System.Linq
c	TextLocation	The location to be copied.
return	System.Linq

TextLocation() public method

Creates a text location object with a specific line and column.

public TextLocation ( int line, int charPos ) : System.Linq
line	int	The one-based line number.
charPos	int	The one-based character position.
return	System.Linq

ToString() public method

Returns a string representation of this location.

public ToString ( ) : string
return	string

operator() public static method

Moves the text location by a specified number of characters.

public static operator ( ) : TextLocation
return	TextLocation

operator() public static method

Compares inequality between two TextLocation objects.

public static operator ( ) : bool
return	bool

Property Details

Start public_oe static_oe property

A location representing the start of the document (line 1, character position 1).

public static TextLocation,NppSharp Start
return	TextLocation