A property within either a NXOpen.VisualReporting.Rule or a NXOpen.VisualReporting.Condition , or used as referenced property information for the report. More...

Inheritance diagram for NXOpen.VisualReporting.Property:

Public Types
enum	DatatypeOption { String, Integer, Real, Boolean, Unknown, Null, Date }
	Represents the possible NXOpen.VisualReporting.Property.SystemDatatype options for a property. More...

enum	TypeOption { ArrangementSpecificPositionProperty, AttributeProperty, ComponentGroupProperty, ComponentNameProperty, DescriptivePartNameProperty, LoadStateProperty, MassKgProperty, MassLbProperty, ModifiedProperty, MultiCadProperty, PartNameProperty, PartUnitsProperty, PiecePartProperty, PositionProperty, PositionControlProperty, ReadOnlyProperty, ReferenceSetProperty, RootPartProperty, SuppressionControlProperty, WeightStatusProperty, TeamcenterProperty, ServerProperty, DegreesOfFreedomProperty, RuleEvaluationResultProperty, CheckMateResultProperty, LastModifiedDateProperty, RequirementsValidationStatusProperty, RepresentationProperty, LastModifiedUserProperty, ComponentProperty, MassGmProperty, PartFamilyMemberProperty, LinkedPartProperty, ProductTemplateProperty, BodyDensityProperty, BodyMassProperty, BodyRadiusGyrationProperty, BodySurfaceAreaProperty, BodyTypeProperty, BodyVolumeProperty, BodyWeightProperty, FaceAreaProperty, FaceTypeProperty, FaceMinRadiusProperty, FacePerimeterProperty, FacePMIFCFProperty, FacePMIFCFCharacteristicsProperty, FacePMIFCFCharFormTolProperty, FacePMIFCFCharLocationTolProperty, FacePMIFCFCharOrientationTolProperty, FacePMIFCFCharProfileTolProperty, FacePMIFCFCharRunoutTolProperty, FacePMIDatumFeatureProperty, FacePMIDatumTargetProperty, ObjectAttributeProperty, ObjectCreatedByUserProperty, ObjectCreatedDateProperty, ObjectCreatedVersionProperty, ObjectRefByWaveLinkProperty, ObjectWaveLinkedProperty, ObjectModifiedByUserProperty, ObjectModifiedDateProperty, ObjectModifiedVersionProperty, PartitionMembershipProperty, ComponentAddedDateProperty, TeamcenterObjectProperty, ComponentPatternTypeProperty, ObjectNameProperty, NXOpenProperty, SheetMetalBendAngleProperty, SheetMetalBendRadiusProperty, SheetMetalFaceTypeAllProperty, SheetMetalFaceTypeBendProperty, SheetMetalFaceTypeDeformProperty, SheetMetalFaceTypeWebProperty, SheetMetalNeutralFactorProperty, SheetMetalBodyTypeProperty, FeatureFailureProperty }
	Represents the possible NXOpen.VisualReporting.Property.PropertyType options for a property 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...

Properties
unsafe string	BitmapName `[get, set]`
	Returns or sets the bitmap name of this property. More...

unsafe string	CustomMessage `[get, set]`
	Returns or sets the custom message of this property. More...

unsafe NXOpen.VisualReporting.Property.TypeOption	PropertyType `[get]`
	Returns the NXOpen.VisualReporting.Property.TypeOption of this NXOpen.VisualReporting.Property . More...

unsafe NXOpen.VisualReporting.Property.DatatypeOption	SystemDatatype `[get]`
	Returns the preferred NXOpen.VisualReporting.Property.DatatypeOption that should be used for the owning NXOpen.VisualReporting.Condition or NXOpen.VisualReporting.Classifier . 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
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...

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

Detailed Description

A property within either a NXOpen.VisualReporting.Rule or a NXOpen.VisualReporting.Condition , or used as referenced property information for the report.

Created in NX7.0.0

Member Enumeration Documentation

enum NXOpen.VisualReporting.Property.DatatypeOption

Represents the possible NXOpen.VisualReporting.Property.SystemDatatype options for a property.

Enumerator
String	String data type
Integer	Integer data type
Real	Floating point data type
Boolean	Boolean data type
Unknown	The data type is unknown
Null	Null data type
Date	Date data type

enum NXOpen.VisualReporting.Property.TypeOption

Represents the possible NXOpen.VisualReporting.Property.PropertyType options for a property

