DialogEngine CATCmdHeaderWithSDOForAgent

Usage: you must use this class as is. You should never derive it.

public class CATCmdHeaderWithSDOForAgent

Class for command headers to represent Dialog Agents in a toolbar.
Role: This header allows you to see a in a toolbar. The agents are set in the Set of Dialog Objects (SDO) by the CATStateCommand thanks to the method.
An object in the SDO is visualized thanks this class under these three conditions:

1. it's a component which OM derives from the component
2. it implements an interface, which derives from , to give its representation
3. it is activated.

Example of usage: You are in a workshop, workbench or in an Add-in

1. Create an instance of the class

    CATCommandHeaderWithSDOForAgent::CATCreateCmdHeaderWithSDOForAgent("HeaderID", IID_CATIMyVisuForMyToolbar);
  

2. Associate this instance with a starter

    // The container which represents the toolbar
    NewAccess(CATCmdContainer,pCATMySDOTlb,CATMySDOTlb);
      ......
      // Starter to visualize all objects in the SDO
      NewAccess(CATCmdStarter,pCATMySDOStr,CATMySDOStr);
       .....
      // Associate the command header with the starter
      SetAccessCommand(pCATMySDOStr,"HeaderID")
  

• HeaderID:Identificator of the header
• IID_CATIMyVisuForMyToolbar: IID of an interface which derives from
• CATMySDOTlb:Identificator of the toolbar where dialog agent will be set
• CATMySDOStr:Identificator of the starter dedicated to the header

Method Index

o CATCreateCmdHeaderWithSDOForAgent(CATString&,IID&)

Constructs a header to represent Dialog Agent in a toolbar.

Methods

Constructs a header to represent Dialog Agent in a toolbar.

Parameters:

iHeaderID

Identificator of the header. You must follow the nomenclature :
ZZZxxxHeaderNameHdr where

1. ZZZ: The trigram of the enterprise
2. xxx: The trigram of FW or the product
3. Hdr: For Header

This identificator is not used for any Nls or Rsc Resources.

iVisuIID

Interface deriving from

.
Agent must implement this interface to be visualized.

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.