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

Inheritance diagram for NXOpen::VisualReporting::VisualReportBuilder:

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

Public Member Functions
void	AddChildToCondition (NXOpen::VisualReporting::Condition condition, NXOpen::VisualReporting::Condition childCondition)
	Add a new child NXOpen::VisualReporting::Condition to this condition. More...

NXString	BitmapNameOfReport ()
	Returns the bitmap name of the NXOpen::VisualReporting::VisualReport . More...

NXString	BitmapNameOfReportingProperty ()
	Returns the bitmap name of the reporting NXOpen::VisualReporting::Property in the active NXOpen::VisualReporting::Classifier . More...

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

NXOpen::VisualReporting::Condition *	CreateAndCondition ()
	Creates a new empty NXOpen::VisualReporting::Condition , but does not add it to a NXOpen::VisualReporting::Rule . More...

NXOpen::VisualReporting::Condition *	CreateBooleanCondition (NXOpen::VisualReporting::Property *property, bool value, NXOpen::VisualReporting::Condition::OperatorOption operatorType)
	Creates a new empty NXOpen::VisualReporting::Condition whose NXOpen::VisualReporting::Condition::Datatype is NXOpen::VisualReporting::Property::DatatypeOptionBoolean , but does not add it to a NXOpen::VisualReporting::Rule . More...

NXOpen::VisualReporting::Condition *	CreateDateCondition (NXOpen::VisualReporting::Property *property, const NXString &value, NXOpen::VisualReporting::Condition::OperatorOption operatorType)
	Creates a new empty NXOpen::VisualReporting::Condition whose NXOpen::VisualReporting::Condition::Datatype is NXOpen::VisualReporting::Property::DatatypeOptionDate , but does not add it to a NXOpen::VisualReporting::Rule . More...

NXOpen::VisualReporting::Condition *	CreateDateCondition (NXOpen::VisualReporting::Property property, const char value, NXOpen::VisualReporting::Condition::OperatorOption operatorType)
	Creates a new empty NXOpen::VisualReporting::Condition whose NXOpen::VisualReporting::Condition::Datatype is NXOpen::VisualReporting::Property::DatatypeOptionDate , but does not add it to a NXOpen::VisualReporting::Rule . More...

NXOpen::VisualReporting::GroupLabel *	CreateGroupLabel (const NXString &name, NXOpen::VisualReporting::Rule rule, NXOpen::VisualReporting::GroupLabel afterGroupLabel)
	Creates a new empty NXOpen::VisualReporting::GroupLabel , and adds it to the given NXOpen::VisualReporting::Rule . More...

NXOpen::VisualReporting::GroupLabel *	CreateGroupLabel (const char name, NXOpen::VisualReporting::Rule rule, NXOpen::VisualReporting::GroupLabel *afterGroupLabel)
	Creates a new empty NXOpen::VisualReporting::GroupLabel , and adds it to the given NXOpen::VisualReporting::Rule . More...

NXOpen::VisualReporting::Condition *	CreateIntegerCondition (NXOpen::VisualReporting::Property *property, int value, NXOpen::VisualReporting::Condition::OperatorOption operatorType)
	Creates a new empty NXOpen::VisualReporting::Condition whose NXOpen::VisualReporting::Condition::Datatype is NXOpen::VisualReporting::Property::DatatypeOptionInteger , but does not add it to a NXOpen::VisualReporting::Rule . More...

NXOpen::VisualReporting::Condition *	CreateNotCondition ()
	Creates a new empty NXOpen::VisualReporting::Condition , but does not add it to a NXOpen::VisualReporting::Rule . More...

NXOpen::VisualReporting::Condition *	CreateNullCondition (NXOpen::VisualReporting::Property *property, bool value, NXOpen::VisualReporting::Condition::OperatorOption operatorType)
	Creates a new empty NXOpen::VisualReporting::Condition whose NXOpen::VisualReporting::Condition::Datatype is NXOpen::VisualReporting::Property::DatatypeOptionNull , but does not add it to a NXOpen::VisualReporting::Rule . More...

NXOpen::VisualReporting::Condition *	CreateOrCondition ()
	Creates a new empty NXOpen::VisualReporting::Condition , but does not add it to a NXOpen::VisualReporting::Rule . More...

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

NXOpen::VisualReporting::Condition *	CreateRealCondition (NXOpen::VisualReporting::Property *property, double value, NXOpen::VisualReporting::Condition::OperatorOption operatorType, double tolerance)
	Creates a new empty NXOpen::VisualReporting::Condition whose NXOpen::VisualReporting::Condition::Datatype is NXOpen::VisualReporting::Property::DatatypeOptionReal , but does not add it to a NXOpen::VisualReporting::Rule . More...

NXOpen::VisualReporting::Condition *	CreateStringCondition (NXOpen::VisualReporting::Property *property, const NXString &value, NXOpen::VisualReporting::Condition::OperatorOption operatorType)
	Creates a new empty NXOpen::VisualReporting::Condition whose NXOpen::VisualReporting::Condition::Datatype is NXOpen::VisualReporting::Property::DatatypeOptionString , but does not add it to a NXOpen::VisualReporting::Rule . More...

NXOpen::VisualReporting::Condition *	CreateStringCondition (NXOpen::VisualReporting::Property property, const char value, NXOpen::VisualReporting::Condition::OperatorOption operatorType)
	Creates a new empty NXOpen::VisualReporting::Condition whose NXOpen::VisualReporting::Condition::Datatype is NXOpen::VisualReporting::Property::DatatypeOptionString , but does not add it to a NXOpen::VisualReporting::Rule . More...

NXOpen::VisualReporting::VisualReport *	CreateVisualReport ()
	Creates a new empty NXOpen::VisualReporting::VisualReport and starts editing it. More...

NXString	CustomMessageOfReport ()
	Returns the custom message of the NXOpen::VisualReporting::VisualReport . More...

NXString	CustomMessageOfReportingProperty ()
	Returns the custom message of the reporting NXOpen::VisualReporting::Property in the active NXOpen::VisualReporting::Classifier . More...

void	DeleteChildCondition (NXOpen::VisualReporting::Condition condition, NXOpen::VisualReporting::Condition childCondition)
	Deletes a NXOpen::VisualReporting::Condition from its parent condition. More...

void	DeleteGroupLabel (NXOpen::VisualReporting::Rule rule, NXOpen::VisualReporting::GroupLabel groupLabel)
	Deletes the given NXOpen::VisualReporting::GroupLabel from the active NXOpen::VisualReporting::Classifier in this NXOpen::VisualReporting::Rule . More...

void	DeleteProperty (NXOpen::VisualReporting::Property *property)
	Delete NXOpen::VisualReporting::Property which has no owner. More...

NXString	DescriptionOfVisualReport ()
	Returns the description of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

