ITextInputPanel::InPlaceBoundingRectangle Property (Windows)

ITextInputPanel::InPlaceBoundingRec...

ITextInputPanel::InPlaceBoundingRectangle Property

Gets the bounding rectangle for Tablet PC Input Panel.

Syntax (get)

C++

 HRESULT get_InPlaceBoundingRectangle(
  [out, retval]  Rect *BoundingRectangle
);

Parameters

BoundingRectangle [out]

The bounding rectangle for the in-place Input Panel when the largest input area for the current input language is showing.

This property is read-only.

Return Value

The method can return one of the following values.

Return code	Description
S_OK	Success.
E_FAIL	An unspecified error occurred.

Remarks

If the Writing Pad or Character Pad is active, then the height of the Insert button is included in the bounding rectangle for the in-place Input Panel. The bounding rectangle does not include the height of the correction comb. When the in-place Input Panel auto grows, the ITextInputPanelEventSink::InPlaceSizeChanging Method/ITextInputPanelEventSink::InPlaceSizeChanged Method event pair is fired and the value of this property is updated to include the additional writing area or writing line.

This element is declared in Peninputpanel.h.

Applies To

ITextInputPanel Interface

Examples

This C++ example implements an EN_SETFOCUS event handler for an Edit control, IDC_EDIT3. It first checks if an ITextInputPanel object, g_pTip, has been created. If it exists, it reports the values of several ITextInputPanel Interface properties to debug output using the TRACE macro.

void CCOMTIPDlg::OnEnSetFocusEdit3()
{
    if (NULL != g_pTip)
    {
		CorrectionMode mode;

		if (SUCCEEDED(g_pTip-&gt;get_CurrentCorrectionMode(&amp;mode)))
        {
			TRACE("CurrentCorrectionMode: %d\n", mode);
		}

		InPlaceState state;

		if (SUCCEEDED(g_pTip-&gt;get_CurrentInPlaceState(&amp;state)))
        {
			TRACE("CurrentInPlaceState: %d\n", state);
		}

		PanelInputArea area;

		if (SUCCEEDED(g_pTip-&gt;get_CurrentInputArea(&amp;area)))
        {
			TRACE("CurrentInputArea: %d\n", area);
		}

		InteractionMode iMode;

		if (SUCCEEDED(g_pTip-&gt;get_CurrentInteractionMode(&amp;iMode)))
        {
			TRACE("CurrentInteractionMode: %d\n", iMode);
		}

        RECT rect;

		if (SUCCEEDED(g_pTip-&gt;get_InPlaceBoundingRectangle(&amp;rect)))
        {
	        TRACE("InPlaceBoundingRectangle.top: %d\n", rect.top);
	        TRACE("InPlaceBoundingRectangle.left: %d\n", rect.left);
	        TRACE("InPlaceBoundingRectangle.bottom: %d\n", rect.bottom);
	        TRACE("InPlaceBoundingRectangle.right: %d\n", rect.right);
        }

	    int nHeight;

		if (SUCCEEDED(g_pTip-&gt;get_PopDownCorrectionHeight(&amp;nHeight)))
        {
	        TRACE("PopDownCorrectionHeight: %d\n", nHeight);
        }

	    if (SUCCEEDED(g_pTip-&gt;get_PopUpCorrectionHeight(&amp;nHeight)))
        {
	        TRACE("PopUpCorrectionHeight: %d\n", nHeight);
        }

		if (SUCCEEDED(g_pTip-&gt;SetInPlacePosition(300, 300, CorrectionPosition_Bottom)))
		{
			TRACE("Call to SetInPlacePosition() succeeded.\n");
		}
		else
		{
			TRACE("Call to SetInPlacePosition() failed.\n");
		}
    }
    else
    {
        TRACE("ITextInputPanel object is NULL.\n");
    }
}

Requirements

Minimum supported client	Windows XP Tablet PC Edition
Minimum supported server	None supported
Header	Peninputpanel.h (also requires Peninputpanel_i.c)
DLL	Tiptsf.dll