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

Inheritance diagram for NXOpen::VisualReporting::VisualReportBuilder:

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::VisualReport *	CommitAsCopy ()
	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::Condition *	CreateAndCondition ()
	Creates a new empty VisualReporting::Condition , but does not add it to a VisualReporting::Rule .

NXOpen::VisualReporting::Condition *	CreateBooleanCondition (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::Condition *	CreateDateCondition (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::Condition *	CreateDateCondition (NXOpen::VisualReporting::Property property, const char 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::GroupLabel *	CreateGroupLabel (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::GroupLabel *	CreateGroupLabel (const char 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::Condition *	CreateIntegerCondition (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::Condition *	CreateNotCondition ()
	Creates a new empty VisualReporting::Condition , but does not add it to a VisualReporting::Rule .

NXOpen::VisualReporting::Condition *	CreateNullCondition (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::Condition *	CreateOrCondition ()
	Creates a new empty VisualReporting::Condition , but does not add it to a VisualReporting::Rule .

NXOpen::VisualReporting::Property *	CreateProperty (NXOpen::VisualReporting::Property::TypeOption propertyType)
	Creates a new empty VisualReporting::Property , but does not add it to a VisualReporting::VisualReport .

NXOpen::VisualReporting::Condition *	CreateRealCondition (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::Condition *	CreateStringCondition (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::Condition *	CreateStringCondition (NXOpen::VisualReporting::Property property, const char 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::VisualReport *	CreateVisualReport ()
	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::Classifier *	GetActiveClassifierOfRule (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::Condition *	GetChildCondition (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::Condition *	GetFilterConditionOfRule (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::GroupLabel *	GetManualGroupLabelOfRule (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.

std::vector < NXOpen::VisualReporting::VisualReport::ObjectTypeOption >	GetObjectTypesOfVisualReport ()
	Gets the VisualReporting::VisualReport::ObjectTypeOption s of the VisualReporting::VisualReport being built by this builder.

NXOpen::VisualReporting::Condition::OperatorOption	GetOperatorTypeOfCondition (NXOpen::VisualReporting::Condition *condition)
	Gets the VisualReporting::Condition::OperatorOption of this condition.

NXOpen::VisualReporting::Condition *	GetParentCondition (NXOpen::VisualReporting::Condition *condition)
	Gets the parent condition of this VisualReporting::Condition .

NXOpen::VisualReporting::Property *	GetPropertyForComparison (NXOpen::VisualReporting::Condition *condition)
	Gets the VisualReporting::Property in the value for comparison of this VisualReporting::Condition .

NXOpen::VisualReporting::Property *	GetPropertyOfCondition (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::Property *	GetReportingPropertyOfRule (NXOpen::VisualReporting::Rule *rule)
	Gets the reporting VisualReporting::Property for the active VisualReporting::Classifier in this VisualReporting::Rule .

NXOpen::VisualReporting::Rule *	GetRule (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::ReportContextOption	ReportContextOfVisualReport ()
	Returns the VisualReporting::VisualReport::ReportContextOption of the VisualReporting::VisualReport being built by this builder.

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.

NXOpen::VisualReporting::VisualReport::ScopeTypeOption	ScopeTypeOfVisualReport ()
	Returns the VisualReporting::VisualReport::ScopeTypeOption 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	SetBitmapNameOfGroupLabel (NXOpen::VisualReporting::GroupLabel groupLabel, const char bitmapName)
	Sets the bitmap of the given VisualReporting::GroupLabel .

void	SetBitmapNameOfReport (const NXString &bitmapName)
	Sets the bitmap name of the VisualReporting::VisualReport .

void	SetBitmapNameOfReport (const char *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 .

void	SetBitmapNameOfReportingProperty (const char *bitmapName)
	Sets the bitmap name of the reporting VisualReporting::Property in the active VisualReporting::Classifier .

NXOpen::VisualReporting::Classifier *	SetClassifierTypeOfRule (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	SetCustomMessageOfGroupLabel (NXOpen::VisualReporting::GroupLabel groupLabel, const char customMessage)
	Sets the custom message of the given VisualReporting::GroupLabel .

void	SetCustomMessageOfReport (const NXString &customMessage)
	Sets the custom message of the VisualReporting::VisualReport .

void	SetCustomMessageOfReport (const char *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	SetCustomMessageOfReportingProperty (const char *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	SetDescriptionOfCondition (NXOpen::VisualReporting::Condition condition, const char 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	SetDescriptionOfVisualReport (const char *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	SetDescriptiveCategoryOfVisualReport (const char *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	SetDestinationTeamcenterFolder (const char *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	SetFilenameOfVisualReport (const char *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	SetKeywordsOfVisualReport (const char *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	SetLowerBoundOfGroupLabel (NXOpen::VisualReporting::GroupLabel groupLabel, const char 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	SetObjectTypesOfVisualReport (const std::vector< NXOpen::VisualReporting::VisualReport::ObjectTypeOption > &objectTypes)
	Sets the VisualReporting::VisualReport::ObjectTypeOption s of the VisualReporting::VisualReport being built by this builder.

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 char 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	SetPropertySpecification (NXOpen::VisualReporting::Property property, const char key, const char *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	SetReportContextOfVisualReport (NXOpen::VisualReporting::VisualReport::ReportContextOption reportContext)
	Sets the VisualReporting::VisualReport::ReportContextOption of the VisualReporting::VisualReport being built by this builder.

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	SetReportNameOfVisualReport (const char *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	SetScopeTypeOfVisualReport (NXOpen::VisualReporting::VisualReport::ScopeTypeOption scopeType)
	Sets the VisualReporting::VisualReport::ScopeTypeOption 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	SetUpperBoundOfGroupLabel (NXOpen::VisualReporting::GroupLabel groupLabel, const char 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	SetUserNameOfGroupLabel (NXOpen::VisualReporting::GroupLabel groupLabel, const char 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	SetUserPromptOfCondition (NXOpen::VisualReporting::Condition condition, const char 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	SetValueOfCondition (NXOpen::VisualReporting::Condition condition, const char 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	SetValueOfGroupLabel (NXOpen::VisualReporting::GroupLabel groupLabel, const char 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.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

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

<br> To create a new instance of this class, use @link VisualReporting::VisualReportManager::CreateVisualReportBuilder  VisualReporting::VisualReportManager::CreateVisualReportBuilder @endlink  <br>

Created in NX7.0.0.

Member Enumeration Documentation

enum NXOpen::VisualReporting::VisualReportBuilder::PropertyUsageOption

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

void NXOpen::VisualReporting::VisualReportBuilder::AddChildToCondition	(	NXOpen::VisualReporting::Condition *	condition,
		NXOpen::VisualReporting::Condition *	childCondition
	)

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

condition	The condition
childCondition	The child condition being added

NXString NXOpen::VisualReporting::VisualReportBuilder::BitmapNameOfReport ( )

Returns the bitmap name of the VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXString NXOpen::VisualReporting::VisualReportBuilder::BitmapNameOfReportingProperty ( )

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")

NXOpen::VisualReporting::VisualReport* NXOpen::VisualReporting::VisualReportBuilder::CommitAsCopy ( )

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 @link VisualReporting::VisualReport VisualReporting::VisualReport@endlink ,
       then @link CommitAsCopy CommitAsCopy@endlink  can be called instead. This behaves
       just like @link Builder::Commit Builder::Commit@endlink  except it does not delete the
       original @link VisualReporting::VisualReport VisualReporting::VisualReport@endlink .
    @return

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXOpen::VisualReporting::Condition* NXOpen::VisualReporting::VisualReportBuilder::CreateAndCondition ( )

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

    @return  The created condition

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXOpen::VisualReporting::Condition* NXOpen::VisualReporting::VisualReportBuilder::CreateBooleanCondition	(	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 .

    @return  The created condition

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

property	The VisualReporting::Property to which this condition will be applied
value	The initial value
operatorType	The initial operator

NXOpen::VisualReporting::Condition* NXOpen::VisualReporting::VisualReportBuilder::CreateDateCondition	(	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 .

    @return  The created condition

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

property	The VisualReporting::Property to which this condition will be applied
value	The initial value NOTE: The full Unicode character set is not supported for this parameter.
operatorType	The initial operator

NXOpen::VisualReporting::Condition* NXOpen::VisualReporting::VisualReportBuilder::CreateDateCondition	(	NXOpen::VisualReporting::Property *	property,
		const char *	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 .

    @return  The created condition

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

property	The VisualReporting::Property to which this condition will be applied
value	The initial value NOTE: The full Unicode character set is not supported for this parameter.
operatorType	The initial operator

NXOpen::VisualReporting::GroupLabel* NXOpen::VisualReporting::VisualReportBuilder::CreateGroupLabel	(	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 .

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

name	The 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.
rule	The rule to which to add it
afterGroupLabel	The group label after which to add it. If NULL then it is inserted at the beginning before any existing group labels

NXOpen::VisualReporting::GroupLabel* NXOpen::VisualReporting::VisualReportBuilder::CreateGroupLabel	(	const char *	name,
		NXOpen::VisualReporting::Rule *	rule,
		NXOpen::VisualReporting::GroupLabel *	afterGroupLabel
	)

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

name	The 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.
rule	The rule to which to add it
afterGroupLabel	The group label after which to add it. If NULL then it is inserted at the beginning before any existing group labels

NXOpen::VisualReporting::Condition* NXOpen::VisualReporting::VisualReportBuilder::CreateIntegerCondition	(	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 .

    @return  The created condition

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

property	The VisualReporting::Property to which this condition will be applied
value	The initial value
operatorType	The initial operator

NXOpen::VisualReporting::Condition* NXOpen::VisualReporting::VisualReportBuilder::CreateNotCondition ( )

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

    @return  The created condition

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXOpen::VisualReporting::Condition* NXOpen::VisualReporting::VisualReportBuilder::CreateNullCondition	(	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 .

    @return  The created condition

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

property	The VisualReporting::Property to which this condition will be applied
value	The initial value
operatorType	The initial operator

NXOpen::VisualReporting::Condition* NXOpen::VisualReporting::VisualReportBuilder::CreateOrCondition ( )

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

    @return  The created condition

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXOpen::VisualReporting::Property* NXOpen::VisualReporting::VisualReportBuilder::CreateProperty ( NXOpen::VisualReporting::Property::TypeOption propertyType )

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

    @return  The created property

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

propertyType Property Type of the VisualReporting::Property being created

NXOpen::VisualReporting::Condition* NXOpen::VisualReporting::VisualReportBuilder::CreateRealCondition	(	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 .

    @return  The created condition

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

property	The VisualReporting::Property to which this condition will be applied
value	The initial value
operatorType	The initial operator
tolerance	The tolerance used in comparisons

NXOpen::VisualReporting::Condition* NXOpen::VisualReporting::VisualReportBuilder::CreateStringCondition	(	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 .

    @return  The created condition

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

property	The VisualReporting::Property to which this condition will be applied
value	The initial value NOTE: The full Unicode character set is not supported for this parameter.
operatorType	The initial operator

NXOpen::VisualReporting::Condition* NXOpen::VisualReporting::VisualReportBuilder::CreateStringCondition	(	NXOpen::VisualReporting::Property *	property,
		const char *	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 .

    @return  The created condition

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

property	The VisualReporting::Property to which this condition will be applied
value	The initial value NOTE: The full Unicode character set is not supported for this parameter.
operatorType	The initial operator

NXOpen::VisualReporting::VisualReport* NXOpen::VisualReporting::VisualReportBuilder::CreateVisualReport ( )

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

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

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXString NXOpen::VisualReporting::VisualReportBuilder::CustomMessageOfReport ( )

Returns the custom message of the VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXString NXOpen::VisualReporting::VisualReportBuilder::CustomMessageOfReportingProperty ( )

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")

void NXOpen::VisualReporting::VisualReportBuilder::DeleteChildCondition	(	NXOpen::VisualReporting::Condition *	condition,
		NXOpen::VisualReporting::Condition *	childCondition
	)

Deletes a VisualReporting::Condition from its parent condition.

       If there are @link VisualReporting::Property VisualReporting::Property@endlink 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

condition	The condition
childCondition	The child condition being removed

void NXOpen::VisualReporting::VisualReportBuilder::DeleteGroupLabel	(	NXOpen::VisualReporting::Rule *	rule,
		NXOpen::VisualReporting::GroupLabel *	groupLabel
	)

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

rule	The rule containing the group label
groupLabel	The group label

void NXOpen::VisualReporting::VisualReportBuilder::DeleteProperty ( NXOpen::VisualReporting::Property * property )

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

property The property to be deleted

NXString NXOpen::VisualReporting::VisualReportBuilder::DescriptionOfVisualReport ( )

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

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXString NXOpen::VisualReporting::VisualReportBuilder::DescriptiveCategoryOfVisualReport ( )

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")

NXString NXOpen::VisualReporting::VisualReportBuilder::DestinationTeamcenterFolder ( )

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 @link VisualReporting::VisualReport::DestinationTeamcenterFolder VisualReporting::VisualReport::DestinationTeamcenterFolder@endlink  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")

void NXOpen::VisualReporting::VisualReportBuilder::EditVisualReport ( NXOpen::VisualReporting::VisualReport * visualReport )

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

visualReport The visual report

void NXOpen::VisualReporting::VisualReportBuilder::EnableUnmatchedGroupOfVisualReport ( bool enableUnmatchedGroup )

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

enableUnmatchedGroup Whether the unmatched group is enabled

NXString NXOpen::VisualReporting::VisualReportBuilder::FilenameOfVisualReport ( )

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

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXOpen::VisualReporting::Classifier* NXOpen::VisualReporting::VisualReportBuilder::GetActiveClassifierOfRule ( NXOpen::VisualReporting::Rule * rule )

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

    @return

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

rule rule

std::vector<NXOpen::VisualReporting::GroupLabel *> NXOpen::VisualReporting::VisualReportBuilder::GetAllGroupLabelsOfRule ( NXOpen::VisualReporting::Rule * rule )

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

    @return  The manually defined groups

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

rule The rule

NXString NXOpen::VisualReporting::VisualReportBuilder::GetBitmapNameOfGroupLabel ( NXOpen::VisualReporting::GroupLabel * groupLabel )

Gets the bitmap of the given VisualReporting::GroupLabel .

    @return  The bitmap name

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

groupLabel The group label

NXOpen::VisualReporting::Condition* NXOpen::VisualReporting::VisualReportBuilder::GetChildCondition	(	NXOpen::VisualReporting::Condition *	condition,
		int	index
	)

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

    @return

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

condition	condition
index	The index of the returned Condition.

std::vector<NXOpen::VisualReporting::Condition *> NXOpen::VisualReporting::VisualReportBuilder::GetChildConditions ( NXOpen::VisualReporting::Condition * condition )

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

    @return

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

condition condition

std::vector<NXOpen::VisualReporting::Classifier *> NXOpen::VisualReporting::VisualReportBuilder::GetClassifiersOfRule ( NXOpen::VisualReporting::Rule * rule )

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

    @return

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

rule rule

NXOpen::VisualReporting::Classifier::TypeOption NXOpen::VisualReporting::VisualReportBuilder::GetClassifierTypeOfRule ( NXOpen::VisualReporting::Rule * rule )

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

    @return  The classifier type

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

rule The rule

NXOpen::NXColor::Rgb NXOpen::VisualReporting::VisualReportBuilder::GetColorOfGroupLabel ( NXOpen::VisualReporting::GroupLabel * groupLabel )

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

    @return  The color

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

groupLabel The group label

NXString NXOpen::VisualReporting::VisualReportBuilder::GetCustomMessageOfGroupLabel ( NXOpen::VisualReporting::GroupLabel * groupLabel )

Gets the custom message of the givenVisualReporting::GroupLabel .

    @return  The bitmap name

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

groupLabel The group label

NXOpen::VisualReporting::Classifier::DateGroupMethodOption NXOpen::VisualReporting::VisualReportBuilder::GetDateGroupMethodOfRule ( NXOpen::VisualReporting::Rule * rule )

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

       Only valid if the active @link VisualReporting::Classifier VisualReporting::Classifier@endlink  in the rule 
       is @link VisualReporting::Classifier::TypeOptionRange VisualReporting::Classifier::TypeOptionRange@endlink  type.
    @return  The range method

Created in NX8.0.1.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

rule The rule

NXString NXOpen::VisualReporting::VisualReportBuilder::GetDescriptionOfCondition ( NXOpen::VisualReporting::Condition * condition )

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

       Only valid for a @link VisualReporting::Condition VisualReporting::Condition@endlink  whose
       @link VisualReporting::Condition::Type VisualReporting::Condition::Type@endlink  is @link VisualReporting::Condition::TypeOptionValueCondition VisualReporting::Condition::TypeOptionValueCondition@endlink 
    @return  The description

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

condition The condition

NXOpen::VisualReporting::GroupLabel::DisplayStyleOption NXOpen::VisualReporting::VisualReportBuilder::GetDisplayStyleForGroupLabel ( NXOpen::VisualReporting::GroupLabel * groupLabel )

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

    @return  The display style

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

groupLabel The group label

NXOpen::VisualReporting::Condition* NXOpen::VisualReporting::VisualReportBuilder::GetFilterConditionOfRule ( NXOpen::VisualReporting::Rule * rule )

Gets the filter VisualReporting::Condition from this rule.

    @return  The filter condition

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

rule The rule

NXOpen::VisualReporting::Classifier::GroupingMethodOption NXOpen::VisualReporting::VisualReportBuilder::GetGroupingMethodOfRule ( NXOpen::VisualReporting::Rule * rule )

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

    @return  The grouping method

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

rule The rule

bool NXOpen::VisualReporting::VisualReportBuilder::GetHasUserSpecifiedValueForCondition ( NXOpen::VisualReporting::Condition * condition )

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

       Only valid for a @link VisualReporting::Condition VisualReporting::Condition@endlink  whose
       @link VisualReporting::Condition::Type VisualReporting::Condition::Type@endlink  is @link VisualReporting::Condition::TypeOptionValueCondition VisualReporting::Condition::TypeOptionValueCondition@endlink 
    @return  Whether the condition's value should be user-specified

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

condition The condition

NXString NXOpen::VisualReporting::VisualReportBuilder::GetLowerBoundOfGroupLabel ( NXOpen::VisualReporting::GroupLabel * groupLabel )

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

    @return  The lower bound

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

groupLabel The group label

bool NXOpen::VisualReporting::VisualReportBuilder::GetManualGroupingForRule ( NXOpen::VisualReporting::Rule * rule )

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

    @return  Whether manual grouping should be used

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

rule The rule

NXOpen::VisualReporting::GroupLabel* NXOpen::VisualReporting::VisualReportBuilder::GetManualGroupLabelOfRule	(	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.

    @return  The specified manually defined group

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

rule	The rule
index	index

std::vector<NXOpen::VisualReporting::GroupLabel *> NXOpen::VisualReporting::VisualReportBuilder::GetManualGroupLabelsOfRule ( NXOpen::VisualReporting::Rule * rule )

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

    @return  The manually defined groups

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

rule The rule

std::vector<NXOpen::VisualReporting::VisualReport::ObjectTypeOption> NXOpen::VisualReporting::VisualReportBuilder::GetObjectTypesOfVisualReport ( )

Gets the VisualReporting::VisualReport::ObjectTypeOption s of the VisualReporting::VisualReport being built by this builder.

       Only valid if the @link VisualReporting::VisualReport::ScopeType VisualReporting::VisualReport::ScopeType@endlink  of the @link VisualReporting::VisualReport VisualReporting::VisualReport@endlink 
       is @link VisualReporting::VisualReport::ScopeTypeOptionSubPart VisualReporting::VisualReport::ScopeTypeOptionSubPart@endlink  type.
    @return  The object types

Created in NX9.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXOpen::VisualReporting::Condition::OperatorOption NXOpen::VisualReporting::VisualReportBuilder::GetOperatorTypeOfCondition ( NXOpen::VisualReporting::Condition * condition )

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

condition The condition

NXOpen::VisualReporting::Condition* NXOpen::VisualReporting::VisualReportBuilder::GetParentCondition ( NXOpen::VisualReporting::Condition * 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

condition condition

NXOpen::VisualReporting::Property* NXOpen::VisualReporting::VisualReportBuilder::GetPropertyForComparison ( NXOpen::VisualReporting::Condition * condition )

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

    @return  The property

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

condition The condition

NXOpen::VisualReporting::Property* NXOpen::VisualReporting::VisualReportBuilder::GetPropertyOfCondition ( NXOpen::VisualReporting::Condition * condition )

Gets the VisualReporting::Property of this condition.

       Only valid for a @link VisualReporting::Condition VisualReporting::Condition@endlink  whose
       @link VisualReporting::Condition::Type VisualReporting::Condition::Type@endlink  is @link VisualReporting::Condition::TypeOptionValueCondition VisualReporting::Condition::TypeOptionValueCondition@endlink 
    @return  The property

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

condition The condition

void NXOpen::VisualReporting::VisualReportBuilder::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.

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

property	The property being ask
propertyType	Property Type of the VisualReporting::Property
key	property key
name	property name

NXOpen::VisualReporting::Classifier::RangeMethodOption NXOpen::VisualReporting::VisualReportBuilder::GetRangeMethodOfRule ( NXOpen::VisualReporting::Rule * rule )

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

       Only valid if the active @link VisualReporting::Classifier VisualReporting::Classifier@endlink  in the rule 
       is @link VisualReporting::Classifier::TypeOptionRange VisualReporting::Classifier::TypeOptionRange@endlink  type.
    @return  The range method

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

rule The rule

void NXOpen::VisualReporting::VisualReportBuilder::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 .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

properties	The reference properties of report
usages	The usages of report
notUsed	notused

void NXOpen::VisualReporting::VisualReportBuilder::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 .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

properties	The reference properties of property
usages	The usages

NXOpen::VisualReporting::Property::DatatypeOption NXOpen::VisualReporting::VisualReportBuilder::GetReportingDatatypeOfRule ( NXOpen::VisualReporting::Rule * rule )

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

    @return  The datatype

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

rule The rule

NXOpen::VisualReporting::Property* NXOpen::VisualReporting::VisualReportBuilder::GetReportingPropertyOfRule ( NXOpen::VisualReporting::Rule * rule )

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

    @return  The property

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

rule The rule

NXOpen::VisualReporting::Rule* NXOpen::VisualReporting::VisualReportBuilder::GetRule ( int index )

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

    @return

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

index The index of the returned VisualReporting::Rule .

std::vector<NXOpen::VisualReporting::Rule *> NXOpen::VisualReporting::VisualReportBuilder::GetRules ( )

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

    @return

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXOpen::VisualReporting::GroupLabel::TagPriorityOption NXOpen::VisualReporting::VisualReportBuilder::GetTagPriorityOfGroupLabel ( NXOpen::VisualReporting::GroupLabel * groupLabel )

Gets the priority of the givenVisualReporting::GroupLabel .

    @return  The priority

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

groupLabel The group label

NXString NXOpen::VisualReporting::VisualReportBuilder::GetUpperBoundOfGroupLabel ( NXOpen::VisualReporting::GroupLabel * groupLabel )

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

    @return  The upper bound

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

groupLabel The group label

NXString NXOpen::VisualReporting::VisualReportBuilder::GetUserNameOfGroupLabel ( NXOpen::VisualReporting::GroupLabel * groupLabel )

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

    @return  The name

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

groupLabel The group label

NXString NXOpen::VisualReporting::VisualReportBuilder::GetUserPromptOfCondition ( NXOpen::VisualReporting::Condition * condition )

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

       Only valid for a @link VisualReporting::Condition VisualReporting::Condition@endlink  whose
       @link VisualReporting::Condition::Type VisualReporting::Condition::Type@endlink  is @link VisualReporting::Condition::TypeOptionValueCondition VisualReporting::Condition::TypeOptionValueCondition@endlink 
    @return  The user-prompt

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

condition The condition

NXString NXOpen::VisualReporting::VisualReportBuilder::GetValueOfCondition ( NXOpen::VisualReporting::Condition * condition )

Gets the value of this VisualReporting::Condition .

       Only valid for a @link VisualReporting::Condition VisualReporting::Condition@endlink  whose
       @link VisualReporting::Condition::Type VisualReporting::Condition::Type@endlink  is @link VisualReporting::Condition::TypeOptionValueCondition VisualReporting::Condition::TypeOptionValueCondition@endlink 
    @return

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

condition condition

NXString NXOpen::VisualReporting::VisualReportBuilder::GetValueOfGroupLabel ( NXOpen::VisualReporting::GroupLabel * groupLabel )

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

    @return  The value

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

groupLabel The group label

bool NXOpen::VisualReporting::VisualReportBuilder::IsChildCondition	(	NXOpen::VisualReporting::Condition *	condition,
		NXOpen::VisualReporting::Condition *	childCondition
	)

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

    @return

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

condition	condition
childCondition	The possible child Condition

NXString NXOpen::VisualReporting::VisualReportBuilder::KeywordsOfVisualReport ( )

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

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

void NXOpen::VisualReporting::VisualReportBuilder::RemoveChildFromCondition	(	NXOpen::VisualReporting::Condition *	condition,
		NXOpen::VisualReporting::Condition *	childCondition
	)

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

condition	The condition
childCondition	The child condition being removed

void NXOpen::VisualReporting::VisualReportBuilder::RemoveFilterConditionFromRule ( NXOpen::VisualReporting::Rule * rule )

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

rule The rule

void NXOpen::VisualReporting::VisualReportBuilder::RemovePropertyFromCondition ( NXOpen::VisualReporting::Condition * condition )

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

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

condition The condition

NXOpen::VisualReporting::VisualReport::ReportContextOption NXOpen::VisualReporting::VisualReportBuilder::ReportContextOfVisualReport ( )

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

Created in NX9.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXOpen::VisualReporting::VisualReport::ReportingObjectTypeOption NXOpen::VisualReporting::VisualReportBuilder::ReportingObjectTypeOfVisualReport ( )

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

       Only valid if the @link VisualReporting::VisualReport::ScopeType VisualReporting::VisualReport::ScopeType@endlink  of the @link VisualReporting::VisualReport VisualReporting::VisualReport@endlink 
       is @link VisualReporting::VisualReport::ScopeTypeOptionComponent VisualReporting::VisualReport::ScopeTypeOptionComponent@endlink  type.

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXOpen::VisualReporting::VisualReport::ReportingStyleOption NXOpen::VisualReporting::VisualReportBuilder::ReportingStyleOfVisualReport ( )

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")

NXString NXOpen::VisualReporting::VisualReportBuilder::ReportNameOfVisualReport ( )

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

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

void NXOpen::VisualReporting::VisualReportBuilder::Save ( )

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

       Note that when NX is connected to Teamcenter, the @link VisualReporting::VisualReportBuilder::FilenameOfVisualReport VisualReporting::VisualReportBuilder::FilenameOfVisualReport@endlink  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")

NXOpen::VisualReporting::VisualReport::SaveDestinationOption NXOpen::VisualReporting::VisualReportBuilder::SaveDestination ( )

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

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

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

NXOpen::VisualReporting::VisualReport::ScopeTypeOption NXOpen::VisualReporting::VisualReportBuilder::ScopeTypeOfVisualReport ( )

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

Created in NX9.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

void NXOpen::VisualReporting::VisualReportBuilder::SetActiveClassifierOfRule	(	NXOpen::VisualReporting::Rule *	rule,
		NXOpen::VisualReporting::Classifier *	activeClassifier
	)

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

rule	rule
activeClassifier	activeclassifier

void NXOpen::VisualReporting::VisualReportBuilder::SetBitmapNameOfGroupLabel	(	NXOpen::VisualReporting::GroupLabel *	groupLabel,
		const NXString &	bitmapName
	)

Sets the bitmap of the given VisualReporting::GroupLabel .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

groupLabel	The group label
bitmapName	The bitmap name

void NXOpen::VisualReporting::VisualReportBuilder::SetBitmapNameOfGroupLabel	(	NXOpen::VisualReporting::GroupLabel *	groupLabel,
		const char *	bitmapName
	)

Sets the bitmap of the given VisualReporting::GroupLabel .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

groupLabel	The group label
bitmapName	The bitmap name

void NXOpen::VisualReporting::VisualReportBuilder::SetBitmapNameOfReport ( const NXString & bitmapName )

Sets the bitmap name of the VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

bitmapName The bitmap name

void NXOpen::VisualReporting::VisualReportBuilder::SetBitmapNameOfReport ( const char * bitmapName )

Sets the bitmap name of the VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

bitmapName The bitmap name

void NXOpen::VisualReporting::VisualReportBuilder::SetBitmapNameOfReportingProperty ( const NXString & bitmapName )

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

bitmapName The bitmap name

void NXOpen::VisualReporting::VisualReportBuilder::SetBitmapNameOfReportingProperty ( const char * bitmapName )

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

bitmapName The bitmap name

NXOpen::VisualReporting::Classifier* NXOpen::VisualReporting::VisualReportBuilder::SetClassifierTypeOfRule	(	NXOpen::VisualReporting::Rule *	rule,
		NXOpen::VisualReporting::Classifier::TypeOption	classifierType
	)

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

       Note that the old @link VisualReporting::Classifier VisualReporting::Classifier@endlink  in this @link VisualReporting::Rule VisualReporting::Rule@endlink  will be deleted 
       and a new @link VisualReporting::Classifier VisualReporting::Classifier@endlink  will be created and set as the active @link VisualReporting::Classifier VisualReporting::Classifier@endlink 
       in this @link VisualReporting::Rule VisualReporting::Rule@endlink .
    @return  The new active classifier

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

rule	The rule
classifierType	The classifier type being set

void NXOpen::VisualReporting::VisualReportBuilder::SetColorOfGroupLabel	(	NXOpen::VisualReporting::GroupLabel *	groupLabel,
		const NXOpen::NXColor::Rgb &	color
	)

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

groupLabel	The group label
color	The color

void NXOpen::VisualReporting::VisualReportBuilder::SetCustomMessageOfGroupLabel	(	NXOpen::VisualReporting::GroupLabel *	groupLabel,
		const NXString &	customMessage
	)

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

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

groupLabel	The group label
customMessage	The bitmap name

void NXOpen::VisualReporting::VisualReportBuilder::SetCustomMessageOfGroupLabel	(	NXOpen::VisualReporting::GroupLabel *	groupLabel,
		const char *	customMessage
	)

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

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

groupLabel	The group label
customMessage	The bitmap name

void NXOpen::VisualReporting::VisualReportBuilder::SetCustomMessageOfReport ( const NXString & customMessage )

Sets the custom message of the VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

customMessage The custom message

void NXOpen::VisualReporting::VisualReportBuilder::SetCustomMessageOfReport ( const char * customMessage )

Sets the custom message of the VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

customMessage The custom message

void NXOpen::VisualReporting::VisualReportBuilder::SetCustomMessageOfReportingProperty ( const NXString & customMessage )

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

customMessage The custom message

void NXOpen::VisualReporting::VisualReportBuilder::SetCustomMessageOfReportingProperty ( const char * customMessage )

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

customMessage The custom message

void NXOpen::VisualReporting::VisualReportBuilder::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 .

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

Created in NX8.0.1.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

rule	The rule
dateGroupMethod	The range method

void NXOpen::VisualReporting::VisualReportBuilder::SetDescriptionOfCondition	(	NXOpen::VisualReporting::Condition *	condition,
		const NXString &	description
	)

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

       Only valid for a @link VisualReporting::Condition VisualReporting::Condition@endlink  whose
       @link VisualReporting::Condition::Type VisualReporting::Condition::Type@endlink  is @link VisualReporting::Condition::TypeOptionValueCondition VisualReporting::Condition::TypeOptionValueCondition@endlink

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

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

void NXOpen::VisualReporting::VisualReportBuilder::SetDescriptionOfCondition	(	NXOpen::VisualReporting::Condition *	condition,
		const char *	description
	)

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

       Only valid for a @link VisualReporting::Condition VisualReporting::Condition@endlink  whose
       @link VisualReporting::Condition::Type VisualReporting::Condition::Type@endlink  is @link VisualReporting::Condition::TypeOptionValueCondition VisualReporting::Condition::TypeOptionValueCondition@endlink

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

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

void NXOpen::VisualReporting::VisualReportBuilder::SetDescriptionOfVisualReport ( const NXString & description )

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

description The description

void NXOpen::VisualReporting::VisualReportBuilder::SetDescriptionOfVisualReport ( const char * description )

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

description The description

void NXOpen::VisualReporting::VisualReportBuilder::SetDescriptiveCategoryOfVisualReport ( const NXString & category )

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

category The category being set

void NXOpen::VisualReporting::VisualReportBuilder::SetDescriptiveCategoryOfVisualReport ( const char * category )

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

category The category being set

void NXOpen::VisualReporting::VisualReportBuilder::SetDestinationTeamcenterFolder ( const NXString & foldername )

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 @link VisualReporting::VisualReport::DestinationTeamcenterFolder VisualReporting::VisualReport::DestinationTeamcenterFolder@endlink  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

foldername The Teamcenter folder name

void NXOpen::VisualReporting::VisualReportBuilder::SetDestinationTeamcenterFolder ( const char * foldername )

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 @link VisualReporting::VisualReport::DestinationTeamcenterFolder VisualReporting::VisualReport::DestinationTeamcenterFolder@endlink  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

foldername The Teamcenter folder name

void NXOpen::VisualReporting::VisualReportBuilder::SetDisplayStyleForGroupLabel	(	NXOpen::VisualReporting::GroupLabel *	groupLabel,
		NXOpen::VisualReporting::GroupLabel::DisplayStyleOption	displayStyle
	)

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

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

groupLabel	The group label
displayStyle	The display style

void NXOpen::VisualReporting::VisualReportBuilder::SetFilenameOfVisualReport ( const NXString & filename )

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

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

filename The file name

void NXOpen::VisualReporting::VisualReportBuilder::SetFilenameOfVisualReport ( const char * filename )

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

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

filename The file name

void NXOpen::VisualReporting::VisualReportBuilder::SetFilterConditionOfRule	(	NXOpen::VisualReporting::Rule *	rule,
		NXOpen::VisualReporting::Condition *	filterCondition
	)

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

rule	The rule
filterCondition	The filter condition being set

void NXOpen::VisualReporting::VisualReportBuilder::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 .

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

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

rule	The rule
groupingMethod	The grouping method

void NXOpen::VisualReporting::VisualReportBuilder::SetHasUserSpecifiedValueForCondition	(	NXOpen::VisualReporting::Condition *	condition,
		bool	isUserSpecified
	)

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

       Only valid for a @link VisualReporting::Condition VisualReporting::Condition@endlink  whose
       @link VisualReporting::Condition::Type VisualReporting::Condition::Type@endlink  is @link VisualReporting::Condition::TypeOptionValueCondition VisualReporting::Condition::TypeOptionValueCondition@endlink

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

condition	The condition
isUserSpecified	Whether the condition's value should be user-specified

void NXOpen::VisualReporting::VisualReportBuilder::SetKeywordsOfVisualReport ( const NXString & keywords )

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

keywords A comma separated string of keywords

void NXOpen::VisualReporting::VisualReportBuilder::SetKeywordsOfVisualReport ( const char * keywords )

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

keywords A comma separated string of keywords

void NXOpen::VisualReporting::VisualReportBuilder::SetLowerBoundOfGroupLabel	(	NXOpen::VisualReporting::GroupLabel *	groupLabel,
		const NXString &	lowerBound
	)

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

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

groupLabel	The group label
lowerBound	The lower bound NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::VisualReporting::VisualReportBuilder::SetLowerBoundOfGroupLabel	(	NXOpen::VisualReporting::GroupLabel *	groupLabel,
		const char *	lowerBound
	)

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

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

groupLabel	The group label
lowerBound	The lower bound NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::VisualReporting::VisualReportBuilder::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 .

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

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

rule	The rule
isManualGrouping	Whether manual grouping should be used

void NXOpen::VisualReporting::VisualReportBuilder::SetObjectTypesOfVisualReport ( const std::vector< NXOpen::VisualReporting::VisualReport::ObjectTypeOption > & objectTypes )

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

       Only valid if the @link VisualReporting::VisualReport::ScopeType VisualReporting::VisualReport::ScopeType@endlink  of the @link VisualReporting::VisualReport VisualReporting::VisualReport@endlink 
       is @link VisualReporting::VisualReport::ScopeTypeOptionSubPart VisualReporting::VisualReport::ScopeTypeOptionSubPart@endlink  type.

Created in NX9.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

objectTypes The object types being set

void NXOpen::VisualReporting::VisualReportBuilder::SetOperatorTypeOfCondition	(	NXOpen::VisualReporting::Condition *	condition,
		NXOpen::VisualReporting::Condition::OperatorOption	operatorType
	)

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

condition	The condition
operatorType	The operator type being set

void NXOpen::VisualReporting::VisualReportBuilder::SetPropertyForComparison	(	NXOpen::VisualReporting::Condition *	condition,
		NXOpen::VisualReporting::Property *	property
	)

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

condition	The condition
property	The property being set

void NXOpen::VisualReporting::VisualReportBuilder::SetPropertyOfCondition	(	NXOpen::VisualReporting::Condition *	condition,
		NXOpen::VisualReporting::Property *	property
	)

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

condition	The condition
property	The property being set

void NXOpen::VisualReporting::VisualReportBuilder::SetPropertySpecification	(	NXOpen::VisualReporting::Property *	property,
		const NXString &	key
	)

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

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

void NXOpen::VisualReporting::VisualReportBuilder::SetPropertySpecification	(	NXOpen::VisualReporting::Property *	property,
		const char *	key
	)

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

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

void NXOpen::VisualReporting::VisualReportBuilder::SetPropertySpecification	(	NXOpen::VisualReporting::Property *	property,
		const NXString &	key,
		const NXString &	name
	)

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

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

void NXOpen::VisualReporting::VisualReportBuilder::SetPropertySpecification	(	NXOpen::VisualReporting::Property *	property,
		const char *	key,
		const char *	name
	)

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

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

void NXOpen::VisualReporting::VisualReportBuilder::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 .

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

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

rule	The rule
rangeMethod	The range method

void NXOpen::VisualReporting::VisualReportBuilder::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 .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

properties	The reference properties of report
usages	The usages of report

void NXOpen::VisualReporting::VisualReportBuilder::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 .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

properties	The reference properties of property
usages	The usages

void NXOpen::VisualReporting::VisualReportBuilder::SetReportContextOfVisualReport ( NXOpen::VisualReporting::VisualReport::ReportContextOption reportContext )

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

Created in NX9.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

reportContext The report context being set

void NXOpen::VisualReporting::VisualReportBuilder::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 .

       However datatype must not be @link VisualReporting::Property::DatatypeOptionUnknown VisualReporting::Property::DatatypeOptionUnknown@endlink .

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

rule	The rule
datatype	The datatype being set

void NXOpen::VisualReporting::VisualReportBuilder::SetReportingObjectTypeOfVisualReport ( NXOpen::VisualReporting::VisualReport::ReportingObjectTypeOption reportingObjectType )

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

       Only valid if the @link VisualReporting::VisualReport::ScopeType VisualReporting::VisualReport::ScopeType@endlink  of the @link VisualReporting::VisualReport VisualReporting::VisualReport@endlink 
       is @link VisualReporting::VisualReport::ScopeTypeOptionComponent VisualReporting::VisualReport::ScopeTypeOptionComponent@endlink  type.

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

reportingObjectType The reporting object being set

void NXOpen::VisualReporting::VisualReportBuilder::SetReportingPropertyOfRule	(	NXOpen::VisualReporting::Rule *	rule,
		NXOpen::VisualReporting::Property *	reportingProperty
	)

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

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

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

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

rule	The rule
reportingProperty	The property being set

void NXOpen::VisualReporting::VisualReportBuilder::SetReportingStyleOfVisualReport ( NXOpen::VisualReporting::VisualReport::ReportingStyleOption reportingStyle )

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

reportingStyle The reporting style being set

void NXOpen::VisualReporting::VisualReportBuilder::SetReportNameOfVisualReport ( const NXString & reportName )

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

reportName The name of the report

void NXOpen::VisualReporting::VisualReportBuilder::SetReportNameOfVisualReport ( const char * reportName )

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

reportName The name of the report

void NXOpen::VisualReporting::VisualReportBuilder::SetSaveDestination ( NXOpen::VisualReporting::VisualReport::SaveDestinationOption destinationOption )

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

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

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

destinationOption The destination option

void NXOpen::VisualReporting::VisualReportBuilder::SetScopeTypeOfVisualReport ( NXOpen::VisualReporting::VisualReport::ScopeTypeOption scopeType )

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

Created in NX9.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

scopeType scopetype

void NXOpen::VisualReporting::VisualReportBuilder::SetTagPriorityOfGroupLabel	(	NXOpen::VisualReporting::GroupLabel *	groupLabel,
		NXOpen::VisualReporting::GroupLabel::TagPriorityOption	tagPriority
	)

Sets the priority of the givenVisualReporting::GroupLabel .

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

groupLabel	The group label
tagPriority	The priority

void NXOpen::VisualReporting::VisualReportBuilder::SetUpperBoundOfGroupLabel	(	NXOpen::VisualReporting::GroupLabel *	groupLabel,
		const NXString &	upperBound
	)

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

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

groupLabel	The group label
upperBound	The upper bound NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::VisualReporting::VisualReportBuilder::SetUpperBoundOfGroupLabel	(	NXOpen::VisualReporting::GroupLabel *	groupLabel,
		const char *	upperBound
	)

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

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

groupLabel	The group label
upperBound	The upper bound NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::VisualReporting::VisualReportBuilder::SetUserNameOfGroupLabel	(	NXOpen::VisualReporting::GroupLabel *	groupLabel,
		const NXString &	name
	)

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

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

void NXOpen::VisualReporting::VisualReportBuilder::SetUserNameOfGroupLabel	(	NXOpen::VisualReporting::GroupLabel *	groupLabel,
		const char *	name
	)

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

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

void NXOpen::VisualReporting::VisualReportBuilder::SetUserPromptOfCondition	(	NXOpen::VisualReporting::Condition *	condition,
		const NXString &	userPrompt
	)

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

       Only valid for a @link VisualReporting::Condition VisualReporting::Condition@endlink  whose
       @link VisualReporting::Condition::Type VisualReporting::Condition::Type@endlink  is @link VisualReporting::Condition::TypeOptionValueCondition VisualReporting::Condition::TypeOptionValueCondition@endlink

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

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

void NXOpen::VisualReporting::VisualReportBuilder::SetUserPromptOfCondition	(	NXOpen::VisualReporting::Condition *	condition,
		const char *	userPrompt
	)

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

       Only valid for a @link VisualReporting::Condition VisualReporting::Condition@endlink  whose
       @link VisualReporting::Condition::Type VisualReporting::Condition::Type@endlink  is @link VisualReporting::Condition::TypeOptionValueCondition VisualReporting::Condition::TypeOptionValueCondition@endlink

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

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

void NXOpen::VisualReporting::VisualReportBuilder::SetValueOfCondition	(	NXOpen::VisualReporting::Condition *	condition,
		const NXString &	value
	)

Sets the value of this VisualReporting::Condition .

       Only valid for a @link VisualReporting::Condition VisualReporting::Condition@endlink  whose
       @link VisualReporting::Condition::Type VisualReporting::Condition::Type@endlink  is @link VisualReporting::Condition::TypeOptionValueCondition VisualReporting::Condition::TypeOptionValueCondition@endlink

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

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

void NXOpen::VisualReporting::VisualReportBuilder::SetValueOfCondition	(	NXOpen::VisualReporting::Condition *	condition,
		const char *	value
	)

Sets the value of this VisualReporting::Condition .

       Only valid for a @link VisualReporting::Condition VisualReporting::Condition@endlink  whose
       @link VisualReporting::Condition::Type VisualReporting::Condition::Type@endlink  is @link VisualReporting::Condition::TypeOptionValueCondition VisualReporting::Condition::TypeOptionValueCondition@endlink

Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

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

void NXOpen::VisualReporting::VisualReportBuilder::SetValueOfGroupLabel	(	NXOpen::VisualReporting::GroupLabel *	groupLabel,
		const NXString &	value
	)

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

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

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

void NXOpen::VisualReporting::VisualReportBuilder::SetValueOfGroupLabel	(	NXOpen::VisualReporting::GroupLabel *	groupLabel,
		const char *	value
	)

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

Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters

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

void NXOpen::VisualReporting::VisualReportBuilder::UnsetUserNameOfGroupLabel ( NXOpen::VisualReporting::GroupLabel * groupLabel )

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

groupLabel The group label

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

VisualReporting_VisualReportBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation