HyphenationFactorForGlyphAtIndex Method (glyphIndex)

Returns the hyphenation factor in effect at a specified location.

Original signature is '- (float)hyphenationFactorForGlyphAtIndex:(NSUInteger)glyphIndex'

Available in Mac OS X v10.4 and later.

Declaration Syntax

Visual Basic

Visual C++

public virtual float HyphenationFactorForGlyphAtIndex(
	NSUInteger glyphIndex
)

Public Overridable Function HyphenationFactorForGlyphAtIndex ( _
	glyphIndex As NSUInteger _
) As Single

public:
virtual float HyphenationFactorForGlyphAtIndex(
	NSUInteger glyphIndex
)

Parameters

glyphIndex (NSUInteger): The index of the glyph position to examine.

Return Value

The hyphenation factor in effect at glyphIndex. The hyphenation factor is a value ranging from 0.0 to 1.0 that controls when hyphenation is attempted. By default, the value is 0.0, meaning hyphenation is off. A factor of 1.0 causes hyphenation to be attempted always.

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)