Class VisualReportBuilder
Inheritance
System.Object
System.MarshalByRefObject
VisualReportBuilder
Implements
System.Runtime.Remoting.Messaging.IMessageSink
Inherited Members
System.MarshalByRefObject.CreateObjRef(System.Type)
System.MarshalByRefObject.GetLifetimeService()
System.MarshalByRefObject.InitializeLifetimeService()
System.MarshalByRefObject.MemberwiseClone(System.Boolean)
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
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 |
| System.String |
|
BitmapNameOfReportingProperty
Declaration
public string BitmapNameOfReportingProperty { get; set; }
Property Value
| Type |
Description |
| System.String |
|
CustomMessageOfReport
Declaration
public string CustomMessageOfReport { get; set; }
Property Value
| Type |
Description |
| System.String |
|
CustomMessageOfReportingProperty
Declaration
public string CustomMessageOfReportingProperty { get; set; }
Property Value
| Type |
Description |
| System.String |
|
DescriptionOfVisualReport
Declaration
public string DescriptionOfVisualReport { get; set; }
Property Value
| Type |
Description |
| System.String |
|
DescriptiveCategoryOfVisualReport
Declaration
public string DescriptiveCategoryOfVisualReport { get; set; }
Property Value
| Type |
Description |
| System.String |
|
DestinationTeamcenterFolder
Declaration
public string DestinationTeamcenterFolder { get; set; }
Property Value
| Type |
Description |
| System.String |
|
FilenameOfVisualReport
Declaration
public string FilenameOfVisualReport { get; set; }
Property Value
| Type |
Description |
| System.String |
|
KeywordsOfVisualReport
Declaration
public string KeywordsOfVisualReport { get; set; }
Property Value
| Type |
Description |
| System.String |
|
ReportContextOfVisualReport
Declaration
[Obsolete("Deprecated in NX9.0.3. Use NXOpen.VisualReporting.VisualReport.ReportContext instead.")]
public VisualReport.ReportContextOption ReportContextOfVisualReport { get; set; }
Property Value
ReportingObjectTypeOfVisualReport
Declaration
public VisualReport.ReportingObjectTypeOption ReportingObjectTypeOfVisualReport { get; set; }
Property Value
ReportingStyleOfVisualReport
Declaration
public VisualReport.ReportingStyleOption ReportingStyleOfVisualReport { get; set; }
Property Value
ReportNameOfVisualReport
Declaration
public string ReportNameOfVisualReport { get; set; }
Property Value
| Type |
Description |
| System.String |
|
SaveDestination
Declaration
public VisualReport.SaveDestinationOption SaveDestination { get; set; }
Property Value
ScopeTypeOfVisualReport
Declaration
public VisualReport.ScopeTypeOption ScopeTypeOfVisualReport { get; set; }
Property Value
Methods
AddChildToCondition(Condition, Condition)
Declaration
public void AddChildToCondition(Condition condition, Condition childCondition)
Parameters
CommitAsCopy()
Declaration
public VisualReport CommitAsCopy()
Returns
CreateAndCondition()
Declaration
public Condition CreateAndCondition()
Returns
CreateBooleanCondition(Property, Boolean, Condition.OperatorOption)
Declaration
public Condition CreateBooleanCondition(Property property, bool value, Condition.OperatorOption operatorType)
Parameters
Returns
CreateDateCondition(Property, String, Condition.OperatorOption)
Declaration
public Condition CreateDateCondition(Property property, string value, Condition.OperatorOption operatorType)
Parameters
Returns
CreateGroupLabel(String, Rule, GroupLabel)
Declaration
public GroupLabel CreateGroupLabel(string name, Rule rule, GroupLabel afterGroupLabel)
Parameters
| Type |
Name |
Description |
| System.String |
name |
|
| Rule |
rule |
|
| GroupLabel |
afterGroupLabel |
|
Returns
CreateIntegerCondition(Property, Int32, Condition.OperatorOption)
Declaration
public Condition CreateIntegerCondition(Property property, int value, Condition.OperatorOption operatorType)
Parameters
Returns
CreateNotCondition()
Declaration
public Condition CreateNotCondition()
Returns
CreateNullCondition(Property, Boolean, Condition.OperatorOption)
Declaration
public Condition CreateNullCondition(Property property, bool value, Condition.OperatorOption operatorType)
Parameters
Returns
CreateOrCondition()
Declaration
public Condition CreateOrCondition()
Returns
CreateProperty(Property.TypeOption)
Declaration
public Property CreateProperty(Property.TypeOption propertyType)
Parameters
Returns
CreateRealCondition(Property, Double, Condition.OperatorOption, Double)
Declaration
public Condition CreateRealCondition(Property property, double value, Condition.OperatorOption operatorType, double tolerance)
Parameters
Returns
CreateStringCondition(Property, String, Condition.OperatorOption)
Declaration
public Condition CreateStringCondition(Property property, string value, Condition.OperatorOption operatorType)
Parameters
Returns
CreateVisualReport()
Declaration
public VisualReport CreateVisualReport()
Returns
DeleteChildCondition(Condition, Condition)
Declaration
public void DeleteChildCondition(Condition condition, Condition childCondition)
Parameters
DeleteGroupLabel(Rule, GroupLabel)
Declaration
public void DeleteGroupLabel(Rule rule, GroupLabel groupLabel)
Parameters
DeleteProperty(Property)
Declaration
public void DeleteProperty(Property property)
Parameters
EditVisualReport(VisualReport)
Declaration
public void EditVisualReport(VisualReport visualReport)
Parameters
EnableUnmatchedGroupOfVisualReport(Boolean)
Declaration
public void EnableUnmatchedGroupOfVisualReport(bool enableUnmatchedGroup)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableUnmatchedGroup |
|
GetActiveClassifierOfRule(Rule)
Declaration
public Classifier GetActiveClassifierOfRule(Rule rule)
Parameters
| Type |
Name |
Description |
| Rule |
rule |
|
Returns
GetAllGroupLabelsOfRule(Rule)
Declaration
public GroupLabel[] GetAllGroupLabelsOfRule(Rule rule)
Parameters
| Type |
Name |
Description |
| Rule |
rule |
|
Returns
GetBitmapNameOfGroupLabel(GroupLabel)
Declaration
public string GetBitmapNameOfGroupLabel(GroupLabel groupLabel)
Parameters
Returns
| Type |
Description |
| System.String |
|
GetChildCondition(Condition, Int32)
Declaration
public Condition GetChildCondition(Condition condition, int index)
Parameters
| Type |
Name |
Description |
| Condition |
condition |
|
| System.Int32 |
index |
|
Returns
GetChildConditions(Condition)
Declaration
public Condition[] GetChildConditions(Condition condition)
Parameters
Returns
GetClassifiersOfRule(Rule)
Declaration
public Classifier[] GetClassifiersOfRule(Rule rule)
Parameters
| Type |
Name |
Description |
| Rule |
rule |
|
Returns
GetClassifierTypeOfRule(Rule)
Declaration
public Classifier.TypeOption GetClassifierTypeOfRule(Rule rule)
Parameters
| Type |
Name |
Description |
| Rule |
rule |
|
Returns
GetColorOfGroupLabel(GroupLabel)
Declaration
public NXColor.Rgb GetColorOfGroupLabel(GroupLabel groupLabel)
Parameters
Returns
GetCustomMessageOfGroupLabel(GroupLabel)
Declaration
public string GetCustomMessageOfGroupLabel(GroupLabel groupLabel)
Parameters
Returns
| Type |
Description |
| System.String |
|
GetDateGroupMethodOfRule(Rule)
Declaration
public Classifier.DateGroupMethodOption GetDateGroupMethodOfRule(Rule rule)
Parameters
| Type |
Name |
Description |
| Rule |
rule |
|
Returns
GetDescriptionOfCondition(Condition)
Declaration
public string GetDescriptionOfCondition(Condition condition)
Parameters
Returns
| Type |
Description |
| System.String |
|
GetDisplayStyleForGroupLabel(GroupLabel)
Declaration
public GroupLabel.DisplayStyleOption GetDisplayStyleForGroupLabel(GroupLabel groupLabel)
Parameters
Returns
GetErrorLevelOfGroupLabel(GroupLabel)
Declaration
public Validation.Result GetErrorLevelOfGroupLabel(GroupLabel groupLabel)
Parameters
Returns
GetFilterConditionOfRule(Rule)
Declaration
public Condition GetFilterConditionOfRule(Rule rule)
Parameters
| Type |
Name |
Description |
| Rule |
rule |
|
Returns
GetGroupingMethodOfRule(Rule)
Declaration
public Classifier.GroupingMethodOption GetGroupingMethodOfRule(Rule rule)
Parameters
| Type |
Name |
Description |
| Rule |
rule |
|
Returns
GetHasUserSpecifiedValueForCondition(Condition)
Declaration
public bool GetHasUserSpecifiedValueForCondition(Condition condition)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
GetLowerBoundOfGroupLabel(GroupLabel)
Declaration
public string GetLowerBoundOfGroupLabel(GroupLabel groupLabel)
Parameters
Returns
| Type |
Description |
| System.String |
|
GetManualGroupingForRule(Rule)
Declaration
public bool GetManualGroupingForRule(Rule rule)
Parameters
| Type |
Name |
Description |
| Rule |
rule |
|
Returns
| Type |
Description |
| System.Boolean |
|
GetManualGroupLabelOfRule(Rule, Int32)
Declaration
public GroupLabel GetManualGroupLabelOfRule(Rule rule, int index)
Parameters
| Type |
Name |
Description |
| Rule |
rule |
|
| System.Int32 |
index |
|
Returns
GetManualGroupLabelsOfRule(Rule)
Declaration
public GroupLabel[] GetManualGroupLabelsOfRule(Rule rule)
Parameters
| Type |
Name |
Description |
| Rule |
rule |
|
Returns
GetObjectTypesOfVisualReport()
Declaration
public VisualReport.ObjectTypeOption[] GetObjectTypesOfVisualReport()
Returns
GetOperatorTypeOfCondition(Condition)
Declaration
public Condition.OperatorOption GetOperatorTypeOfCondition(Condition condition)
Parameters
Returns
GetParentCondition(Condition)
Declaration
public Condition GetParentCondition(Condition condition)
Parameters
Returns
GetPropertyForComparison(Condition)
Declaration
public Property GetPropertyForComparison(Condition condition)
Parameters
Returns
GetPropertyOfCondition(Condition)
Declaration
public Property GetPropertyOfCondition(Condition condition)
Parameters
Returns
GetPropertySpecification(Property, out Property.TypeOption, out String, out String)
Declaration
public void GetPropertySpecification(Property property, out Property.TypeOption propertyType, out string key, out string name)
Parameters
GetRangeMethodOfRule(Rule)
Declaration
public Classifier.RangeMethodOption GetRangeMethodOfRule(Rule rule)
Parameters
| Type |
Name |
Description |
| Rule |
rule |
|
Returns
GetReferencePropertiesOfReport(out Property[], out VisualReportBuilder.PropertyUsageOption[], out Int32)
Declaration
public void GetReferencePropertiesOfReport(out Property[] properties, out VisualReportBuilder.PropertyUsageOption[] usages, out int notUsed)
Parameters
GetReferencePropertiesOfReportingProperty(out Property[], out VisualReportBuilder.PropertyUsageOption[])
Declaration
public void GetReferencePropertiesOfReportingProperty(out Property[] properties, out VisualReportBuilder.PropertyUsageOption[] usages)
Parameters
GetReportingDatatypeOfRule(Rule)
Declaration
public Property.DatatypeOption GetReportingDatatypeOfRule(Rule rule)
Parameters
| Type |
Name |
Description |
| Rule |
rule |
|
Returns
GetReportingPropertyOfRule(Rule)
Declaration
public Property GetReportingPropertyOfRule(Rule rule)
Parameters
| Type |
Name |
Description |
| Rule |
rule |
|
Returns
GetRule(Int32)
Declaration
public Rule GetRule(int index)
Parameters
| Type |
Name |
Description |
| System.Int32 |
index |
|
Returns
GetRules()
Declaration
Returns
GetTagPriorityOfGroupLabel(GroupLabel)
Declaration
public GroupLabel.TagPriorityOption GetTagPriorityOfGroupLabel(GroupLabel groupLabel)
Parameters
Returns
GetUpperBoundOfGroupLabel(GroupLabel)
Declaration
public string GetUpperBoundOfGroupLabel(GroupLabel groupLabel)
Parameters
Returns
| Type |
Description |
| System.String |
|
GetUserNameOfGroupLabel(GroupLabel)
Declaration
public string GetUserNameOfGroupLabel(GroupLabel groupLabel)
Parameters
Returns
| Type |
Description |
| System.String |
|
GetUserPromptOfCondition(Condition)
Declaration
public string GetUserPromptOfCondition(Condition condition)
Parameters
Returns
| Type |
Description |
| System.String |
|
GetValueOfCondition(Condition)
Declaration
public string GetValueOfCondition(Condition condition)
Parameters
Returns
| Type |
Description |
| System.String |
|
GetValueOfGroupLabel(GroupLabel)
Declaration
public string GetValueOfGroupLabel(GroupLabel groupLabel)
Parameters
Returns
| Type |
Description |
| System.String |
|
IsChildCondition(Condition, Condition)
Declaration
public bool IsChildCondition(Condition condition, Condition childCondition)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
RemoveChildFromCondition(Condition, Condition)
Declaration
public void RemoveChildFromCondition(Condition condition, Condition childCondition)
Parameters
RemoveFilterConditionFromRule(Rule)
Declaration
public void RemoveFilterConditionFromRule(Rule rule)
Parameters
| Type |
Name |
Description |
| Rule |
rule |
|
RemovePropertyFromCondition(Condition)
Declaration
public void RemovePropertyFromCondition(Condition condition)
Parameters
Save()
Declaration
SetActiveClassifierOfRule(Rule, Classifier)
Declaration
public void SetActiveClassifierOfRule(Rule rule, Classifier activeClassifier)
Parameters
SetBitmapNameOfGroupLabel(GroupLabel, String)
Declaration
public void SetBitmapNameOfGroupLabel(GroupLabel groupLabel, string bitmapName)
Parameters
| Type |
Name |
Description |
| GroupLabel |
groupLabel |
|
| System.String |
bitmapName |
|
SetClassifierTypeOfRule(Rule, Classifier.TypeOption)
Declaration
public Classifier SetClassifierTypeOfRule(Rule rule, Classifier.TypeOption classifierType)
Parameters
Returns
SetColorOfGroupLabel(GroupLabel, NXColor.Rgb)
Declaration
public void SetColorOfGroupLabel(GroupLabel groupLabel, NXColor.Rgb color)
Parameters
SetCustomMessageOfGroupLabel(GroupLabel, String)
Declaration
public void SetCustomMessageOfGroupLabel(GroupLabel groupLabel, string customMessage)
Parameters
| Type |
Name |
Description |
| GroupLabel |
groupLabel |
|
| System.String |
customMessage |
|
SetDateGroupMethodOfRule(Rule, Classifier.DateGroupMethodOption)
Declaration
public void SetDateGroupMethodOfRule(Rule rule, Classifier.DateGroupMethodOption dateGroupMethod)
Parameters
SetDescriptionOfCondition(Condition, String)
Declaration
public void SetDescriptionOfCondition(Condition condition, string description)
Parameters
| Type |
Name |
Description |
| Condition |
condition |
|
| System.String |
description |
|
SetDisplayStyleForGroupLabel(GroupLabel, GroupLabel.DisplayStyleOption)
Declaration
public void SetDisplayStyleForGroupLabel(GroupLabel groupLabel, GroupLabel.DisplayStyleOption displayStyle)
Parameters
SetErrorLevelOfGroupLabel(GroupLabel, Validation.Result)
Declaration
public void SetErrorLevelOfGroupLabel(GroupLabel groupLabel, Validation.Result errorLevel)
Parameters
SetFilterConditionOfRule(Rule, Condition)
Declaration
public void SetFilterConditionOfRule(Rule rule, Condition filterCondition)
Parameters
SetGroupingMethodOfRule(Rule, Classifier.GroupingMethodOption)
Declaration
public void SetGroupingMethodOfRule(Rule rule, Classifier.GroupingMethodOption groupingMethod)
Parameters
SetHasUserSpecifiedValueForCondition(Condition, Boolean)
Declaration
public void SetHasUserSpecifiedValueForCondition(Condition condition, bool isUserSpecified)
Parameters
| Type |
Name |
Description |
| Condition |
condition |
|
| System.Boolean |
isUserSpecified |
|
SetLowerBoundOfGroupLabel(GroupLabel, String)
Declaration
public void SetLowerBoundOfGroupLabel(GroupLabel groupLabel, string lowerBound)
Parameters
| Type |
Name |
Description |
| GroupLabel |
groupLabel |
|
| System.String |
lowerBound |
|
SetManualGroupingForRule(Rule, Boolean)
Declaration
public void SetManualGroupingForRule(Rule rule, bool isManualGrouping)
Parameters
| Type |
Name |
Description |
| Rule |
rule |
|
| System.Boolean |
isManualGrouping |
|
SetObjectTypesOfVisualReport(VisualReport.ObjectTypeOption[])
Declaration
public void SetObjectTypesOfVisualReport(VisualReport.ObjectTypeOption[] objectTypes)
Parameters
SetOperatorTypeOfCondition(Condition, Condition.OperatorOption)
Declaration
public void SetOperatorTypeOfCondition(Condition condition, Condition.OperatorOption operatorType)
Parameters
SetPropertyForComparison(Condition, Property)
Declaration
public void SetPropertyForComparison(Condition condition, Property property)
Parameters
SetPropertyOfCondition(Condition, Property)
Declaration
public void SetPropertyOfCondition(Condition condition, Property property)
Parameters
SetPropertySpecification(Property, String)
Declaration
public void SetPropertySpecification(Property property, string key)
Parameters
| Type |
Name |
Description |
| Property |
property |
|
| System.String |
key |
|
SetPropertySpecification(Property, String, String)
Declaration
public void SetPropertySpecification(Property property, string key, string name)
Parameters
| Type |
Name |
Description |
| Property |
property |
|
| System.String |
key |
|
| System.String |
name |
|
SetRangeMethodOfRule(Rule, Classifier.RangeMethodOption)
Declaration
public void SetRangeMethodOfRule(Rule rule, Classifier.RangeMethodOption rangeMethod)
Parameters
SetReferencePropertiesOfReport(Property[], VisualReportBuilder.PropertyUsageOption[])
Declaration
public void SetReferencePropertiesOfReport(Property[] properties, VisualReportBuilder.PropertyUsageOption[] usages)
Parameters
SetReferencePropertiesOfReportingProperty(Property[], VisualReportBuilder.PropertyUsageOption[])
Declaration
public void SetReferencePropertiesOfReportingProperty(Property[] properties, VisualReportBuilder.PropertyUsageOption[] usages)
Parameters
SetReportingDatatypeOfRule(Rule, Property.DatatypeOption)
Declaration
public void SetReportingDatatypeOfRule(Rule rule, Property.DatatypeOption datatype)
Parameters
SetReportingPropertyOfRule(Rule, Property)
Declaration
public void SetReportingPropertyOfRule(Rule rule, Property reportingProperty)
Parameters
SetTagPriorityOfGroupLabel(GroupLabel, GroupLabel.TagPriorityOption)
Declaration
public void SetTagPriorityOfGroupLabel(GroupLabel groupLabel, GroupLabel.TagPriorityOption tagPriority)
Parameters
SetUpperBoundOfGroupLabel(GroupLabel, String)
Declaration
public void SetUpperBoundOfGroupLabel(GroupLabel groupLabel, string upperBound)
Parameters
| Type |
Name |
Description |
| GroupLabel |
groupLabel |
|
| System.String |
upperBound |
|
SetUserNameOfGroupLabel(GroupLabel, String)
Declaration
public void SetUserNameOfGroupLabel(GroupLabel groupLabel, string name)
Parameters
| Type |
Name |
Description |
| GroupLabel |
groupLabel |
|
| System.String |
name |
|
SetUserPromptOfCondition(Condition, String)
Declaration
public void SetUserPromptOfCondition(Condition condition, string userPrompt)
Parameters
| Type |
Name |
Description |
| Condition |
condition |
|
| System.String |
userPrompt |
|
SetValueOfCondition(Condition, String)
Declaration
public void SetValueOfCondition(Condition condition, string value)
Parameters
| Type |
Name |
Description |
| Condition |
condition |
|
| System.String |
value |
|
SetValueOfGroupLabel(GroupLabel, String)
Declaration
public void SetValueOfGroupLabel(GroupLabel groupLabel, string value)
Parameters
| Type |
Name |
Description |
| GroupLabel |
groupLabel |
|
| System.String |
value |
|
UnsetUserNameOfGroupLabel(GroupLabel)
Declaration
public void UnsetUserNameOfGroupLabel(GroupLabel groupLabel)
Parameters
Implements
System.Runtime.Remoting.Messaging.IMessageSink