A manager for load, creation and activation of visual reports. More...

Inheritance diagram for NXOpen.VisualReporting.VisualReportManager:

Classes
class	_VisualReportManagerGetBooleanTypePropertyValueAdapter

class	_VisualReportManagerGetDateTypePropertyValueAdapter

class	_VisualReportManagerGetIntegerTypePropertyValueAdapter

class	_VisualReportManagerGetRealTypePropertyValueAdapter

class	_VisualReportManagerGetStringTypePropertyValueAdapter

Public Member Functions
unsafe void	ActivateCurrentVisualReport ()
	Activates the NXOpen.VisualReporting.VisualReportManager.Current visual report. More...

unsafe NXOpen.VisualReporting.SpecifyDateBuilder	CreateSpecifyDateBuilder ()
	Creates a NXOpen.VisualReporting.SpecifyDateBuilder . More...

unsafe NXOpen.VisualReporting.VisualReportBuilder	CreateVisualReportBuilder (NXOpen.VisualReporting.VisualReport visualReport)
	Creates a NXOpen.VisualReporting.VisualReportBuilder and starts editing a copy of the given NXOpen.VisualReporting.VisualReport . More...

unsafe void	DeactivateCurrentVisualReport ()
	Deactivates the NXOpen.VisualReporting.VisualReportManager.Current visual report. More...

delegate bool	GetBooleanTypePropertyValue (NXOpen.NXObject nxObject)
	User defined method that is called when ask an boolean property value. More...

delegate NXOpen.NXObject.ComputationalTime	GetDateTypePropertyValue (NXOpen.NXObject nxObject)
	User defined method that is called when ask an date property value. More...

delegate int	GetIntegerTypePropertyValue (NXOpen.NXObject nxObject)
	User defined method that is called when ask an integer type property value. More...

delegate double	GetRealTypePropertyValue (NXOpen.NXObject nxObject)
	User defined method that is called when ask an double type property value. More...

delegate string	GetStringTypePropertyValue (NXOpen.NXObject nxObject)
	User defined method that is called when ask an string type property value. More...

unsafe NXOpen.VisualReporting.VisualReport	MergeReports (NXOpen.VisualReporting.VisualReport[] visualReports, string mergedReportName, string mergedReportDescription)
	Merges multiple existing NXOpen.VisualReporting.VisualReport into one NXOpen.VisualReporting.VisualReport , but does not set them to be the NXOpen.VisualReporting.VisualReportManager.Current visual report or activate them, and does not save the merged NXOpen.VisualReporting.VisualReport . More...

unsafe NXOpen.VisualReporting.VisualReport	Open (string filename)
	Opens an existing NXOpen.VisualReporting.VisualReport , but does not set it to be the NXOpen.VisualReporting.VisualReportManager.Current visual report or activate it. More...

unsafe NXOpen.VisualReporting.VisualReport[]	OpenReports (string[] folders, string[] names)
	Opens existing NXOpen.VisualReporting.VisualReport , but does not set them to be the NXOpen.VisualReporting.VisualReportManager.Current visual report or activate them. More...

unsafe void	RegisterProperty (string propertyKey, string propertyName, NXOpen.VisualReporting.VisualReport.ScopeTypeOption scopeType, NXOpen.VisualReporting.VisualReport.ObjectTypeOption[] objectTypes, NXOpen.VisualReporting.Property.DatatypeOption dataType, bool isValidInNative, bool isValidInTeamcenter, NXOpen.VisualReporting.VisualReportManager.GetStringTypePropertyValue getStringTypePropertyValue)
	Registers a string type property. More...

unsafe void	RegisterProperty (string propertyKey, string propertyName, NXOpen.VisualReporting.VisualReport.ScopeTypeOption scopeType, NXOpen.VisualReporting.VisualReport.ObjectTypeOption[] objectTypes, NXOpen.VisualReporting.Property.DatatypeOption dataType, bool isValidInNative, bool isValidInTeamcenter, NXOpen.VisualReporting.VisualReportManager.GetIntegerTypePropertyValue getIntegerTypePropertyValue)
	Registers an integer type property. More...

unsafe void	RegisterProperty (string propertyKey, string propertyName, NXOpen.VisualReporting.VisualReport.ScopeTypeOption scopeType, NXOpen.VisualReporting.VisualReport.ObjectTypeOption[] objectTypes, NXOpen.VisualReporting.Property.DatatypeOption dataType, bool isValidInNative, bool isValidInTeamcenter, NXOpen.VisualReporting.VisualReportManager.GetRealTypePropertyValue getRealTypePropertyValue)
	Registers a double type property. More...

unsafe void	RegisterProperty (string propertyKey, string propertyName, NXOpen.VisualReporting.VisualReport.ScopeTypeOption scopeType, NXOpen.VisualReporting.VisualReport.ObjectTypeOption[] objectTypes, NXOpen.VisualReporting.Property.DatatypeOption dataType, bool isValidInNative, bool isValidInTeamcenter, NXOpen.VisualReporting.VisualReportManager.GetBooleanTypePropertyValue getBooleanTypePropertyValue)
	Registers a boolean type property. More...

unsafe void	RegisterProperty (string propertyKey, string propertyName, NXOpen.VisualReporting.VisualReport.ScopeTypeOption scopeType, NXOpen.VisualReporting.VisualReport.ObjectTypeOption[] objectTypes, NXOpen.VisualReporting.Property.DatatypeOption dataType, bool isValidInNative, bool isValidInTeamcenter, NXOpen.VisualReporting.VisualReportManager.GetDateTypePropertyValue getDateTypePropertyValue)
	Registers a NXOpen.NXObject.ComputationalTime type property. More...

unsafe void	Unload (NXOpen.VisualReporting.VisualReport visualReport)
	Unloads an opened NXOpen.VisualReporting.VisualReport . More...

unsafe void	UnregisterProperty (string propertyKey)
	Unregisters a property. 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.VisualReport	Current `[get, set]`
	Returns or sets the current NXOpen.VisualReporting.VisualReport . More...

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

NXOpen.VisualReporting.VisualReportExplorer	VisualReportExplorer `[get]`
	Returns the NXOpen.VisualReporting.VisualReportExplorer belonging to this visual report manager More...

NXOpen.VisualReporting.VisualReportCollection	VisualReports `[get]`
	Returns the NXOpen.VisualReporting.VisualReportCollection belonging to this visual report manager 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

A manager for load, creation and activation of visual reports.

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

Created in NX7.0.0

Member Function Documentation

unsafe void NXOpen.VisualReporting.VisualReportManager.ActivateCurrentVisualReport ( )

inline

Activates the NXOpen.VisualReporting.VisualReportManager.Current visual report.

Created in NX7.0.0

License requirements: None.

unsafe NXOpen.VisualReporting.SpecifyDateBuilder NXOpen.VisualReporting.VisualReportManager.CreateSpecifyDateBuilder ( )

inline

Creates a NXOpen.VisualReporting.SpecifyDateBuilder .

Created in NX8.0.0

License requirements: None.

Returns: The created builder

unsafe NXOpen.VisualReporting.VisualReportBuilder NXOpen.VisualReporting.VisualReportManager.CreateVisualReportBuilder ( NXOpen.VisualReporting.VisualReport visualReport )

inline

Creates a NXOpen.VisualReporting.VisualReportBuilder and starts editing a copy of the given NXOpen.VisualReporting.VisualReport .

Created in NX7.0.0

License requirements: nx_visual_reporting ("Visual Reporting")

Parameters

visualReport The VisualReport for which this builder is being created. Can be a null reference (Nothing in Visual Basic)

Returns: The created builder

unsafe void NXOpen.VisualReporting.VisualReportManager.DeactivateCurrentVisualReport ( )

inline

Deactivates the NXOpen.VisualReporting.VisualReportManager.Current visual report.

Created in NX7.0.0

License requirements: None.

delegate bool NXOpen.VisualReporting.VisualReportManager.GetBooleanTypePropertyValue ( NXOpen.NXObject nxObject )

User defined method that is called when ask an boolean property value.

Created in NX12.0.0

License requirements: nx_visual_reporting ("Visual Reporting")

Parameters

nxObject

delegate NXOpen.NXObject.ComputationalTime NXOpen.VisualReporting.VisualReportManager.GetDateTypePropertyValue ( NXOpen.NXObject nxObject )

User defined method that is called when ask an date property value.

Created in NX12.0.0

License requirements: nx_visual_reporting ("Visual Reporting")

Parameters

nxObject

delegate int NXOpen.VisualReporting.VisualReportManager.GetIntegerTypePropertyValue ( NXOpen.NXObject nxObject )

User defined method that is called when ask an integer type property value.

Created in NX12.0.0

License requirements: nx_visual_reporting ("Visual Reporting")

Parameters

nxObject

delegate double NXOpen.VisualReporting.VisualReportManager.GetRealTypePropertyValue ( NXOpen.NXObject nxObject )

User defined method that is called when ask an double type property value.

Created in NX12.0.0

License requirements: nx_visual_reporting ("Visual Reporting")

Parameters

nxObject

delegate string NXOpen.VisualReporting.VisualReportManager.GetStringTypePropertyValue ( NXOpen.NXObject nxObject )

User defined method that is called when ask an string type property value.

Created in NX12.0.0

License requirements: nx_visual_reporting ("Visual Reporting")

Parameters

nxObject

