API Reference > Other Classes > OdDgEditorReactor Class > OdDgEditorReactor Methods > OdDgEditorReactor::xrefSubcommandOverlayItem Method
OdDgEditorReactor::xrefSubcommandOverlayItem Method
Syntax
C++
virtual void xrefSubcommandOverlayItem(int activity, const OdString& xrefPath);
Parameters 
Description 
int activity 
[in] Overlay activity.  
const OdString& xrefPath 
[in] Xref path. 

Notification function called during an Xref Overlay operation. 

 

This function will called multiple times as an Xrefs are overlayed. 

activity must be one of the following: 

 

Name 
Value 
Description 
kStart 
The Overlay has started. xrefPath is undefined. 
kStartItem 
The Overlay of the Xref with the specified path has been started. 
 
 
Notification will be made for the 
 
 
original Xref and any dependent Xrefs. 
kEndItem 
The Overlay of the Xref with the specified path has been successfully completed. 
 
 
Notification will be made for the 
 
 
original Xref and any dependent Xrefs. 
kEnd 
The Overlay has completed successfully. xrefPath is undefined. 
kAborted 
The Overlay has failed to complete for the Xref with the specified filename. 

 

This function can be triggered by any action that results in the resolution of Xrefs.

  • xrefSubcommandAttachItem
  • xrefSubcommandBindItem
  • xrefSubcommandDetachItem
  • xrefSubcommandPathItem
  • xrefSubcommandReloadItem
  • xrefSubcommandUnloadItem

Copyright © 2002–2020. Open Design Alliance. All rights reserved.