Class VisualReportBuilder

Inheritance
object
MarshalByRefObject
NXRemotableObject
TaggedObject
Builder
VisualReportBuilder
Implements
IMessageSink
Inherited Members
Namespace: NXOpen.VisualReporting
Assembly: NXOpen.dll
Syntax
public class VisualReportBuilder : Builder, IMessageSink, IComponentBuilder

Constructors

VisualReportBuilder()

Declaration
protected VisualReportBuilder()

Properties

BitmapNameOfReport

Declaration
public string BitmapNameOfReport { get; set; }
Property Value
Type Description
string

BitmapNameOfReportingProperty

Declaration
public string BitmapNameOfReportingProperty { get; set; }
Property Value
Type Description
string

CustomMessageOfReport

Declaration
public string CustomMessageOfReport { get; set; }
Property Value
Type Description
string

CustomMessageOfReportingProperty

Declaration
public string CustomMessageOfReportingProperty { get; set; }
Property Value
Type Description
string

DescriptionOfVisualReport

Declaration
public string DescriptionOfVisualReport { get; set; }
Property Value
Type Description
string

DescriptiveCategoryOfVisualReport

Declaration
public string DescriptiveCategoryOfVisualReport { get; set; }
Property Value
Type Description
string

DestinationTeamcenterFolder

Declaration
public string DestinationTeamcenterFolder { get; set; }
Property Value
Type Description
string

FilenameOfVisualReport

Declaration
public string FilenameOfVisualReport { get; set; }
Property Value
Type Description
string

KeywordsOfVisualReport

Declaration
public string KeywordsOfVisualReport { get; set; }
Property Value
Type Description
string

ReportContextOfVisualReport

Declaration
[Obsolete("Deprecated in NX9.0.3.  Use NXOpen.VisualReporting.VisualReport.ReportContext instead.")]
public VisualReport.ReportContextOption ReportContextOfVisualReport { get; set; }
Property Value
Type Description
VisualReport.ReportContextOption

ReportNameOfVisualReport

Declaration
public string ReportNameOfVisualReport { get; set; }
Property Value
Type Description
string

ReportingObjectTypeOfVisualReport

Declaration
public VisualReport.ReportingObjectTypeOption ReportingObjectTypeOfVisualReport { get; set; }
Property Value
Type Description
VisualReport.ReportingObjectTypeOption

ReportingStyleOfVisualReport

Declaration
public VisualReport.ReportingStyleOption ReportingStyleOfVisualReport { get; set; }
Property Value
Type Description
VisualReport.ReportingStyleOption

SaveDestination

Declaration
public VisualReport.SaveDestinationOption SaveDestination { get; set; }
Property Value
Type Description
VisualReport.SaveDestinationOption

ScopeNameOfVisualReport

Declaration
public string ScopeNameOfVisualReport { get; set; }
Property Value
Type Description
string

ScopeTypeOfVisualReport

Declaration
public VisualReport.ScopeTypeOption ScopeTypeOfVisualReport { get; set; }
Property Value
Type Description
VisualReport.ScopeTypeOption

Methods

AddChildToCondition(Condition, Condition)

Declaration
public void AddChildToCondition(Condition condition, Condition childCondition)
Parameters
Type Name Description
Condition condition
Condition childCondition

CommitAsCopy()

Declaration
public VisualReport CommitAsCopy()
Returns
Type Description
VisualReport

CreateAndCondition()

Declaration
public Condition CreateAndCondition()
Returns
Type Description
Condition

CreateBooleanCondition(Property, bool, OperatorOption)

Declaration
public Condition CreateBooleanCondition(Property property, bool value, Condition.OperatorOption operatorType)
Parameters
Type Name Description
Property property
bool value
Condition.OperatorOption operatorType
Returns
Type Description
Condition

CreateDateCondition(Property, string, OperatorOption)

Declaration
public Condition CreateDateCondition(Property property, string value, Condition.OperatorOption operatorType)
Parameters
Type Name Description
Property property
string value
Condition.OperatorOption operatorType
Returns
Type Description
Condition

CreateGroupLabel(string, Rule, GroupLabel)

