CorrectionMode Enumeration

Article
10/19/2012

Specifies the correction modes of the Tablet PC Input Panel.

Namespace: Microsoft.Ink.TextInput
Assembly: Microsoft.Ink (in Microsoft.Ink.dll)

Syntax

'Declaration
Public Enumeration CorrectionMode
'Usage
Dim instance As CorrectionMode

public enum CorrectionMode

public enum class CorrectionMode

public enum CorrectionMode

Members

	Member name	Description
	NotVisible	The Input Panel and the correction comb are not visible.
	PreInsertion	The correction comb is shown in the pre-insertion mode.
	PostInsertionCollapsed	The correction comb is shown in the post-insertion collapsed mode.
	PostInsertionExpanded	The correction comb is shown in the post-insertion expanded mode.

Remarks

When used with the CurrentCorrectionMode property it allows an application to determine the current configuration of the correction comb.

The TextInputPanel object provides detailed information about and control of the correction mode. Knowing the correction mode helps applications determine the current size of the Input Panel. Controlling how the post-insertion correction expands in an application is one way to customize the correction experience in an application.

There are two basic modes in which the correction comb may appear; pre-insertion and post-insertion. The pre-insertion correction comb corrects text before inserting it into an application. Activate the pre-insertion mode by tapping on the pending text that appears below the baseline in the Writing Pad as the user inks.

The post-insertion correction comb is used to correct text after it has been inserted into an application. Activate the post-insertion mode by placing the insertion point in or selecting text that was previously inserted.

post-insertion correction comb may appear either above or below Input Panel or it may appear collapsed or expanded. In the collapsed state the post-insertion correction comb only shows a list of alternates. In the expanded state it includes both the alternates and an area to rewrite the word.

Examples

The following example demonstrates the use of CorrectionMode. tip_CorrectionModeChanging is an event handler for the CorrectionModeChanging event. The tip object is an instance of TextInputPanel. The OldMode and CurrentCorrectionMode values are used to set the TextBox.Text property of a TextBox, outputTextBox. OldMode and CurrentCorrectionMode contain one of the CorrectionMode values.

Sub tip_CorrectionModeChanging(ByVal sender As Object, ByVal e As CorrectionModeChangeEventArgs)
    outputTextBox.Text += "Old Correction Mode is " + e.OldMode.ToString() + Environment.NewLine
    outputTextBox.Text += "Current Correction Mode is " + tip.CurrentCorrectionMode.ToString() + Environment.NewLine
End Sub

void tip_CorrectionModeChanging(object sender, CorrectionModeChangeEventArgs e)
{
    outputTextBox.Text += "Old Correction Mode is " + e.OldMode + Environment.NewLine;
    outputTextBox.Text += "Current Correction Mode is " + tip.CurrentCorrectionMode + Environment.NewLine;
}

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.0

Share via