Export (0) Print
Expand All

InkCollector.AutoRedraw property

Applies to: desktop apps only

Gets or sets a value that specifies whether an ink collector repaints the ink when the window is invalidated.

This property is read/write.

Syntax

HRESULT put_AutoRedraw(
  [in]           VARIANT_BOOL AutoRedraw
);

HRESULT get_AutoRedraw(
  [out, retval]  VARIANT_BOOL *AutoRedraw
);

Property value

VARIANT_TRUE to repaintthe ink when the window is invalidated; otherwise, VARIANT_FALSE. The default value is VARIANT_TRUE.

Error codes

NameMeaning
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 VARIANT_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 VARIANT_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 VARIANT_FALSE, the ink appears while inking unless the 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 VARIANT_FALSE for the InkCollector object, the InkOverlay object, or the InkPicture control. Use the events in the following table to handle the repainting.

Object or ControlEvent

InkCollector Object

The underlying controls Invalidated and Paint events.

InkOverlay Object

The underlying controls Invalidated and Paint events.

InkPicture Control

InkPicture controls inherited Invalidated and Paint events.

 

Requirements

Minimum supported client

Windows XP Tablet PC Edition

Minimum supported server

None supported

Header

Msinkaut.h (also requires Msinkaut_i.c)

Library

InkObj.dll

See also

InkCollector Class
DynamicRendering Property
Draw Method [InkRenderer Class]
Draw Method
InkDisp Class

 

 

Send comments about this topic to Microsoft

Build date: 3/6/2012

Community Additions

ADD
Show:
© 2014 Microsoft