NXString	DescriptiveCategoryOfVisualReport ()
	Returns the descriptive category of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

NXString	DestinationTeamcenterFolder ()
	Returns the destination Teamcenter folder for saving the NXOpen::VisualReporting::VisualReport being built by this builder to Teamcenter database. More...

void	EditVisualReport (NXOpen::VisualReporting::VisualReport *visualReport)
	Starts editing a NXOpen::VisualReporting::VisualReport . More...

void	EnableUnmatchedGroupOfVisualReport (bool enableUnmatchedGroup)
	Sets whether use of NXOpen::VisualReporting::VisualReport::UnmatchedGroupLabel is enabled for the NXOpen::VisualReporting::VisualReport being built by this builder. More...

NXString	FilenameOfVisualReport ()
	Returns the file name of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

NXOpen::VisualReporting::Classifier *	GetActiveClassifierOfRule (NXOpen::VisualReporting::Rule *rule)
	Gets the active NXOpen::VisualReporting::Classifier in this NXOpen::VisualReporting::Rule for a multiple properties report. More...

std::vector < NXOpen::VisualReporting::GroupLabel * >	GetAllGroupLabelsOfRule (NXOpen::VisualReporting::Rule *rule)
	Returns the NXOpen::VisualReporting::GroupLabel s associated with the active NXOpen::VisualReporting::Classifier in this NXOpen::VisualReporting::Rule . More...

NXString	GetBitmapNameOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel)
	Gets the bitmap of the given NXOpen::VisualReporting::GroupLabel . More...

NXOpen::VisualReporting::Condition *	GetChildCondition (NXOpen::VisualReporting::Condition *condition, int index)
	Returns the specified child NXOpen::VisualReporting::Condition from this NXOpen::VisualReporting::Condition. More...

std::vector < NXOpen::VisualReporting::Condition * >	GetChildConditions (NXOpen::VisualReporting::Condition *condition)
	Returns all the child NXOpen::VisualReporting::Condition s in this NXOpen::VisualReporting::Condition. More...

std::vector < NXOpen::VisualReporting::Classifier * >	GetClassifiersOfRule (NXOpen::VisualReporting::Rule *rule)
	Returns the NXOpen::VisualReporting::Classifier s associated with this NXOpen::VisualReporting::Rule . More...

NXOpen::VisualReporting::Classifier::TypeOption	GetClassifierTypeOfRule (NXOpen::VisualReporting::Rule *rule)
	Gets the reporting NXOpen::VisualReporting::Classifier::TypeOption for the active NXOpen::VisualReporting::Classifier in this NXOpen::VisualReporting::Rule . More...

NXOpen::NXColor::Rgb	GetColorOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel)
	Gets the NXOpen::VisualReporting::GroupLabel::Color of the given NXOpen::VisualReporting::GroupLabel . More...

NXString	GetCustomMessageOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel)
	Gets the custom message of the givenNXOpen::VisualReporting::GroupLabel . More...

NXOpen::VisualReporting::Classifier::DateGroupMethodOption	GetDateGroupMethodOfRule (NXOpen::VisualReporting::Rule *rule)
	Gets the NXOpen::VisualReporting::Classifier::DateGroupMethodOption of the active NXOpen::VisualReporting::Classifier in the given NXOpen::VisualReporting::Rule . More...

NXString	GetDescriptionOfCondition (NXOpen::VisualReporting::Condition *condition)
	Gets the NXOpen::VisualReporting::Condition::Description of the specified NXOpen::VisualReporting::Condition . More...

NXOpen::VisualReporting::GroupLabel::DisplayStyleOption	GetDisplayStyleForGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel)
	Gets the NXOpen::VisualReporting::GroupLabel::DisplayStyleOption of the given NXOpen::VisualReporting::GroupLabel. More...

NXOpen::Validation::Result	GetErrorLevelOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel)
	Gets the error level of the givenNXOpen::VisualReporting::GroupLabel . More...

NXOpen::VisualReporting::Condition *	GetFilterConditionOfRule (NXOpen::VisualReporting::Rule *rule)
	Gets the filter NXOpen::VisualReporting::Condition from this rule. More...

NXOpen::VisualReporting::Classifier::GroupingMethodOption	GetGroupingMethodOfRule (NXOpen::VisualReporting::Rule *rule)
	Gets the NXOpen::VisualReporting::Classifier::GroupingMethodOption of the active NXOpen::VisualReporting::Classifier in this NXOpen::VisualReporting::Rule . More...

bool	GetHasUserSpecifiedValueForCondition (NXOpen::VisualReporting::Condition *condition)
	Gets NXOpen::VisualReporting::Condition::HasUserSpecifiedValue on the specified NXOpen::VisualReporting::Condition . More...

NXString	GetLowerBoundOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel)
	Gets the NXOpen::VisualReporting::GroupLabel::LowerBound of the given NXOpen::VisualReporting::GroupLabel . More...

bool	GetManualGroupingForRule (NXOpen::VisualReporting::Rule *rule)
	Gets whether the NXOpen::VisualReporting::Classifier::GroupingMethodOption of the active NXOpen::VisualReporting::Classifier in this NXOpen::VisualReporting::Rule is NXOpen::VisualReporting::Classifier::GroupingMethodOptionManual . More...

NXOpen::VisualReporting::GroupLabel *	GetManualGroupLabelOfRule (NXOpen::VisualReporting::Rule *rule, int index)
	Returns the specified NXOpen::VisualReporting::GroupLabel s associated with the active NXOpen::VisualReporting::Classifier in this NXOpen::VisualReporting::Rule which are manually defined. More...

std::vector < NXOpen::VisualReporting::GroupLabel * >	GetManualGroupLabelsOfRule (NXOpen::VisualReporting::Rule *rule)
	Returns the NXOpen::VisualReporting::GroupLabel s associated with the active NXOpen::VisualReporting::Classifier in this NXOpen::VisualReporting::Rule which are manually defined. More...

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

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

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

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

NXOpen::VisualReporting::Property *	GetPropertyOfCondition (NXOpen::VisualReporting::Condition *condition)
	Gets the NXOpen::VisualReporting::Property of this condition. More...

void	GetPropertySpecification (NXOpen::VisualReporting::Property property, NXOpen::VisualReporting::Property::TypeOption propertyType, NXString key, NXString name)
	Gets the property specification of the NXOpen::VisualReporting::Property being built by this builder. More...

NXOpen::VisualReporting::Classifier::RangeMethodOption	GetRangeMethodOfRule (NXOpen::VisualReporting::Rule *rule)
	Gets the NXOpen::VisualReporting::Classifier::RangeMethodOption of the active NXOpen::VisualReporting::Classifier in the given NXOpen::VisualReporting::Rule . More...

void	GetReferencePropertiesOfReport (std::vector< NXOpen::VisualReporting::Property * > &properties, std::vector< NXOpen::VisualReporting::VisualReportBuilder::PropertyUsageOption > &usages, int *notUsed)
	Gets the message NXOpen::VisualReporting::Property list of the NXOpen::VisualReporting::VisualReport . More...

void	GetReferencePropertiesOfReportingProperty (std::vector< NXOpen::VisualReporting::Property * > &properties, std::vector< NXOpen::VisualReporting::VisualReportBuilder::PropertyUsageOption > &usages)
	Gets the message NXOpen::VisualReporting::Property list of the NXOpen::VisualReporting::Property in the active NXOpen::VisualReporting::Classifier . More...

NXOpen::VisualReporting::Property::DatatypeOption	GetReportingDatatypeOfRule (NXOpen::VisualReporting::Rule *rule)
	Gets the NXOpen::VisualReporting::Property::DatatypeOption of the active NXOpen::VisualReporting::Classifier 's reporting NXOpen::VisualReporting::Property in this NXOpen::VisualReporting::Rule . More...

NXOpen::VisualReporting::Property *	GetReportingPropertyOfRule (NXOpen::VisualReporting::Rule *rule)
	Gets the reporting NXOpen::VisualReporting::Property for the active NXOpen::VisualReporting::Classifier in this NXOpen::VisualReporting::Rule . More...

NXOpen::VisualReporting::Rule *	GetRule (int index)
	Return the specified NXOpen::VisualReporting::Rule from the NXOpen::VisualReporting::VisualReport being built by this builder. More...

std::vector < NXOpen::VisualReporting::Rule * >	GetRules ()
	Returns all the NXOpen::VisualReporting::Rule s in the NXOpen::VisualReporting::VisualReport being built by this builder. More...

NXOpen::VisualReporting::GroupLabel::TagPriorityOption	GetTagPriorityOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel)
	Gets the priority of the givenNXOpen::VisualReporting::GroupLabel . More...

NXString	GetUpperBoundOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel)
	Gets the NXOpen::VisualReporting::GroupLabel::UpperBound of the given NXOpen::VisualReporting::GroupLabel . More...

NXString	GetUserNameOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel)
	Gets the NXOpen::NXObject::Name of the given NXOpen::VisualReporting::GroupLabel . More...

NXString	GetUserPromptOfCondition (NXOpen::VisualReporting::Condition *condition)
	Gets the NXOpen::VisualReporting::Condition::UserPrompt of the specified NXOpen::VisualReporting::Condition . More...

NXString	GetValueOfCondition (NXOpen::VisualReporting::Condition *condition)
	Gets the value of this NXOpen::VisualReporting::Condition . More...

NXString	GetValueOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel)
	Gets the NXOpen::VisualReporting::GroupLabel::Value of the given NXOpen::VisualReporting::GroupLabel . More...

bool	IsChildCondition (NXOpen::VisualReporting::Condition condition, NXOpen::VisualReporting::Condition childCondition)
	Returns whether the given NXOpen::VisualReporting::Condition is an immediate child of this condition. More...

NXString	KeywordsOfVisualReport ()
	Returns the keywords of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

void	RemoveChildFromCondition (NXOpen::VisualReporting::Condition condition, NXOpen::VisualReporting::Condition childCondition)
	Removes a condition from its parent condition. More...

void	RemoveFilterConditionFromRule (NXOpen::VisualReporting::Rule *rule)
	Removes any existing filter NXOpen::VisualReporting::Condition from this rule. More...

void	RemovePropertyFromCondition (NXOpen::VisualReporting::Condition *condition)
	Removes the current NXOpen::VisualReporting::Property from this condition without deleting it. More...

NXOpen::VisualReporting::VisualReport::ReportContextOption	ReportContextOfVisualReport ()
	Returns the NXOpen::VisualReporting::VisualReport::ReportContextOption of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

NXOpen::VisualReporting::VisualReport::ReportingObjectTypeOption	ReportingObjectTypeOfVisualReport ()
	Returns the reporting object type of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

NXOpen::VisualReporting::VisualReport::ReportingStyleOption	ReportingStyleOfVisualReport ()
	Returns the reporting style of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

NXString	ReportNameOfVisualReport ()
	Returns the name of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

void	Save ()
	Saves the NXOpen::VisualReporting::VisualReport to its current NXOpen::VisualReporting::VisualReportBuilder::FilenameOfVisualReport . More...

NXOpen::VisualReporting::VisualReport::SaveDestinationOption	SaveDestination ()
	Returns the NXOpen::VisualReporting::VisualReport::SaveDestinationOption of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

NXOpen::VisualReporting::VisualReport::ScopeTypeOption	ScopeTypeOfVisualReport ()
	Returns the NXOpen::VisualReporting::VisualReport::ScopeTypeOption of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

void	SetActiveClassifierOfRule (NXOpen::VisualReporting::Rule rule, NXOpen::VisualReporting::Classifier activeClassifier)
	Sets the active NXOpen::VisualReporting::Classifier in this NXOpen::VisualReporting::Rule for a multiple properties report. More...

void	SetBitmapNameOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel, const NXString &bitmapName)
	Sets the bitmap of the given NXOpen::VisualReporting::GroupLabel . More...

void	SetBitmapNameOfGroupLabel (NXOpen::VisualReporting::GroupLabel groupLabel, const char bitmapName)
	Sets the bitmap of the given NXOpen::VisualReporting::GroupLabel . More...

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

void	SetBitmapNameOfReport (const char *bitmapName)
	Sets the bitmap name of the NXOpen::VisualReporting::VisualReport . More...

void	SetBitmapNameOfReportingProperty (const NXString &bitmapName)
	Sets the bitmap name of the reporting NXOpen::VisualReporting::Property in the active NXOpen::VisualReporting::Classifier . More...

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

NXOpen::VisualReporting::Classifier *	SetClassifierTypeOfRule (NXOpen::VisualReporting::Rule *rule, NXOpen::VisualReporting::Classifier::TypeOption classifierType)
	Sets the reporting NXOpen::VisualReporting::Classifier::TypeOption for the active NXOpen::VisualReporting::Classifier in this NXOpen::VisualReporting::Rule . More...

void	SetColorOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel, const NXOpen::NXColor::Rgb &color)
	Sets the NXOpen::VisualReporting::GroupLabel::Color of the given NXOpen::VisualReporting::GroupLabel . More...

void	SetCustomMessageOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel, const NXString &customMessage)
	Sets the custom message of the given NXOpen::VisualReporting::GroupLabel . More...

void	SetCustomMessageOfGroupLabel (NXOpen::VisualReporting::GroupLabel groupLabel, const char customMessage)
	Sets the custom message of the given NXOpen::VisualReporting::GroupLabel . More...

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

void	SetCustomMessageOfReport (const char *customMessage)
	Sets the custom message of the NXOpen::VisualReporting::VisualReport . More...

void	SetCustomMessageOfReportingProperty (const NXString &customMessage)
	Sets the custom message of the reporting NXOpen::VisualReporting::Property in the active NXOpen::VisualReporting::Classifier . More...

void	SetCustomMessageOfReportingProperty (const char *customMessage)
	Sets the custom message of the reporting NXOpen::VisualReporting::Property in the active NXOpen::VisualReporting::Classifier . More...

void	SetDateGroupMethodOfRule (NXOpen::VisualReporting::Rule *rule, NXOpen::VisualReporting::Classifier::DateGroupMethodOption dateGroupMethod)
	Sets the NXOpen::VisualReporting::Classifier::DateGroupMethodOption of the active NXOpen::VisualReporting::Classifier in the given NXOpen::VisualReporting::Rule . More...

void	SetDescriptionOfCondition (NXOpen::VisualReporting::Condition *condition, const NXString &description)
	Sets the NXOpen::VisualReporting::Condition::Description of the specified NXOpen::VisualReporting::Condition . More...

void	SetDescriptionOfCondition (NXOpen::VisualReporting::Condition condition, const char description)
	Sets the NXOpen::VisualReporting::Condition::Description of the specified NXOpen::VisualReporting::Condition . More...

void	SetDescriptionOfVisualReport (const NXString &description)
	Sets the description of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

void	SetDescriptionOfVisualReport (const char *description)
	Sets the description of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

void	SetDescriptiveCategoryOfVisualReport (const NXString &category)
	Sets the descriptive category of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

void	SetDescriptiveCategoryOfVisualReport (const char *category)
	Sets the descriptive category of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

void	SetDestinationTeamcenterFolder (const NXString &foldername)
	Sets the destination Teamcenter folder for saving the NXOpen::VisualReporting::VisualReport being built by this builder to Teamcenter database. More...

void	SetDestinationTeamcenterFolder (const char *foldername)
	Sets the destination Teamcenter folder for saving the NXOpen::VisualReporting::VisualReport being built by this builder to Teamcenter database. More...

void	SetDisplayStyleForGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel, NXOpen::VisualReporting::GroupLabel::DisplayStyleOption displayStyle)
	Sets the NXOpen::VisualReporting::GroupLabel::DisplayStyleOption of the given NXOpen::VisualReporting::GroupLabel. More...

void	SetErrorLevelOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel, NXOpen::Validation::Result errorLevel)
	Sets the priority of the givenNXOpen::VisualReporting::GroupLabel . More...

void	SetFilenameOfVisualReport (const NXString &filename)
	Sets the file name of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

void	SetFilenameOfVisualReport (const char *filename)
	Sets the file name of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

void	SetFilterConditionOfRule (NXOpen::VisualReporting::Rule rule, NXOpen::VisualReporting::Condition filterCondition)
	Sets the filter NXOpen::VisualReporting::Condition from this rule. More...

void	SetGroupingMethodOfRule (NXOpen::VisualReporting::Rule *rule, NXOpen::VisualReporting::Classifier::GroupingMethodOption groupingMethod)
	Sets the NXOpen::VisualReporting::Classifier::GroupingMethodOption of the active NXOpen::VisualReporting::Classifier in the given NXOpen::VisualReporting::Rule . More...

void	SetHasUserSpecifiedValueForCondition (NXOpen::VisualReporting::Condition *condition, bool isUserSpecified)
	Sets NXOpen::VisualReporting::Condition::HasUserSpecifiedValue on the specified NXOpen::VisualReporting::Condition . More...

void	SetKeywordsOfVisualReport (const NXString &keywords)
	Sets the keywords of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

void	SetKeywordsOfVisualReport (const char *keywords)
	Sets the keywords of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

void	SetLowerBoundOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel, const NXString &lowerBound)
	Sets the NXOpen::VisualReporting::GroupLabel::LowerBound of the given NXOpen::VisualReporting::GroupLabel . More...

void	SetLowerBoundOfGroupLabel (NXOpen::VisualReporting::GroupLabel groupLabel, const char lowerBound)
	Sets the NXOpen::VisualReporting::GroupLabel::LowerBound of the given NXOpen::VisualReporting::GroupLabel . More...

void	SetManualGroupingForRule (NXOpen::VisualReporting::Rule *rule, bool isManualGrouping)
	Sets whether the NXOpen::VisualReporting::Classifier::GroupingMethodOption of the active NXOpen::VisualReporting::Classifier in this NXOpen::VisualReporting::Rule is NXOpen::VisualReporting::Classifier::GroupingMethodOptionManual . More...

void	SetObjectTypesOfVisualReport (const std::vector< NXOpen::VisualReporting::VisualReport::ObjectTypeOption > &objectTypes)
	Sets the NXOpen::VisualReporting::VisualReport::ObjectTypeOption s of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

void	SetOperatorTypeOfCondition (NXOpen::VisualReporting::Condition *condition, NXOpen::VisualReporting::Condition::OperatorOption operatorType)
	Sets the NXOpen::VisualReporting::Condition::OperatorOption of this condition. More...

void	SetPropertyForComparison (NXOpen::VisualReporting::Condition condition, NXOpen::VisualReporting::Property property)
	Sets the NXOpen::VisualReporting::Property in the value for comparison of this NXOpen::VisualReporting::Condition . More...

void	SetPropertyOfCondition (NXOpen::VisualReporting::Condition condition, NXOpen::VisualReporting::Property property)
	Sets the NXOpen::VisualReporting::Property of this condition. More...

void	SetPropertySpecification (NXOpen::VisualReporting::Property *property, const NXString &key)
	Sets the property specification of the NXOpen::VisualReporting::Property being built by this builder. More...

void	SetPropertySpecification (NXOpen::VisualReporting::Property property, const char key)
	Sets the property specification of the NXOpen::VisualReporting::Property being built by this builder. More...

void	SetPropertySpecification (NXOpen::VisualReporting::Property *property, const NXString &key, const NXString &name)
	Sets the property specification of the NXOpen::VisualReporting::Property being built by this builder. More...

void	SetPropertySpecification (NXOpen::VisualReporting::Property property, const char key, const char *name)
	Sets the property specification of the NXOpen::VisualReporting::Property being built by this builder. More...

void	SetRangeMethodOfRule (NXOpen::VisualReporting::Rule *rule, NXOpen::VisualReporting::Classifier::RangeMethodOption rangeMethod)
	Sets the NXOpen::VisualReporting::Classifier::RangeMethodOption of the active NXOpen::VisualReporting::Classifier in the given NXOpen::VisualReporting::Rule . More...

