Insert Property, SftMask Object

Defines the current insert/overtype mode.

Syntax

Get

Put

object

A SftMask object.

Boolean

Defines the current insert/overtype mode.

Comments

The Insert property defines the current insert/overtype mode.

Overtype mode is visually indicated by the selection which is automatically extended to include one character position (if possible).

The user switches between insert and overtype mode using the Insert key. The application can switch between modes using the Insert property.

The InputMode property is used to define the control's insert/overtype mode behavior.

To allow an application to display the current insert/overtype mode, e.g., in a status bar, the InputModeUpdate event is used to notify the application of any mode change that may occur, through user interaction, input focus change or application driven changes. By responding to the InputModeUpdate event, an application is guaranteed to be notified of the current input mode.

Examples

VB.NET View entire sample code

Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
    AxSftMask1.Caption.Text = "Insert->"
    AxSftMask1.InputMode = SftMaskInputModeConstants.inputSftMaskInsert
    AxSftMask2.Caption.Text = "Overtype->"
    AxSftMask2.InputMode = SftMaskInputModeConstants.inputSftMaskOvertype
End Sub

Private Sub AxSftMask1_InputModeUpdate(ByVal sender As Object, ByVal e As AxSftMaskLib70._ISftMaskEvents_InputModeUpdateEvent) Handles AxSftMask1.InputModeUpdate
    Label1.Text = e.insertMode
End Sub

Private Sub AxSftMask2_InputModeUpdate(ByVal sender As Object, ByVal e As AxSftMaskLib70._ISftMaskEvents_InputModeUpdateEvent) Handles AxSftMask2.InputModeUpdate
    Label1.Text = e.insertMode
End Sub

VB6 View entire sample code

Private Sub Form_Load()
    SftMask1.Caption.Text = "Insert->"
    SftMask1.InputMode = inputSftMaskInsert
    SftMask2.Caption.Text = "Overtype->"
    SftMask2.InputMode = inputSftMaskOvertype
End Sub

Private Sub SftMask1_InputModeUpdate(ByVal InsertMode As Boolean)
    Label1.Caption = InsertMode
End Sub

Private Sub SftMask2_InputModeUpdate(ByVal InsertMode As Boolean)
    Label1.Caption = InsertMode
End Sub

C# View entire sample code

private void Form1_Load(object sender, System.EventArgs e)
{
    axSftMask1.Caption.Text = "Insert->";
    axSftMask1.InputMode = SftMaskInputModeConstants.inputSftMaskInsert;
    axSftMask2.Caption.Text = "Overtype->";
    axSftMask2.InputMode = SftMaskInputModeConstants.inputSftMaskOvertype;
}

private void axSftMask1_InputModeUpdate(object sender, AxSftMaskLib70._ISftMaskEvents_InputModeUpdateEvent e)
{
    label1.Text = e.insertMode.ToString();
}

private void axSftMask2_InputModeUpdate(object sender, AxSftMaskLib70._ISftMaskEvents_InputModeUpdateEvent e)
{
    label1.Text = e.insertMode.ToString();

C++ View entire sample code

{
    CDialog::OnInitDialog();

    m_pMask1 = m_Mask1.GetControlUnknown();
    _ASSERT(m_pMask1 != NULL);
    m_pMask2 = m_Mask2.GetControlUnknown();
    _ASSERT(m_pMask2 != NULL);

    m_pMask1->Caption->Text = _T("Insert->");
    m_pMask1->InputMode = inputSftMaskInsert;
    m_pMask2->Caption->Text = _T("Overtype->");
    m_pMask2->InputMode = inputSftMaskOvertype;

    return TRUE;
}

See Also SftMask Object | Object Hierarchy