Declaration
public GroupLabel CreateGroupLabel(string name, Rule rule, GroupLabel afterGroupLabel)
Parameters
Type Name Description
string name
Rule rule
GroupLabel afterGroupLabel
Returns
Type Description
GroupLabel

CreateIntegerCondition(Property, int, OperatorOption)

Declaration
public Condition CreateIntegerCondition(Property property, int value, Condition.OperatorOption operatorType)
Parameters
Type Name Description
Property property
int value
Condition.OperatorOption operatorType
Returns
Type Description
Condition

CreateNotCondition()

Declaration
public Condition CreateNotCondition()
Returns
Type Description
Condition

CreateNullCondition(Property, bool, OperatorOption)

Declaration
public Condition CreateNullCondition(Property property, bool value, Condition.OperatorOption operatorType)
Parameters
Type Name Description
Property property
bool value
Condition.OperatorOption operatorType
Returns
Type Description
Condition

CreateOrCondition()

Declaration
public Condition CreateOrCondition()
Returns
Type Description
Condition

CreateProperty(TypeOption)

Declaration
public Property CreateProperty(Property.TypeOption propertyType)
Parameters
Type Name Description
Property.TypeOption propertyType
Returns
Type Description
Property

CreateProperty(string)

Declaration
public Property CreateProperty(string propertyId)
Parameters
Type Name Description
string propertyId
Returns
Type Description
Property

CreateRealCondition(Property, double, OperatorOption, double)

Declaration
public Condition CreateRealCondition(Property property, double value, Condition.OperatorOption operatorType, double tolerance)
Parameters
Type Name Description
Property property
double value
Condition.OperatorOption operatorType
double tolerance
Returns
Type Description
Condition

CreateStringCondition(Property, string, OperatorOption)

Declaration
public Condition CreateStringCondition(Property property, string value, Condition.OperatorOption operatorType)
Parameters
Type Name Description
Property property
string value
Condition.OperatorOption operatorType
Returns
Type Description
Condition

CreateVisualReport()

Declaration
public VisualReport CreateVisualReport()
Returns
Type Description
VisualReport

DeleteChildCondition(Condition, Condition)

Declaration
public void DeleteChildCondition(Condition condition, Condition childCondition)
Parameters
Type Name Description
Condition condition
Condition childCondition

DeleteGroupLabel(Rule, GroupLabel)

Declaration
public void DeleteGroupLabel(Rule rule, GroupLabel groupLabel)
Parameters
Type Name Description
Rule rule
GroupLabel groupLabel

DeleteProperty(Property)

Declaration
public void DeleteProperty(Property property)
Parameters
Type Name Description
Property property

EditVisualReport(VisualReport)

Declaration
public void EditVisualReport(VisualReport visualReport)
Parameters
Type Name Description
VisualReport visualReport

EnableUnmatchedGroupOfVisualReport(bool)

Declaration
public void EnableUnmatchedGroupOfVisualReport(bool enableUnmatchedGroup)
Parameters
Type Name Description
bool enableUnmatchedGroup

GetActiveClassifierOfRule(Rule)

Declaration
public Classifier GetActiveClassifierOfRule(Rule rule)
Parameters
Type Name Description
Rule rule
Returns
Type Description
Classifier

GetAllGroupLabelsOfRule(Rule)

Declaration
public GroupLabel[] GetAllGroupLabelsOfRule(Rule rule)
Parameters
Type Name Description
Rule rule
Returns
Type Description
GroupLabel[]

GetBitmapNameOfGroupLabel(GroupLabel)

Declaration
public string GetBitmapNameOfGroupLabel(GroupLabel groupLabel)
Parameters
Type Name Description
GroupLabel groupLabel
Returns
Type Description
string

GetChildCondition(Condition, int)

Declaration
public Condition GetChildCondition(Condition condition, int index)
Parameters
Type Name Description
Condition condition
int index
Returns
Type Description
Condition

GetChildConditions(Condition)

Declaration
public Condition[] GetChildConditions(Condition condition)
Parameters
Type Name Description
Condition condition
Returns
Type Description
Condition[]

GetClassifierTypeOfRule(Rule)

Declaration
public Classifier.TypeOption GetClassifierTypeOfRule(Rule rule)
Parameters
Type Name Description
Rule rule
Returns
Type Description
Classifier.TypeOption

