IInkOverlay::AutoRedraw
4/8/2010
Gets or sets a value that specifies whether an IInkOverlay control repaints the ink when the window is invalidated.
Syntax
[propput] HRESULT put_AutoRedraw ([in] VARIANT_BOOL AutoRedraw);
[propget] HRESULT get_AutoRedraw ([out, retval] VARIANT_BOOL
*AutoRedraw
);
Parameters
AutoRedraw
Value that specifies whether an ink collector repaints the ink when the window is invalidated.This property is read/write.
Value | Description |
---|---|
TRUE |
Default. The ink collector repaints the ink when the window is invalidated. |
FALSE |
The ink collector does not repaint the ink when the window is invalidated. |
Return Value
HRESULT value | Description |
---|---|
S_OK |
Success. |
E_POINTER |
The AutoRedraw parameter is an invalid pointer. |
E_INK_EXCEPTION |
An exception occurred while processing. |
E_INVALIDARG |
The flag is invalid. |
Remarks
If TRUE, the ink collector repaints the ink when the window is invalidated. For example, if you minimize the window and then restore it, the ink is automatically redrawn. If FALSE, the ink collector does not repaint the ink when the window is invalidated. For example, if you minimize the window and then restore it, the ink disappears from the screen.
When AutoRedraw is FALSE, the ink appears while inking unless the IInkOverlay::DynamicRendering property is false.
When your application is performing custom rendering or when your application is sensitive to painting issues, you can handle the repainting yourself and set the AutoRedraw property to FALSE for the IInkOverlay control. Use the underlying controls' Invalidated and Paint events to handle the repainting.
Requirements
Header | msinkaut.h |
Windows Embedded CE | Windows CE 5.0 and later |
Windows Mobile | Windows Mobile 6 Classic and later, Windows Mobile 6 Professional and later |