CheckGrammarOfStringStartingAtLanguageWrapInSpellDocumentWithTagDetails Method (string, start, language, wrap, documentTag, outDetails)

Initiates a grammatical analysis of a given string.

Original signature is '- (NSRange)checkGrammarOfString:(NSString *)string startingAt:(NSInteger)start language:(NSString *)language wrap:(BOOL)wrap inSpellDocumentWithTag:(NSInteger)documentTag details:(NSArray **)outDetails'

Available in Mac OS X v10.5 and later.

Declaration Syntax

Visual Basic

Visual C++

public virtual NSRange CheckGrammarOfStringStartingAtLanguageWrapInSpellDocumentWithTagDetails(
	NSString string,
	NSInteger start,
	NSString language,
	bool wrap,
	NSInteger documentTag,
	out NSArray outDetails
)

Public Overridable Function CheckGrammarOfStringStartingAtLanguageWrapInSpellDocumentWithTagDetails ( _
	string As NSString, _
	start As NSInteger, _
	language As NSString, _
	wrap As Boolean, _
	documentTag As NSInteger, _
	<OutAttribute> ByRef outDetails As NSArray _
) As NSRange

public:
virtual NSRange CheckGrammarOfStringStartingAtLanguageWrapInSpellDocumentWithTagDetails(
	NSString^ string, 
	NSInteger start, 
	NSString^ language, 
	bool wrap, 
	NSInteger documentTag, 
	[OutAttribute] NSArray^% outDetails
)

Parameters

string (NSString): String to analyze.

start (NSInteger): Location within string at which to start the analysis.

language (NSString): Language use in string. When nil, the language selected in the Spelling panel is used.

wrap (Boolean): YES to specify that the analysis continue to the beginning of string when the end is reached.

documentTag (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.

outDetails (NSArray%): On output, dictionaries describing grammar-analysis details within the flagged grammatical unit. See the NSSpellServer class for information about these dictionaries.

Return Value

Location of the first flagged grammatical unit.

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)