PenInputPanel.Top Property

Article
10/19/2012

Deprecated. Gets the vertical, or y-axis, location of the top edge of the PenInputPanel object, in screen coordinates. PenInputPanel has been replaced by Microsoft.Ink.TextInput.

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

Syntax

'Declaration
Public ReadOnly Property Top As Integer
'Usage
Dim instance As PenInputPanel 
Dim value As Integer 

value = instance.Top

public int Top { get; }

public:
property int Top {
    int get ();
}

public function get Top () : int

Property Value

Type: System.Int32
The vertical, or y-axis, location of the top edge of the PenInputPanel object, in screen coordinates.

Remarks

To explicitly override the automatic positioning behavior of the PenInputPanel object, use the Left and Top properties of the object to determine the current position of the pen input panel.

You can also override the automatic positioning behavior of the PenInputPanel object by listening for the Left and Top properties of the PenInputPanelMovingEventArgs object during a PanelMoving event.

Security Note:
If using under partial trust, this property requires SecurityPermissionFlag.AllFlags permission, in addition to the permissions required by PenInputPanel. See Security and Trust for more information.

Examples

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 uses the Top property to add a sentence to the content of theInkEdit, stating where the top edge of the PenInputPanel object is located, in screen coordinates.

[C#]

//...

// Declare 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 (e.NewVisibility)
        {
            // Display the top edge of the panel
            // in the attached edit control
            theSenderPanel.AttachedEditControl.Text +=
                    "The top edge of the panel is at ";
            theSenderPanel.AttachedEditControl.Text += theSenderPanel.Top.ToString();
            theSenderPanel.AttachedEditControl.Text += " pixels.\n";
        }
    }
}

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 uses the Top property to add a sentence to the content of theInkEdit, stating where the top edge of the PenInputPanel object is located, in screen coordinates.

[Visual Basic]

'...

' 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(ByVal sender As Object, ByVal 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 e.NewVisibility Then
            ' Display the top edge of the panel
            ' in the attached edit control
            theSenderPanel.AttachedEditControl.Text += _
                     "The top edge of the panel is at "

            theSenderPanel.AttachedEditControl.Text += _
                     theSenderPanel.Top.ToString()

            theSenderPanel.AttachedEditControl.Text += _
                     " pixels." + ControlChars.Lf
        End If
    End If
End Sub 'VisibleChanged_Event

Platforms

Windows 7, Windows Vista, Windows Server 2008 R2, Windows Server 2008

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