FailureMessageAccessor.ShouldMergeWithMessage
Method
Description:
Checks if the FailureMessage should be merged with the other FailureMessage for better user experience.
Checks if the FailureMessage should be merged with the other FailureMessage for better user experience.
Remarks:
Messages should be merged if all user-visible information except failing elements is the same, failure resolution types are the same and merging lists of failing elements keeps message text applicable to all of them equally. Method is used by the Revit UI to display multiple messages as one.
Messages should be merged if all user-visible information except failing elements is the same, failure resolution types are the same and merging lists of failing elements keeps message text applicable to all of them equally. Method is used by the Revit UI to display multiple messages as one.
Parameters
Parameter | Type | Description |
---|---|---|
messageToMergeWith | FailureMessageAccessor |
Return Value
Type | Description |
---|---|
Boolean | True if messages should be merged |
Exceptions
Exception | Condition |
---|---|
ArgumentException | messageToMergeWith has not been properly initialized. |
ArgumentNullException | A non-optional argument was null |
InvalidOperationException | This FailureMessageAccessor has not been properly initialized. |