GetClassifiersOfRule(Rule)

Declaration
public Classifier[] GetClassifiersOfRule(Rule rule)
Parameters
Type Name Description
Rule rule
Returns
Type Description
Classifier[]

GetColorOfGroupLabel(GroupLabel)

Declaration
public NXColor.Rgb GetColorOfGroupLabel(GroupLabel groupLabel)
Parameters
Type Name Description
GroupLabel groupLabel
Returns
Type Description
NXColor.Rgb

GetCustomMessageOfGroupLabel(GroupLabel)

Declaration
public string GetCustomMessageOfGroupLabel(GroupLabel groupLabel)
Parameters
Type Name Description
GroupLabel groupLabel
Returns
Type Description
string

GetDateGroupMethodOfRule(Rule)

Declaration
public Classifier.DateGroupMethodOption GetDateGroupMethodOfRule(Rule rule)
Parameters
Type Name Description
Rule rule
Returns
Type Description
Classifier.DateGroupMethodOption

GetDescriptionOfCondition(Condition)

Declaration
public string GetDescriptionOfCondition(Condition condition)
Parameters
Type Name Description
Condition condition
Returns
Type Description
string

GetDisplayStyleForGroupLabel(GroupLabel)

Declaration
public GroupLabel.DisplayStyleOption GetDisplayStyleForGroupLabel(GroupLabel groupLabel)
Parameters
Type Name Description
GroupLabel groupLabel
Returns
Type Description
GroupLabel.DisplayStyleOption

GetErrorLevelOfGroupLabel(GroupLabel)

Declaration
public Validation.Result GetErrorLevelOfGroupLabel(GroupLabel groupLabel)
Parameters
Type Name Description
GroupLabel groupLabel
Returns
Type Description
Validation.Result

GetFilterConditionOfRule(Rule)

Declaration
public Condition GetFilterConditionOfRule(Rule rule)
Parameters
Type Name Description
Rule rule
Returns
Type Description
Condition

GetGroupingMethodOfRule(Rule)

Declaration
public Classifier.GroupingMethodOption GetGroupingMethodOfRule(Rule rule)
Parameters
Type Name Description
Rule rule
Returns
Type Description
Classifier.GroupingMethodOption

GetHasUserSpecifiedValueForCondition(Condition)

Declaration
public bool GetHasUserSpecifiedValueForCondition(Condition condition)
Parameters
Type Name Description
Condition condition
Returns
Type Description
bool

GetLowerBoundOfGroupLabel(GroupLabel)

Declaration
public string GetLowerBoundOfGroupLabel(GroupLabel groupLabel)
Parameters
Type Name Description
GroupLabel groupLabel
Returns
Type Description
string

GetManualGroupLabelOfRule(Rule, int)

Declaration
public GroupLabel GetManualGroupLabelOfRule(Rule rule, int index)
Parameters
Type Name Description
Rule rule
int index
Returns
Type Description
GroupLabel

GetManualGroupLabelsOfRule(Rule)

Declaration
public GroupLabel[] GetManualGroupLabelsOfRule(Rule rule)
Parameters
Type Name Description
Rule rule
Returns
Type Description
GroupLabel[]

GetManualGroupingForRule(Rule)

Declaration
public bool GetManualGroupingForRule(Rule rule)
Parameters
Type Name Description
Rule rule
Returns
Type Description
bool

GetObjectTypesOfVisualReport()

Declaration
public VisualReport.ObjectTypeOption[] GetObjectTypesOfVisualReport()
Returns
Type Description
ObjectTypeOption[]

GetOperatorTypeOfCondition(Condition)

Declaration
public Condition.OperatorOption GetOperatorTypeOfCondition(Condition condition)
Parameters
Type Name Description
Condition condition
Returns
Type Description
Condition.OperatorOption

GetParentCondition(Condition)

Declaration
public Condition GetParentCondition(Condition condition)
Parameters
Type Name Description
Condition condition
Returns
Type Description
Condition

GetPropertyForComparison(Condition)

Declaration
public Property GetPropertyForComparison(Condition condition)
Parameters
Type Name Description
Condition condition
Returns
Type Description
Property

