The Explorer of the results of a visual report. More...

Inheritance diagram for NXOpen.VisualReporting.VisualReportExplorer:

Public Types
enum	ExploreReportOption { Off, On }
	Represents whether Explore Report mode is on or off. More...

enum	ReportDownStatus { None, End, More }
	Status reported by NXOpen.VisualReporting.VisualReportExplorer.ReportDown . More...

enum	ReportOnObjectsOption { Replace, Add }
	When the set of objects to report upon is changed, should the contents of the set be replaced or extended. More...

Public Member Functions
unsafe void	ClearReportObjects ()
	Remove all objects from the visual report. More...

unsafe NXOpen.VisualReporting.GroupLabel	GetExploringGroup ()
	Gets the exploring NXOpen.VisualReporting.GroupLabel More...

unsafe void	RemoveReportObjects (NXOpen.NXObject[] nxObjects)
	Remove objects from report. More...

unsafe NXOpen.VisualReporting.VisualReportExplorer.ReportDownStatus	ReportDown (NXOpen.VisualReporting.VisualReportExplorer.ReportOnObjectsOption reportOnObjectsOption)
	Report down the assembly, starting from the NXOpen.Assemblies.ComponentAssembly.RootComponent . More...

unsafe NXOpen.VisualReporting.VisualReportExplorer.ReportDownStatus	ReportDown (NXOpen.NXObject[] nxObjects, NXOpen.VisualReporting.VisualReportExplorer.ReportOnObjectsOption reportOnObjectsOption)
	Report down from a starting array of objects. More...

unsafe void	ReportOnChildren (NXOpen.NXObject[] nxObjects, NXOpen.VisualReporting.VisualReportExplorer.ReportOnObjectsOption reportOnObjectsOption)
	Report on the children of nxObjects. More...

unsafe void	ReportOnObjects (NXOpen.NXObject[] nxObjects, NXOpen.VisualReporting.VisualReportExplorer.ReportOnObjectsOption reportOnObjectsOption)
	Set objects to report upon. More...

unsafe void	ReportOnParents (NXOpen.NXObject[] nxObjects, NXOpen.VisualReporting.VisualReportExplorer.ReportOnObjectsOption reportOnObjectsOption)
	Report on the parents of the nxObjects. More...

unsafe void	ResetReportObjects ()
	Resets the objects to report upon. More...

unsafe void	SetGroupToExplore (NXOpen.VisualReporting.GroupLabel groupLabel)
	Sets the NXOpen.VisualReporting.GroupLabel to explore. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe NXOpen.VisualReporting.VisualReportExplorer.ExploreReportOption	ExploreReport `[get, set]`
	Returns or sets the Explore Report setting More...

Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void	initialize ()
	<exclude> More...

Detailed Description

The Explorer of the results of a visual report.

The Visual Report Explorer enables a report to focus on specified objects or on a particular group in the visual report.

To obtain an instance of this class, refer to NXOpen.VisualReporting.VisualReportManager

Created in NX7.5.0

Member Enumeration Documentation

enum NXOpen.VisualReporting.VisualReportExplorer.ExploreReportOption

Represents whether Explore Report mode is on or off.

Enumerator
Off	Explore Visual Report results is off
On	Explore Visual Report results is on

enum NXOpen.VisualReporting.VisualReportExplorer.ReportDownStatus

Status reported by NXOpen.VisualReporting.VisualReportExplorer.ReportDown .

Enumerator
None	There are no objects of interest below the specified objects
End	Report Down has reached the lowest level on all branches of the assembly
More	There are more objects of interest below the currently reported upon objects

enum NXOpen.VisualReporting.VisualReportExplorer.ReportOnObjectsOption

When the set of objects to report upon is changed, should the contents of the set be replaced or extended.

Enumerator
Replace	Replace the existing set of objects
Add	Add to the existing set of objects

Member Function Documentation

unsafe void NXOpen.VisualReporting.VisualReportExplorer.ClearReportObjects ( )

inline

Remove all objects from the visual report.

Created in NX7.5.0

License requirements: None.

unsafe NXOpen.VisualReporting.GroupLabel NXOpen.VisualReporting.VisualReportExplorer.GetExploringGroup ( )

inline

Gets the exploring NXOpen.VisualReporting.GroupLabel

Created in NX8.0.0

License requirements: None.

Returns: The exploring group

unsafe void NXOpen.VisualReporting.VisualReportExplorer.RemoveReportObjects ( NXOpen.NXObject[] nxObjects )

inline

Remove objects from report.

Created in NX7.5.0

License requirements: None.

Parameters

nxObjects Objects to remove from report

unsafe NXOpen.VisualReporting.VisualReportExplorer.ReportDownStatus NXOpen.VisualReporting.VisualReportExplorer.ReportDown ( NXOpen.VisualReporting.VisualReportExplorer.ReportOnObjectsOption reportOnObjectsOption )

inline

Report down the assembly, starting from the NXOpen.Assemblies.ComponentAssembly.RootComponent .

A group to explore should have been specified for this method to have any effect. The first time this method is called the operation will start from NXOpen.Assemblies.ComponentAssembly.RootComponent . On subsequent calls, the set of objects currently reported upon will be used as the starting point.

Created in NX7.5.0

License requirements: None.

Parameters

reportOnObjectsOption Add to or replace objects in report

Returns: Status from the report down operation

unsafe NXOpen.VisualReporting.VisualReportExplorer.ReportDownStatus NXOpen.VisualReporting.VisualReportExplorer.ReportDown	(	NXOpen.NXObject[]	nxObjects,
		NXOpen.VisualReporting.VisualReportExplorer.ReportOnObjectsOption	reportOnObjectsOption
	)

inline

Report down from a starting array of objects.

A group to explore should have been specified for this method to have any effect. On subsequent calls to NXOpen.VisualReporting.VisualReportExplorer.ReportDown , with no nxObjects array, the set of objects currently reported upon will be used as the starting point.

Created in NX7.5.0

License requirements: None.

Parameters

nxObjects	Objects from which to start report down operation
reportOnObjectsOption	Add to or replace objects in report

Returns: Status from the report down operation

unsafe void NXOpen.VisualReporting.VisualReportExplorer.ReportOnChildren	(	NXOpen.NXObject[]	nxObjects,
		NXOpen.VisualReporting.VisualReportExplorer.ReportOnObjectsOption	reportOnObjectsOption
	)

inline

Report on the children of nxObjects.

The children will either replace the existing contents of the report or be added to the report. This operation is intended for NXOpen.Assemblies.Component s and will report on direct children of the components. If an object is not an instance of NXOpen.Assemblies.Component or if it has no children then nothing will be changed.

Created in NX7.5.0

License requirements: None.

Parameters

nxObjects	Objects whose children will be reported upon
reportOnObjectsOption	Add to or replace objects in report

unsafe void NXOpen.VisualReporting.VisualReportExplorer.ReportOnObjects	(	NXOpen.NXObject[]	nxObjects,
		NXOpen.VisualReporting.VisualReportExplorer.ReportOnObjectsOption	reportOnObjectsOption
	)

inline

Set objects to report upon.

Created in NX7.5.0

License requirements: None.

Parameters

nxObjects	Objects to report upon
reportOnObjectsOption	Add to or replace objects in report

unsafe void NXOpen.VisualReporting.VisualReportExplorer.ReportOnParents	(	NXOpen.NXObject[]	nxObjects,
		NXOpen.VisualReporting.VisualReportExplorer.ReportOnObjectsOption	reportOnObjectsOption
	)

inline

Report on the parents of the nxObjects.

The parents will either replace the existing contents of the report or be added to the report. This operation is intended for NXOpen.Assemblies.Component s and will report on the parent of the component. If the object is not an instance of NXOpen.Assemblies.Component or if it has no parent then nothing will be changed.

Created in NX7.5.0

License requirements: None.

Parameters

nxObjects	Objects whose parents will be reported upon
reportOnObjectsOption	Add to or replace objects in report

unsafe void NXOpen.VisualReporting.VisualReportExplorer.ResetReportObjects ( )

inline

Resets the objects to report upon.

If there is no group to explore set, then all leaf nodes of the assembly will be included in the report. If a group to explore is set, then elements of that group will be reported upon. Where there are two elements of the group on the same branch of the assembly, the lowest will be reported upon.

Created in NX7.5.0

License requirements: None.

unsafe void NXOpen.VisualReporting.VisualReportExplorer.SetGroupToExplore ( NXOpen.VisualReporting.GroupLabel groupLabel )

inline

Sets the NXOpen.VisualReporting.GroupLabel to explore.

The NXOpen.VisualReporting.GroupLabel to explore can be set to a null reference (Nothing in Visual Basic). If there is no active visual report, then nothing will happen. Note that the NXOpen.VisualReporting.GroupLabel should belong to the active visual report otherwise the call will fail. This method will also cause the objects reported upon to be reset in the same way as a call to ResetReportObjects .

Created in NX7.5.0

License requirements: None.

Parameters

groupLabel The group to explore

Property Documentation

unsafe NXOpen.VisualReporting.VisualReportExplorer.ExploreReportOption NXOpen.VisualReporting.VisualReportExplorer.ExploreReport

getset

Returns or sets the Explore Report setting

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

Tag NXOpen.VisualReporting.VisualReportExplorer.Tag

get

Returns the tag of this object.

The documentation for this class was generated from the following file:

VisualReporting_VisualReportExplorer.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation