CharacterIndexForPointTrackingInMarkedRange Method (point, mappingMode, inMarkedRange)

Returns the location in the text document that maps to a global point.

Original signature is '- (NSInteger)characterIndexForPoint:(NSPoint)point tracking:(IMKLocationToOffsetMappingMode)mappingMode inMarkedRange:(BOOL*)inMarkedRange'

Available in Mac OS X v10.5 and later.

Declaration Syntax

Visual Basic

Visual C++

NSInteger CharacterIndexForPointTrackingInMarkedRange(
	NSPoint point,
	IMKLocationToOffsetMappingMode mappingMode,
	out NSRect inMarkedRange
)

Function CharacterIndexForPointTrackingInMarkedRange ( _
	point As NSPoint, _
	mappingMode As IMKLocationToOffsetMappingMode, _
	<OutAttribute> ByRef inMarkedRange As NSRect _
) As NSInteger

NSInteger CharacterIndexForPointTrackingInMarkedRange(
	NSPoint point, 
	IMKLocationToOffsetMappingMode mappingMode, 
	[OutAttribute] NSRect% inMarkedRange
)

Parameters

point (NSPoint): The point to map. This is a global point, typically from a mouse down operation.

mappingMode (IMKLocationToOffsetMappingMode): The mapping mode. If the input method is tracking the mouse, the mode should be kIMKMouseTrackingMode. If the input method simply wants to map a screen position to an offset, than set the mode to kIMKNearestBoundaryMode.

inMarkedRange (NSRect%): On return, if the point is inside the text body and inside the marked range, this parameter is set to YES. Otherwise, if the point is outside the marked range, then on return this parameter is set to NO.

Return Value

The location in the text document.

Version Information

Available in Monobjc Bridge: 10.6 (For Mac OS X 10.6 and later), 10.5 (For Mac OS X 10.5 and later)

Assembly: Monobjc.InputMethodKit (Module: Monobjc.InputMethodKit)