unsafe NXOpen.VisualReporting.VisualReport NXOpen.VisualReporting.VisualReportManager.MergeReports	(	NXOpen.VisualReporting.VisualReport[]	visualReports,
		string	mergedReportName,
		string	mergedReportDescription
	)

inline

Merges multiple existing NXOpen.VisualReporting.VisualReport into one NXOpen.VisualReporting.VisualReport , but does not set them to be the NXOpen.VisualReporting.VisualReportManager.Current visual report or activate them, and does not save the merged NXOpen.VisualReporting.VisualReport .

Created in NX8.0.0

License requirements: nx_visual_reporting ("Visual Reporting")

Parameters

visualReports	array of existing reports
mergedReportName	name of the merged report
mergedReportDescription	description of the merged report

Returns: merged report

unsafe NXOpen.VisualReporting.VisualReport NXOpen.VisualReporting.VisualReportManager.Open ( string filename )

inline

Opens an existing NXOpen.VisualReporting.VisualReport , but does not set it to be the NXOpen.VisualReporting.VisualReportManager.Current visual report or activate it.

If the visual report file cannot be opened, or if there is a problem parsing the file, then an exception will be raised.

If opening a managed report then it is recommended to use NXOpen.VisualReporting.VisualReportManager.OpenReports which can take a container path and list of dataset names

Created in NX7.0.0

License requirements: nx_visual_reporting ("Visual Reporting")

Parameters

filename The filename of the visual report to open

Returns

unsafe NXOpen.VisualReporting.VisualReport [] NXOpen.VisualReporting.VisualReportManager.OpenReports	(	string[]	folders,
		string[]	names
	)

inline

Opens existing NXOpen.VisualReporting.VisualReport , but does not set them to be the NXOpen.VisualReporting.VisualReportManager.Current visual report or activate them.

If the visual report file cannot be opened, or if there is a problem parsing the file, then an exception will be raised.

This can be used in native mode by sending in a folder path and filenames, or in managed mode using a container path and dataset names.

Created in NX7.5.0

License requirements: nx_visual_reporting ("Visual Reporting")

Parameters

folders	array of folders to be searched
names	array of report names

Returns: array of opened reports

unsafe void NXOpen.VisualReporting.VisualReportManager.RegisterProperty	(	string	propertyKey,
		string	propertyName,
		NXOpen.VisualReporting.VisualReport.ScopeTypeOption	scopeType,
		NXOpen.VisualReporting.VisualReport.ObjectTypeOption[]	objectTypes,
		NXOpen.VisualReporting.Property.DatatypeOption	dataType,
		bool	isValidInNative,
		bool	isValidInTeamcenter,
		NXOpen.VisualReporting.VisualReportManager.GetStringTypePropertyValue	getStringTypePropertyValue
	)

inline

Registers a string type property.

The property key and property name should be unique in current session. Parameters 'isValidInNative' and 'isValidInTeamcenter' shouldn't be 'false' at the same time.

Created in NX12.0.0

License requirements: nx_visual_reporting ("Visual Reporting")

Parameters

propertyKey	property key
propertyName	property name
scopeType	property scope type
objectTypes	object types
dataType	property data type
isValidInNative	is property valid in native mode
isValidInTeamcenter	is property valid in Teamcenter mode
getStringTypePropertyValue	callback function that returns a string type property value

unsafe void NXOpen.VisualReporting.VisualReportManager.RegisterProperty	(	string	propertyKey,
		string	propertyName,
		NXOpen.VisualReporting.VisualReport.ScopeTypeOption	scopeType,
		NXOpen.VisualReporting.VisualReport.ObjectTypeOption[]	objectTypes,
		NXOpen.VisualReporting.Property.DatatypeOption	dataType,
		bool	isValidInNative,
		bool	isValidInTeamcenter,
		NXOpen.VisualReporting.VisualReportManager.GetIntegerTypePropertyValue	getIntegerTypePropertyValue
	)

inline

Registers an integer type property.

The property key and property name should be unique in current session. Parameters 'isValidInNative' and 'isValidInTeamcenter' shouldn't be 'false' at the same time.

Created in NX12.0.0

License requirements: nx_visual_reporting ("Visual Reporting")

Parameters

propertyKey	property key
propertyName	property name
scopeType	property scope type
objectTypes	object types
dataType	property data type
isValidInNative	is property valid in native mode
isValidInTeamcenter	is property valid in Teamcenter mode
getIntegerTypePropertyValue	callback function that returns a integer type property value

unsafe void NXOpen.VisualReporting.VisualReportManager.RegisterProperty	(	string	propertyKey,
		string	propertyName,
		NXOpen.VisualReporting.VisualReport.ScopeTypeOption	scopeType,
		NXOpen.VisualReporting.VisualReport.ObjectTypeOption[]	objectTypes,
		NXOpen.VisualReporting.Property.DatatypeOption	dataType,
		bool	isValidInNative,
		bool	isValidInTeamcenter,
		NXOpen.VisualReporting.VisualReportManager.GetRealTypePropertyValue	getRealTypePropertyValue
	)

inline

Registers a double type property.

The property key and property name should be unique in current session. Parameters 'isValidInNative' and 'isValidInTeamcenter' shouldn't be 'false' at the same time.

Created in NX12.0.0

License requirements: nx_visual_reporting ("Visual Reporting")

Parameters

propertyKey	property key
propertyName	property name
scopeType	property scope type
objectTypes	object types
dataType	property data type
isValidInNative	is property valid in native mode
isValidInTeamcenter	is property valid in Teamcenter mode
getRealTypePropertyValue	callback function that returns a double type property value

unsafe void NXOpen.VisualReporting.VisualReportManager.RegisterProperty	(	string	propertyKey,
		string	propertyName,
		NXOpen.VisualReporting.VisualReport.ScopeTypeOption	scopeType,
		NXOpen.VisualReporting.VisualReport.ObjectTypeOption[]	objectTypes,
		NXOpen.VisualReporting.Property.DatatypeOption	dataType,
		bool	isValidInNative,
		bool	isValidInTeamcenter,
		NXOpen.VisualReporting.VisualReportManager.GetBooleanTypePropertyValue	getBooleanTypePropertyValue
	)

inline

Registers a boolean type property.

The property key and property name should be unique in current session. Parameters 'isValidInNative' and 'isValidInTeamcenter' shouldn't be 'false' at the same time.

Created in NX12.0.0

License requirements: nx_visual_reporting ("Visual Reporting")

Parameters

propertyKey	property key
propertyName	property name
scopeType	property scope type
objectTypes	object types
dataType	property data type
isValidInNative	is property valid in native mode
isValidInTeamcenter	is property valid in Teamcenter mode
getBooleanTypePropertyValue	callback function that returns a bool property value

unsafe void NXOpen.VisualReporting.VisualReportManager.RegisterProperty	(	string	propertyKey,
		string	propertyName,
		NXOpen.VisualReporting.VisualReport.ScopeTypeOption	scopeType,
		NXOpen.VisualReporting.VisualReport.ObjectTypeOption[]	objectTypes,
		NXOpen.VisualReporting.Property.DatatypeOption	dataType,
		bool	isValidInNative,
		bool	isValidInTeamcenter,
		NXOpen.VisualReporting.VisualReportManager.GetDateTypePropertyValue	getDateTypePropertyValue
	)

inline

Registers a NXOpen.NXObject.ComputationalTime type property.

The property key and property name should be unique in current session. Parameters 'isValidInNative' and 'isValidInTeamcenter' shouldn't be 'false' at the same time.

Created in NX12.0.0

License requirements: nx_visual_reporting ("Visual Reporting")

Parameters

propertyKey	property key
propertyName	property name
scopeType	property scope type
objectTypes	object types
dataType	property data type
isValidInNative	is property valid in native mode
isValidInTeamcenter	is property valid in Teamcenter mode
getDateTypePropertyValue	callback function that returns a NXOpen.NXObject.ComputationalTime type property value

unsafe void NXOpen.VisualReporting.VisualReportManager.Unload ( NXOpen.VisualReporting.VisualReport visualReport )

inline

Unloads an opened NXOpen.VisualReporting.VisualReport .

Created in NX8.0.0

License requirements: nx_visual_reporting ("Visual Reporting")

Parameters

visualReport

unsafe void NXOpen.VisualReporting.VisualReportManager.UnregisterProperty ( string propertyKey )

inline

Unregisters a property.

When the library which the property resides in is unloaded from NX session, this method should be called to unregister the property.

Created in NX12.0.0

License requirements: nx_visual_reporting ("Visual Reporting")

Parameters

propertyKey property key

Property Documentation

unsafe NXOpen.VisualReporting.VisualReport NXOpen.VisualReporting.VisualReportManager.Current

getset

Returns or sets the current NXOpen.VisualReporting.VisualReport .

Created in NX7.0.0

License requirements to get this property: None.

License requirements to set this property: None.

Tag NXOpen.VisualReporting.VisualReportManager.Tag

get

Returns the tag of this object.

NXOpen.VisualReporting.VisualReportExplorer NXOpen.VisualReporting.VisualReportManager.VisualReportExplorer

get

Returns the NXOpen.VisualReporting.VisualReportExplorer belonging to this visual report manager

Created in NX7.5.0

NXOpen.VisualReporting.VisualReportCollection NXOpen.VisualReporting.VisualReportManager.VisualReports

get

Returns the NXOpen.VisualReporting.VisualReportCollection belonging to this visual report manager

Created in NX7.0.0

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

VisualReporting_VisualReportManager.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation