RequestCheckingOfStringRangeTypesOptionsInSpellDocumentWithTagCompletionHandler Method (stringToCheck, range, checkingTypes, options, tag, completionHandler)

Requests that the string be checked in the background.

Original signature is '- (NSInteger)requestCheckingOfString:(NSString *)stringToCheck range:(NSRange)range types:(NSTextCheckingTypes)checkingTypes options:(NSDictionary *)options inSpellDocumentWithTag:(NSInteger)tag completionHandler:(void (^)(NSInteger sequenceNumber, NSArray *results, NSOrthography *orthography, NSInteger wordCount))completionHandler'

Available in Mac OS X v10.6 and later.

Declaration Syntax

Visual Basic

Visual C++

public virtual NSInteger RequestCheckingOfStringRangeTypesOptionsInSpellDocumentWithTagCompletionHandler(
	NSString stringToCheck,
	NSRange range,
	NSTextCheckingTypes checkingTypes,
	NSDictionary options,
	NSInteger tag,
	Action<NSInteger, NSArray, NSOrthography, int> completionHandler
)

Public Overridable Function RequestCheckingOfStringRangeTypesOptionsInSpellDocumentWithTagCompletionHandler ( _
	stringToCheck As NSString, _
	range As NSRange, _
	checkingTypes As NSTextCheckingTypes, _
	options As NSDictionary, _
	tag As NSInteger, _
	completionHandler As Action(Of NSInteger, NSArray, NSOrthography, Integer) _
) As NSInteger

public:
virtual NSInteger RequestCheckingOfStringRangeTypesOptionsInSpellDocumentWithTagCompletionHandler(
	NSString^ stringToCheck, 
	NSRange range, 
	NSTextCheckingTypes checkingTypes, 
	NSDictionary^ options, 
	NSInteger tag, 
	Action<NSInteger, NSArray^, NSOrthography^, int>^ completionHandler
)

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.

completionHandler (Action<(Of <(<'NSInteger, NSArray, NSOrthography, Int32>)>)>): The completion handler block object will be called (in an arbitrary context) when results are available, with the sequence number and results.

Return Value

The return value is a monotonically increasing sequence number that can be used to keep track of requests in flight.

Version Information

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

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