NXOpen .NET Reference
12.0.0
|
A manager for load, creation and activation of visual reports. More...
Properties | |
Tag | Tag [get] |
Returns the tag of this object. More... | |
NXOpen.VisualReporting.VisualReportCollection | VisualReports [get] |
Returns the NXOpen.VisualReporting.VisualReportCollection belonging to this visual report manager More... | |
NXOpen.VisualReporting.VisualReportExplorer | VisualReportExplorer [get] |
Returns the NXOpen.VisualReporting.VisualReportExplorer belonging to this visual report manager More... | |
unsafe NXOpen.VisualReporting.VisualReport | Current [get, set] |
Returns or sets the current NXOpen.VisualReporting.VisualReport . More... | |
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
unsafe void NXOpen.VisualReporting.VisualReportManager.ActivateCurrentVisualReport | ( | ) |
Activates the NXOpen.VisualReporting.VisualReportManager.Current visual report.
Created in NX7.0.0
License requirements: None.
unsafe NXOpen.VisualReporting.SpecifyDateBuilder NXOpen.VisualReporting.VisualReportManager.CreateSpecifyDateBuilder | ( | ) |
Creates a NXOpen.VisualReporting.SpecifyDateBuilder .
Created in NX8.0.0
License requirements: None.
unsafe NXOpen.VisualReporting.VisualReportBuilder NXOpen.VisualReporting.VisualReportManager.CreateVisualReportBuilder | ( | NXOpen.VisualReporting.VisualReport | visualReport | ) |
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")
visualReport | The VisualReport for which this builder is being created. Can be a null reference (Nothing in Visual Basic) |
unsafe void NXOpen.VisualReporting.VisualReportManager.DeactivateCurrentVisualReport | ( | ) |
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")
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")
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")
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")
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")
nxObject |
unsafe NXOpen.VisualReporting.VisualReport NXOpen.VisualReporting.VisualReportManager.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 .
Created in NX8.0.0
License requirements: nx_visual_reporting ("Visual Reporting")
visualReports | array of existing reports |
mergedReportName | name of the merged report |
mergedReportDescription | description of the merged report |
unsafe NXOpen.VisualReporting.VisualReport NXOpen.VisualReporting.VisualReportManager.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.
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")
filename | The filename of the visual report to open |
unsafe NXOpen.VisualReporting.VisualReport [] NXOpen.VisualReporting.VisualReportManager.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.
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")
folders | array of folders to be searched |
names | array of report names |
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 | ||
) |
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")
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 | ||
) |
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")
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 | ||
) |
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")
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 | ||
) |
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")
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 | ||
) |
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")
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 | ) |
Unloads an opened NXOpen.VisualReporting.VisualReport .
Created in NX8.0.0
License requirements: nx_visual_reporting ("Visual Reporting")
visualReport |
unsafe void NXOpen.VisualReporting.VisualReportManager.UnregisterProperty | ( | string | propertyKey | ) |
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")
propertyKey | property key |
|
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.
|
get |
Returns the tag of this object.
|
get |
Returns the NXOpen.VisualReporting.VisualReportExplorer belonging to this visual report manager
Created in NX7.5.0
|
get |
Returns the NXOpen.VisualReporting.VisualReportCollection belonging to this visual report manager
Created in NX7.0.0