GetPropertyOfCondition(Condition)

Declaration
public Property GetPropertyOfCondition(Condition condition)
Parameters
Type Name Description
Condition condition
Returns
Type Description
Property

GetPropertySpecification(Property, out TypeOption, out string, out string)

Declaration
public void GetPropertySpecification(Property property, out Property.TypeOption propertyType, out string key, out string name)
Parameters
Type Name Description
Property property
Property.TypeOption propertyType
string key
string name

GetRangeMethodOfRule(Rule)

Declaration
public Classifier.RangeMethodOption GetRangeMethodOfRule(Rule rule)
Parameters
Type Name Description
Rule rule
Returns
Type Description
Classifier.RangeMethodOption

GetReferencePropertiesOfReport(out Property[], out PropertyUsageOption[], out int)

Declaration
public void GetReferencePropertiesOfReport(out Property[] properties, out VisualReportBuilder.PropertyUsageOption[] usages, out int notUsed)
Parameters
Type Name Description
Property[] properties
PropertyUsageOption[] usages
int notUsed

GetReferencePropertiesOfReportingProperty(out Property[], out PropertyUsageOption[])

Declaration
public void GetReferencePropertiesOfReportingProperty(out Property[] properties, out VisualReportBuilder.PropertyUsageOption[] usages)
Parameters
Type Name Description
Property[] properties
PropertyUsageOption[] usages

GetReportingDatatypeOfRule(Rule)

Declaration
public Property.DatatypeOption GetReportingDatatypeOfRule(Rule rule)
Parameters
Type Name Description
Rule rule
Returns
Type Description
Property.DatatypeOption

GetReportingPropertyOfRule(Rule)

Declaration
public Property GetReportingPropertyOfRule(Rule rule)
Parameters
Type Name Description
Rule rule
Returns
Type Description
Property

GetRule(int)

Declaration
public Rule GetRule(int index)
Parameters
Type Name Description
int index
Returns
Type Description
Rule

GetRules()

Declaration
public Rule[] GetRules()
Returns
Type Description
Rule[]

GetTagPriorityOfGroupLabel(GroupLabel)

Declaration
public GroupLabel.TagPriorityOption GetTagPriorityOfGroupLabel(GroupLabel groupLabel)
Parameters
Type Name Description
GroupLabel groupLabel
Returns
Type Description
GroupLabel.TagPriorityOption

GetToleranceOfRule(Rule)

Declaration
public double GetToleranceOfRule(Rule rule)
Parameters
Type Name Description
Rule rule
Returns
Type Description
double

GetUpperBoundOfGroupLabel(GroupLabel)

Declaration
public string GetUpperBoundOfGroupLabel(GroupLabel groupLabel)
Parameters
Type Name Description
GroupLabel groupLabel
Returns
Type Description
string

GetUserNameOfGroupLabel(GroupLabel)

Declaration
public string GetUserNameOfGroupLabel(GroupLabel groupLabel)
Parameters
Type Name Description
GroupLabel groupLabel
Returns
Type Description
string

GetUserPromptOfCondition(Condition)

Declaration
public string GetUserPromptOfCondition(Condition condition)
Parameters
Type Name Description
Condition condition
Returns
Type Description
string

GetValueOfCondition(Condition)

Declaration
public string GetValueOfCondition(Condition condition)
Parameters
Type Name Description
Condition condition
Returns
Type Description
string

GetValueOfGroupLabel(GroupLabel)

Declaration
public string GetValueOfGroupLabel(GroupLabel groupLabel)
Parameters
Type Name Description
GroupLabel groupLabel
Returns
Type Description
string

IsChildCondition(Condition, Condition)

Declaration
public bool IsChildCondition(Condition condition, Condition childCondition)
Parameters
Type Name Description
Condition condition
Condition childCondition
Returns
Type Description
bool

RemoveChildFromCondition(Condition, Condition)

Declaration
public void RemoveChildFromCondition(Condition condition, Condition childCondition)
Parameters
Type Name Description
Condition condition
Condition childCondition

RemoveFilterConditionFromRule(Rule)

Declaration
public void RemoveFilterConditionFromRule(Rule rule)
Parameters
Type Name Description
Rule rule

