AttributesForCharacterIndexLineHeightRectangle Method (index, lineRect)

Returns a dictionary of text attributes for the text at the provided character index.

Original signature is '- (NSDictionary*)attributesForCharacterIndex:(NSUInteger)index lineHeightRectangle:(NSRect*)lineRect'

Available in Mac OS X v10.5 and later.

Declaration Syntax

Visual Basic

Visual C++

NSDictionary AttributesForCharacterIndexLineHeightRectangle(
	NSUInteger index,
	out NSRect lineRect
)

Function AttributesForCharacterIndexLineHeightRectangle ( _
	index As NSUInteger, _
	<OutAttribute> ByRef lineRect As NSRect _
) As NSDictionary

NSDictionary^ AttributesForCharacterIndexLineHeightRectangle(
	NSUInteger index, 
	[OutAttribute] NSRect% lineRect
)

Parameters

index (NSUInteger): The character index whose attributes you want to retrieve. The index is relative to the inline session. Note that if there is no inline session the value of index should be 0, which indicates that the information should be taken from the current selection.

lineRect (NSRect%): On return, a rectangle that frames a one-pixel wide rectangle with the height of the line. This rectangle is oriented the same way the line is oriented.

Return Value

A dictionary that contains the text attributes for the text at the provided character index. The returned NSDictionary object is an autoreleased object. The attributes include the CTFontRef for the text at that index, and the text orientation. The text orientation is indicated by an NSNumber whose value is 0 if the text is vertically oriented and 1 if the text is horizontally oriented. The key for this value is IMKTextOrientationKey.

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)