IPen​.ClearOnResolutionChange [Property][Get/Set]

Controls whether the Process Analyst Control will automatically clear the data cache in response to human interaction methods that result in a data resolution change, for example, when the user manipulates the horizontal axis scaling. In normal operation this property is set to TRUE by default. Turning the property to FALSE will result in the action not clearing the data cache. This property can only be changed when the DataPoint property is not bound (that is, Empty). Once the cache is full it will roll samples off the back as new samples arrive. This property is useful when the pen is unbound and the AddSample method is used.

Defined As

• [VBA] Boolean ClearOnResolutionChange

• [Cicode] INT ClearOnResolutionChange

• [C++] VARIANT_BOOL ClearOnResolutionChange

Execution Result

If the property get/set succeeds the return value will be Success. If the return variable is bad, the return value will be InvalidArgument. If the pen is deleted, the return value will be AccessDenied.

Limits

• True (-1): User action clears the data cache

• False (0): User action does not clear the data cache

Calling Syntax

Assumes you have passed a valid pen object into the function.

[VBA]

Sub Example(pen As Object)
Dim ResoChange As Boolean
`Getting Property value
ResoChange = pen.ClearOnResolutionChange
`Setting Property value
pen.ClearOnResolutionChange = False
End Sub

[Cicode]

FUNCTION Example(OBJECT hPen)
INT bResoChange;
// Getting current property value
bResoChange = _ObjectGetProperty(hPen, "ClearOnResolutionChange");
// Setting Property
_ObjectSetProperty(hPen, "ClearOnResolutionChange", 0);
END