CheckSpellingOfStringStartingAtLanguageWrapInSpellDocumentWithTagWordCount Method (stringToCheck, startingOffset, language, wrapFlag, tag, wordCount)

Starts the search for a misspelled word in a string starting at specified offset within the string.

Original signature is '- (NSRange)checkSpellingOfString:(NSString *)stringToCheck startingAt:(NSInteger)startingOffset language:(NSString *)language wrap:(BOOL)wrapFlag inSpellDocumentWithTag:(NSInteger)tag wordCount:(NSInteger *)wordCount'

Available in Mac OS X v10.0 and later.

Declaration Syntax

Visual Basic

Visual C++

public virtual NSRange CheckSpellingOfStringStartingAtLanguageWrapInSpellDocumentWithTagWordCount(
	NSString stringToCheck,
	NSInteger startingOffset,
	NSString language,
	bool wrapFlag,
	NSInteger tag,
	out NSInteger wordCount
)

Public Overridable Function CheckSpellingOfStringStartingAtLanguageWrapInSpellDocumentWithTagWordCount ( _
	stringToCheck As NSString, _
	startingOffset As NSInteger, _
	language As NSString, _
	wrapFlag As Boolean, _
	tag As NSInteger, _
	<OutAttribute> ByRef wordCount As NSInteger _
) As NSRange

public:
virtual NSRange CheckSpellingOfStringStartingAtLanguageWrapInSpellDocumentWithTagWordCount(
	NSString^ stringToCheck, 
	NSInteger startingOffset, 
	NSString^ language, 
	bool wrapFlag, 
	NSInteger tag, 
	[OutAttribute] NSInteger% wordCount
)

Parameters

stringToCheck (NSString): The string object containing the words to spellcheck.

startingOffset (NSInteger): The offset within stringToCheck at which to begin spellchecking.

language (NSString): The language of the words in the string. If language is nil, or if you obtain the value by sending language to self, the current selection in the Spelling panel’s pop-up menu is used. Do not pass in an empty string for language.

wrapFlag (Boolean): YES to indicate that spell checking should continue at the beginning of the string when the end of the string is reached; NO to indicate that spellchecking should stop at the end of the document.

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.

wordCount (NSInteger%): Returns by indirection a count of the words spell-checked up to and including the first error (if any), or -1 if the spell checker fails or does not support word counting. Specify NULL if you do not want this word count.

Return Value

The range of the first misspelled word and optionally (and by reference) the count of words spellchecked in the string in wordCount.

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)