RemovePropertyFromCondition(Condition)

Declaration
public void RemovePropertyFromCondition(Condition condition)
Parameters
Type Name Description
Condition condition

Save()

Declaration
public void Save()

SetActiveClassifierOfRule(Rule, Classifier)

Declaration
public void SetActiveClassifierOfRule(Rule rule, Classifier activeClassifier)
Parameters
Type Name Description
Rule rule
Classifier activeClassifier

SetBitmapNameOfGroupLabel(GroupLabel, string)

Declaration
public void SetBitmapNameOfGroupLabel(GroupLabel groupLabel, string bitmapName)
Parameters
Type Name Description
GroupLabel groupLabel
string bitmapName

SetClassifierTypeOfRule(Rule, TypeOption)

Declaration
public Classifier SetClassifierTypeOfRule(Rule rule, Classifier.TypeOption classifierType)
Parameters
Type Name Description
Rule rule
Classifier.TypeOption classifierType
Returns
Type Description
Classifier

SetColorOfGroupLabel(GroupLabel, Rgb)

Declaration
public void SetColorOfGroupLabel(GroupLabel groupLabel, NXColor.Rgb color)
Parameters
Type Name Description
GroupLabel groupLabel
NXColor.Rgb color

SetCustomMessageOfGroupLabel(GroupLabel, string)

Declaration
public void SetCustomMessageOfGroupLabel(GroupLabel groupLabel, string customMessage)
Parameters
Type Name Description
GroupLabel groupLabel
string customMessage

SetDateGroupMethodOfRule(Rule, DateGroupMethodOption)

Declaration
public void SetDateGroupMethodOfRule(Rule rule, Classifier.DateGroupMethodOption dateGroupMethod)
Parameters
Type Name Description
Rule rule
Classifier.DateGroupMethodOption dateGroupMethod

SetDescriptionOfCondition(Condition, string)

Declaration
public void SetDescriptionOfCondition(Condition condition, string description)
Parameters
Type Name Description
Condition condition
string description

SetDisplayStyleForGroupLabel(GroupLabel, DisplayStyleOption)

Declaration
public void SetDisplayStyleForGroupLabel(GroupLabel groupLabel, GroupLabel.DisplayStyleOption displayStyle)
Parameters
Type Name Description
GroupLabel groupLabel
GroupLabel.DisplayStyleOption displayStyle

SetErrorLevelOfGroupLabel(GroupLabel, Result)

Declaration
public void SetErrorLevelOfGroupLabel(GroupLabel groupLabel, Validation.Result errorLevel)
Parameters
Type Name Description
GroupLabel groupLabel
Validation.Result errorLevel

SetFilterConditionOfRule(Rule, Condition)

Declaration
public void SetFilterConditionOfRule(Rule rule, Condition filterCondition)
Parameters
Type Name Description
Rule rule
Condition filterCondition

SetGroupingMethodOfRule(Rule, GroupingMethodOption)

Declaration
public void SetGroupingMethodOfRule(Rule rule, Classifier.GroupingMethodOption groupingMethod)
Parameters
Type Name Description
Rule rule
Classifier.GroupingMethodOption groupingMethod

SetHasUserSpecifiedValueForCondition(Condition, bool)

Declaration
public void SetHasUserSpecifiedValueForCondition(Condition condition, bool isUserSpecified)
Parameters
Type Name Description
Condition condition
bool isUserSpecified

SetLowerBoundOfGroupLabel(GroupLabel, string)

Declaration
public void SetLowerBoundOfGroupLabel(GroupLabel groupLabel, string lowerBound)
Parameters
Type Name Description
GroupLabel groupLabel
string lowerBound

SetManualGroupingForRule(Rule, bool)

Declaration
public void SetManualGroupingForRule(Rule rule, bool isManualGrouping)
Parameters
Type Name Description
Rule rule
bool isManualGrouping

SetObjectTypesOfVisualReport(ObjectTypeOption[])

Declaration
public void SetObjectTypesOfVisualReport(VisualReport.ObjectTypeOption[] objectTypes)
Parameters
Type Name Description
ObjectTypeOption[] objectTypes

