CheckStringRangeTypesOptionsInSpellDocumentWithTagOrthographyWordCount Method (stringToCheck, range, checkingTypes, options, tag, orthography, wordCount)

Requests unified text checking for the given range of the given string.

Original signature is '- (NSArray *)checkString:(NSString *)stringToCheck range:(NSRange)range types:(NSTextCheckingTypes)checkingTypes options:(NSDictionary *)options inSpellDocumentWithTag:(NSInteger)tag orthography:(NSOrthography **)orthography wordCount:(NSInteger *)wordCount'

Available in Mac OS X v10.6 and later.

Declaration Syntax

Visual Basic

Visual C++

public virtual NSArray CheckStringRangeTypesOptionsInSpellDocumentWithTagOrthographyWordCount(
	NSString stringToCheck,
	NSRange range,
	NSTextCheckingTypes checkingTypes,
	NSDictionary options,
	NSInteger tag,
	out NSOrthography orthography,
	out NSInteger wordCount
)

Public Overridable Function CheckStringRangeTypesOptionsInSpellDocumentWithTagOrthographyWordCount ( _
	stringToCheck As NSString, _
	range As NSRange, _
	checkingTypes As NSTextCheckingTypes, _
	options As NSDictionary, _
	tag As NSInteger, _
	<OutAttribute> ByRef orthography As NSOrthography, _
	<OutAttribute> ByRef wordCount As NSInteger _
) As NSArray

public:
virtual NSArray^ CheckStringRangeTypesOptionsInSpellDocumentWithTagOrthographyWordCount(
	NSString^ stringToCheck, 
	NSRange range, 
	NSTextCheckingTypes checkingTypes, 
	NSDictionary^ options, 
	NSInteger tag, 
	[OutAttribute] NSOrthography^% orthography, 
	[OutAttribute] NSInteger% wordCount
)

Parameters

stringToCheck (NSString): The string to check.

range (NSRange): The range of the string to check.

checkingTypes (NSTextCheckingTypes): The type of checking to be performed. The possible constants are listed in NSTextCheckingType and can be combined using the C bit-wise OR operator to perform multiple checks at the same time.

options (NSDictionary): The options dictionary specifying the types of checking to perform. See “Spell Checking Option Dictionary Keys” for the possible keys and expected values.

tag (NSInteger): An identifier unique within the application used to inform the spell checker which document that text is associated, potentially for many purposes, not necessarily just for ignored words. A value of 0 can be passed in for text not associated with a particular document.

orthography (NSOrthography%): Returns by-reference, the orthography of the range of the string. See NSOrthography for more information.

wordCount (NSInteger%): Returns by-reference, the word count for the range of the string.

Return Value

An array of NSTextCheckingResult objects describing particular items found during checking and their individual ranges, sorted by range origin, then range end, then result type.

Version Information

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

Assembly: Monobjc.AppKit (Module: Monobjc.AppKit)