NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::VisualReporting::VisualReportBuilder Class Reference

A Builder for creating and editing VisualReporting::VisualReport s. More...

Inheritance diagram for NXOpen::VisualReporting::VisualReportBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  PropertyUsageOption { PropertyUsageOptionTooltip, PropertyUsageOptionInfoView, PropertyUsageOptionTooltipAndInfoView }
 Represents the usage option of reference VisualReporting::Property. More...

Public Member Functions

void AddChildToCondition (NXOpen::VisualReporting::Condition *condition, NXOpen::VisualReporting::Condition *childCondition)
 Add a new child VisualReporting::Condition to this condition.
NXString BitmapNameOfReport ()
 Returns the bitmap name of the VisualReporting::VisualReport .
NXString BitmapNameOfReportingProperty ()
 Returns the bitmap name of the reporting VisualReporting::Property in the active VisualReporting::Classifier .
NXOpen::VisualReporting::VisualReportCommitAsCopy ()
 When Builder::Commit is called on this builder, it will delete the original VisualReporting::VisualReport whose copy the builder is editing and install the copied VisualReporting::VisualReport to the VisualReporting::VisualReportManager .
NXOpen::VisualReporting::ConditionCreateAndCondition ()
 Creates a new empty VisualReporting::Condition , but does not add it to a VisualReporting::Rule .
NXOpen::VisualReporting::ConditionCreateBooleanCondition (NXOpen::VisualReporting::Property *property, bool value, NXOpen::VisualReporting::Condition::OperatorOption operatorType)
 Creates a new empty VisualReporting::Condition whose VisualReporting::Condition::Datatype is VisualReporting::Property::DatatypeOptionBoolean , but does not add it to a VisualReporting::Rule .
NXOpen::VisualReporting::ConditionCreateDateCondition (NXOpen::VisualReporting::Property *property, const NXString &value, NXOpen::VisualReporting::Condition::OperatorOption operatorType)
 Creates a new empty VisualReporting::Condition whose VisualReporting::Condition::Datatype is VisualReporting::Property::DatatypeOptionDate , but does not add it to a VisualReporting::Rule .
NXOpen::VisualReporting::GroupLabelCreateGroupLabel (const NXString &name, NXOpen::VisualReporting::Rule *rule, NXOpen::VisualReporting::GroupLabel *afterGroupLabel)
 Creates a new empty VisualReporting::GroupLabel , and adds it to the given VisualReporting::Rule .
NXOpen::VisualReporting::ConditionCreateIntegerCondition (NXOpen::VisualReporting::Property *property, int value, NXOpen::VisualReporting::Condition::OperatorOption operatorType)
 Creates a new empty VisualReporting::Condition whose VisualReporting::Condition::Datatype is VisualReporting::Property::DatatypeOptionInteger , but does not add it to a VisualReporting::Rule .
NXOpen::VisualReporting::ConditionCreateNotCondition ()
 Creates a new empty VisualReporting::Condition , but does not add it to a VisualReporting::Rule .
NXOpen::VisualReporting::ConditionCreateNullCondition (NXOpen::VisualReporting::Property *property, bool value, NXOpen::VisualReporting::Condition::OperatorOption operatorType)
 Creates a new empty VisualReporting::Condition whose VisualReporting::Condition::Datatype is VisualReporting::Property::DatatypeOptionNull , but does not add it to a VisualReporting::Rule .
NXOpen::VisualReporting::ConditionCreateOrCondition ()
 Creates a new empty VisualReporting::Condition , but does not add it to a VisualReporting::Rule .
NXOpen::VisualReporting::PropertyCreateProperty (NXOpen::VisualReporting::Property::TypeOption propertyType)
 Creates a new empty VisualReporting::Property , but does not add it to a VisualReporting::VisualReport .
NXOpen::VisualReporting::ConditionCreateRealCondition (NXOpen::VisualReporting::Property *property, double value, NXOpen::VisualReporting::Condition::OperatorOption operatorType, double tolerance)
 Creates a new empty VisualReporting::Condition whose VisualReporting::Condition::Datatype is VisualReporting::Property::DatatypeOptionReal , but does not add it to a VisualReporting::Rule .
NXOpen::VisualReporting::ConditionCreateStringCondition (NXOpen::VisualReporting::Property *property, const NXString &value, NXOpen::VisualReporting::Condition::OperatorOption operatorType)
 Creates a new empty VisualReporting::Condition whose VisualReporting::Condition::Datatype is VisualReporting::Property::DatatypeOptionString , but does not add it to a VisualReporting::Rule .
NXOpen::VisualReporting::VisualReportCreateVisualReport ()
 Creates a new empty VisualReporting::VisualReport and starts editing it.
NXString CustomMessageOfReport ()
 Returns the custom message of the VisualReporting::VisualReport .
NXString CustomMessageOfReportingProperty ()
 Returns the custom message of the reporting VisualReporting::Property in the active VisualReporting::Classifier .
void DeleteChildCondition (NXOpen::VisualReporting::Condition *condition, NXOpen::VisualReporting::Condition *childCondition)
 Deletes a VisualReporting::Condition from its parent condition.
void DeleteGroupLabel (NXOpen::VisualReporting::Rule *rule, NXOpen::VisualReporting::GroupLabel *groupLabel)
 Deletes the given VisualReporting::GroupLabel from the active VisualReporting::Classifier in this VisualReporting::Rule .
void DeleteProperty (NXOpen::VisualReporting::Property *property)
 Delete VisualReporting::Property which has no owner.
NXString DescriptionOfVisualReport ()
 Returns the description of the VisualReporting::VisualReport being built by this builder.
NXString DescriptiveCategoryOfVisualReport ()
 Returns the descriptive category of the VisualReporting::VisualReport being built by this builder.
NXString DestinationTeamcenterFolder ()
 Returns the destination Teamcenter folder for saving the VisualReporting::VisualReport being built by this builder to Teamcenter database.
void EditVisualReport (NXOpen::VisualReporting::VisualReport *visualReport)
 Starts editing a VisualReporting::VisualReport .
void EnableUnmatchedGroupOfVisualReport (bool enableUnmatchedGroup)
 Sets whether use of VisualReporting::VisualReport::UnmatchedGroupLabel is enabled for the VisualReporting::VisualReport being built by this builder.
NXString FilenameOfVisualReport ()
 Returns the file name of the VisualReporting::VisualReport being built by this builder.
NXOpen::VisualReporting::ClassifierGetActiveClassifierOfRule (NXOpen::VisualReporting::Rule *rule)
 Gets the active VisualReporting::Classifier in this VisualReporting::Rule for a multiple properties report.
std::vector
< NXOpen::VisualReporting::GroupLabel * > 
GetAllGroupLabelsOfRule (NXOpen::VisualReporting::Rule *rule)
 Returns the VisualReporting::GroupLabel s associated with the active VisualReporting::Classifier in this VisualReporting::Rule .
NXString GetBitmapNameOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel)
 Gets the bitmap of the given VisualReporting::GroupLabel .
NXOpen::VisualReporting::ConditionGetChildCondition (NXOpen::VisualReporting::Condition *condition, int index)
 Returns the specified child VisualReporting::Condition from this VisualReporting::Condition.
std::vector
< NXOpen::VisualReporting::Condition * > 
GetChildConditions (NXOpen::VisualReporting::Condition *condition)
 Returns all the child VisualReporting::Condition s in this VisualReporting::Condition.
std::vector
< NXOpen::VisualReporting::Classifier * > 
GetClassifiersOfRule (NXOpen::VisualReporting::Rule *rule)
 Returns the VisualReporting::Classifier s associated with this VisualReporting::Rule .
NXOpen::VisualReporting::Classifier::TypeOption GetClassifierTypeOfRule (NXOpen::VisualReporting::Rule *rule)
 Gets the reporting VisualReporting::Classifier::TypeOption for the active VisualReporting::Classifier in this VisualReporting::Rule .
NXOpen::NXColor::Rgb GetColorOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel)
 Gets the VisualReporting::GroupLabel::Color of the given VisualReporting::GroupLabel .
NXString GetCustomMessageOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel)
 Gets the custom message of the givenVisualReporting::GroupLabel .
NXOpen::VisualReporting::Classifier::DateGroupMethodOption GetDateGroupMethodOfRule (NXOpen::VisualReporting::Rule *rule)
 Gets the VisualReporting::Classifier::DateGroupMethodOption of the active VisualReporting::Classifier in the given VisualReporting::Rule .
NXString GetDescriptionOfCondition (NXOpen::VisualReporting::Condition *condition)
 Gets the VisualReporting::Condition::Description of the specified VisualReporting::Condition .
NXOpen::VisualReporting::GroupLabel::DisplayStyleOption GetDisplayStyleForGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel)
 Gets the VisualReporting::GroupLabel::DisplayStyleOption of the given VisualReporting::GroupLabel.
NXOpen::VisualReporting::ConditionGetFilterConditionOfRule (NXOpen::VisualReporting::Rule *rule)
 Gets the filter VisualReporting::Condition from this rule.
NXOpen::VisualReporting::Classifier::GroupingMethodOption GetGroupingMethodOfRule (NXOpen::VisualReporting::Rule *rule)
 Gets the VisualReporting::Classifier::GroupingMethodOption of the active VisualReporting::Classifier in this VisualReporting::Rule .
bool GetHasUserSpecifiedValueForCondition (NXOpen::VisualReporting::Condition *condition)
 Gets VisualReporting::Condition::HasUserSpecifiedValue on the specified VisualReporting::Condition .
NXString GetLowerBoundOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel)
 Gets the VisualReporting::GroupLabel::LowerBound of the given VisualReporting::GroupLabel .
bool GetManualGroupingForRule (NXOpen::VisualReporting::Rule *rule)
 Gets whether the VisualReporting::Classifier::GroupingMethodOption of the active VisualReporting::Classifier in this VisualReporting::Rule is VisualReporting::Classifier::GroupingMethodOptionManual .
NXOpen::VisualReporting::GroupLabelGetManualGroupLabelOfRule (NXOpen::VisualReporting::Rule *rule, int index)
 Returns the specified VisualReporting::GroupLabel s associated with the active VisualReporting::Classifier in this VisualReporting::Rule which are manually defined.
std::vector
< NXOpen::VisualReporting::GroupLabel * > 
GetManualGroupLabelsOfRule (NXOpen::VisualReporting::Rule *rule)
 Returns the VisualReporting::GroupLabel s associated with the active VisualReporting::Classifier in this VisualReporting::Rule which are manually defined.
NXOpen::VisualReporting::Condition::OperatorOption GetOperatorTypeOfCondition (NXOpen::VisualReporting::Condition *condition)
 Gets the VisualReporting::Condition::OperatorOption of this condition.
NXOpen::VisualReporting::ConditionGetParentCondition (NXOpen::VisualReporting::Condition *condition)
 Gets the parent condition of this VisualReporting::Condition .
NXOpen::VisualReporting::PropertyGetPropertyForComparison (NXOpen::VisualReporting::Condition *condition)
 Gets the VisualReporting::Property in the value for comparison of this VisualReporting::Condition .
NXOpen::VisualReporting::PropertyGetPropertyOfCondition (NXOpen::VisualReporting::Condition *condition)
 Gets the VisualReporting::Property of this condition.
void GetPropertySpecification (NXOpen::VisualReporting::Property *property, NXOpen::VisualReporting::Property::TypeOption *propertyType, NXString *key, NXString *name)
 Gets the property specification of the VisualReporting::Property being built by this builder.
NXOpen::VisualReporting::Classifier::RangeMethodOption GetRangeMethodOfRule (NXOpen::VisualReporting::Rule *rule)
 Gets the VisualReporting::Classifier::RangeMethodOption of the active VisualReporting::Classifier in the given VisualReporting::Rule .
void GetReferencePropertiesOfReport (std::vector< NXOpen::VisualReporting::Property * > &properties, std::vector< NXOpen::VisualReporting::VisualReportBuilder::PropertyUsageOption > &usages, int *notUsed)
 Gets the message VisualReporting::Property list of the VisualReporting::VisualReport .
void GetReferencePropertiesOfReportingProperty (std::vector< NXOpen::VisualReporting::Property * > &properties, std::vector< NXOpen::VisualReporting::VisualReportBuilder::PropertyUsageOption > &usages)
 Gets the message VisualReporting::Property list of the VisualReporting::Property in the active VisualReporting::Classifier .
NXOpen::VisualReporting::Property::DatatypeOption GetReportingDatatypeOfRule (NXOpen::VisualReporting::Rule *rule)
 Gets the VisualReporting::Property::DatatypeOption of the active VisualReporting::Classifier 's reporting VisualReporting::Property in this VisualReporting::Rule .
NXOpen::VisualReporting::PropertyGetReportingPropertyOfRule (NXOpen::VisualReporting::Rule *rule)
 Gets the reporting VisualReporting::Property for the active VisualReporting::Classifier in this VisualReporting::Rule .
NXOpen::VisualReporting::RuleGetRule (int index)
 Return the specified VisualReporting::Rule from the VisualReporting::VisualReport being built by this builder.
std::vector
< NXOpen::VisualReporting::Rule * > 
GetRules ()
 Returns all the VisualReporting::Rule s in the VisualReporting::VisualReport being built by this builder.
NXOpen::VisualReporting::GroupLabel::TagPriorityOption GetTagPriorityOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel)
 Gets the priority of the givenVisualReporting::GroupLabel .
NXString GetUpperBoundOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel)
 Gets the VisualReporting::GroupLabel::UpperBound of the given VisualReporting::GroupLabel .
NXString GetUserNameOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel)
 Gets the NXObject::Name of the given VisualReporting::GroupLabel .
NXString GetUserPromptOfCondition (NXOpen::VisualReporting::Condition *condition)
 Gets the VisualReporting::Condition::UserPrompt of the specified VisualReporting::Condition .
NXString GetValueOfCondition (NXOpen::VisualReporting::Condition *condition)
 Gets the value of this VisualReporting::Condition .
NXString GetValueOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel)
 Gets the VisualReporting::GroupLabel::Value of the given VisualReporting::GroupLabel .
bool IsChildCondition (NXOpen::VisualReporting::Condition *condition, NXOpen::VisualReporting::Condition *childCondition)
 Returns whether the given VisualReporting::Condition is an immediate child of this condition.
NXString KeywordsOfVisualReport ()
 Returns the keywords of the VisualReporting::VisualReport being built by this builder.
void RemoveChildFromCondition (NXOpen::VisualReporting::Condition *condition, NXOpen::VisualReporting::Condition *childCondition)
 Removes a condition from its parent condition.
void RemoveFilterConditionFromRule (NXOpen::VisualReporting::Rule *rule)
 Removes any existing filter VisualReporting::Condition from this rule.
void RemovePropertyFromCondition (NXOpen::VisualReporting::Condition *condition)
 Removes the current VisualReporting::Property from this condition without deleting it.
NXOpen::VisualReporting::VisualReport::ReportingObjectTypeOption ReportingObjectTypeOfVisualReport ()
 Returns the reporting object type of the VisualReporting::VisualReport being built by this builder.
NXOpen::VisualReporting::VisualReport::ReportingStyleOption ReportingStyleOfVisualReport ()
 Returns the reporting style of the VisualReporting::VisualReport being built by this builder.
NXString ReportNameOfVisualReport ()
 Returns the name of the VisualReporting::VisualReport being built by this builder.
void Save ()
 Saves the VisualReporting::VisualReport to its current VisualReporting::VisualReportBuilder::FilenameOfVisualReport .
NXOpen::VisualReporting::VisualReport::SaveDestinationOption SaveDestination ()
 Returns the VisualReporting::VisualReport::SaveDestinationOption of the VisualReporting::VisualReport being built by this builder.
void SetActiveClassifierOfRule (NXOpen::VisualReporting::Rule *rule, NXOpen::VisualReporting::Classifier *activeClassifier)
 Sets the active VisualReporting::Classifier in this VisualReporting::Rule for a multiple properties report.
void SetBitmapNameOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel, const NXString &bitmapName)
 Sets the bitmap of the given VisualReporting::GroupLabel .
void SetBitmapNameOfReport (const NXString &bitmapName)
 Sets the bitmap name of the VisualReporting::VisualReport .
void SetBitmapNameOfReportingProperty (const NXString &bitmapName)
 Sets the bitmap name of the reporting VisualReporting::Property in the active VisualReporting::Classifier .
NXOpen::VisualReporting::ClassifierSetClassifierTypeOfRule (NXOpen::VisualReporting::Rule *rule, NXOpen::VisualReporting::Classifier::TypeOption classifierType)
 Sets the reporting VisualReporting::Classifier::TypeOption for the active VisualReporting::Classifier in this VisualReporting::Rule .
void SetColorOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel, const NXOpen::NXColor::Rgb &color)
 Sets the VisualReporting::GroupLabel::Color of the given VisualReporting::GroupLabel .
void SetCustomMessageOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel, const NXString &customMessage)
 Sets the custom message of the given VisualReporting::GroupLabel .
void SetCustomMessageOfReport (const NXString &customMessage)
 Sets the custom message of the VisualReporting::VisualReport .
void SetCustomMessageOfReportingProperty (const NXString &customMessage)
 Sets the custom message of the reporting VisualReporting::Property in the active VisualReporting::Classifier .
void SetDateGroupMethodOfRule (NXOpen::VisualReporting::Rule *rule, NXOpen::VisualReporting::Classifier::DateGroupMethodOption dateGroupMethod)
 Sets the VisualReporting::Classifier::DateGroupMethodOption of the active VisualReporting::Classifier in the given VisualReporting::Rule .
void SetDescriptionOfCondition (NXOpen::VisualReporting::Condition *condition, const NXString &description)
 Sets the VisualReporting::Condition::Description of the specified VisualReporting::Condition .
void SetDescriptionOfVisualReport (const NXString &description)
 Sets the description of the VisualReporting::VisualReport being built by this builder.
void SetDescriptiveCategoryOfVisualReport (const NXString &category)
 Sets the descriptive category of the VisualReporting::VisualReport being built by this builder.
void SetDestinationTeamcenterFolder (const NXString &foldername)
 Sets the destination Teamcenter folder for saving the VisualReporting::VisualReport being built by this builder to Teamcenter database.
void SetDisplayStyleForGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel, NXOpen::VisualReporting::GroupLabel::DisplayStyleOption displayStyle)
 Sets the VisualReporting::GroupLabel::DisplayStyleOption of the given VisualReporting::GroupLabel.
void SetFilenameOfVisualReport (const NXString &filename)
 Sets the file name of the VisualReporting::VisualReport being built by this builder.
void SetFilterConditionOfRule (NXOpen::VisualReporting::Rule *rule, NXOpen::VisualReporting::Condition *filterCondition)
 Sets the filter VisualReporting::Condition from this rule.
void SetGroupingMethodOfRule (NXOpen::VisualReporting::Rule *rule, NXOpen::VisualReporting::Classifier::GroupingMethodOption groupingMethod)
 Sets the VisualReporting::Classifier::GroupingMethodOption of the active VisualReporting::Classifier in the given VisualReporting::Rule .
void SetHasUserSpecifiedValueForCondition (NXOpen::VisualReporting::Condition *condition, bool isUserSpecified)
 Sets VisualReporting::Condition::HasUserSpecifiedValue on the specified VisualReporting::Condition .
void SetKeywordsOfVisualReport (const NXString &keywords)
 Sets the keywords of the VisualReporting::VisualReport being built by this builder.
void SetLowerBoundOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel, const NXString &lowerBound)
 Sets the VisualReporting::GroupLabel::LowerBound of the given VisualReporting::GroupLabel .
void SetManualGroupingForRule (NXOpen::VisualReporting::Rule *rule, bool isManualGrouping)
 Sets whether the VisualReporting::Classifier::GroupingMethodOption of the active VisualReporting::Classifier in this VisualReporting::Rule is VisualReporting::Classifier::GroupingMethodOptionManual .
void SetOperatorTypeOfCondition (NXOpen::VisualReporting::Condition *condition, NXOpen::VisualReporting::Condition::OperatorOption operatorType)
 Sets the VisualReporting::Condition::OperatorOption of this condition.
void SetPropertyForComparison (NXOpen::VisualReporting::Condition *condition, NXOpen::VisualReporting::Property *property)
 Sets the VisualReporting::Property in the value for comparison of this VisualReporting::Condition .
void SetPropertyOfCondition (NXOpen::VisualReporting::Condition *condition, NXOpen::VisualReporting::Property *property)
 Sets the VisualReporting::Property of this condition.
void SetPropertySpecification (NXOpen::VisualReporting::Property *property, const NXString &key)
 Sets the property specification of the VisualReporting::Property being built by this builder.
void SetPropertySpecification (NXOpen::VisualReporting::Property *property, const NXString &key, const NXString &name)
 Sets the property specification of the VisualReporting::Property being built by this builder.
void SetRangeMethodOfRule (NXOpen::VisualReporting::Rule *rule, NXOpen::VisualReporting::Classifier::RangeMethodOption rangeMethod)
 Sets the VisualReporting::Classifier::RangeMethodOption of the active VisualReporting::Classifier in the given VisualReporting::Rule .
void SetReferencePropertiesOfReport (const std::vector< NXOpen::VisualReporting::Property * > &properties, const std::vector< NXOpen::VisualReporting::VisualReportBuilder::PropertyUsageOption > &usages)
 Sets the message VisualReporting::Property list of the VisualReporting::VisualReport .
void SetReferencePropertiesOfReportingProperty (const std::vector< NXOpen::VisualReporting::Property * > &properties, const std::vector< NXOpen::VisualReporting::VisualReportBuilder::PropertyUsageOption > &usages)
 Sets the message VisualReporting::Property list of the VisualReporting::Property in the active VisualReporting::Classifier .
void SetReportingDatatypeOfRule (NXOpen::VisualReporting::Rule *rule, NXOpen::VisualReporting::Property::DatatypeOption datatype)
 Sets the VisualReporting::Property::DatatypeOption of the active VisualReporting::Classifier 's reporting VisualReporting::Property in this VisualReporting::Rule .
void SetReportingObjectTypeOfVisualReport (NXOpen::VisualReporting::VisualReport::ReportingObjectTypeOption reportingObjectType)
 Sets the reporting object type of the VisualReporting::VisualReport being built by this builder.
void SetReportingPropertyOfRule (NXOpen::VisualReporting::Rule *rule, NXOpen::VisualReporting::Property *reportingProperty)
 Sets the reporting VisualReporting::Property for the active VisualReporting::Classifier in this VisualReporting::Rule .
void SetReportingStyleOfVisualReport (NXOpen::VisualReporting::VisualReport::ReportingStyleOption reportingStyle)
 Sets the reporting style of the VisualReporting::VisualReport being built by this builder.
void SetReportNameOfVisualReport (const NXString &reportName)
 Sets the name of the VisualReporting::VisualReport being built by this builder.
void SetSaveDestination (NXOpen::VisualReporting::VisualReport::SaveDestinationOption destinationOption)
 Sets the VisualReporting::VisualReport::SaveDestinationOption of the VisualReporting::VisualReport being built by this builder.
void SetTagPriorityOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel, NXOpen::VisualReporting::GroupLabel::TagPriorityOption tagPriority)
 Sets the priority of the givenVisualReporting::GroupLabel .
void SetUpperBoundOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel, const NXString &upperBound)
 Sets the VisualReporting::GroupLabel::UpperBound of the given VisualReporting::GroupLabel .
void SetUserNameOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel, const NXString &name)
 Sets the NXObject::Name of the given VisualReporting::GroupLabel .
void SetUserPromptOfCondition (NXOpen::VisualReporting::Condition *condition, const NXString &userPrompt)
 Sets the VisualReporting::Condition::UserPrompt of the specified VisualReporting::Condition .
void SetValueOfCondition (NXOpen::VisualReporting::Condition *condition, const NXString &value)
 Sets the value of this VisualReporting::Condition .
void SetValueOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel, const NXString &value)
 Sets the VisualReporting::GroupLabel::Value of the given VisualReporting::GroupLabel .
void UnsetUserNameOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel)
 Resets the VisualReporting::GroupLabel::IsNameUserSpecified status of the given VisualReporting::GroupLabel so that the name is now system-generated.