SetOperatorTypeOfCondition(Condition, OperatorOption)

Declaration
public void SetOperatorTypeOfCondition(Condition condition, Condition.OperatorOption operatorType)
Parameters
Type Name Description
Condition condition
Condition.OperatorOption operatorType

SetPropertyForComparison(Condition, Property)

Declaration
public void SetPropertyForComparison(Condition condition, Property property)
Parameters
Type Name Description
Condition condition
Property property

SetPropertyOfCondition(Condition, Property)

Declaration
public void SetPropertyOfCondition(Condition condition, Property property)
Parameters
Type Name Description
Condition condition
Property property

SetPropertySpecification(Property, string)

Declaration
public void SetPropertySpecification(Property property, string key)
Parameters
Type Name Description
Property property
string key

SetPropertySpecification(Property, string, string)

Declaration
public void SetPropertySpecification(Property property, string key, string name)
Parameters
Type Name Description
Property property
string key
string name

SetRangeMethodOfRule(Rule, RangeMethodOption)

Declaration
public void SetRangeMethodOfRule(Rule rule, Classifier.RangeMethodOption rangeMethod)
Parameters
Type Name Description
Rule rule
Classifier.RangeMethodOption rangeMethod

SetReferencePropertiesOfReport(Property[], PropertyUsageOption[])

Declaration
public void SetReferencePropertiesOfReport(Property[] properties, VisualReportBuilder.PropertyUsageOption[] usages)
Parameters
Type Name Description
Property[] properties
PropertyUsageOption[] usages

SetReferencePropertiesOfReportingProperty(Property[], PropertyUsageOption[])

Declaration
public void SetReferencePropertiesOfReportingProperty(Property[] properties, VisualReportBuilder.PropertyUsageOption[] usages)
Parameters
Type Name Description
Property[] properties
PropertyUsageOption[] usages

SetReportingDatatypeOfRule(Rule, DatatypeOption)

Declaration
public void SetReportingDatatypeOfRule(Rule rule, Property.DatatypeOption datatype)
Parameters
Type Name Description
Rule rule
Property.DatatypeOption datatype

SetReportingPropertyOfRule(Rule, Property)

Declaration
public void SetReportingPropertyOfRule(Rule rule, Property reportingProperty)
Parameters
Type Name Description
Rule rule
Property reportingProperty

SetTagPriorityOfGroupLabel(GroupLabel, TagPriorityOption)

Declaration
public void SetTagPriorityOfGroupLabel(GroupLabel groupLabel, GroupLabel.TagPriorityOption tagPriority)
Parameters
Type Name Description
GroupLabel groupLabel
GroupLabel.TagPriorityOption tagPriority

SetToleranceOfRule(Rule, double)

Declaration
public void SetToleranceOfRule(Rule rule, double tolerance)
Parameters
Type Name Description
Rule rule
double tolerance

SetUpperBoundOfGroupLabel(GroupLabel, string)

Declaration
public void SetUpperBoundOfGroupLabel(GroupLabel groupLabel, string upperBound)
Parameters
Type Name Description
GroupLabel groupLabel
string upperBound

SetUserNameOfGroupLabel(GroupLabel, string)

Declaration
public void SetUserNameOfGroupLabel(GroupLabel groupLabel, string name)
Parameters
Type Name Description
GroupLabel groupLabel
string name

SetUserPromptOfCondition(Condition, string)

Declaration
public void SetUserPromptOfCondition(Condition condition, string userPrompt)
Parameters
Type Name Description
Condition condition
string userPrompt

SetValueOfCondition(Condition, string)

Declaration
public void SetValueOfCondition(Condition condition, string value)
Parameters
Type Name Description
Condition condition
string value

SetValueOfGroupLabel(GroupLabel, string)

Declaration
public void SetValueOfGroupLabel(GroupLabel groupLabel, string value)
Parameters
Type Name Description
GroupLabel groupLabel
string value

UnsetUserNameOfGroupLabel(GroupLabel)

Declaration
public void UnsetUserNameOfGroupLabel(GroupLabel groupLabel)
Parameters
Type Name Description
GroupLabel groupLabel

Implements

System.Runtime.Remoting.Messaging.IMessageSink