Unknown 'ReasonsForChange' for ApplicationEvents_OnDocumentChange

[mr_ensing]

We are running an add-in that is monitoring several ModelingEvents for changes to certain documents. These events don't get triggered when an occurrence of an array is suppressed (or un-suppressed).

So I'm investigating ApplicationEvents_OnDocumentChange as a way to trigger on suppression of an array occurrence.

I'm running in debug mode and monitoring the ReasonsForChange-values.

IntelliSense suggests the following values:

But when I suppress an array occurrence, a value of 17 is returned. I haven't got a clue what this means:

 

Any insights?

[WCrihfield]

Hi @mr_ensing 

Here is the online help page for that CommandTypesEnum.  It still only gives fairly minimal information about each one though.

[WCrihfield]

If you read the online help page for that ApplicationEvents.OnDocumentChange method, where it talks about that 'ReasonsForChange' variable, it says that it can be a single value from that Enum, or multiple values.  Then mentions that when it's multiple values, you may have to use 'Bitwise' operations (Link1, Link2) to find out which specific ones are involved.  When more than one value are involved, it will return its numerical value, which will be the numerical values of all matching variations added together.  Since you got a value of 17 in your one image, I might assume that both the 'kShapeEditCmdType' and the 'kUpdateWithReferencesCmdType' might be involved, since their two values (1 & 16) would add up to 17.  Just food for thought.

[mr_ensing]

I had a feeling bitwise operations where in my future, thanks for confirming it.

And thanks for the links to the help pages. My Google-Fu needs some practice.

I'll be investigating the NameValueMap parameter next.

[mr_ensing]

For now I'm using this bitwise comparison:

If (ReasonsForChange And CommandTypesEnum.kShapeEditCmdType) = CommandTypesEnum.kShapeEditCmdType And
    (ReasonsForChange And CommandTypesEnum.kUpdateWithReferencesCmdType) = CommandTypesEnum.kUpdateWithReferencesCmdType Then
    'stuff
End If

I let users confirm if the event was indeed an (un)suppression of a pattern occurrence.

I realise that with this comparison not only the value of 17 passes.

Also, the add-in is counting the number of faces before and after the event. Is there is no change, this all doesn't matter.

[WCrihfield]

Just had a thought about this situation.  Have you tried looking into the AssemblyEvents.OnOccurrenceChange event?  That sounds like it should cover the event you are talking about here, but I have not tested it myself for that specific scenario yet.

[mr_ensing · Accepted solution]

I assume that AssemblyEvents concern component pattern, not feature patterns.

But, I just figured out how to get some useful information out of  the Context NameValueMap.

Before I just tried:

Debug.Print(Context.ToString)

That did not give me anything useful. Of course I should have investigated the NameValueMap more:

Debug.Print(" DisplayName: " & Context.Value("DisplayName"))
Debug.Print("InternalName: " & Context.Value("InternalName"))

This results in:

DisplayName: Suppress pattern occurrences
InternalName: CompositeChange

So no more guessing, confirming with user and logging. 

[WCrihfield]

OK.  Apparently I misunderstood.  When I saw the terms 'occurrence of an array', 'array occurrences', 'pattern occurrence', I kept seeing the occurrence / occurrences word and was thinking about ComponentOccurrence objects and the OccurrencePattern, FeatureBasedOccurrencePattern, RectangularOccurrencePattern, CircularOccurrencePattern objects in an assembly.  But you were actually talking about things like CurcularPatternFeatures, RectangularPatternFeatures, SketchDrivenPatternFeatures in a Part and their 'FeaturePatternElements'.  Well, glad to hear you got it figured out.  Dealing with the OnDocumentChange event is definitely one of the most complex ones, and one of the most often triggered, so it can degrade performance if not handled efficiently.

[bradeneuropeArthur]

Does anybody know why the event isn't triggered at all.

Private Sub m_AppEvents_OnDocumentChange(DocumentObject As _Document, BeforeOrAfter As EventTimingEnum, ReasonsForChange As CommandTypesEnum, Context As NameValueMap, ByRef HandlingCode As HandlingCodeEnum) Handles m_AppEvents.OnDocumentChange

[Maxim-CADman77]

@mr_ensing 
Inventor's SDK 'Developer Tools' contains 'Event Watcher' util that can be of some help.
Below is the result it gave me on Occurrence Suppress of the FeaturePattern

With all respect ... I don't think the solution based on 'DisplayName' should be considered as reliable.
... It was just a lucky coincidence for your particular case.
It won't work with any Inventor localization except English.

I believe you need to read each name out of the 'InternalNamesList' for presence of 'Suppress Single Occurrence'.

If Context.Value("InternalName") = "CompositeChange" AndAlso Context.Value("InternalNamesList").Length > 0 Then

	For Each sCmdName In Context.Value("InternalNamesList")

		If sCmdName = "Suppress Single Occurrence" Then
			' Do something
			Exit For
		End If
	Next
End If