void	SetReferencePropertiesOfReport (const std::vector< NXOpen::VisualReporting::Property * > &properties, const std::vector< NXOpen::VisualReporting::VisualReportBuilder::PropertyUsageOption > &usages)
	Sets the message NXOpen::VisualReporting::Property list of the NXOpen::VisualReporting::VisualReport . More...

void	SetReferencePropertiesOfReportingProperty (const std::vector< NXOpen::VisualReporting::Property * > &properties, const std::vector< NXOpen::VisualReporting::VisualReportBuilder::PropertyUsageOption > &usages)
	Sets the message NXOpen::VisualReporting::Property list of the NXOpen::VisualReporting::Property in the active NXOpen::VisualReporting::Classifier . More...

void	SetReportContextOfVisualReport (NXOpen::VisualReporting::VisualReport::ReportContextOption reportContext)
	Sets the NXOpen::VisualReporting::VisualReport::ReportContextOption of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

void	SetReportingDatatypeOfRule (NXOpen::VisualReporting::Rule *rule, NXOpen::VisualReporting::Property::DatatypeOption datatype)
	Sets the NXOpen::VisualReporting::Property::DatatypeOption of the active NXOpen::VisualReporting::Classifier 's reporting NXOpen::VisualReporting::Property in this NXOpen::VisualReporting::Rule . More...

void	SetReportingObjectTypeOfVisualReport (NXOpen::VisualReporting::VisualReport::ReportingObjectTypeOption reportingObjectType)
	Sets the reporting object type of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

void	SetReportingPropertyOfRule (NXOpen::VisualReporting::Rule rule, NXOpen::VisualReporting::Property reportingProperty)
	Sets the reporting NXOpen::VisualReporting::Property for the active NXOpen::VisualReporting::Classifier in this NXOpen::VisualReporting::Rule . More...

void	SetReportingStyleOfVisualReport (NXOpen::VisualReporting::VisualReport::ReportingStyleOption reportingStyle)
	Sets the reporting style of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

void	SetReportNameOfVisualReport (const NXString &reportName)
	Sets the name of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

void	SetReportNameOfVisualReport (const char *reportName)
	Sets the name of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

void	SetSaveDestination (NXOpen::VisualReporting::VisualReport::SaveDestinationOption destinationOption)
	Sets the NXOpen::VisualReporting::VisualReport::SaveDestinationOption of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

void	SetScopeTypeOfVisualReport (NXOpen::VisualReporting::VisualReport::ScopeTypeOption scopeType)
	Sets the NXOpen::VisualReporting::VisualReport::ScopeTypeOption of the NXOpen::VisualReporting::VisualReport being built by this builder. More...

void	SetTagPriorityOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel, NXOpen::VisualReporting::GroupLabel::TagPriorityOption tagPriority)
	Sets the priority of the givenNXOpen::VisualReporting::GroupLabel . More...

void	SetUpperBoundOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel, const NXString &upperBound)
	Sets the NXOpen::VisualReporting::GroupLabel::UpperBound of the given NXOpen::VisualReporting::GroupLabel . More...

void	SetUpperBoundOfGroupLabel (NXOpen::VisualReporting::GroupLabel groupLabel, const char upperBound)
	Sets the NXOpen::VisualReporting::GroupLabel::UpperBound of the given NXOpen::VisualReporting::GroupLabel . More...

void	SetUserNameOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel, const NXString &name)
	Sets the NXOpen::NXObject::Name of the given NXOpen::VisualReporting::GroupLabel . More...

void	SetUserNameOfGroupLabel (NXOpen::VisualReporting::GroupLabel groupLabel, const char name)
	Sets the NXOpen::NXObject::Name of the given NXOpen::VisualReporting::GroupLabel . More...

void	SetUserPromptOfCondition (NXOpen::VisualReporting::Condition *condition, const NXString &userPrompt)
	Sets the NXOpen::VisualReporting::Condition::UserPrompt of the specified NXOpen::VisualReporting::Condition . More...

void	SetUserPromptOfCondition (NXOpen::VisualReporting::Condition condition, const char userPrompt)
	Sets the NXOpen::VisualReporting::Condition::UserPrompt of the specified NXOpen::VisualReporting::Condition . More...

void	SetValueOfCondition (NXOpen::VisualReporting::Condition *condition, const NXString &value)
	Sets the value of this NXOpen::VisualReporting::Condition . More...

void	SetValueOfCondition (NXOpen::VisualReporting::Condition condition, const char value)
	Sets the value of this NXOpen::VisualReporting::Condition . More...

void	SetValueOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel, const NXString &value)
	Sets the NXOpen::VisualReporting::GroupLabel::Value of the given NXOpen::VisualReporting::GroupLabel . More...

void	SetValueOfGroupLabel (NXOpen::VisualReporting::GroupLabel groupLabel, const char value)
	Sets the NXOpen::VisualReporting::GroupLabel::Value of the given NXOpen::VisualReporting::GroupLabel . More...

void	UnsetUserNameOfGroupLabel (NXOpen::VisualReporting::GroupLabel *groupLabel)
	Resets the NXOpen::VisualReporting::GroupLabel::IsNameUserSpecified status of the given NXOpen::VisualReporting::GroupLabel so that the name is now system-generated. More...

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

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

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

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

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

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

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

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

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

Created in NX7.0.0.

Member Enumeration Documentation

enum NXOpen::VisualReporting::VisualReportBuilder::PropertyUsageOption

Represents the usage option of reference NXOpen::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 NXOpen::VisualReporting::Condition to this condition.

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

Created in NX7.0.0.

License requirements : None

Parameters

condition	The condition
childCondition	The child condition being added

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

Returns the bitmap name of the NXOpen::VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : None

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

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

Created in NX8.0.0.

License requirements : None

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

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

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

Returns: Created in NX7.0.0.

License requirements : None

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

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

Returns: The created condition
Created in NX7.0.0.

License requirements : None

NXOpen::VisualReporting::Condition* NXOpen::VisualReporting::VisualReportBuilder::CreateBooleanCondition	(	NXOpen::VisualReporting::Property *	property,
		bool	value,
		NXOpen::VisualReporting::Condition::OperatorOption	operatorType
	)

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

Returns: The created condition
Created in NX7.0.0.

License requirements : None

Parameters

property	The NXOpen::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 NXOpen::VisualReporting::Condition whose NXOpen::VisualReporting::Condition::Datatype is NXOpen::VisualReporting::Property::DatatypeOptionDate , but does not add it to a NXOpen::VisualReporting::Rule .

Returns: The created condition
Created in NX8.0.0.

License requirements : None

Parameters

property	The NXOpen::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 char *	value,
		NXOpen::VisualReporting::Condition::OperatorOption	operatorType
	)

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

Returns: The created condition
Created in NX8.0.0.

License requirements : None

Parameters