Enumerator
ArrangementSpecificPositionProperty	Arrangement specific positioning
AttributeProperty	Part attribute property
ComponentGroupProperty	Component group name
ComponentNameProperty	Component name
DescriptivePartNameProperty	Descriptive part name
LoadStateProperty	The load state of the component
MassKgProperty	The mass of the component in pounds
MassLbProperty	The mass of the component in kilograms
ModifiedProperty	Whether the component is modified
MultiCadProperty	Parts mastered in a CAD system other than NX
PartNameProperty	Part name
PartUnitsProperty	Part units
PiecePartProperty	Piece part
PositionProperty	The position of the component
PositionControlProperty	The position control of the component
ReadOnlyProperty	Whether the component is read-only
ReferenceSetProperty	The reference set used by the component
RootPartProperty	Root part occurrence
SuppressionControlProperty	The suppression control of the component
WeightStatusProperty	The weight status of the component
TeamcenterProperty	Teamcenter property
ServerProperty	Server Property defined in server side report
DegreesOfFreedomProperty	The freedom degree of the component
RuleEvaluationResultProperty	Rule Evaluation for results in part
CheckMateResultProperty	Check-Mate result
LastModifiedDateProperty	last modify date property
RequirementsValidationStatusProperty	Requirement validate result
RepresentationProperty	Representation Status
LastModifiedUserProperty	last modify user property
ComponentProperty	Assembly Navigator column property
MassGmProperty	The mass of the component in grams
PartFamilyMemberProperty	Part family member
LinkedPartProperty	Linked part
ProductTemplateProperty	Product Template
BodyDensityProperty	Body density property
BodyMassProperty	Body mass property
BodyRadiusGyrationProperty	Body radius gyration property
BodySurfaceAreaProperty	Body surface area property
BodyTypeProperty	Body type property
BodyVolumeProperty	Body volume property
BodyWeightProperty	Body weight property
FaceAreaProperty	Face area property
FaceTypeProperty	Face type property
FaceMinRadiusProperty	Face minimum radius property
FacePerimeterProperty	Face perimeter property
FacePMIFCFProperty	Face PMI FCF property
FacePMIFCFCharacteristicsProperty	Face PMI FCF characteristics property
FacePMIFCFCharFormTolProperty	Face PMI FCF form characteristics property
FacePMIFCFCharLocationTolProperty	Face PMI FCF location characteristics property
FacePMIFCFCharOrientationTolProperty	Face PMI FCF orientation characteristics property
FacePMIFCFCharProfileTolProperty	Face PMI FCF profile characteristics property
FacePMIFCFCharRunoutTolProperty	Face PMI FCF run out characteristics property
FacePMIDatumFeatureProperty	Face PMI datum feature property
FacePMIDatumTargetProperty	Face PMI datum target property
ObjectAttributeProperty	Subpart object attribute property
ObjectCreatedByUserProperty	Subpart object created by user property
ObjectCreatedDateProperty	Subpart object created date property
ObjectCreatedVersionProperty	Subpart object created version property
ObjectRefByWaveLinkProperty	Subpart object referenced by Wave link property
ObjectWaveLinkedProperty	Subpart object Wave linked property
ObjectModifiedByUserProperty	Subpart object modified by user property
ObjectModifiedDateProperty	Subpart object modified date property
ObjectModifiedVersionProperty	Subpart object modified version property
PartitionMembershipProperty	Partition Membership property
ComponentAddedDateProperty	Component Added Date
TeamcenterObjectProperty	Teamcenter Object property
ComponentPatternTypeProperty	Component Pattern Type property
ObjectNameProperty	Subpart object name property
NXOpenProperty	NX Open property
SheetMetalBendAngleProperty	Sheet Metal Bend Angle Property
SheetMetalBendRadiusProperty	Sheet Metal Bend Radius Property
SheetMetalFaceTypeAllProperty	Sheet Metal All Face Type Property
SheetMetalFaceTypeBendProperty	Sheet Metal Bend Face Type Property
SheetMetalFaceTypeDeformProperty	Sheet Metal Deform Face Type Property
SheetMetalFaceTypeWebProperty	Sheet Metal Web Face Type Property
SheetMetalNeutralFactorProperty	Sheet Metal Neutral Factor Property
SheetMetalBodyTypeProperty	Sheet Metal Body Type Property
FeatureFailureProperty	Feature failure component property

Property Documentation

unsafe string NXOpen.VisualReporting.Property.BitmapName

getset

Returns or sets the bitmap name of 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.Property.CustomMessage

getset

Returns or sets the custom message of 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 NXOpen.VisualReporting.Property.TypeOption NXOpen.VisualReporting.Property.PropertyType

get

Returns the NXOpen.VisualReporting.Property.TypeOption of this NXOpen.VisualReporting.Property .

Note that this NXOpen.VisualReporting.Property.PropertyType cannot be modified. Instead it is specified when creating this NXOpen.VisualReporting.Property by using the appropriate function:

NXOpen.VisualReporting.VisualReportBuilder.CreateProperty

Created in NX7.0.0

License requirements: None.

unsafe NXOpen.VisualReporting.Property.DatatypeOption NXOpen.VisualReporting.Property.SystemDatatype

get

Returns the preferred NXOpen.VisualReporting.Property.DatatypeOption that should be used for the owning NXOpen.VisualReporting.Condition or NXOpen.VisualReporting.Classifier .

This function will return a data type of NXOpen.VisualReporting.Property.DatatypeOption.Unknown for properties whose NXOpen.VisualReporting.Property.PropertyType is NXOpen.VisualReporting.Property.TypeOption.TeamcenterProperty , NXOpen.VisualReporting.Property.TypeOption.ServerProperty , or NXOpen.VisualReporting.Property.TypeOption.AttributeProperty where the preferred data type cannot be determined.

Note that this NXOpen.VisualReporting.Property.SystemDatatype cannot be modified. Instead it is determined when creating this NXOpen.VisualReporting.Property by using the appropriate function:

NXOpen.VisualReporting.VisualReportBuilder.CreateProperty

Created in NX7.0.0

License requirements: None.

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

VisualReporting_Property.cs

Public Types

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Property Documentation