IXRTextBox::GetCaretBrush (Compact 2013)

  • Article

3/28/2014

This method gets the brush that is used to render the vertical bar that indicates the insertion point in this text box.

Syntax

virtual HRESULT STDMETHODCALLTYPE GetCaretBrush(
    __out IXRBrush** ppCaretBrush
) = 0;

Parameters

  • ppCaretBrush
    [out] Pointer to a pointer to an IXRBrush object that represents the brush used to render the vertical bar that indicates the insertion point.

Return Value

Returns an HRESULT that indicates success or failure.

Remarks

To use a specific interface pointer type, you can use the helper template version of this method that XAML for Windows Embedded provides. When you supply a derived type, this version automatically supplies a type-safe method that implicitly converts the returned type from a generic interface, so you do not have to explicitly call QueryInterface to convert the generic interface into the required object type.

.NET Framework Equivalent

System.Windows.Controls.TextBox.CaretBrush

Requirements

Header

XamlRuntime.h

sysgen

SYSGEN_XAML_RUNTIME

See Also

Reference

IXRTextBox