property	The NXOpen::VisualReporting::Property to which this condition will be applied
value	The initial value
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 NXOpen::VisualReporting::GroupLabel , and adds it to the given NXOpen::VisualReporting::Rule .

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

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

License requirements : None

Parameters

name	The initial name. If this name is empty then a system-generated name will be assigned when the owning NXOpen::VisualReporting::VisualReport is next activated
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 NXOpen::VisualReporting::GroupLabel , and adds it to the given NXOpen::VisualReporting::Rule .

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

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

License requirements : None

Parameters

name	The initial name. If this name is empty then a system-generated name will be assigned when the owning NXOpen::VisualReporting::VisualReport is next activated
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 NXOpen::VisualReporting::Condition whose NXOpen::VisualReporting::Condition::Datatype is NXOpen::VisualReporting::Property::DatatypeOptionInteger , but does not add it to a NXOpen::VisualReporting::Rule .

Returns: The created condition
Created in NX7.0.0.

License requirements : None

Parameters

property	The NXOpen::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 NXOpen::VisualReporting::Condition , but does not add it to a NXOpen::VisualReporting::Rule .

Returns: The created condition
Created in NX7.0.0.

License requirements : None

NXOpen::VisualReporting::Condition* NXOpen::VisualReporting::VisualReportBuilder::CreateNullCondition	(	NXOpen::VisualReporting::Property *	property,
		bool	value,
		NXOpen::VisualReporting::Condition::OperatorOption	operatorType
	)

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

Returns: The created condition
Created in NX8.0.0.

License requirements : None

Parameters

property	The NXOpen::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 NXOpen::VisualReporting::Condition , but does not add it to a NXOpen::VisualReporting::Rule .

Returns: The created condition
Created in NX7.0.0.

License requirements : None

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

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

Returns: The created property
Created in NX7.0.0.

License requirements : None

Parameters

propertyType Property Type of the NXOpen::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 NXOpen::VisualReporting::Condition whose NXOpen::VisualReporting::Condition::Datatype is NXOpen::VisualReporting::Property::DatatypeOptionReal , but does not add it to a NXOpen::VisualReporting::Rule .

Returns: The created condition
Created in NX7.0.0.

License requirements : None

Parameters

property	The NXOpen::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 NXOpen::VisualReporting::Condition whose NXOpen::VisualReporting::Condition::Datatype is NXOpen::VisualReporting::Property::DatatypeOptionString , but does not add it to a NXOpen::VisualReporting::Rule .

Returns: The created condition
Created in NX7.0.0.

License requirements : None

Parameters

property	The NXOpen::VisualReporting::Property to which this condition will be applied
value	The initial value
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 NXOpen::VisualReporting::Condition whose NXOpen::VisualReporting::Condition::Datatype is NXOpen::VisualReporting::Property::DatatypeOptionString , but does not add it to a NXOpen::VisualReporting::Rule .

Returns: The created condition
Created in NX7.0.0.

License requirements : None

Parameters

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

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

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

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

Returns: Created in NX7.0.0.

License requirements : None

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

Returns the custom message of the NXOpen::VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : None

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

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

Created in NX8.0.0.

License requirements : None

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

Deletes a NXOpen::VisualReporting::Condition from its parent condition.

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

Created in NX8.0.0.

License requirements : None

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 NXOpen::VisualReporting::GroupLabel from the active NXOpen::VisualReporting::Classifier in this NXOpen::VisualReporting::Rule .

Created in NX7.0.0.

License requirements : None

Parameters

rule	The rule containing the group label
groupLabel	The group label

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

Delete NXOpen::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 : None

Parameters

property The property to be deleted

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

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

Created in NX8.0.0.

License requirements : None

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

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

Created in NX8.0.0.

License requirements : None

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

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

Created in NX8.0.0.

License requirements : None

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

Starts editing a NXOpen::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 NXOpen::VisualReporting::VisualReportBuilder::CommitAsCopy is called, the copied NXOpen::VisualReporting::VisualReport will be added to the NXOpen::VisualReporting::VisualReportManager without deleting the one given in this function.

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

Created in NX7.0.0.

License requirements : None

Parameters

visualReport The visual report

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

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

Created in NX7.0.0.

License requirements : None

Parameters

enableUnmatchedGroup Whether the unmatched group is enabled

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

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

Created in NX8.0.0.

License requirements : None

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

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

Returns: Created in NX8.0.0.

License requirements : None

Parameters

rule rule

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

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

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

License requirements : None

Parameters

rule The rule

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

Gets the bitmap of the given NXOpen::VisualReporting::GroupLabel .

Returns: The bitmap name
Created in NX8.0.0.

License requirements : None

Parameters

groupLabel The group label

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

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

Returns: Created in NX8.0.0.

License requirements : None

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 NXOpen::VisualReporting::Condition s in this NXOpen::VisualReporting::Condition.

Returns: Created in NX8.0.0.

License requirements : None

Parameters

condition condition

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

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

Returns: Created in NX8.0.0.

License requirements : None

Parameters

rule rule

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

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

Returns: The classifier type
Created in NX8.0.0.

License requirements : None

Parameters

rule The rule

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

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

Returns: The color
Created in NX8.0.0.

License requirements : None

Parameters

groupLabel The group label

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

Gets the custom message of the givenNXOpen::VisualReporting::GroupLabel .

Returns: The bitmap name
Created in NX8.0.0.

License requirements : None

Parameters

groupLabel The group label

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

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

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

Returns: The range method
Created in NX8.0.1.

License requirements : None

Parameters

rule The rule

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

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

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

Returns: The description
Created in NX8.0.0.

License requirements : None

Parameters

condition The condition

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

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

Returns: The display style
Created in NX8.0.0.

License requirements : None

Parameters

groupLabel The group label

NXOpen::Validation::Result NXOpen::VisualReporting::VisualReportBuilder::GetErrorLevelOfGroupLabel ( NXOpen::VisualReporting::GroupLabel * groupLabel )

Gets the error level of the givenNXOpen::VisualReporting::GroupLabel .

Returns: The error level
Created in NX12.0.0.

License requirements : None

Parameters

groupLabel The group label

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

Gets the filter NXOpen::VisualReporting::Condition from this rule.

Returns: The filter condition
Created in NX8.0.0.

License requirements : None

Parameters

rule The rule

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

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

Returns: The grouping method
Created in NX8.0.0.

License requirements : None

Parameters

rule The rule

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

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

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

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

License requirements : None

Parameters

condition The condition

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

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

Returns: The lower bound
Created in NX8.0.0.

License requirements : None

Parameters

groupLabel The group label

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

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

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

License requirements : None

Parameters

rule The rule

NXOpen::VisualReporting::GroupLabel* NXOpen::VisualReporting::VisualReportBuilder::GetManualGroupLabelOfRule	(	NXOpen::VisualReporting::Rule *	rule,
		int	index
	)

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

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

