NXOpen .NET Reference Guide
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.VisualReporting.VisualReport Class Reference

A visual report can be activated by the NXOpen.VisualReporting.VisualReportManager to apply colors to objects in the graphics window. More...

Inheritance diagram for NXOpen.VisualReporting.VisualReport:
NXOpen.NXObject NXOpen.TaggedObject NXOpen.INXObject NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  ObjectTypeOption { Body, Face }
 Represents the possible report object type options for a NXOpen.VisualReporting.VisualReport . More...
 
enum  ReportContextOption { Assembly, WorkPart }
 Represents the possible NXOpen.VisualReporting.VisualReport.ReportContext options for a NXOpen.VisualReporting.VisualReport . More...
 
enum  ReportingObjectTypeOption { Part, Component, Inferred }
 Represents the possible NXOpen.VisualReporting.VisualReport.ReportingObjectType for a NXOpen.VisualReporting.VisualReport . More...
 
enum  ReportingStyleOption { ColorObject, TagObject, ColorAndTagObject }
 Represents the possible NXOpen.VisualReporting.VisualReport.ReportingStyle for a NXOpen.VisualReporting.VisualReport . More...
 
enum  SaveDestinationOption { Local, Teamcenter }
 Represents the possible NXOpen.VisualReporting.VisualReport.SaveDestination options for a NXOpen.VisualReporting.VisualReport . More...
 
enum  ScopeTypeOption { Component, SubPart }
 Represents the possible NXOpen.VisualReporting.VisualReport.ScopeType options for a NXOpen.VisualReporting.VisualReport . More...
 
- Public Types inherited from NXOpen.NXObject
enum  AttributeType {
  Invalid, Null, Boolean, Integer,
  Real, String, Time, Reference,
  Any = 100
}
 Specifies attribute type. More...
 
enum  DateAndTimeFormat { Numeric, Textual }
 Specifies the format of the date and time attribute. More...
 

Public Member Functions

unsafe
NXOpen.VisualReporting.Property[] 
GetAllDefinedProperties ()
 Returns the NXOpen.VisualReporting.Property s which has been defined in this NXOpen.VisualReporting.VisualReport . More...
 
unsafe
NXOpen.VisualReporting.GroupLabel[] 
GetGroupLabels ()
 Returns the result NXOpen.VisualReporting.GroupLabel s from the activated NXOpen.VisualReporting.VisualReport . More...
 
unsafe
NXOpen.VisualReporting.GroupLabel[] 
GetGroupLabelsOfResultCategory (NXOpen.VisualReporting.ResultCategory category)
 Returns the result NXOpen.VisualReporting.GroupLabel s of a NXOpen.VisualReporting.ResultCategory from the activated NXOpen.VisualReporting.VisualReport . More...
 
unsafe string GetKeywords ()
 Gets a comma separated string of the keywords for this NXOpen.VisualReporting.VisualReport . More...
 
unsafe NXOpen.NXObject[] GetObjectsInGroup (NXOpen.VisualReporting.GroupLabel groupLabel)
 Returns the NXOpen.NXObject s that belong to the group with this NXOpen.VisualReporting.GroupLabel . More...
 
unsafe
NXOpen.VisualReporting.VisualReport.ObjectTypeOption[] 
GetObjectTypes ()
 Returns the NXOpen.VisualReporting.VisualReport.ObjectTypeOption s of this NXOpen.VisualReporting.VisualReport . More...
 
unsafe string GetPropertyValueOfObject (NXOpen.VisualReporting.Property property, NXOpen.VisualReporting.GroupLabel groupLabel, NXOpen.NXObject nxObject)
 Returns the value of the NXOpen.VisualReporting.Property s for the NXOpen.NXObject in the result NXOpen.VisualReporting.GroupLabel . More...
 
unsafe
NXOpen.VisualReporting.ResultCategory[] 
GetResultCategories ()
 Returns the NXOpen.VisualReporting.ResultCategory s from the activated NXOpen.VisualReporting.VisualReport . More...
 
unsafe NXOpen.VisualReporting.Rule GetRule (int index)
 Return the specified NXOpen.VisualReporting.Rule from this NXOpen.VisualReporting.VisualReport More...
 
unsafe
NXOpen.VisualReporting.Rule[] 
GetRules ()
 Returns all the NXOpen.VisualReporting.Rule s in this NXOpen.VisualReporting.VisualReport More...
 
unsafe void RemoveResultCategory (NXOpen.VisualReporting.ResultCategory theCategory)
 Removes the NXOpen.VisualReporting.ResultCategory from NXOpen.VisualReporting.VisualReport . More...
 
unsafe void Save ()
 Saves this NXOpen.VisualReporting.VisualReport to its current NXOpen.VisualReporting.VisualReport.Filename . More...
 
unsafe void SetKeywords (string keywords)
 Sets a comma separated string of the keywords for this NXOpen.VisualReporting.VisualReport . More...
 
- Public Member Functions inherited from NXOpen.NXObject
unsafe NXOpen.AttributeIterator CreateAttributeIterator ()
 Create an attribute iterator More...
 
unsafe void DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type)
 Deletes all attributes of a specific type. More...
 
unsafe void DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes all attributes of a specific type with the option to update or not. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title)
 Deletes an attribute by type and title. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
unsafe void DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
unsafe void DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option)
 Deletes the attributes on the object, if any, that satisfy the given iterator More...
 
unsafe void DeleteUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes the attributes encountered with the given Type with option to update or not. More...
 
unsafe NXOpen.INXObject FindObject (string journalIdentifier)
 Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
 Gets all the attribute titles of a specific type. More...
 
unsafe bool GetBooleanUserAttribute (string title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
unsafe
NXOpen.NXObject.ComputationalTime 
GetComputationalTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe int GetIntegerAttribute (string title)
 Gets an integer attribute by title. More...
 
unsafe int GetIntegerUserAttribute (string title, int index)
 Gets an integer attribute by Title and array Index. More...
 
unsafe bool GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info)
 Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...
 
unsafe string GetPdmReferenceAttributeValue (string attributeTitle)
 Gets the value of PDM Reference attribute for given object. More...
 
unsafe double GetRealAttribute (string title)
 Gets a real attribute by title. More...
 
unsafe double GetRealUserAttribute (string title, int index)
 Gets a real attribute by Title and array Index. More...
 
unsafe string GetReferenceAttribute (string title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
unsafe string GetStringAttribute (string title)
 Gets a string attribute value by title. More...
 
unsafe string GetStringUserAttribute (string title, int index)
 Gets a string attribute by Title and array Index. More...
 
unsafe string GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
 Gets a time attribute by title. More...
 
unsafe string GetTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe
NXOpen.NXObject.AttributeInformation 
GetUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type)
 Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
 
unsafe string GetUserAttributeAsString (string title, NXOpen.NXObject.AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.NXObject.AttributeType type)
 Gets the count of set attributes on the object, if any, of the given type. More...
 
unsafe int GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
 Gets the count of attributes on the object, if any, of the given type. More...
 
unsafe bool GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
 Determine the lock of the given attribute. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (NXOpen.AttributeIterator iterator)
 Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset)
 Gets all the attributes of the given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset, bool addStringValues)
 Gets all the attributes of the given object. More...
 
unsafe string[] GetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe int GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type)
 Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
 
unsafe NXOpen.NXObject[] GetUserAttributeSourceObjects ()
 Returns an array of objects from which this object presents attributes. More...
 
unsafe bool HasUserAttribute (NXOpen.AttributeIterator iterator)
 Determines if an attribute exists on the object, that satisfies the given iterator More...
 
unsafe bool HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
 Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
 
unsafe void Print ()
 Prints a representation of this object to the system log file. More...
 
unsafe void SetAttribute (string title, int value)
 Creates or modifies an integer attribute. More...
 
unsafe void SetAttribute (string title, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, double value)
 Creates or modifies a real attribute. More...
 
unsafe void SetAttribute (string title, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, string value)
 Creates or modifies a string attribute. More...
 
unsafe void SetAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
unsafe void SetAttribute (string title, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
unsafe void SetName (string name)
 Sets the custom name of the object. More...
 
unsafe void SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
unsafe void SetReferenceAttribute (string title, string value)
 Creates or modifies a string attribute which uses a reference string. More...
 
unsafe void SetReferenceAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
unsafe void SetTimeAttribute (string title, string value)
 Creates or modifies a time attribute. More...
 
unsafe void SetTimeAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option)
 Creates or modifies an attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
 Lock or unlock the given attribute. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. 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 string BitmapName [get, set]
 Returns or sets the bitmap name of this NXOpen.VisualReporting.VisualReport . More...
 
unsafe string CustomMessage [get, set]
 Returns or sets the custom message of this NXOpen.VisualReporting.VisualReport . More...
 
unsafe string Description [get, set]
 Returns or sets the description of this NXOpen.VisualReporting.VisualReport More...
 
unsafe string DescriptiveCategory [get, set]
 Returns or sets the category of this NXOpen.VisualReporting.VisualReport . More...
 
unsafe string DestinationTeamcenterFolder [get, set]
 Returns or sets the destination Teamcenter folder for saving the NXOpen.VisualReporting.VisualReport to Teamcenter database. More...
 
unsafe string Filename [get, set]
 Returns or sets the filename where this NXOpen.VisualReporting.VisualReport was opened from or will be saved to. More...
 
unsafe bool IsUnmatchedGroupEnabled [get, set]
 Returns or sets whether use of NXOpen.VisualReporting.VisualReport.UnmatchedGroupLabel is enabled. More...
 
unsafe
NXOpen.VisualReporting.VisualReport.ReportContextOption 
ReportContext [get, set]
 Returns or sets the NXOpen.VisualReporting.VisualReport.ReportContextOption of this NXOpen.VisualReporting.VisualReport . More...
 
unsafe
NXOpen.VisualReporting.VisualReport.ReportingObjectTypeOption 
ReportingObjectType [get, set]
 Returns or sets the NXOpen.VisualReporting.VisualReport.ReportingObjectTypeOption of this NXOpen.VisualReporting.VisualReport . More...
 
unsafe
NXOpen.VisualReporting.VisualReport.ReportingStyleOption 
ReportingStyle [get, set]
 Returns or sets the NXOpen.VisualReporting.VisualReport.ReportingStyleOption of this NXOpen.VisualReporting.VisualReport . More...
 
unsafe
NXOpen.VisualReporting.VisualReport.SaveDestinationOption 
SaveDestination [get, set]
 Returns or sets the NXOpen.VisualReporting.VisualReport.SaveDestinationOption of the NXOpen.VisualReporting.VisualReport . More...
 
unsafe
NXOpen.VisualReporting.VisualReport.ScopeTypeOption 
ScopeType [get]
 Returns the NXOpen.VisualReporting.VisualReport.ScopeTypeOption of this NXOpen.VisualReporting.VisualReport . More...
 
unsafe
NXOpen.VisualReporting.GroupLabel 
UnmatchedGroupLabel [get]
 Returns the NXOpen.VisualReporting.GroupLabel which is used for unmatched object. More...
 
unsafe
NXOpen.VisualReporting.UnmatchedResultCategory 
UnmatchedResultCategory [get]
 Returns the NXOpen.VisualReporting.UnmatchedResultCategory from the activated NXOpen.VisualReporting.VisualReport . More...
 
- Properties inherited from NXOpen.NXObject
unsafe bool IsOccurrence [get]
 Returns whether this object is an occurrence or not. More...
 
unsafe string JournalIdentifier [get]
 Returns the identifier that would be recorded in a journal for this object. More...
 
unsafe string Name [get]
 Returns the custom name of the object. More...
 
unsafe NXOpen.Assemblies.Component OwningComponent [get]
 Returns the owning component, if this object is an occurrence. More...
 
unsafe NXOpen.BasePart OwningPart [get]
 Returns the owning part of this object More...
 
unsafe NXOpen.INXObject Prototype [get]
 Returns the prototype of this object if it is an occurrence. More...
 
- Properties inherited from NXOpen.TaggedObject
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...
 
- Properties inherited from NXOpen.INXObject
bool IsOccurrence [get]
 Returns whether this object is an occurrence or not. More...
 
string JournalIdentifier [get]
 Returns the identifier that would be recorded in a journal for this object. More...
 
string Name [get]
 Returns the custom name of the object. More...
 
NXOpen.Assemblies.Component OwningComponent [get]
 Returns the owning component, if this object is an occurrence. More...
 
NXOpen.BasePart OwningPart [get]
 Returns the owning part of this object More...
 
NXOpen.INXObject Prototype [get]
 Returns the prototype of this object if it is an occurrence. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

A visual report can be activated by the NXOpen.VisualReporting.VisualReportManager to apply colors to objects in the graphics window.

An active visual report groups objects according to filtering conditions and classification rules. The contents of the groups can be accessed via NXOpen.VisualReporting.VisualReport.GetGroupLabels and NXOpen.VisualReporting.VisualReport.GetObjectsInGroup .

Created in NX7.0.0

Member Enumeration Documentation

Represents the possible report object type options for a NXOpen.VisualReporting.VisualReport .

Only valid if the NXOpen.VisualReporting.VisualReport.ScopeType of the NXOpen.VisualReporting.VisualReport is NXOpen.VisualReporting.VisualReport.ScopeTypeOption.SubPart type.

Enumerator
Body 

The report objects are bodies

Face 

The report objects are faces

Represents the possible NXOpen.VisualReporting.VisualReport.ReportContext options for a NXOpen.VisualReporting.VisualReport .

Enumerator
Assembly 

Collect objects from entire assembly

WorkPart 

Collect objects from work part only

Represents the possible NXOpen.VisualReporting.VisualReport.ReportingObjectType for a NXOpen.VisualReporting.VisualReport .

Only valid if the NXOpen.VisualReporting.VisualReport.ScopeType of the NXOpen.VisualReporting.VisualReport is NXOpen.VisualReporting.VisualReport.ScopeTypeOption.Component type.

Enumerator
Part 

The reporting objects are parts.

Component 

The reporting objects are components.

Inferred 

The reporting objects are inferred from the properties used in the report.

Represents the possible NXOpen.VisualReporting.VisualReport.ReportingStyle for a NXOpen.VisualReporting.VisualReport .

Enumerator
ColorObject 

Matching objects will be colored

TagObject 

Matching objects will be tagged

ColorAndTagObject 

Matching objects will be both colored and tagged

Represents the possible NXOpen.VisualReporting.VisualReport.SaveDestination options for a NXOpen.VisualReporting.VisualReport .

Enumerator
Local 

Saves the report in the local file system.

Teamcenter 

Saves the report in the Teamcenter database.

Represents the possible NXOpen.VisualReporting.VisualReport.ScopeType options for a NXOpen.VisualReporting.VisualReport .

Enumerator
Component 

The report is assembly component report

SubPart 

The report is sub-part object report

Member Function Documentation

unsafe NXOpen.VisualReporting.Property [] NXOpen.VisualReporting.VisualReport.GetAllDefinedProperties ( )
inline

Returns the NXOpen.VisualReporting.Property s which has been defined in this NXOpen.VisualReporting.VisualReport .

The returned properties include those properties defined in NXOpen.VisualReporting.Condition s, in NXOpen.VisualReporting.Classifier s, and in the referenced properties.

Created in NX8.0.0

License requirements: None.

Returns
Properties defined in this visual report
unsafe NXOpen.VisualReporting.GroupLabel [] NXOpen.VisualReporting.VisualReport.GetGroupLabels ( )
inline

Returns the result NXOpen.VisualReporting.GroupLabel s from the activated NXOpen.VisualReporting.VisualReport .

There are no NXOpen.VisualReporting.GroupLabel s if the NXOpen.VisualReporting.VisualReport is not activated. You can acess the user defined NXOpen.VisualReporting.GroupLabel s by NXOpen.VisualReporting.VisualReportBuilder.GetManualGroupLabelsOfRule .

Created in NX7.0.0

License requirements: None.

Returns
unsafe NXOpen.VisualReporting.GroupLabel [] NXOpen.VisualReporting.VisualReport.GetGroupLabelsOfResultCategory ( NXOpen.VisualReporting.ResultCategory  category)
inline

Returns the result NXOpen.VisualReporting.GroupLabel s of a NXOpen.VisualReporting.ResultCategory from the activated NXOpen.VisualReporting.VisualReport .

Created in NX8.0.0

License requirements: None.

Parameters
category
Returns
unsafe string NXOpen.VisualReporting.VisualReport.GetKeywords ( )
inline

Gets a comma separated string of the keywords for this NXOpen.VisualReporting.VisualReport .

Created in NX7.5.0

License requirements: None.

Returns
unsafe NXOpen.NXObject [] NXOpen.VisualReporting.VisualReport.GetObjectsInGroup ( NXOpen.VisualReporting.GroupLabel  groupLabel)
inline

Returns the NXOpen.NXObject s that belong to the group with this NXOpen.VisualReporting.GroupLabel .

Created in NX7.0.0

License requirements: None.

Parameters
groupLabelA group label of this visual report
Returns
unsafe NXOpen.VisualReporting.VisualReport.ObjectTypeOption [] NXOpen.VisualReporting.VisualReport.GetObjectTypes ( )
inline
unsafe string NXOpen.VisualReporting.VisualReport.GetPropertyValueOfObject ( NXOpen.VisualReporting.Property  property,
NXOpen.VisualReporting.GroupLabel  groupLabel,
NXOpen.NXObject  nxObject 
)
inline

Returns the value of the NXOpen.VisualReporting.Property s for the NXOpen.NXObject in the result NXOpen.VisualReporting.GroupLabel .

It will return a null reference (Nothing in Visual Basic) if the NXOpen.VisualReporting.VisualReport is not activated, or the NXOpen.VisualReporting.Property does not belong to the properties defined in this NXOpen.VisualReporting.VisualReport , or the NXOpen.NXObject doesn't belong to the specified result NXOpen.VisualReporting.GroupLabel .

Created in NX8.0.0

License requirements: None.

Parameters
propertyA property defined in this visual report
groupLabelA result group of this visual report
nxObjectA NXOpen.NXObject which belongs to the result group
Returns
unsafe NXOpen.VisualReporting.ResultCategory [] NXOpen.VisualReporting.VisualReport.GetResultCategories ( )
inline

Returns the NXOpen.VisualReporting.ResultCategory s from the activated NXOpen.VisualReporting.VisualReport .

There are no NXOpen.VisualReporting.ResultCategory s if the NXOpen.VisualReporting.VisualReport is not activated.

Created in NX8.0.0

License requirements: None.

Returns
unsafe NXOpen.VisualReporting.Rule NXOpen.VisualReporting.VisualReport.GetRule ( int  index)
inline

Return the specified NXOpen.VisualReporting.Rule from this NXOpen.VisualReporting.VisualReport

Created in NX7.0.0

License requirements: None.

Parameters
indexThe index of the returned NXOpen.VisualReporting.Rule .
Returns
unsafe NXOpen.VisualReporting.Rule [] NXOpen.VisualReporting.VisualReport.GetRules ( )
inline

Returns all the NXOpen.VisualReporting.Rule s in this NXOpen.VisualReporting.VisualReport

Created in NX7.0.0

License requirements: None.

Returns
unsafe void NXOpen.VisualReporting.VisualReport.RemoveResultCategory ( NXOpen.VisualReporting.ResultCategory  theCategory)
inline

Removes the NXOpen.VisualReporting.ResultCategory from NXOpen.VisualReporting.VisualReport .

The NXOpen.VisualReporting.Classifier which populates this NXOpen.VisualReporting.ResultCategory will also be removed from the NXOpen.VisualReporting.Rule in the NXOpen.VisualReporting.VisualReport .

Created in NX8.0.0

License requirements: nx_visual_reporting ("Visual Reporting")

Parameters
theCategory
unsafe void NXOpen.VisualReporting.VisualReport.Save ( )
inline

Saves this NXOpen.VisualReporting.VisualReport to its current NXOpen.VisualReporting.VisualReport.Filename .

Note that when NX is connected to Teamcenter, the NXOpen.VisualReporting.VisualReport.Filename will be updated to the report dataset identifier after the report is saved to Teamcenter database.

Created in NX7.0.0

License requirements: nx_visual_reporting ("Visual Reporting")

unsafe void NXOpen.VisualReporting.VisualReport.SetKeywords ( string  keywords)
inline

Sets a comma separated string of the keywords for this NXOpen.VisualReporting.VisualReport .

Created in NX8.0.0

License requirements: nx_visual_reporting ("Visual Reporting")

Parameters
keywords

Property Documentation

unsafe string NXOpen.VisualReporting.VisualReport.BitmapName
getset

Returns or sets the bitmap name of this NXOpen.VisualReporting.VisualReport .

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: nx_visual_reporting ("Visual Reporting")

unsafe string NXOpen.VisualReporting.VisualReport.CustomMessage
getset

Returns or sets the custom message of this NXOpen.VisualReporting.VisualReport .

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: nx_visual_reporting ("Visual Reporting")

unsafe string NXOpen.VisualReporting.VisualReport.Description
getset

Returns or sets the description of this NXOpen.VisualReporting.VisualReport

Created in NX7.0.0

License requirements to get this property: None.

License requirements to set this property: nx_visual_reporting ("Visual Reporting")

unsafe string NXOpen.VisualReporting.VisualReport.DescriptiveCategory
getset

Returns or sets the category of this NXOpen.VisualReporting.VisualReport .

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: nx_visual_reporting ("Visual Reporting")

unsafe string NXOpen.VisualReporting.VisualReport.DestinationTeamcenterFolder
getset

Returns or sets the destination Teamcenter folder for saving the NXOpen.VisualReporting.VisualReport to Teamcenter database.

Note that this property is only needed when NX is connected to Teamcenter and report is saved as a copy to Teamcenter database. This NXOpen.VisualReporting.VisualReport.DestinationTeamcenterFolder may return a null reference (Nothing in Visual Basic) if you haven't set a folder name on this property.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: nx_visual_reporting ("Visual Reporting")

unsafe string NXOpen.VisualReporting.VisualReport.Filename
getset

Returns or sets the filename where this NXOpen.VisualReporting.VisualReport was opened from or will be saved to.

Note that when NX is connected to Teamcenter, this property is the report dataset identifier from Teamcenter database. If it is a new report, it will be the report dataset name. When the report is save by NXOpen.VisualReporting.VisualReport.Save , the report dataset identifier will be saved in this property.

Created in NX7.0.0

License requirements to get this property: None.

License requirements to set this property: nx_visual_reporting ("Visual Reporting")

unsafe bool NXOpen.VisualReporting.VisualReport.IsUnmatchedGroupEnabled
getset

Returns or sets whether use of NXOpen.VisualReporting.VisualReport.UnmatchedGroupLabel is enabled.

Created in NX7.0.0

License requirements to get this property: None.

License requirements to set this property: nx_visual_reporting ("Visual Reporting")

unsafe NXOpen.VisualReporting.VisualReport.ReportContextOption NXOpen.VisualReporting.VisualReport.ReportContext
getset

Returns or sets the NXOpen.VisualReporting.VisualReport.ReportContextOption of this NXOpen.VisualReporting.VisualReport .

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: nx_visual_reporting ("Visual Reporting")

unsafe NXOpen.VisualReporting.VisualReport.ReportingObjectTypeOption NXOpen.VisualReporting.VisualReport.ReportingObjectType
getset

Returns or sets the NXOpen.VisualReporting.VisualReport.ReportingObjectTypeOption of this NXOpen.VisualReporting.VisualReport .

Only valid if the NXOpen.VisualReporting.VisualReport.ScopeType of the NXOpen.VisualReporting.VisualReport is NXOpen.VisualReporting.VisualReport.ScopeTypeOption.Component type.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: nx_visual_reporting ("Visual Reporting")

unsafe NXOpen.VisualReporting.VisualReport.ReportingStyleOption NXOpen.VisualReporting.VisualReport.ReportingStyle
getset

Returns or sets the NXOpen.VisualReporting.VisualReport.ReportingStyleOption of this NXOpen.VisualReporting.VisualReport .

Created in NX7.0.0

License requirements to get this property: None.

License requirements to set this property: nx_visual_reporting ("Visual Reporting")

unsafe NXOpen.VisualReporting.VisualReport.SaveDestinationOption NXOpen.VisualReporting.VisualReport.SaveDestination
getset

Returns or sets the NXOpen.VisualReporting.VisualReport.SaveDestinationOption of the NXOpen.VisualReporting.VisualReport .

Note that this property will always be NXOpen.VisualReporting.VisualReport.SaveDestinationOption.Local when NX is not connected to Teamcenter.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: nx_visual_reporting ("Visual Reporting")

unsafe NXOpen.VisualReporting.VisualReport.ScopeTypeOption NXOpen.VisualReporting.VisualReport.ScopeType
get

Returns the NXOpen.VisualReporting.VisualReport.ScopeTypeOption of this NXOpen.VisualReporting.VisualReport .

Created in NX9.0.0

License requirements: None.

unsafe NXOpen.VisualReporting.GroupLabel NXOpen.VisualReporting.VisualReport.UnmatchedGroupLabel
get

Returns the NXOpen.VisualReporting.GroupLabel which is used for unmatched object.

It will return a null reference (Nothing in Visual Basic) if the NXOpen.VisualReporting.VisualReport is not activated.

Created in NX7.0.0

License requirements: None.

unsafe NXOpen.VisualReporting.UnmatchedResultCategory NXOpen.VisualReporting.VisualReport.UnmatchedResultCategory
get

Returns the NXOpen.VisualReporting.UnmatchedResultCategory from the activated NXOpen.VisualReporting.VisualReport .

It will return a null reference (Nothing in Visual Basic) if the NXOpen.VisualReporting.VisualReport is not activated.

Created in NX8.0.0

License requirements: None.


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.