Detailed Description

A Builder for creating and editing VisualReporting::VisualReport s.


To create a new instance of this class, use VisualReporting::VisualReportManager::CreateVisualReportBuilder

Created in NX7.0.0.


Member Enumeration Documentation

Represents the usage option of reference VisualReporting::Property.

Enumerator:
PropertyUsageOptionTooltip 

The property is used in tooltip only.

PropertyUsageOptionInfoView 

The property is used in info view only.

PropertyUsageOptionTooltipAndInfoView 

tooltip and info view


Member Function Documentation

Add a new child VisualReporting::Condition to this condition.

If the child is already a child of another VisualReporting::Condition or VisualReporting::Rule , then it is removed from that other object. The new child must have been created in the same VisualReporting::VisualReport as this parent condition. If this is a VisualReporting::Condition::TypeOptionNotCondition then this replaces the existing child, and the existing child is deleted.


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
conditionThe condition
childConditionThe child condition being added

Returns the bitmap name of the VisualReporting::VisualReport .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Returns the bitmap name of the reporting VisualReporting::Property in the active VisualReporting::Classifier .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

When Builder::Commit is called on this builder, it will delete the original VisualReporting::VisualReport whose copy the builder is editing and install the copied VisualReporting::VisualReport to the VisualReporting::VisualReportManager .

If it is required not to delete the original VisualReporting::VisualReport , then CommitAsCopy can be called instead. This behaves just like Builder::Commit except it does not delete the original VisualReporting::VisualReport .

Returns:

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Creates a new empty VisualReporting::Condition , but does not add it to a VisualReporting::Rule .

Returns:
The created condition
Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Creates a new empty VisualReporting::Condition whose VisualReporting::Condition::Datatype is VisualReporting::Property::DatatypeOptionBoolean , but does not add it to a VisualReporting::Rule .

Returns:
The created condition
Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
propertyThe VisualReporting::Property to which this condition will be applied
valueThe initial value
operatorTypeThe initial operator

Creates a new empty VisualReporting::Condition whose VisualReporting::Condition::Datatype is VisualReporting::Property::DatatypeOptionDate , but does not add it to a VisualReporting::Rule .

Returns:
The created condition
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
propertyThe VisualReporting::Property to which this condition will be applied
valueThe initial value
NOTE: The full Unicode character set is not supported for this parameter.
operatorTypeThe initial operator

Creates a new empty VisualReporting::GroupLabel , and adds it to the given VisualReporting::Rule .

This can only be called if the active VisualReporting::Classifier in this rule is using VisualReporting::Classifier::GroupingMethodOptionManual grouping.

Returns:
The created group label
Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
nameThe initial name. If this name is empty then a system-generated name will be assigned when the owning VisualReporting::VisualReport is next activated
NOTE: The full Unicode character set is not supported for this parameter.
ruleThe rule to which to add it
afterGroupLabelThe group label after which to add it. If NULL then it is inserted at the beginning before any existing group labels

Creates a new empty VisualReporting::Condition whose VisualReporting::Condition::Datatype is VisualReporting::Property::DatatypeOptionInteger , but does not add it to a VisualReporting::Rule .

Returns:
The created condition
Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
propertyThe VisualReporting::Property to which this condition will be applied
valueThe initial value
operatorTypeThe initial operator

Creates a new empty VisualReporting::Condition , but does not add it to a VisualReporting::Rule .

Returns:
The created condition
Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Creates a new empty VisualReporting::Condition whose VisualReporting::Condition::Datatype is VisualReporting::Property::DatatypeOptionNull , but does not add it to a VisualReporting::Rule .

Returns:
The created condition
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
propertyThe VisualReporting::Property to which this condition will be applied
valueThe initial value
operatorTypeThe initial operator

Creates a new empty VisualReporting::Condition , but does not add it to a VisualReporting::Rule .

Returns:
The created condition
Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Creates a new empty VisualReporting::Property , but does not add it to a VisualReporting::VisualReport .

Returns:
The created property
Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
propertyTypeProperty Type of the VisualReporting::Property being created

Creates a new empty VisualReporting::Condition whose VisualReporting::Condition::Datatype is VisualReporting::Property::DatatypeOptionReal , but does not add it to a VisualReporting::Rule .

Returns:
The created condition
Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
propertyThe VisualReporting::Property to which this condition will be applied
valueThe initial value
operatorTypeThe initial operator
toleranceThe tolerance used in comparisons

Creates a new empty VisualReporting::Condition whose VisualReporting::Condition::Datatype is VisualReporting::Property::DatatypeOptionString , but does not add it to a VisualReporting::Rule .

Returns:
The created condition
Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
propertyThe VisualReporting::Property to which this condition will be applied
valueThe initial value
NOTE: The full Unicode character set is not supported for this parameter.
operatorTypeThe initial operator

Creates a new empty VisualReporting::VisualReport and starts editing it.

The created VisualReporting::VisualReport will not be added to the VisualReporting::VisualReportManager until Builder::Commit or VisualReporting::VisualReportBuilder::CommitAsCopy is called on this builder.

Returns:

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Returns the custom message of the VisualReporting::VisualReport .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Returns the custom message of the reporting VisualReporting::Property in the active VisualReporting::Classifier .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Deletes a VisualReporting::Condition from its parent condition.

If there are VisualReporting::Property s associated with this condition, these properties will be deleted. If there are child conditions associated with this condtion, these child conditions will be deleted too.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
conditionThe condition
childConditionThe child condition being removed

Deletes the given VisualReporting::GroupLabel from the active VisualReporting::Classifier in this VisualReporting::Rule .


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
ruleThe rule containing the group label
groupLabelThe group label

Delete VisualReporting::Property which has no owner.

Before call this function, User must be sure there is no reference to this object


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
propertyThe property to be deleted

Returns the description of the VisualReporting::VisualReport being built by this builder.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Returns the descriptive category of the VisualReporting::VisualReport being built by this builder.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Returns the destination Teamcenter folder for saving the VisualReporting::VisualReport being built by this builder 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 VisualReporting::VisualReport::DestinationTeamcenterFolder may return NULL if you haven't set a folder name on this property.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Starts editing a VisualReporting::VisualReport .

The builder will create a copy of the given VisualReport and all edits will be applied to that copy. When Builder::Commit is called on this builder, the supplied VisualReport will be deleted and replaced with the new one. Alternatively if VisualReporting::VisualReportBuilder::CommitAsCopy is called, the copied VisualReporting::VisualReport will be added to the VisualReporting::VisualReportManager without deleting the one given in this function.

Any current VisualReporting::VisualReport which this builder is currently building will be deleted when this function is called.


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
visualReportThe visual report

Sets whether use of VisualReporting::VisualReport::UnmatchedGroupLabel is enabled for the VisualReporting::VisualReport being built by this builder.


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
enableUnmatchedGroupWhether the unmatched group is enabled

Returns the file name of the VisualReporting::VisualReport being built by this builder.

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 VisualReporting::VisualReportBuilder::Save , the report dataset identifier will be saved in this property.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Gets the active VisualReporting::Classifier in this VisualReporting::Rule for a multiple properties report.

Returns:

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
rulerule

Returns the VisualReporting::GroupLabel s associated with the active VisualReporting::Classifier in this VisualReporting::Rule .

Returns:
The manually defined groups
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
ruleThe rule

Gets the bitmap of the given VisualReporting::GroupLabel .

Returns:
The bitmap name
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
groupLabelThe group label

Returns the specified child VisualReporting::Condition from this VisualReporting::Condition.

Returns:

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
conditioncondition
indexThe index of the returned Condition.

Returns all the child VisualReporting::Condition s in this VisualReporting::Condition.

Returns:

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
conditioncondition

Returns the VisualReporting::Classifier s associated with this VisualReporting::Rule .

Returns:

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
rulerule

Gets the reporting VisualReporting::Classifier::TypeOption for the active VisualReporting::Classifier in this VisualReporting::Rule .

Returns:
The classifier type
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
ruleThe rule

Gets the VisualReporting::GroupLabel::Color of the given VisualReporting::GroupLabel .

Returns:
The color
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
groupLabelThe group label

Gets the custom message of the givenVisualReporting::GroupLabel .

Returns:
The bitmap name
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
groupLabelThe group label

Gets the VisualReporting::Classifier::DateGroupMethodOption of the active VisualReporting::Classifier in the given VisualReporting::Rule .

Only valid if the active VisualReporting::Classifier in the rule is VisualReporting::Classifier::TypeOptionRange type.

Returns:
The range method
Created in NX8.0.1.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
ruleThe rule

Gets the VisualReporting::Condition::Description of the specified VisualReporting::Condition .

Only valid for a VisualReporting::Condition whose VisualReporting::Condition::Type is VisualReporting::Condition::TypeOptionValueCondition

Returns:
The description
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
conditionThe condition

Gets the VisualReporting::GroupLabel::DisplayStyleOption of the given VisualReporting::GroupLabel.

Returns:
The display style
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
groupLabelThe group label

Gets the filter VisualReporting::Condition from this rule.

Returns:
The filter condition
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
ruleThe rule

Gets the VisualReporting::Classifier::GroupingMethodOption of the active VisualReporting::Classifier in this VisualReporting::Rule .

Returns:
The grouping method
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
ruleThe rule

Gets VisualReporting::Condition::HasUserSpecifiedValue on the specified VisualReporting::Condition .

Only valid for a VisualReporting::Condition whose VisualReporting::Condition::Type is VisualReporting::Condition::TypeOptionValueCondition

Returns:
Whether the condition's value should be user-specified
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
conditionThe condition

Gets the VisualReporting::GroupLabel::LowerBound of the given VisualReporting::GroupLabel .

Returns:
The lower bound
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
groupLabelThe group label

Gets whether the VisualReporting::Classifier::GroupingMethodOption of the active VisualReporting::Classifier in this VisualReporting::Rule is VisualReporting::Classifier::GroupingMethodOptionManual .

Returns:
Whether manual grouping should be used
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
ruleThe rule

Returns the specified VisualReporting::GroupLabel s associated with the active VisualReporting::Classifier in this VisualReporting::Rule which are manually defined.

Returns:
The specified manually defined group
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
ruleThe rule
indexindex

Returns the VisualReporting::GroupLabel s associated with the active VisualReporting::Classifier in this VisualReporting::Rule which are manually defined.

Returns:
The manually defined groups
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
ruleThe rule

Gets the VisualReporting::Condition::OperatorOption of this condition.

Only valid if VisualReporting::Condition::TypeOption is VisualReporting::Condition::TypeOptionValueCondition

Returns:
The operator type being set
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
conditionThe condition

Gets the parent condition of this VisualReporting::Condition .

If this condition has no parent or if the parent isn't a condition then this returns NULL.

Returns:

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
conditioncondition

Gets the VisualReporting::Property in the value for comparison of this VisualReporting::Condition .

Returns:
The property
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
conditionThe condition

Gets the VisualReporting::Property of this condition.

Only valid for a VisualReporting::Condition whose VisualReporting::Condition::Type is VisualReporting::Condition::TypeOptionValueCondition

Returns:
The property
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
conditionThe condition

Gets the property specification of the VisualReporting::Property being built by this builder.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
propertyThe property being ask
propertyTypeProperty Type of the VisualReporting::Property
keyproperty key
nameproperty name

Gets the VisualReporting::Classifier::RangeMethodOption of the active VisualReporting::Classifier in the given VisualReporting::Rule .

Only valid if the active VisualReporting::Classifier in the rule is VisualReporting::Classifier::TypeOptionRange type.

Returns:
The range method
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
ruleThe rule

Gets the message VisualReporting::Property list of the VisualReporting::VisualReport .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
propertiesThe reference properties of report
usagesThe usages of report
notUsednotused

Gets the message VisualReporting::Property list of the VisualReporting::Property in the active VisualReporting::Classifier .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
propertiesThe reference properties of property
usagesThe usages

Gets the VisualReporting::Property::DatatypeOption of the active VisualReporting::Classifier 's reporting VisualReporting::Property in this VisualReporting::Rule .

Returns:
The datatype
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
ruleThe rule

Gets the reporting VisualReporting::Property for the active VisualReporting::Classifier in this VisualReporting::Rule .

