SetOptionalContext Method (beforeToCheckSnippet, afterToCheckSnippet)

Keyoti RapidSpell Desktop .NET

Provides the engine with any helpful text around the text snippet which will be passed to the Check method. Implementation is not required.

Declaration Syntax

Visual Basic

Visual C++

public virtual void SetOptionalContext(
	string beforeToCheckSnippet,
	string afterToCheckSnippet
)

public virtual void SetOptionalContext(
	string beforeToCheckSnippet,
	string afterToCheckSnippet
)

Public Overridable Sub SetOptionalContext ( 
	beforeToCheckSnippet As String,
	afterToCheckSnippet As String
)

Public Overridable Sub SetOptionalContext ( 
	beforeToCheckSnippet As String,
	afterToCheckSnippet As String
)

public:
virtual void SetOptionalContext(
	String^ beforeToCheckSnippet, 
	String^ afterToCheckSnippet
)

public:
virtual void SetOptionalContext(
	String^ beforeToCheckSnippet, 
	String^ afterToCheckSnippet
)

abstract SetOptionalContext : 
        beforeToCheckSnippet : string * 
        afterToCheckSnippet : string -> unit 
override SetOptionalContext : 
        beforeToCheckSnippet : string * 
        afterToCheckSnippet : string -> unit

abstract SetOptionalContext : 
        beforeToCheckSnippet : string * 
        afterToCheckSnippet : string -> unit 
override SetOptionalContext : 
        beforeToCheckSnippet : string * 
        afterToCheckSnippet : string -> unit

Parameters

beforeToCheckSnippet (String): Any text before the to check snippet

afterToCheckSnippet (String): Any text after the snippet

Remarks

Eg. if the document contains "This is an an example piece." and Check will be called on "an example piece", then the fact that 'an' is duplicated will not be detected. Therefore, by passing "This is an " to beforeToCheckSnippet the checker will be able to detect that an is duplicated.

Assembly: Keyoti.RapidSpell.NET4 (Module: Keyoti.RapidSpell.NET4.dll) Version: 6.2.21.412