License requirements : None

Parameters

rule	The rule
index	index

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

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

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

License requirements : None

Parameters

rule The rule

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

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

Only valid if the NXOpen::VisualReporting::VisualReport::ScopeType of the NXOpen::VisualReporting::VisualReport is NXOpen::VisualReporting::VisualReport::ScopeTypeOptionSubPart type.

Returns: The object types
Created in NX9.0.0.

License requirements : None

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

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

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

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

License requirements : None

Parameters

condition The condition

NXOpen::VisualReporting::Condition* NXOpen::VisualReporting::VisualReportBuilder::GetParentCondition ( NXOpen::VisualReporting::Condition * condition )

Gets the parent condition of this NXOpen::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 : None

Parameters

condition condition

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

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

Returns: The property
Created in NX8.0.0.

License requirements : None

Parameters

condition The condition

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

Gets the NXOpen::VisualReporting::Property of this condition.

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

Returns: The property
Created in NX8.0.0.

License requirements : None

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 NXOpen::VisualReporting::Property being built by this builder.

Created in NX8.0.0.

License requirements : None

Parameters

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

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

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

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

Returns: The range method
Created in NX8.0.0.

License requirements : None

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 NXOpen::VisualReporting::Property list of the NXOpen::VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : None

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 NXOpen::VisualReporting::Property list of the NXOpen::VisualReporting::Property in the active NXOpen::VisualReporting::Classifier .

Created in NX8.0.0.

License requirements : None

Parameters

properties	The reference properties of property
usages	The usages

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

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

Returns: The datatype
Created in NX8.0.0.

License requirements : None

Parameters

rule The rule

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

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

Returns: The property
Created in NX8.0.0.

License requirements : None

Parameters

rule The rule

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

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

Returns: Created in NX8.0.0.

License requirements : None

Parameters

index The index of the returned NXOpen::VisualReporting::Rule .

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

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

Returns: Created in NX8.0.0.

License requirements : None

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

Gets the priority of the givenNXOpen::VisualReporting::GroupLabel .

Returns: The priority
Created in NX8.0.0.

License requirements : None

Parameters

groupLabel The group label

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

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

Returns: The upper bound
Created in NX8.0.0.

License requirements : None

Parameters

groupLabel The group label

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

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

Returns: The name
Created in NX8.0.0.

License requirements : None

Parameters

groupLabel The group label

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

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

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

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

License requirements : None

Parameters

condition The condition

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

Gets the value of this NXOpen::VisualReporting::Condition .

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

Returns: Created in NX8.0.0.

License requirements : None

Parameters

condition condition

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

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

Returns: The value
Created in NX8.0.0.

License requirements : None

Parameters

groupLabel The group label

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

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

Returns: Created in NX8.0.0.

License requirements : None

Parameters

condition	condition
childCondition	The possible child Condition

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

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

Created in NX8.0.0.

License requirements : None

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 NXOpen::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 : None

Parameters

condition	The condition
childCondition	The child condition being removed

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

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

This will not delete the condition.

Created in NX7.0.0.

License requirements : None

Parameters

rule The rule

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

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

Created in NX7.0.0.

License requirements : None

Parameters

condition The condition

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

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

Deprecated:: Deprecated in NX9.0.3. Use NXOpen::VisualReporting::VisualReport::ReportContext instead.

Created in NX9.0.0.

License requirements : None

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

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

Only valid if the NXOpen::VisualReporting::VisualReport::ScopeType of the NXOpen::VisualReporting::VisualReport is NXOpen::VisualReporting::VisualReport::ScopeTypeOptionComponent type.

Created in NX8.0.0.

License requirements : None

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

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

Created in NX8.0.0.

License requirements : None

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

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

Created in NX8.0.0.

License requirements : None

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

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

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

Created in NX8.0.0.

License requirements : None

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

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

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

Created in NX8.0.0.

License requirements : None

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

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

Created in NX9.0.0.

License requirements : None

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

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

Created in NX8.0.0.

License requirements : None

Parameters

rule	rule
activeClassifier	activeclassifier

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

Sets the bitmap of the given NXOpen::VisualReporting::GroupLabel .

Created in NX8.0.0.

License requirements : None

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

Created in NX8.0.0.

License requirements : None

Parameters

groupLabel	The group label
bitmapName	The bitmap name

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

Sets the bitmap name of the NXOpen::VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : None

Parameters

bitmapName The bitmap name

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

Sets the bitmap name of the NXOpen::VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : None

Parameters

bitmapName The bitmap name

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

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

Created in NX8.0.0.

License requirements : None

Parameters

bitmapName The bitmap name

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

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

Created in NX8.0.0.

License requirements : None

Parameters

bitmapName The bitmap name

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

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

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

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

License requirements : None

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 NXOpen::VisualReporting::GroupLabel::Color of the given NXOpen::VisualReporting::GroupLabel .

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

Created in NX7.0.0.

License requirements : None

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

Created in NX8.0.0.

License requirements : None

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

Created in NX8.0.0.

License requirements : None

Parameters

groupLabel	The group label
customMessage	The bitmap name

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

Sets the custom message of the NXOpen::VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : None

Parameters

customMessage The custom message

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

Sets the custom message of the NXOpen::VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : None

Parameters

customMessage The custom message

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

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

Created in NX8.0.0.

License requirements : None

Parameters

customMessage The custom message

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

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

Created in NX8.0.0.

License requirements : None

Parameters

customMessage The custom message

void NXOpen::VisualReporting::VisualReportBuilder::SetDateGroupMethodOfRule	(	NXOpen::VisualReporting::Rule *	rule,
		NXOpen::VisualReporting::Classifier::DateGroupMethodOption	dateGroupMethod
	)

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

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

Created in NX8.0.1.

License requirements : None

Parameters

rule	The rule
dateGroupMethod	The range method

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

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

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

Created in NX7.0.0.

License requirements : None

Parameters

condition	The condition
description	The description

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

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

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

Created in NX7.0.0.

License requirements : None

Parameters

condition	The condition
description	The description

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

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

Created in NX8.0.0.

License requirements : None

Parameters

description The description

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

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

Created in NX8.0.0.

License requirements : None

Parameters

description The description

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

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

Created in NX7.5.0.

License requirements : None

Parameters

category The category being set

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

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

Created in NX7.5.0.

License requirements : None

Parameters

category The category being set

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

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

Created in NX8.0.0.

License requirements : None

Parameters

foldername The Teamcenter folder name

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

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

Created in NX8.0.0.

License requirements : None

Parameters

foldername The Teamcenter folder name

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

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

Created in NX8.0.0.

License requirements : None

Parameters

groupLabel	The group label
displayStyle	The display style

void NXOpen::VisualReporting::VisualReportBuilder::SetErrorLevelOfGroupLabel	(	NXOpen::VisualReporting::GroupLabel *	groupLabel,
		NXOpen::Validation::Result	errorLevel
	)

Sets the priority of the givenNXOpen::VisualReporting::GroupLabel .

Created in NX12.0.0.

License requirements : None

Parameters

groupLabel	The group label
errorLevel	The error level

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

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

Created in NX8.0.0.

License requirements : None

Parameters

filename The file name

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

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

Created in NX8.0.0.

License requirements : None

Parameters

filename The file name

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

Sets the filter NXOpen::VisualReporting::Condition from this rule.

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

Created in NX7.0.0.

License requirements : None

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 NXOpen::VisualReporting::Classifier::GroupingMethodOption of the active NXOpen::VisualReporting::Classifier in the given NXOpen::VisualReporting::Rule .

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

Created in NX8.0.0.

License requirements : None

Parameters

rule	The rule
groupingMethod	The grouping method

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

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

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

Created in NX7.0.0.

License requirements : None

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 NXOpen::VisualReporting::VisualReport being built by this builder.

Created in NX8.0.0.

License requirements : None

Parameters

keywords A comma separated string of keywords

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

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

Created in NX8.0.0.

License requirements : None

Parameters

keywords A comma separated string of keywords

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

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

Created in NX8.0.0.

License requirements : None

Parameters

groupLabel	The group label
lowerBound	The lower bound

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

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

Created in NX8.0.0.

License requirements : None

Parameters

groupLabel	The group label
lowerBound	The lower bound

void NXOpen::VisualReporting::VisualReportBuilder::SetManualGroupingForRule	(	NXOpen::VisualReporting::Rule *	rule,
		bool	isManualGrouping
	)

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

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

Created in NX7.0.0.

License requirements : None

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 NXOpen::VisualReporting::VisualReport::ObjectTypeOption s of the NXOpen::VisualReporting::VisualReport being built by this builder.

Only valid if the NXOpen::VisualReporting::VisualReport::ScopeType of the NXOpen::VisualReporting::VisualReport is NXOpen::VisualReporting::VisualReport::ScopeTypeOptionSubPart type.

Created in NX9.0.0.

License requirements : None

Parameters

objectTypes The object types being set

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

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

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

Created in NX7.0.0.

License requirements : None

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 NXOpen::VisualReporting::Property in the value for comparison of this NXOpen::VisualReporting::Condition .

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

Created in NX8.0.0.

License requirements : None

Parameters

condition	The condition
property	The property being set

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

Sets the NXOpen::VisualReporting::Property of this condition.

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

Created in NX7.0.0.

License requirements : None

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 NXOpen::VisualReporting::Property being built by this builder.

Created in NX8.0.0.

License requirements : None

Parameters

property	The property being set
key	property key

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

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

Created in NX8.0.0.

License requirements : None

Parameters

property	The property being set
key	property key

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

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

Created in NX8.0.0.

License requirements : None

Parameters

property	The property being set
key	property key
name	property name

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

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

Created in NX8.0.0.

License requirements : None

Parameters

property	The property being set
key	property key
name	property name

void NXOpen::VisualReporting::VisualReportBuilder::SetRangeMethodOfRule	(	NXOpen::VisualReporting::Rule *	rule,
		NXOpen::VisualReporting::Classifier::RangeMethodOption	rangeMethod
	)

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

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

Created in NX8.0.0.

License requirements : None

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 NXOpen::VisualReporting::Property list of the NXOpen::VisualReporting::VisualReport .

Created in NX8.0.0.

License requirements : None

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 NXOpen::VisualReporting::Property list of the NXOpen::VisualReporting::Property in the active NXOpen::VisualReporting::Classifier .

Created in NX8.0.0.

License requirements : None

Parameters

properties	The reference properties of property
usages	The usages

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

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

Deprecated:: Deprecated in NX9.0.3. Use NXOpen::VisualReporting::VisualReport::SetReportContext instead.

Created in NX9.0.0.

License requirements : None

Parameters

reportContext The report context being set

void NXOpen::VisualReporting::VisualReportBuilder::SetReportingDatatypeOfRule	(	NXOpen::VisualReporting::Rule *	rule,
		NXOpen::VisualReporting::Property::DatatypeOption	datatype
	)

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

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

Created in NX7.0.0.

License requirements : None

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 NXOpen::VisualReporting::VisualReport being built by this builder.

Only valid if the NXOpen::VisualReporting::VisualReport::ScopeType of the NXOpen::VisualReporting::VisualReport is NXOpen::VisualReporting::VisualReport::ScopeTypeOptionComponent type.

Created in NX8.0.0.

License requirements : None

Parameters

reportingObjectType The reporting object being set

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

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

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

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

Created in NX7.0.0.

License requirements : None

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 NXOpen::VisualReporting::VisualReport being built by this builder.

Created in NX8.0.0.

License requirements : None

Parameters

reportingStyle The reporting style being set

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

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

Created in NX8.0.0.

License requirements : None

Parameters

reportName The name of the report

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

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

Created in NX8.0.0.

License requirements : None

Parameters

reportName The name of the report

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

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

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

Created in NX8.0.0.

License requirements : None

Parameters

destinationOption The destination option

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

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

Created in NX9.0.0.

License requirements : None

Parameters

scopeType scopetype

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

Sets the priority of the givenNXOpen::VisualReporting::GroupLabel .

Created in NX8.0.0.

License requirements : None

Parameters

groupLabel	The group label
tagPriority	The priority

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

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

Created in NX8.0.0.

License requirements : None

Parameters

groupLabel	The group label
upperBound	The upper bound

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

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

Created in NX8.0.0.

License requirements : None

Parameters

groupLabel	The group label
upperBound	The upper bound

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

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

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

Created in NX7.0.0.

License requirements : None

Parameters

groupLabel	The group label
name	The name

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

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

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

Created in NX7.0.0.

License requirements : None

Parameters

groupLabel	The group label
name	The name

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

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

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

Created in NX7.0.0.

License requirements : None

Parameters

condition	The condition
userPrompt	The user-prompt

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

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

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

Created in NX7.0.0.

License requirements : None

Parameters

condition	The condition
userPrompt	The user-prompt

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

Sets the value of this NXOpen::VisualReporting::Condition .

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

Created in NX8.0.0.

License requirements : None

Parameters

condition	condition
value	value

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

Sets the value of this NXOpen::VisualReporting::Condition .

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

Created in NX8.0.0.

License requirements : None

Parameters

condition	condition
value	value

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

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

Created in NX7.0.0.

License requirements : None

Parameters

groupLabel	The group label
value	The value

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

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

Created in NX7.0.0.

License requirements : None

Parameters

groupLabel	The group label
value	The value

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

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

Created in NX7.0.0.

License requirements : None

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