Returns:
The property
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
ruleThe rule

Return the specified VisualReporting::Rule from the VisualReporting::VisualReport being built by this builder.

Returns:

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
indexThe index of the returned VisualReporting::Rule .

Returns all the VisualReporting::Rule s in the VisualReporting::VisualReport being built by this builder.

Returns:

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Gets the priority of the givenVisualReporting::GroupLabel .

Returns:
The priority
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
groupLabelThe group label

Gets the VisualReporting::GroupLabel::UpperBound of the given VisualReporting::GroupLabel .

Returns:
The upper bound
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
groupLabelThe group label

Gets the NXObject::Name of the given VisualReporting::GroupLabel .

Returns:
The name
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
groupLabelThe group label

Gets the VisualReporting::Condition::UserPrompt of the specified VisualReporting::Condition .

Only valid for a VisualReporting::Condition whose VisualReporting::Condition::Type is VisualReporting::Condition::TypeOptionValueCondition

Returns:
The user-prompt
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
conditionThe condition

Gets the value of this VisualReporting::Condition .

Only valid for a VisualReporting::Condition whose VisualReporting::Condition::Type is VisualReporting::Condition::TypeOptionValueCondition

Returns:

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
conditioncondition

Gets the VisualReporting::GroupLabel::Value of the given VisualReporting::GroupLabel .

Returns:
The value
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
groupLabelThe group label

Returns whether the given VisualReporting::Condition is an immediate child of this condition.

Returns:

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
conditioncondition
childConditionThe possible child Condition

Returns the keywords of the VisualReporting::VisualReport being built by this builder.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Removes a condition from its parent condition.

If the condition has an associated VisualReporting::Property that will be deleted too. If the condition has any child conditions, those will all be deleted too.


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
conditionThe condition
childConditionThe child condition being removed

Removes any existing filter VisualReporting::Condition from this rule.

This will not delete the condition.


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
ruleThe rule

Removes the current VisualReporting::Property from this condition without deleting it.


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
conditionThe condition

Returns the reporting object type of the VisualReporting::VisualReport being built by this builder.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Returns the reporting style of the VisualReporting::VisualReport being built by this builder.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Returns the name of the VisualReporting::VisualReport being built by this builder.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Saves the VisualReporting::VisualReport to its current VisualReporting::VisualReportBuilder::FilenameOfVisualReport .

Note that when NX is connected to Teamcenter, the VisualReporting::VisualReportBuilder::FilenameOfVisualReport will be updated to the report dataset identifier after the report is saved to Teamcenter database.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Returns the VisualReporting::VisualReport::SaveDestinationOption of the VisualReporting::VisualReport being built by this builder.

Note that this property will always be VisualReporting::VisualReport::SaveDestinationOptionLocal when NX is not connected to Teamcenter.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Sets the active VisualReporting::Classifier in this VisualReporting::Rule for a multiple properties report.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
rulerule
activeClassifieractiveclassifier

Sets the bitmap of the given VisualReporting::GroupLabel .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
groupLabelThe group label
bitmapNameThe bitmap name

Sets the bitmap name of the VisualReporting::VisualReport .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
bitmapNameThe bitmap name

Sets the bitmap name of the reporting VisualReporting::Property in the active VisualReporting::Classifier .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
bitmapNameThe bitmap name

Sets the reporting VisualReporting::Classifier::TypeOption for the active VisualReporting::Classifier in this VisualReporting::Rule .

Note that the old VisualReporting::Classifier in this VisualReporting::Rule will be deleted and a new VisualReporting::Classifier will be created and set as the active VisualReporting::Classifier in this VisualReporting::Rule .

Returns:
The new active classifier
Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")
Parameters:
ruleThe rule
classifierTypeThe classifier type being set

Sets the VisualReporting::GroupLabel::Color of the given VisualReporting::GroupLabel .

This also changes VisualReporting::GroupLabel::DisplayStyle to VisualReporting::GroupLabel::DisplayStyleOptionSpecifiedColor .


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
groupLabelThe group label
colorThe color

Sets the custom message of the given VisualReporting::GroupLabel .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
groupLabelThe group label
customMessageThe bitmap name

Sets the custom message of the VisualReporting::VisualReport .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
customMessageThe custom message

Sets the custom message of the reporting VisualReporting::Property in the active VisualReporting::Classifier .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
customMessageThe custom message

Sets the VisualReporting::Classifier::DateGroupMethodOption of the active VisualReporting::Classifier in the given VisualReporting::Rule .

Only valid if the active VisualReporting::Classifier in the rule is VisualReporting::Classifier::TypeOptionRange type.


Created in NX8.0.1.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
ruleThe rule
dateGroupMethodThe range method

Sets the VisualReporting::Condition::Description of the specified VisualReporting::Condition .

Only valid for a VisualReporting::Condition whose VisualReporting::Condition::Type is VisualReporting::Condition::TypeOptionValueCondition


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
conditionThe condition
descriptionThe description
NOTE: The full Unicode character set is not supported for this parameter.

Sets the description of the VisualReporting::VisualReport being built by this builder.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
descriptionThe description

Sets the descriptive category of the VisualReporting::VisualReport being built by this builder.


Created in NX7.5.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
categoryThe category being set

Sets the destination Teamcenter folder for saving the VisualReporting::VisualReport being built by this builder 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 VisualReporting::VisualReport::DestinationTeamcenterFolder may return NULL if you haven't set a folder name on this property.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
foldernameThe Teamcenter folder name

Sets the VisualReporting::GroupLabel::DisplayStyleOption of the given VisualReporting::GroupLabel.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
groupLabelThe group label
displayStyleThe display style

Sets the file name of the VisualReporting::VisualReport being built by this builder.

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 VisualReporting::VisualReportBuilder::Save , the report dataset identifier will be saved in this property.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
filenameThe file name

Sets the filter VisualReporting::Condition from this rule.

Setting this will delete any existing VisualReporting::Rule::FilterCondition and all of its children (except it won't delete the replacement VisualReporting::Condition being set by this call).


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
ruleThe rule
filterConditionThe filter condition being set

Sets the VisualReporting::Classifier::GroupingMethodOption of the active VisualReporting::Classifier in the given VisualReporting::Rule .

If the active VisualReporting::Classifier uses manual grouping then no VisualReporting::GroupLabel s will be automatically generated, and they should instead be added using VisualReporting::VisualReportBuilder::CreateGroupLabel .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
ruleThe rule
groupingMethodThe grouping method

Sets VisualReporting::Condition::HasUserSpecifiedValue on the specified VisualReporting::Condition .

Only valid for a VisualReporting::Condition whose VisualReporting::Condition::Type is VisualReporting::Condition::TypeOptionValueCondition


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
conditionThe condition
isUserSpecifiedWhether the condition's value should be user-specified

Sets the keywords of the VisualReporting::VisualReport being built by this builder.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
keywordsA comma separated string of keywords

Sets the VisualReporting::GroupLabel::LowerBound of the given VisualReporting::GroupLabel .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
groupLabelThe group label
lowerBoundThe lower bound
NOTE: The full Unicode character set is not supported for this parameter.

Sets whether the VisualReporting::Classifier::GroupingMethodOption of the active VisualReporting::Classifier in this VisualReporting::Rule is VisualReporting::Classifier::GroupingMethodOptionManual .

If it uses VisualReporting::Classifier::GroupingMethodOptionManual , then no VisualReporting::GroupLabel s will be automatically generated, and they should instead be added manually as required using VisualReporting::VisualReportBuilder::CreateGroupLabel .


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
ruleThe rule
isManualGroupingWhether manual grouping should be used

Sets the VisualReporting::Condition::OperatorOption of this condition.

Only valid if VisualReporting::Condition::TypeOption is VisualReporting::Condition::TypeOptionValueCondition


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
conditionThe condition
operatorTypeThe operator type being set

Sets the VisualReporting::Property in the value for comparison of this VisualReporting::Condition .

If the VisualReporting::Property is set to NULL, then it is deleted.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
conditionThe condition
propertyThe property being set

Sets the VisualReporting::Property of this condition.

If the VisualReporting::Property is set to NULL, then it is deleted. Only valid for a VisualReporting::Condition whose VisualReporting::Condition::Type is VisualReporting::Condition::TypeOptionValueCondition


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
conditionThe condition
propertyThe property being set

Sets the property specification of the VisualReporting::Property being built by this builder.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
propertyThe property being set
keyproperty key
NOTE: The full Unicode character set is not supported for this parameter.

Sets the property specification of the VisualReporting::Property being built by this builder.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
propertyThe property being set
keyproperty key
NOTE: The full Unicode character set is not supported for this parameter.
nameproperty name
NOTE: The full Unicode character set is not supported for this parameter.

Sets the VisualReporting::Classifier::RangeMethodOption of the active VisualReporting::Classifier in the given VisualReporting::Rule .

Only valid if the active VisualReporting::Classifier in the rule is VisualReporting::Classifier::TypeOptionRange type.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
ruleThe rule
rangeMethodThe range method

Sets the message VisualReporting::Property list of the VisualReporting::VisualReport .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
propertiesThe reference properties of report
usagesThe usages of report

Sets the message VisualReporting::Property list of the VisualReporting::Property in the active VisualReporting::Classifier .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
propertiesThe reference properties of property
usagesThe usages

Sets the VisualReporting::Property::DatatypeOption of the active VisualReporting::Classifier 's reporting VisualReporting::Property in this VisualReporting::Rule .

However datatype must not be VisualReporting::Property::DatatypeOptionUnknown .


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
ruleThe rule
datatypeThe datatype being set

Sets the reporting object type of the VisualReporting::VisualReport being built by this builder.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
reportingObjectTypeThe reporting object being set

Sets the reporting VisualReporting::Property for the active VisualReporting::Classifier in this VisualReporting::Rule .

If the reporting VisualReporting::Property of the rule is set to NULL, then it is deleted.

Only valid for a VisualReporting::Classifier in this VisualReporting::Rule whose VisualReporting::Classifier::TypeOption is VisualReporting::Classifier::TypeOptionValue or VisualReporting::Classifier::TypeOptionRange .


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
ruleThe rule
reportingPropertyThe property being set

Sets the reporting style of the VisualReporting::VisualReport being built by this builder.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
reportingStyleThe reporting style being set

Sets the name of the VisualReporting::VisualReport being built by this builder.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
reportNameThe name of the report

Sets the VisualReporting::VisualReport::SaveDestinationOption of the VisualReporting::VisualReport being built by this builder.

Note that this property will always be VisualReporting::VisualReport::SaveDestinationOptionLocal when NX is not connected to Teamcenter.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
destinationOptionThe destination option

Sets the priority of the givenVisualReporting::GroupLabel .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
groupLabelThe group label
tagPriorityThe priority

Sets the VisualReporting::GroupLabel::UpperBound of the given VisualReporting::GroupLabel .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
groupLabelThe group label
upperBoundThe upper bound
NOTE: The full Unicode character set is not supported for this parameter.

Sets the NXObject::Name of the given VisualReporting::GroupLabel .

Calling this function will cause VisualReporting::GroupLabel::IsNameUserSpecified to return true.


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
groupLabelThe group label
nameThe name
NOTE: The full Unicode character set is not supported for this parameter.

Sets the VisualReporting::Condition::UserPrompt of the specified VisualReporting::Condition .

Only valid for a VisualReporting::Condition whose VisualReporting::Condition::Type is VisualReporting::Condition::TypeOptionValueCondition


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
conditionThe condition
userPromptThe user-prompt
NOTE: The full Unicode character set is not supported for this parameter.

Sets the value of this VisualReporting::Condition .

Only valid for a VisualReporting::Condition whose VisualReporting::Condition::Type is VisualReporting::Condition::TypeOptionValueCondition


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
conditioncondition
value
NOTE: The full Unicode character set is not supported for this parameter.

Sets the VisualReporting::GroupLabel::Value of the given VisualReporting::GroupLabel .


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
groupLabelThe group label
valueThe value
NOTE: The full Unicode character set is not supported for this parameter.

Resets the VisualReporting::GroupLabel::IsNameUserSpecified status of the given VisualReporting::GroupLabel so that the name is now system-generated.


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
groupLabelThe group label

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