UnderlineGlyphRangeUnderlineTypeLineFragmentRectLineFragmentGlyphRangeContainerOrigin Method (glyphRange, underlineVal, lineRect, lineGlyphRange, containerOrigin)

Calculates subranges to be underlined for the glyphs in a given range and draws the underlining as appropriate.

Original signature is '- (void)underlineGlyphRange:(NSRange)glyphRange underlineType:(NSInteger)underlineVal lineFragmentRect:(NSRect)lineRect lineFragmentGlyphRange:(NSRange)lineGlyphRange containerOrigin:(NSPoint)containerOrigin'

Available in Mac OS X v10.0 and later.

Declaration Syntax

Visual Basic

Visual C++

public virtual void UnderlineGlyphRangeUnderlineTypeLineFragmentRectLineFragmentGlyphRangeContainerOrigin(
	NSRange glyphRange,
	NSInteger underlineVal,
	NSRect lineRect,
	NSRange lineGlyphRange,
	NSPoint containerOrigin
)

Public Overridable Sub UnderlineGlyphRangeUnderlineTypeLineFragmentRectLineFragmentGlyphRangeContainerOrigin ( _
	glyphRange As NSRange, _
	underlineVal As NSInteger, _
	lineRect As NSRect, _
	lineGlyphRange As NSRange, _
	containerOrigin As NSPoint _
)

public:
virtual void UnderlineGlyphRangeUnderlineTypeLineFragmentRectLineFragmentGlyphRangeContainerOrigin(
	NSRange glyphRange, 
	NSInteger underlineVal, 
	NSRect lineRect, 
	NSRange lineGlyphRange, 
	NSPoint containerOrigin
)

Parameters

glyphRange (NSRange): A range of glyphs, which must belong to a single line fragment rectangle (as returned by lineFragmentRectForGlyphAtIndex:effectiveRange:).

underlineVal (NSInteger): The style of underlining to draw. This value is a mask derived from the value for NSUnderlineStyleAttributeName—for example, (NSUnderlinePatternDash | NSUnderlineStyleThick | NSUnderlineByWordMask). Subclasses can define custom underlining styles.

lineRect (NSRect): The line fragment rectangle containing the glyphs to draw underlining for.

lineGlyphRange (NSRange): The range of all glyphs within that line fragment rectangle.

containerOrigin (NSPoint): The origin of the line fragment rectangle’s NSTextContainer in its NSTextView.

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.AppKit (Module: Monobjc.AppKit)