Allow user to view and edit User Data on particular components. The data is stored inside a
UserDataMap and the associated template is used to present a modal Property Page
to the user.
The following requirements must be meet in order for the command to work:
The selection must contain a selection of components, or the input argument should provide a SubComponent object
specifying these components.
A least one of the components must be part of a cluster.
This cluster must have a templated User Data Map on it.
For example if polygon number 4 is selected then there needs to be a
polygon cluster that includes polygon 4 in it, and there must be a User Data Map with a valid
UserDataMap.Template on this cluster.
Unless a specific UserDataMap is provided in the argument (or part of the selection), the
first User Data Map that meets these criteria, if any, is used, which can have implications if multiple
user data maps are placed on the same object.
If multiple components are specified then the first component is used to initialize the controls on the
user interface. If the user clicks OK then the values of the controls of the User Interface
will be saved on each of the provided components.
If there is no user data (see UserDataMap.IsEmpty) on the selected component then the
user interface is shown with all the controls at their default values.
InspectUserData( InputObjs ); |
| Parameter | Type | Description |
|---|---|---|
| InputObjs | XSICollection of Objects |
At the very least this argument needs to specify the subcomponents that will be inspected. It can also include the User Data Map that contains the data that is to be inspected. If no User Data Map is specified then the command will attempt to find a suitable UserDataMap. Default Value: Current Selection |