PenInputPanel.Visible Property

  • Article

PenInputPanel.Visible Property

Gets or sets a value that indicates whether the PenInputPanel object is visible.

Definition

Visual Basic .NET Public Property Visible As Boolean
C# public bool Visible { get; set; }
Managed C++ public: __property bool* get_Visible();
public: __property void set_Visible(bool*);

Property Value

System.Boolean. Whether the pen input panel is visible.

This property is read/write.

true The pen input panel is visible.
false Default. The pen input panel is not visible.

Exceptions

COMException Leave Site:
ObjectDisposedException Leave Site:

Remarks

You can set the Visible property to true only when the attached control has focus. Otherwise, setting this property generates an error.

The Visible property does not apply to the Tablet PC Input Panel hover target.

Examples

[C#]

This C# example creates a PenInputPanel object, thePenInputPanel, and attaches it to an InkEdit control, theInkEdit. It then attaches a VisibleChanged event handler, VisibleChanged_Event. The event handler adds a sentence to the content of theInkEdit if the Visible property is set to true.

//...

// Delcare the PenInputPanel object
PenInputPanel thePenInputPanel;

public Form1()
{
    // Required for Windows Form Designer support
    InitializeComponent();

    // Create and attach the new PenInputPanel to an InkEdit control.
    thePenInputPanel = new PenInputPanel(theInkEdit);

    // Add a VisibleChanged event handler
    thePenInputPanel.VisibleChanged +=
        new PenInputPanelVisibleChangedEventHandler(VisibleChanged_Event);
}

//...

public void VisibleChanged_Event(object sender,
                                 PenInputPanelVisibleChangedEventArgs e)
{
    // Make sure the object that generated
    // the event is a PenInputPanel object
    if (sender is PenInputPanel)
    {
        PenInputPanel theSenderPanel = (PenInputPanel)sender;

        // When the panel has become visible...
        if (theSenderPanel.Visible)
        {
            // Display a message in the attached edit control
            theSenderPanel.AttachedEditControl.Text += "The panel is visible." + Environment.NewLine;
        }
    }
}

[Visual Basic .NET]

This Microsoft® Visual Basic® .NET example creates a PenInputPanel object, thePenInputPanel, and attaches it to an InkEdit control, theInkEdit. It then attaches a VisibleChanged event handler, VisibleChanged_Event. The event handler adds a sentence to the content of theInkEdit if the Visible property is set to true.

'...

' Declare the PenInputPanel object
Dim thePenInputPanel As PenInputPanel

Public Sub New()
    MyBase.New()

    ' Required for Windows Form Designer support
    InitializeComponent()

    ' Create and attach the new PenInputPanel to an InkEdit control.
    thePenInputPanel = New PenInputPanel(theInkEdit)

    ' Add a VisibleChanged event handler
    AddHandler thePenInputPanel.VisibleChanged, _
               AddressOf VisibleChanged_Event
End Sub 'New

'...

Public Sub VisibleChanged_Event(sender As Object, e As _
                                PenInputPanelVisibleChangedEventArgs)
    ' Make sure the object that generated
    ' the event is a PenInputPanel object
    If TypeOf sender Is PenInputPanel Then
       Dim theSenderPanel As PenInputPanel = CType(sender, PenInputPanel)

       ' When the panel has become visible...
       If theSenderPanel.Visible Then
          ' Display a message in the attached edit control
          theSenderPanel.AttachedEditControl.Text &= _
                   "The panel is visible." & Environment.NewLine
       End If
    End If
End Sub 'VisibleChanged_Event

See Also