Share via


Dirty Property

Dirty Property

Returns or sets the value that specifies whether the strokes of an InkDisp object have been modified since the last time the ink was saved.

Declaration

[C++]

[propput] HRESULT put_Dirty ([in] VARIANT_BOOL Dirty);
[propget] HRESULT get_Dirty ([out, retval] VARIANT_BOOL* Dirty);

[Microsoft® Visual Basic® 6.0]

Public Property Get Dirty() As Boolean
Public Property Let Dirty(ByVal isDirty As Boolean)

Property Value

VARIANT_BOOL Returns or sets the Boolean value that specifies whether an InkDisp object has been modified.

This property is read/write.

TRUE Default.If the ink has been modified.
FALSE If the ink has not been modified.

Return Value

HRESULT value Description
S_OK Success.
E_POINTER The parameter pointer was NULL (Nothing in Visual Basic 6.0) or invalid.
E_INK_EXCEPTION An exception occurred inside the method.
E_INVALIDARG The specified mode is invalid.

Remarks

After ink is saved, the dirty flag is automatically cleared and the value of this property is FALSE. To save ink, call the Save method.

Example

[Visual Basic 6.0]

This Visual Basic 6.0 example returns the dirty state of an InkDisp object.

Dim isDirty As Boolean
isDirty = theInkCollector.Ink.Dirty

Applies To