Function ProAnnotationDisplay
Description
Sets an annotation to be temporarily displayed or repainted. This change is in effect only until the next window repaint. The target model (owner, comp_path->owner, or drawing) must be the current model. Note: Functions ProAnnotationDisplay and ProAnnotationUndisplay should be used together. To edit a shown annotation, it must be first undisplayed using ProAnnotationUndisplay, followed by the editing function calls, and finally must be redisplayed by calling ProAnnotationDisplay.
Replacement in Object TOOLKIT: |
Synopsis
#include <ProAnnotation.h>
ProAnnotationDisplay | |
( ProAnnotation* annotation /* (In) The annotation (note, gtol, surface finish, symbol, ref. dim., driven dim, dimension). */ ProAsmcomppath* comp_path /* (In) The assembly component path. Pass NULL when not required. */ ProDrawing drawing /* (In) The drawing where the annotation should be displayed or repainted. Pass NULL when not required. */ ProView view /* (In) The drawing view. Pass NULL to when not required. Required if the annotation is not already shown in the target drawing (determines which view will house the temporary display). */ ) |
Returns
The function succeeded. | |
One or more arguments was invalid. | |
The target model is not the current model. | |
The annotation cannot be shown due to orientation conflicts in theview. | |
License check failure. | |
Annotation is present on hidden or blank layer and so can't be shown. |
Sample Code References
User Guide References