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

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

Inheritance diagram for NXOpen.VisualReporting.VisualReportBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  PropertyUsageOption { Tooltip, InfoView, TooltipAndInfoView }
 Represents the usage option of reference NXOpen.VisualReporting.Property More...
 

Public Member Functions

unsafe void AddChildToCondition (NXOpen.VisualReporting.Condition condition, NXOpen.VisualReporting.Condition childCondition)
 Add a new child NXOpen.VisualReporting.Condition to this condition. More...
 
unsafe
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...
 
unsafe
NXOpen.VisualReporting.Condition 
CreateAndCondition ()
 Creates a new empty NXOpen.VisualReporting.Condition , but does not add it to a NXOpen.VisualReporting.Rule . More...
 
unsafe
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.DatatypeOption.Boolean , but does not add it to a NXOpen.VisualReporting.Rule . More...
 
unsafe
NXOpen.VisualReporting.Condition 
CreateDateCondition (NXOpen.VisualReporting.Property property, string value, NXOpen.VisualReporting.Condition.OperatorOption operatorType)
 Creates a new empty NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Datatype is NXOpen.VisualReporting.Property.DatatypeOption.Date , but does not add it to a NXOpen.VisualReporting.Rule . More...
 
unsafe
NXOpen.VisualReporting.GroupLabel 
CreateGroupLabel (string 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...
 
unsafe
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.DatatypeOption.Integer , but does not add it to a NXOpen.VisualReporting.Rule . More...
 
unsafe
NXOpen.VisualReporting.Condition 
CreateNotCondition ()
 Creates a new empty NXOpen.VisualReporting.Condition , but does not add it to a NXOpen.VisualReporting.Rule . More...
 
unsafe
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.DatatypeOption.Null , but does not add it to a NXOpen.VisualReporting.Rule . More...
 
unsafe
NXOpen.VisualReporting.Condition 
CreateOrCondition ()
 Creates a new empty NXOpen.VisualReporting.Condition , but does not add it to a NXOpen.VisualReporting.Rule . More...
 
unsafe
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...
 
unsafe
NXOpen.VisualReporting.Property 
CreateProperty (string propertyId)
 Creates a new empty NXOpen.VisualReporting.Property , but does not add it to a NXOpen.VisualReporting.VisualReport . More...
 
unsafe
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.DatatypeOption.Real , but does not add it to a NXOpen.VisualReporting.Rule . More...
 
unsafe
NXOpen.VisualReporting.Condition 
CreateStringCondition (NXOpen.VisualReporting.Property property, string value, NXOpen.VisualReporting.Condition.OperatorOption operatorType)
 Creates a new empty NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Datatype is NXOpen.VisualReporting.Property.DatatypeOption.String , but does not add it to a NXOpen.VisualReporting.Rule . More...
 
unsafe
NXOpen.VisualReporting.VisualReport 
CreateVisualReport ()
 Creates a new empty NXOpen.VisualReporting.VisualReport and starts editing it. More...
 
unsafe void DeleteChildCondition (NXOpen.VisualReporting.Condition condition, NXOpen.VisualReporting.Condition childCondition)
 Deletes a NXOpen.VisualReporting.Condition from its parent condition. More...
 
unsafe 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...
 
unsafe void DeleteProperty (NXOpen.VisualReporting.Property property)
 Delete NXOpen.VisualReporting.Property which has no owner. More...
 
unsafe void EditVisualReport (NXOpen.VisualReporting.VisualReport visualReport)
 Starts editing a NXOpen.VisualReporting.VisualReport . More...
 
unsafe 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...
 
unsafe
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...
 
unsafe
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...
 
unsafe string GetBitmapNameOfGroupLabel (NXOpen.VisualReporting.GroupLabel groupLabel)
 Gets the bitmap of the given NXOpen.VisualReporting.GroupLabel . More...
 
unsafe
NXOpen.VisualReporting.Condition 
GetChildCondition (NXOpen.VisualReporting.Condition condition, int index)
 Returns the specified child NXOpen.VisualReporting.Condition from this NXOpen.VisualReporting.Condition More...
 
unsafe
NXOpen.VisualReporting.Condition[] 
GetChildConditions (NXOpen.VisualReporting.Condition condition)
 Returns all the child NXOpen.VisualReporting.Condition s in this NXOpen.VisualReporting.Condition More...
 
unsafe
NXOpen.VisualReporting.Classifier[] 
GetClassifiersOfRule (NXOpen.VisualReporting.Rule rule)
 Returns the NXOpen.VisualReporting.Classifier s associated with this NXOpen.VisualReporting.Rule . More...
 
unsafe
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...
 
unsafe NXOpen.NXColor.Rgb GetColorOfGroupLabel (NXOpen.VisualReporting.GroupLabel groupLabel)
 Gets the NXOpen.VisualReporting.GroupLabel.Color of the given NXOpen.VisualReporting.GroupLabel . More...
 
unsafe string GetCustomMessageOfGroupLabel (NXOpen.VisualReporting.GroupLabel groupLabel)
 Gets the custom message of the givenNXOpen.VisualReporting.GroupLabel . More...
 
unsafe
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...
 
unsafe string GetDescriptionOfCondition (NXOpen.VisualReporting.Condition condition)
 Gets the NXOpen.VisualReporting.Condition.Description of the specified NXOpen.VisualReporting.Condition . More...
 
unsafe
NXOpen.VisualReporting.GroupLabel.DisplayStyleOption 
GetDisplayStyleForGroupLabel (NXOpen.VisualReporting.GroupLabel groupLabel)
 Gets the NXOpen.VisualReporting.GroupLabel.DisplayStyleOption of the given NXOpen.VisualReporting.GroupLabel More...
 
unsafe NXOpen.Validation.Result GetErrorLevelOfGroupLabel (NXOpen.VisualReporting.GroupLabel groupLabel)
 Gets the error level of the givenNXOpen.VisualReporting.GroupLabel . More...
 
unsafe
NXOpen.VisualReporting.Condition 
GetFilterConditionOfRule (NXOpen.VisualReporting.Rule rule)
 Gets the filter NXOpen.VisualReporting.Condition from this rule. More...
 
unsafe
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...
 
unsafe bool GetHasUserSpecifiedValueForCondition (NXOpen.VisualReporting.Condition condition)
 Gets NXOpen.VisualReporting.Condition.HasUserSpecifiedValue on the specified NXOpen.VisualReporting.Condition . More...
 
unsafe string GetLowerBoundOfGroupLabel (NXOpen.VisualReporting.GroupLabel groupLabel)
 Gets the NXOpen.VisualReporting.GroupLabel.LowerBound of the given NXOpen.VisualReporting.GroupLabel . More...
 
unsafe 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.GroupingMethodOption.Manual . More...
 
unsafe
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...
 
unsafe
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...
 
unsafe
NXOpen.VisualReporting.VisualReport.ObjectTypeOption[] 
GetObjectTypesOfVisualReport ()
 Gets the NXOpen.VisualReporting.VisualReport.ObjectTypeOption s of the NXOpen.VisualReporting.VisualReport being built by this builder. More...
 
unsafe
NXOpen.VisualReporting.Condition.OperatorOption 
GetOperatorTypeOfCondition (NXOpen.VisualReporting.Condition condition)
 Gets the NXOpen.VisualReporting.Condition.OperatorOption of this condition. More...
 
unsafe
NXOpen.VisualReporting.Condition 
GetParentCondition (NXOpen.VisualReporting.Condition condition)
 Gets the parent condition of this NXOpen.VisualReporting.Condition . More...
 
unsafe
NXOpen.VisualReporting.Property 
GetPropertyForComparison (NXOpen.VisualReporting.Condition condition)
 Gets the NXOpen.VisualReporting.Property in the value for comparison of this NXOpen.VisualReporting.Condition . More...
 
unsafe
NXOpen.VisualReporting.Property 
GetPropertyOfCondition (NXOpen.VisualReporting.Condition condition)
 Gets the NXOpen.VisualReporting.Property of this condition. More...
 
unsafe void GetPropertySpecification (NXOpen.VisualReporting.Property property, out NXOpen.VisualReporting.Property.TypeOption propertyType, out string key, out string name)
 Gets the property specification of the NXOpen.VisualReporting.Property being built by this builder. More...
 
unsafe
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...
 
unsafe void GetReferencePropertiesOfReport (out NXOpen.VisualReporting.Property[] properties, out NXOpen.VisualReporting.VisualReportBuilder.PropertyUsageOption[] usages, out int notUsed)
 Gets the message NXOpen.VisualReporting.Property list of the NXOpen.VisualReporting.VisualReport . More...
 
unsafe void GetReferencePropertiesOfReportingProperty (out NXOpen.VisualReporting.Property[] properties, out NXOpen.VisualReporting.VisualReportBuilder.PropertyUsageOption[] usages)
 Gets the message NXOpen.VisualReporting.Property list of the NXOpen.VisualReporting.Property in the active NXOpen.VisualReporting.Classifier . More...
 
unsafe
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...
 
unsafe
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...
 
unsafe NXOpen.VisualReporting.Rule GetRule (int index)
 Return the specified NXOpen.VisualReporting.Rule from the NXOpen.VisualReporting.VisualReport being built by this builder. More...
 
unsafe
NXOpen.VisualReporting.Rule[] 
GetRules ()
 Returns all the NXOpen.VisualReporting.Rule s in the NXOpen.VisualReporting.VisualReport being built by this builder. More...
 
unsafe
NXOpen.VisualReporting.GroupLabel.TagPriorityOption 
GetTagPriorityOfGroupLabel (NXOpen.VisualReporting.GroupLabel groupLabel)
 Gets the priority of the givenNXOpen.VisualReporting.GroupLabel . More...
 
unsafe double GetToleranceOfRule (NXOpen.VisualReporting.Rule rule)
 Gets the tolerance of the active NXOpen.VisualReporting.Classifier in the given NXOpen.VisualReporting.Rule More...
 
unsafe string GetUpperBoundOfGroupLabel (NXOpen.VisualReporting.GroupLabel groupLabel)
 Gets the NXOpen.VisualReporting.GroupLabel.UpperBound of the given NXOpen.VisualReporting.GroupLabel . More...
 
unsafe string GetUserNameOfGroupLabel (NXOpen.VisualReporting.GroupLabel groupLabel)
 Gets the NXOpen.NXObject.Name of the given NXOpen.VisualReporting.GroupLabel . More...
 
unsafe string GetUserPromptOfCondition (NXOpen.VisualReporting.Condition condition)
 Gets the NXOpen.VisualReporting.Condition.UserPrompt of the specified NXOpen.VisualReporting.Condition . More...
 
unsafe string GetValueOfCondition (NXOpen.VisualReporting.Condition condition)
 Gets the value of this NXOpen.VisualReporting.Condition . More...
 
unsafe string GetValueOfGroupLabel (NXOpen.VisualReporting.GroupLabel groupLabel)
 Gets the NXOpen.VisualReporting.GroupLabel.Value of the given NXOpen.VisualReporting.GroupLabel . More...
 
unsafe 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...
 
unsafe void RemoveChildFromCondition (NXOpen.VisualReporting.Condition condition, NXOpen.VisualReporting.Condition childCondition)
 Removes a condition from its parent condition. More...
 
unsafe void RemoveFilterConditionFromRule (NXOpen.VisualReporting.Rule rule)
 Removes any existing filter NXOpen.VisualReporting.Condition from this rule. More...
 
unsafe void RemovePropertyFromCondition (NXOpen.VisualReporting.Condition condition)
 Removes the current NXOpen.VisualReporting.Property from this condition without deleting it. More...
 
unsafe void Save ()
 Saves the NXOpen.VisualReporting.VisualReport to its current NXOpen.VisualReporting.VisualReportBuilder.FilenameOfVisualReport . More...
 
unsafe 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...
 
unsafe void SetBitmapNameOfGroupLabel (NXOpen.VisualReporting.GroupLabel groupLabel, string bitmapName)
 Sets the bitmap of the given NXOpen.VisualReporting.GroupLabel . More...
 
unsafe
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...
 
unsafe void SetColorOfGroupLabel (NXOpen.VisualReporting.GroupLabel groupLabel, NXOpen.NXColor.Rgb color)
 Sets the NXOpen.VisualReporting.GroupLabel.Color of the given NXOpen.VisualReporting.GroupLabel . More...
 
unsafe void SetCustomMessageOfGroupLabel (NXOpen.VisualReporting.GroupLabel groupLabel, string customMessage)
 Sets the custom message of the given NXOpen.VisualReporting.GroupLabel . More...
 
unsafe 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...
 
unsafe void SetDescriptionOfCondition (NXOpen.VisualReporting.Condition condition, string description)
 Sets the NXOpen.VisualReporting.Condition.Description of the specified NXOpen.VisualReporting.Condition . More...
 
unsafe void SetDisplayStyleForGroupLabel (NXOpen.VisualReporting.GroupLabel groupLabel, NXOpen.VisualReporting.GroupLabel.DisplayStyleOption displayStyle)
 Sets the NXOpen.VisualReporting.GroupLabel.DisplayStyleOption of the given NXOpen.VisualReporting.GroupLabel More...
 
unsafe void SetErrorLevelOfGroupLabel (NXOpen.VisualReporting.GroupLabel groupLabel, NXOpen.Validation.Result errorLevel)
 Sets the priority of the givenNXOpen.VisualReporting.GroupLabel . More...
 
unsafe void SetFilterConditionOfRule (NXOpen.VisualReporting.Rule rule, NXOpen.VisualReporting.Condition filterCondition)
 Sets the filter NXOpen.VisualReporting.Condition from this rule. More...
 
unsafe 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...
 
unsafe void SetHasUserSpecifiedValueForCondition (NXOpen.VisualReporting.Condition condition, bool isUserSpecified)
 Sets NXOpen.VisualReporting.Condition.HasUserSpecifiedValue on the specified NXOpen.VisualReporting.Condition . More...
 
unsafe void SetLowerBoundOfGroupLabel (NXOpen.VisualReporting.GroupLabel groupLabel, string lowerBound)
 Sets the NXOpen.VisualReporting.GroupLabel.LowerBound of the given NXOpen.VisualReporting.GroupLabel . More...
 
unsafe 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.GroupingMethodOption.Manual . More...
 
unsafe void SetObjectTypesOfVisualReport (NXOpen.VisualReporting.VisualReport.ObjectTypeOption[] objectTypes)
 Sets the NXOpen.VisualReporting.VisualReport.ObjectTypeOption s of the NXOpen.VisualReporting.VisualReport being built by this builder. More...
 
unsafe void SetOperatorTypeOfCondition (NXOpen.VisualReporting.Condition condition, NXOpen.VisualReporting.Condition.OperatorOption operatorType)
 Sets the NXOpen.VisualReporting.Condition.OperatorOption of this condition. More...
 
unsafe 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...
 
unsafe void SetPropertyOfCondition (NXOpen.VisualReporting.Condition condition, NXOpen.VisualReporting.Property property)
 Sets the NXOpen.VisualReporting.Property of this condition. More...
 
unsafe void SetPropertySpecification (NXOpen.VisualReporting.Property property, string key)
 Sets the property specification of the NXOpen.VisualReporting.Property being built by this builder. More...
 
unsafe void SetPropertySpecification (NXOpen.VisualReporting.Property property, string key, string name)
 Sets the property specification of the NXOpen.VisualReporting.Property being built by this builder. More...
 
unsafe 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...
 
unsafe void SetReferencePropertiesOfReport (NXOpen.VisualReporting.Property[] properties, NXOpen.VisualReporting.VisualReportBuilder.PropertyUsageOption[] usages)
 Sets the message NXOpen.VisualReporting.Property list of the NXOpen.VisualReporting.VisualReport . More...
 
unsafe void SetReferencePropertiesOfReportingProperty (NXOpen.VisualReporting.Property[] properties, NXOpen.VisualReporting.VisualReportBuilder.PropertyUsageOption[] usages)
 Sets the message NXOpen.VisualReporting.Property list of the NXOpen.VisualReporting.Property in the active NXOpen.VisualReporting.Classifier . More...
 
unsafe 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...
 
unsafe 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...
 
unsafe void SetTagPriorityOfGroupLabel (NXOpen.VisualReporting.GroupLabel groupLabel, NXOpen.VisualReporting.GroupLabel.TagPriorityOption tagPriority)
 Sets the priority of the givenNXOpen.VisualReporting.GroupLabel . More...
 
unsafe void SetToleranceOfRule (NXOpen.VisualReporting.Rule rule, double tolerance)
 Sets the tolerance of the active NXOpen.VisualReporting.Classifier in the given NXOpen.VisualReporting.Rule More...
 
unsafe void SetUpperBoundOfGroupLabel (NXOpen.VisualReporting.GroupLabel groupLabel, string upperBound)
 Sets the NXOpen.VisualReporting.GroupLabel.UpperBound of the given NXOpen.VisualReporting.GroupLabel . More...
 
unsafe void SetUserNameOfGroupLabel (NXOpen.VisualReporting.GroupLabel groupLabel, string name)
 Sets the NXOpen.NXObject.Name of the given NXOpen.VisualReporting.GroupLabel . More...
 
unsafe void SetUserPromptOfCondition (NXOpen.VisualReporting.Condition condition, string userPrompt)
 Sets the NXOpen.VisualReporting.Condition.UserPrompt of the specified NXOpen.VisualReporting.Condition . More...
 
unsafe void SetValueOfCondition (NXOpen.VisualReporting.Condition condition, string value)
 Sets the value of this NXOpen.VisualReporting.Condition . More...
 
unsafe void SetValueOfGroupLabel (NXOpen.VisualReporting.GroupLabel groupLabel, string value)
 Sets the NXOpen.VisualReporting.GroupLabel.Value of the given NXOpen.VisualReporting.GroupLabel . More...
 
unsafe 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
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe string BitmapNameOfReport [get, set]
 Returns or sets the bitmap name of the NXOpen.VisualReporting.VisualReport . More...
 
unsafe string BitmapNameOfReportingProperty [get, set]
 Returns or sets the bitmap name of the reporting NXOpen.VisualReporting.Property in the active NXOpen.VisualReporting.Classifier . More...
 
unsafe string CustomMessageOfReport [get, set]
 Returns or sets the custom message of the NXOpen.VisualReporting.VisualReport . More...
 
unsafe string CustomMessageOfReportingProperty [get, set]
 Returns or sets the custom message of the reporting NXOpen.VisualReporting.Property in the active NXOpen.VisualReporting.Classifier . More...
 
unsafe string DescriptionOfVisualReport [get, set]
 Returns or sets the description of the NXOpen.VisualReporting.VisualReport being built by this builder. More...
 
unsafe string DescriptiveCategoryOfVisualReport [get, set]
 Returns or sets the descriptive category of the NXOpen.VisualReporting.VisualReport being built by this builder. More...
 
unsafe string DestinationTeamcenterFolder [get, set]
 Returns or sets the destination Teamcenter folder for saving the NXOpen.VisualReporting.VisualReport being built by this builder to Teamcenter database. More...
 
unsafe string FilenameOfVisualReport [get, set]
 Returns or sets the file name of the NXOpen.VisualReporting.VisualReport being built by this builder. More...
 
unsafe string KeywordsOfVisualReport [get, set]
 Returns or sets the keywords of the NXOpen.VisualReporting.VisualReport being built by this builder. More...
 
unsafe
NXOpen.VisualReporting.VisualReport.ReportContextOption 
ReportContextOfVisualReport [get, set]
 Returns or sets the NXOpen.VisualReporting.VisualReport.ReportContextOption of the NXOpen.VisualReporting.VisualReport being built by this builder. More...
 
unsafe
NXOpen.VisualReporting.VisualReport.ReportingObjectTypeOption 
ReportingObjectTypeOfVisualReport [get, set]
 Returns or sets the reporting object type of the NXOpen.VisualReporting.VisualReport being built by this builder. More...
 
unsafe
NXOpen.VisualReporting.VisualReport.ReportingStyleOption 
ReportingStyleOfVisualReport [get, set]
 Returns or sets the reporting style of the NXOpen.VisualReporting.VisualReport being built by this builder. More...
 
unsafe string ReportNameOfVisualReport [get, set]
 Returns or sets the name of the NXOpen.VisualReporting.VisualReport being built by this builder. More...
 
unsafe
NXOpen.VisualReporting.VisualReport.SaveDestinationOption 
SaveDestination [get, set]
 Returns or sets the NXOpen.VisualReporting.VisualReport.SaveDestinationOption of the NXOpen.VisualReporting.VisualReport being built by this builder. More...
 
unsafe
NXOpen.VisualReporting.VisualReport.ScopeTypeOption 
ScopeTypeOfVisualReport [get, set]
 Returns or sets the NXOpen.VisualReporting.VisualReport.ScopeTypeOption of the NXOpen.VisualReporting.VisualReport being built by this builder. More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> 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

Represents the usage option of reference NXOpen.VisualReporting.Property

Enumerator
Tooltip 

The property is used in tooltip only

InfoView 

The property is used in info view only

TooltipAndInfoView 

Member Function Documentation

unsafe void NXOpen.VisualReporting.VisualReportBuilder.AddChildToCondition ( NXOpen.VisualReporting.Condition  condition,
NXOpen.VisualReporting.Condition  childCondition 
)
inline

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.TypeOption.NotCondition then this replaces the existing child, and the existing child is deleted.

Created in NX7.0.0

License requirements: None.

Parameters
conditionThe condition
childConditionThe child condition being added
unsafe NXOpen.VisualReporting.VisualReport NXOpen.VisualReporting.VisualReportBuilder.CommitAsCopy ( )
inline

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 .

Created in NX7.0.0

License requirements: None.

Returns
unsafe NXOpen.VisualReporting.Condition NXOpen.VisualReporting.VisualReportBuilder.CreateAndCondition ( )
inline

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

Created in NX7.0.0

License requirements: None.

Returns
The created condition
unsafe NXOpen.VisualReporting.Condition NXOpen.VisualReporting.VisualReportBuilder.CreateBooleanCondition ( NXOpen.VisualReporting.Property  property,
bool  value,
NXOpen.VisualReporting.Condition.OperatorOption  operatorType 
)
inline

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

Created in NX7.0.0

License requirements: None.

Parameters
propertyThe NXOpen.VisualReporting.Property to which this condition will be applied
valueThe initial value
operatorTypeThe initial operator
Returns
The created condition
unsafe NXOpen.VisualReporting.Condition NXOpen.VisualReporting.VisualReportBuilder.CreateDateCondition ( NXOpen.VisualReporting.Property  property,
string  value,
NXOpen.VisualReporting.Condition.OperatorOption  operatorType 
)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
propertyThe NXOpen.VisualReporting.Property to which this condition will be applied
valueThe initial value
operatorTypeThe initial operator
Returns
The created condition
unsafe NXOpen.VisualReporting.GroupLabel NXOpen.VisualReporting.VisualReportBuilder.CreateGroupLabel ( string  name,
NXOpen.VisualReporting.Rule  rule,
NXOpen.VisualReporting.GroupLabel  afterGroupLabel 
)
inline

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.GroupingMethodOption.Manual grouping.

Created in NX7.0.0

License requirements: None.

Parameters
nameThe initial name. If this name is empty then a system-generated name will be assigned when the owning NXOpen.VisualReporting.VisualReport is next activated
ruleThe rule to which to add it
afterGroupLabelThe group label after which to add it. If a null reference (Nothing in Visual Basic) then it is inserted at the beginning before any existing group labels
Returns
The created group label
unsafe NXOpen.VisualReporting.Condition NXOpen.VisualReporting.VisualReportBuilder.CreateIntegerCondition ( NXOpen.VisualReporting.Property  property,
int  value,
NXOpen.VisualReporting.Condition.OperatorOption  operatorType 
)
inline

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

Created in NX7.0.0

License requirements: None.

Parameters
propertyThe NXOpen.VisualReporting.Property to which this condition will be applied
valueThe initial value
operatorTypeThe initial operator
Returns
The created condition
unsafe NXOpen.VisualReporting.Condition NXOpen.VisualReporting.VisualReportBuilder.CreateNotCondition ( )
inline

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

Created in NX7.0.0

License requirements: None.

Returns
The created condition
unsafe NXOpen.VisualReporting.Condition NXOpen.VisualReporting.VisualReportBuilder.CreateNullCondition ( NXOpen.VisualReporting.Property  property,
bool  value,
NXOpen.VisualReporting.Condition.OperatorOption  operatorType 
)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
propertyThe NXOpen.VisualReporting.Property to which this condition will be applied
valueThe initial value
operatorTypeThe initial operator
Returns
The created condition
unsafe NXOpen.VisualReporting.Condition NXOpen.VisualReporting.VisualReportBuilder.CreateOrCondition ( )
inline

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

Created in NX7.0.0

License requirements: None.

Returns
The created condition
unsafe NXOpen.VisualReporting.Property NXOpen.VisualReporting.VisualReportBuilder.CreateProperty ( NXOpen.VisualReporting.Property.TypeOption  propertyType)
inline

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

Created in NX7.0.0

License requirements: None.

Parameters
propertyTypeProperty Type of the NXOpen.VisualReporting.Property being created
Returns
The created property
unsafe NXOpen.VisualReporting.Property NXOpen.VisualReporting.VisualReportBuilder.CreateProperty ( string  propertyId)
inline

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

Created in NX1847.0.0

License requirements: None.

Parameters
propertyIdProperty Identifier of the NXOpen.VisualReporting.Property being created
Returns
The created property
unsafe NXOpen.VisualReporting.Condition NXOpen.VisualReporting.VisualReportBuilder.CreateRealCondition ( NXOpen.VisualReporting.Property  property,
double  value,
NXOpen.VisualReporting.Condition.OperatorOption  operatorType,
double  tolerance 
)
inline

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

Created in NX7.0.0

License requirements: None.

Parameters
propertyThe NXOpen.VisualReporting.Property to which this condition will be applied
valueThe initial value
operatorTypeThe initial operator
toleranceThe tolerance used in comparisons
Returns
The created condition
unsafe NXOpen.VisualReporting.Condition NXOpen.VisualReporting.VisualReportBuilder.CreateStringCondition ( NXOpen.VisualReporting.Property  property,
string  value,
NXOpen.VisualReporting.Condition.OperatorOption  operatorType 
)
inline

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

Created in NX7.0.0

License requirements: None.

Parameters
propertyThe NXOpen.VisualReporting.Property to which this condition will be applied
valueThe initial value
operatorTypeThe initial operator
Returns
The created condition
unsafe NXOpen.VisualReporting.VisualReport NXOpen.VisualReporting.VisualReportBuilder.CreateVisualReport ( )
inline

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.

Created in NX7.0.0

License requirements: None.

Returns
unsafe void NXOpen.VisualReporting.VisualReportBuilder.DeleteChildCondition ( NXOpen.VisualReporting.Condition  condition,
NXOpen.VisualReporting.Condition  childCondition 
)
inline

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
conditionThe condition
childConditionThe child condition being removed
unsafe void NXOpen.VisualReporting.VisualReportBuilder.DeleteGroupLabel ( NXOpen.VisualReporting.Rule  rule,
NXOpen.VisualReporting.GroupLabel  groupLabel 
)
inline

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
ruleThe rule containing the group label
groupLabelThe group label
unsafe void NXOpen.VisualReporting.VisualReportBuilder.DeleteProperty ( NXOpen.VisualReporting.Property  property)
inline

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
propertyThe property to be deleted
unsafe void NXOpen.VisualReporting.VisualReportBuilder.EditVisualReport ( NXOpen.VisualReporting.VisualReport  visualReport)
inline

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
visualReportThe visual report
unsafe void NXOpen.VisualReporting.VisualReportBuilder.EnableUnmatchedGroupOfVisualReport ( bool  enableUnmatchedGroup)
inline

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
enableUnmatchedGroupWhether the unmatched group is enabled
unsafe NXOpen.VisualReporting.Classifier NXOpen.VisualReporting.VisualReportBuilder.GetActiveClassifierOfRule ( NXOpen.VisualReporting.Rule  rule)
inline

Gets 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
Returns
unsafe NXOpen.VisualReporting.GroupLabel [] NXOpen.VisualReporting.VisualReportBuilder.GetAllGroupLabelsOfRule ( NXOpen.VisualReporting.Rule  rule)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
ruleThe rule
Returns
The manually defined groups
unsafe string NXOpen.VisualReporting.VisualReportBuilder.GetBitmapNameOfGroupLabel ( NXOpen.VisualReporting.GroupLabel  groupLabel)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
groupLabelThe group label
Returns
The bitmap name
unsafe NXOpen.VisualReporting.Condition NXOpen.VisualReporting.VisualReportBuilder.GetChildCondition ( NXOpen.VisualReporting.Condition  condition,
int  index 
)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
condition
indexThe index of the returned Condition.
Returns
unsafe NXOpen.VisualReporting.Condition [] NXOpen.VisualReporting.VisualReportBuilder.GetChildConditions ( NXOpen.VisualReporting.Condition  condition)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
condition
Returns
unsafe NXOpen.VisualReporting.Classifier [] NXOpen.VisualReporting.VisualReportBuilder.GetClassifiersOfRule ( NXOpen.VisualReporting.Rule  rule)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
rule
Returns
unsafe NXOpen.VisualReporting.Classifier.TypeOption NXOpen.VisualReporting.VisualReportBuilder.GetClassifierTypeOfRule ( NXOpen.VisualReporting.Rule  rule)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
ruleThe rule
Returns
The classifier type
unsafe NXOpen.NXColor.Rgb NXOpen.VisualReporting.VisualReportBuilder.GetColorOfGroupLabel ( NXOpen.VisualReporting.GroupLabel  groupLabel)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
groupLabelThe group label
Returns
The color
unsafe string NXOpen.VisualReporting.VisualReportBuilder.GetCustomMessageOfGroupLabel ( NXOpen.VisualReporting.GroupLabel  groupLabel)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
groupLabelThe group label
Returns
The bitmap name
unsafe NXOpen.VisualReporting.Classifier.DateGroupMethodOption NXOpen.VisualReporting.VisualReportBuilder.GetDateGroupMethodOfRule ( NXOpen.VisualReporting.Rule  rule)
inline

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.TypeOption.Range type.

Created in NX8.0.1

License requirements: None.

Parameters
ruleThe rule
Returns
The range method
unsafe string NXOpen.VisualReporting.VisualReportBuilder.GetDescriptionOfCondition ( NXOpen.VisualReporting.Condition  condition)
inline

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.TypeOption.ValueCondition

Created in NX8.0.0

License requirements: None.

Parameters
conditionThe condition
Returns
The description
unsafe NXOpen.VisualReporting.GroupLabel.DisplayStyleOption NXOpen.VisualReporting.VisualReportBuilder.GetDisplayStyleForGroupLabel ( NXOpen.VisualReporting.GroupLabel  groupLabel)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
groupLabelThe group label
Returns
The display style
unsafe NXOpen.Validation.Result NXOpen.VisualReporting.VisualReportBuilder.GetErrorLevelOfGroupLabel ( NXOpen.VisualReporting.GroupLabel  groupLabel)
inline

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

Created in NX12.0.0

License requirements: None.

Parameters
groupLabelThe group label
Returns
The error level
unsafe NXOpen.VisualReporting.Condition NXOpen.VisualReporting.VisualReportBuilder.GetFilterConditionOfRule ( NXOpen.VisualReporting.Rule  rule)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
ruleThe rule
Returns
The filter condition
unsafe NXOpen.VisualReporting.Classifier.GroupingMethodOption NXOpen.VisualReporting.VisualReportBuilder.GetGroupingMethodOfRule ( NXOpen.VisualReporting.Rule  rule)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
ruleThe rule
Returns
The grouping method
unsafe bool NXOpen.VisualReporting.VisualReportBuilder.GetHasUserSpecifiedValueForCondition ( NXOpen.VisualReporting.Condition  condition)
inline

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.TypeOption.ValueCondition

Created in NX8.0.0

License requirements: None.

Parameters
conditionThe condition
Returns
Whether the condition's value should be user-specified
unsafe string NXOpen.VisualReporting.VisualReportBuilder.GetLowerBoundOfGroupLabel ( NXOpen.VisualReporting.GroupLabel  groupLabel)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
groupLabelThe group label
Returns
The lower bound
unsafe bool NXOpen.VisualReporting.VisualReportBuilder.GetManualGroupingForRule ( NXOpen.VisualReporting.Rule  rule)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
ruleThe rule
Returns
Whether manual grouping should be used
unsafe NXOpen.VisualReporting.GroupLabel NXOpen.VisualReporting.VisualReportBuilder.GetManualGroupLabelOfRule ( NXOpen.VisualReporting.Rule  rule,
int  index 
)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
ruleThe rule
index
Returns
The specified manually defined group
unsafe NXOpen.VisualReporting.GroupLabel [] NXOpen.VisualReporting.VisualReportBuilder.GetManualGroupLabelsOfRule ( NXOpen.VisualReporting.Rule  rule)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
ruleThe rule
Returns
The manually defined groups
unsafe NXOpen.VisualReporting.VisualReport.ObjectTypeOption [] NXOpen.VisualReporting.VisualReportBuilder.GetObjectTypesOfVisualReport ( )
inline
unsafe NXOpen.VisualReporting.Condition.OperatorOption NXOpen.VisualReporting.VisualReportBuilder.GetOperatorTypeOfCondition ( NXOpen.VisualReporting.Condition  condition)
inline

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

Only valid if NXOpen.VisualReporting.Condition.TypeOption is NXOpen.VisualReporting.Condition.TypeOption.ValueCondition

Created in NX8.0.0

License requirements: None.

Parameters
conditionThe condition
Returns
The operator type being set
unsafe NXOpen.VisualReporting.Condition NXOpen.VisualReporting.VisualReportBuilder.GetParentCondition ( NXOpen.VisualReporting.Condition  condition)
inline

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 a null reference (Nothing in Visual Basic).

Created in NX8.0.0

License requirements: None.

Parameters
condition
Returns
unsafe NXOpen.VisualReporting.Property NXOpen.VisualReporting.VisualReportBuilder.GetPropertyForComparison ( NXOpen.VisualReporting.Condition  condition)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
conditionThe condition
Returns
The property
unsafe NXOpen.VisualReporting.Property NXOpen.VisualReporting.VisualReportBuilder.GetPropertyOfCondition ( NXOpen.VisualReporting.Condition  condition)
inline

Gets the NXOpen.VisualReporting.Property of this condition.

Only valid for a NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Type is NXOpen.VisualReporting.Condition.TypeOption.ValueCondition

Created in NX8.0.0

License requirements: None.

Parameters
conditionThe condition
Returns
The property
unsafe void NXOpen.VisualReporting.VisualReportBuilder.GetPropertySpecification ( NXOpen.VisualReporting.Property  property,
out NXOpen.VisualReporting.Property.TypeOption  propertyType,
out string  key,
out string  name 
)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
propertyThe property being ask
propertyTypeProperty Type of the NXOpen.VisualReporting.Property
keyproperty key
nameproperty name
unsafe NXOpen.VisualReporting.Classifier.RangeMethodOption NXOpen.VisualReporting.VisualReportBuilder.GetRangeMethodOfRule ( NXOpen.VisualReporting.Rule  rule)
inline

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.TypeOption.Range type.

Created in NX8.0.0

License requirements: None.

Parameters
ruleThe rule
Returns
The range method
unsafe void NXOpen.VisualReporting.VisualReportBuilder.GetReferencePropertiesOfReport ( out NXOpen.VisualReporting.Property[]  properties,
out NXOpen.VisualReporting.VisualReportBuilder.PropertyUsageOption[]  usages,
out int  notUsed 
)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
propertiesThe reference properties of report
usagesThe usages of report
notUsed
unsafe void NXOpen.VisualReporting.VisualReportBuilder.GetReferencePropertiesOfReportingProperty ( out NXOpen.VisualReporting.Property[]  properties,
out NXOpen.VisualReporting.VisualReportBuilder.PropertyUsageOption[]  usages 
)
inline

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
propertiesThe reference properties of property
usagesThe usages
unsafe NXOpen.VisualReporting.Property.DatatypeOption NXOpen.VisualReporting.VisualReportBuilder.GetReportingDatatypeOfRule ( NXOpen.VisualReporting.Rule  rule)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
ruleThe rule
Returns
The datatype
unsafe NXOpen.VisualReporting.Property NXOpen.VisualReporting.VisualReportBuilder.GetReportingPropertyOfRule ( NXOpen.VisualReporting.Rule  rule)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
ruleThe rule
Returns
The property
unsafe NXOpen.VisualReporting.Rule NXOpen.VisualReporting.VisualReportBuilder.GetRule ( int  index)
inline

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

Created in NX8.0.0

License requirements: None.

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

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

Created in NX8.0.0

License requirements: None.

Returns
unsafe NXOpen.VisualReporting.GroupLabel.TagPriorityOption NXOpen.VisualReporting.VisualReportBuilder.GetTagPriorityOfGroupLabel ( NXOpen.VisualReporting.GroupLabel  groupLabel)
inline

Gets the priority of the givenNXOpen.VisualReporting.GroupLabel .

Created in NX8.0.0

License requirements: None.

Parameters
groupLabelThe group label
Returns
The priority
unsafe double NXOpen.VisualReporting.VisualReportBuilder.GetToleranceOfRule ( NXOpen.VisualReporting.Rule  rule)
inline

Gets the tolerance 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.TypeOption.Value type.

Created in NX1899.0.0

License requirements: None.

Parameters
ruleThe rule
Returns
The tolerance value
unsafe string NXOpen.VisualReporting.VisualReportBuilder.GetUpperBoundOfGroupLabel ( NXOpen.VisualReporting.GroupLabel  groupLabel)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
groupLabelThe group label
Returns
The upper bound
unsafe string NXOpen.VisualReporting.VisualReportBuilder.GetUserNameOfGroupLabel ( NXOpen.VisualReporting.GroupLabel  groupLabel)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
groupLabelThe group label
Returns
The name
unsafe string NXOpen.VisualReporting.VisualReportBuilder.GetUserPromptOfCondition ( NXOpen.VisualReporting.Condition  condition)
inline

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.TypeOption.ValueCondition

Created in NX8.0.0

License requirements: None.

Parameters
conditionThe condition
Returns
The user-prompt
unsafe string NXOpen.VisualReporting.VisualReportBuilder.GetValueOfCondition ( NXOpen.VisualReporting.Condition  condition)
inline

Gets the value of this NXOpen.VisualReporting.Condition .

Only valid for a NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Type is NXOpen.VisualReporting.Condition.TypeOption.ValueCondition

Created in NX8.0.0

License requirements: None.

Parameters
condition
Returns
unsafe string NXOpen.VisualReporting.VisualReportBuilder.GetValueOfGroupLabel ( NXOpen.VisualReporting.GroupLabel  groupLabel)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
groupLabelThe group label
Returns
The value
unsafe bool NXOpen.VisualReporting.VisualReportBuilder.IsChildCondition ( NXOpen.VisualReporting.Condition  condition,
NXOpen.VisualReporting.Condition  childCondition 
)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
condition
childConditionThe possible child Condition
Returns
unsafe void NXOpen.VisualReporting.VisualReportBuilder.RemoveChildFromCondition ( NXOpen.VisualReporting.Condition  condition,
NXOpen.VisualReporting.Condition  childCondition 
)
inline

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
conditionThe condition
childConditionThe child condition being removed
unsafe void NXOpen.VisualReporting.VisualReportBuilder.RemoveFilterConditionFromRule ( NXOpen.VisualReporting.Rule  rule)
inline

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
ruleThe rule
unsafe void NXOpen.VisualReporting.VisualReportBuilder.RemovePropertyFromCondition ( NXOpen.VisualReporting.Condition  condition)
inline

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

Created in NX7.0.0

License requirements: None.

Parameters
conditionThe condition
unsafe void NXOpen.VisualReporting.VisualReportBuilder.Save ( )
inline

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.

unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetActiveClassifierOfRule ( NXOpen.VisualReporting.Rule  rule,
NXOpen.VisualReporting.Classifier  activeClassifier 
)
inline

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
activeClassifier
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetBitmapNameOfGroupLabel ( NXOpen.VisualReporting.GroupLabel  groupLabel,
string  bitmapName 
)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
groupLabelThe group label
bitmapNameThe bitmap name
unsafe NXOpen.VisualReporting.Classifier NXOpen.VisualReporting.VisualReportBuilder.SetClassifierTypeOfRule ( NXOpen.VisualReporting.Rule  rule,
NXOpen.VisualReporting.Classifier.TypeOption  classifierType 
)
inline

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 .

Created in NX8.0.0

License requirements: None.

Parameters
ruleThe rule
classifierTypeThe classifier type being set
Returns
The new active classifier
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetColorOfGroupLabel ( NXOpen.VisualReporting.GroupLabel  groupLabel,
NXOpen.NXColor.Rgb  color 
)
inline

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

This also changes NXOpen.VisualReporting.GroupLabel.DisplayStyle to NXOpen.VisualReporting.GroupLabel.DisplayStyleOption.SpecifiedColor .

Created in NX7.0.0

License requirements: None.

Parameters
groupLabelThe group label
colorThe color
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetCustomMessageOfGroupLabel ( NXOpen.VisualReporting.GroupLabel  groupLabel,
string  customMessage 
)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
groupLabelThe group label
customMessageThe bitmap name
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetDateGroupMethodOfRule ( NXOpen.VisualReporting.Rule  rule,
NXOpen.VisualReporting.Classifier.DateGroupMethodOption  dateGroupMethod 
)
inline

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.TypeOption.Range type.

Created in NX8.0.1

License requirements: None.

Parameters
ruleThe rule
dateGroupMethodThe range method
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetDescriptionOfCondition ( NXOpen.VisualReporting.Condition  condition,
string  description 
)
inline

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.TypeOption.ValueCondition

Created in NX7.0.0

License requirements: None.

Parameters
conditionThe condition
descriptionThe description
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetDisplayStyleForGroupLabel ( NXOpen.VisualReporting.GroupLabel  groupLabel,
NXOpen.VisualReporting.GroupLabel.DisplayStyleOption  displayStyle 
)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
groupLabelThe group label
displayStyleThe display style
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetErrorLevelOfGroupLabel ( NXOpen.VisualReporting.GroupLabel  groupLabel,
NXOpen.Validation.Result  errorLevel 
)
inline

Sets the priority of the givenNXOpen.VisualReporting.GroupLabel .

Created in NX12.0.0

License requirements: None.

Parameters
groupLabelThe group label
errorLevelThe error level
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetFilterConditionOfRule ( NXOpen.VisualReporting.Rule  rule,
NXOpen.VisualReporting.Condition  filterCondition 
)
inline

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
ruleThe rule
filterConditionThe filter condition being set
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetGroupingMethodOfRule ( NXOpen.VisualReporting.Rule  rule,
NXOpen.VisualReporting.Classifier.GroupingMethodOption  groupingMethod 
)
inline

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
ruleThe rule
groupingMethodThe grouping method
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetHasUserSpecifiedValueForCondition ( NXOpen.VisualReporting.Condition  condition,
bool  isUserSpecified 
)
inline

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.TypeOption.ValueCondition

Created in NX7.0.0

License requirements: None.

Parameters
conditionThe condition
isUserSpecifiedWhether the condition's value should be user-specified
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetLowerBoundOfGroupLabel ( NXOpen.VisualReporting.GroupLabel  groupLabel,
string  lowerBound 
)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
groupLabelThe group label
lowerBoundThe lower bound
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetManualGroupingForRule ( NXOpen.VisualReporting.Rule  rule,
bool  isManualGrouping 
)
inline

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

If it uses NXOpen.VisualReporting.Classifier.GroupingMethodOption.Manual , 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
ruleThe rule
isManualGroupingWhether manual grouping should be used
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetObjectTypesOfVisualReport ( NXOpen.VisualReporting.VisualReport.ObjectTypeOption[]  objectTypes)
inline

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.ScopeTypeOption.SubPart type.

Created in NX9.0.0

License requirements: None.

Parameters
objectTypesThe object types being set
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetOperatorTypeOfCondition ( NXOpen.VisualReporting.Condition  condition,
NXOpen.VisualReporting.Condition.OperatorOption  operatorType 
)
inline

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

Only valid if NXOpen.VisualReporting.Condition.TypeOption is NXOpen.VisualReporting.Condition.TypeOption.ValueCondition

Created in NX7.0.0

License requirements: None.

Parameters
conditionThe condition
operatorTypeThe operator type being set
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetPropertyForComparison ( NXOpen.VisualReporting.Condition  condition,
NXOpen.VisualReporting.Property  property 
)
inline

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

If the NXOpen.VisualReporting.Property is set to a null reference (Nothing in Visual Basic), then it is deleted.

Created in NX8.0.0

License requirements: None.

Parameters
conditionThe condition
propertyThe property being set
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetPropertyOfCondition ( NXOpen.VisualReporting.Condition  condition,
NXOpen.VisualReporting.Property  property 
)
inline

Sets the NXOpen.VisualReporting.Property of this condition.

If the NXOpen.VisualReporting.Property is set to a null reference (Nothing in Visual Basic), then it is deleted. Only valid for a NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Type is NXOpen.VisualReporting.Condition.TypeOption.ValueCondition

Created in NX7.0.0

License requirements: None.

Parameters
conditionThe condition
propertyThe property being set
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetPropertySpecification ( NXOpen.VisualReporting.Property  property,
string  key 
)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
propertyThe property being set
keyproperty key
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetPropertySpecification ( NXOpen.VisualReporting.Property  property,
string  key,
string  name 
)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
propertyThe property being set
keyproperty key
nameproperty name
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetRangeMethodOfRule ( NXOpen.VisualReporting.Rule  rule,
NXOpen.VisualReporting.Classifier.RangeMethodOption  rangeMethod 
)
inline

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.TypeOption.Range type.

Created in NX8.0.0

License requirements: None.

Parameters
ruleThe rule
rangeMethodThe range method
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetReferencePropertiesOfReport ( NXOpen.VisualReporting.Property[]  properties,
NXOpen.VisualReporting.VisualReportBuilder.PropertyUsageOption[]  usages 
)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
propertiesThe reference properties of report
usagesThe usages of report
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetReferencePropertiesOfReportingProperty ( NXOpen.VisualReporting.Property[]  properties,
NXOpen.VisualReporting.VisualReportBuilder.PropertyUsageOption[]  usages 
)
inline

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
propertiesThe reference properties of property
usagesThe usages
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetReportingDatatypeOfRule ( NXOpen.VisualReporting.Rule  rule,
NXOpen.VisualReporting.Property.DatatypeOption  datatype 
)
inline

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.DatatypeOption.Unknown .

Created in NX7.0.0

License requirements: None.

Parameters
ruleThe rule
datatypeThe datatype being set
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetReportingPropertyOfRule ( NXOpen.VisualReporting.Rule  rule,
NXOpen.VisualReporting.Property  reportingProperty 
)
inline

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 a null reference (Nothing in Visual Basic), 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.TypeOption.Value or NXOpen.VisualReporting.Classifier.TypeOption.Range .

Created in NX7.0.0

License requirements: None.

Parameters
ruleThe rule
reportingPropertyThe property being set
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetTagPriorityOfGroupLabel ( NXOpen.VisualReporting.GroupLabel  groupLabel,
NXOpen.VisualReporting.GroupLabel.TagPriorityOption  tagPriority 
)
inline

Sets the priority of the givenNXOpen.VisualReporting.GroupLabel .

Created in NX8.0.0

License requirements: None.

Parameters
groupLabelThe group label
tagPriorityThe priority
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetToleranceOfRule ( NXOpen.VisualReporting.Rule  rule,
double  tolerance 
)
inline

Sets the tolerance 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.TypeOption.Value type.

Created in NX1899.0.0

License requirements: None.

Parameters
ruleThe rule
toleranceThe tolerance value
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetUpperBoundOfGroupLabel ( NXOpen.VisualReporting.GroupLabel  groupLabel,
string  upperBound 
)
inline

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

Created in NX8.0.0

License requirements: None.

Parameters
groupLabelThe group label
upperBoundThe upper bound
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetUserNameOfGroupLabel ( NXOpen.VisualReporting.GroupLabel  groupLabel,
string  name 
)
inline

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
groupLabelThe group label
nameThe name
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetUserPromptOfCondition ( NXOpen.VisualReporting.Condition  condition,
string  userPrompt 
)
inline

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.TypeOption.ValueCondition

Created in NX7.0.0

License requirements: None.

Parameters
conditionThe condition
userPromptThe user-prompt
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetValueOfCondition ( NXOpen.VisualReporting.Condition  condition,
string  value 
)
inline

Sets the value of this NXOpen.VisualReporting.Condition .

Only valid for a NXOpen.VisualReporting.Condition whose NXOpen.VisualReporting.Condition.Type is NXOpen.VisualReporting.Condition.TypeOption.ValueCondition

Created in NX8.0.0

License requirements: None.

Parameters
condition
value
unsafe void NXOpen.VisualReporting.VisualReportBuilder.SetValueOfGroupLabel ( NXOpen.VisualReporting.GroupLabel  groupLabel,
string  value 
)
inline

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

Created in NX7.0.0

License requirements: None.

Parameters
groupLabelThe group label
valueThe value
unsafe void NXOpen.VisualReporting.VisualReportBuilder.UnsetUserNameOfGroupLabel ( NXOpen.VisualReporting.GroupLabel  groupLabel)
inline

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
groupLabelThe group label

Property Documentation

unsafe string NXOpen.VisualReporting.VisualReportBuilder.BitmapNameOfReport
getset

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

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.VisualReporting.VisualReportBuilder.BitmapNameOfReportingProperty
getset

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

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.VisualReporting.VisualReportBuilder.CustomMessageOfReport
getset

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

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.VisualReporting.VisualReportBuilder.CustomMessageOfReportingProperty
getset

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

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.VisualReporting.VisualReportBuilder.DescriptionOfVisualReport
getset

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

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.VisualReporting.VisualReportBuilder.DescriptiveCategoryOfVisualReport
getset

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

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.VisualReporting.VisualReportBuilder.DestinationTeamcenterFolder
getset

Returns or 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 a null reference (Nothing in Visual Basic) if you haven't set a folder name on this property.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.VisualReporting.VisualReportBuilder.FilenameOfVisualReport
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.VisualReporting.VisualReportBuilder.KeywordsOfVisualReport
getset

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

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.VisualReporting.VisualReport.ReportContextOption NXOpen.VisualReporting.VisualReportBuilder.ReportContextOfVisualReport
getset

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

Created in NX9.0.0

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

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.VisualReporting.VisualReport.ReportingObjectTypeOption NXOpen.VisualReporting.VisualReportBuilder.ReportingObjectTypeOfVisualReport
getset

Returns or 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.ScopeTypeOption.Component type.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.VisualReporting.VisualReport.ReportingStyleOption NXOpen.VisualReporting.VisualReportBuilder.ReportingStyleOfVisualReport
getset

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

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.VisualReporting.VisualReportBuilder.ReportNameOfVisualReport
getset

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

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

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

Returns or 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.SaveDestinationOption.Local when NX is not connected to Teamcenter.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.VisualReporting.VisualReport.ScopeTypeOption NXOpen.VisualReporting.VisualReportBuilder.ScopeTypeOfVisualReport
getset

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

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.


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