NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::VisualReporting::GroupLabel Class Reference

A group label corresponds to a group of objects in the results of an applied VisualReporting::VisualReport . More...

Inheritance diagram for NXOpen::VisualReporting::GroupLabel:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

List of all members.

Public Types

enum  DisplayStyleOption { DisplayStyleOptionDeEmphasis, DisplayStyleOptionSpecifiedColor, DisplayStyleOptionOriginalColor, DisplayStyleOptionAutomaticColor }
 Represents the possible display style options for a VisualReporting::GroupLabel . More...
enum  TagPriorityOption { TagPriorityOptionLow, TagPriorityOptionMedium, TagPriorityOptionHigh }
 Represents the possible priority options for a VisualReporting::GroupLabel . More...

Public Member Functions

NXString BitmapName ()
 Returns the bitmap name of this VisualReporting::GroupLabel .
NXOpen::NXColor::Rgb Color ()
 Returns the color of the VisualReporting::GroupLabel
Created in NX7.0.0.
NXString CustomMessage ()
 Returns the custom message of this VisualReporting::GroupLabel .
NXOpen::VisualReporting::GroupLabel::DisplayStyleOption DisplayStyle ()
 Returns the VisualReporting::GroupLabel::DisplayStyleOption of the VisualReporting::GroupLabel
Created in NX7.0.0.
bool IsManual ()
 Returns whether the VisualReporting::GroupLabel is manual.
bool IsNameUserSpecified ()
 Returns whether the VisualReporting::GroupLabel has a user-specified NXObject::Name .
NXString LowerBound ()
 Returns the lower bound value of the VisualReporting::GroupLabel (if it is being grouped by range)
Created in NX8.0.0.
void SetBitmapName (const NXString &bitmapName)
 Sets the bitmap name of this VisualReporting::GroupLabel .
void SetColor (const NXOpen::NXColor::Rgb &color)
 Sets the color of the VisualReporting::GroupLabel
Created in NX7.5.0.
void SetCustomMessage (const NXString &customMessage)
 Sets the custom message of this VisualReporting::GroupLabel .
void SetDisplayStyle (NXOpen::VisualReporting::GroupLabel::DisplayStyleOption displayStyle)
 Sets the VisualReporting::GroupLabel::DisplayStyleOption of the VisualReporting::GroupLabel
Created in NX7.5.0.
void SetLowerBound (const NXString &fromValue)
 Sets the lower bound value of the VisualReporting::GroupLabel (if it is being grouped by range)
Created in NX8.0.0.
void SetManual (bool isManual)
 Sets whether the VisualReporting::GroupLabel is manual.
void SetNameUserSpecified (bool isNameUserSpecified)
 Sets whether the VisualReporting::GroupLabel has a user-specified NXObject::Name .
void SetTagPriority (NXOpen::VisualReporting::GroupLabel::TagPriorityOption tagPriority)
 Sets the Tag Priority of this VisualReporting::GroupLabel .
void SetUpperBound (const NXString &upperBound)
 Sets the upper bound value of the VisualReporting::GroupLabel (if it is being grouped by range)
Created in NX8.0.0.
void SetValue (const NXString &groupLabelValue)
 Sets the value of the VisualReporting::GroupLabel (if it is being grouped by value)
Created in NX8.0.0.
NXOpen::VisualReporting::GroupLabel::TagPriorityOption TagPriority ()
 Returns the Tag Priority of this VisualReporting::GroupLabel .
NXString UpperBound ()
 Returns the upper bound value of the VisualReporting::GroupLabel (if it is being grouped by range)
Created in NX8.0.0.
NXString Value ()
 Returns the value of the VisualReporting::GroupLabel (if it is being grouped by value)
Created in NX7.0.0.

Detailed Description

A group label corresponds to a group of objects in the results of an applied VisualReporting::VisualReport .


Created in NX7.0.0.


Member Enumeration Documentation

Represents the possible display style options for a VisualReporting::GroupLabel .

Enumerator:
DisplayStyleOptionDeEmphasis 

Matching objects will be de-emphasized.

DisplayStyleOptionSpecifiedColor 

Matching objects will be shown using VisualReporting::GroupLabel::Color.

DisplayStyleOptionOriginalColor 

Matching objects will be shown using their original color.

DisplayStyleOptionAutomaticColor 

Matching objects will be shown using VisualReporting::GroupLabel::Color which is system determined.

Represents the possible priority options for a VisualReporting::GroupLabel .

Enumerator:
TagPriorityOptionLow 

Low priority.

TagPriorityOptionMedium 

Medium priority.

TagPriorityOptionHigh 

Hign priority.


Member Function Documentation

Returns the bitmap name of this VisualReporting::GroupLabel .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Returns the color of the VisualReporting::GroupLabel
Created in NX7.0.0.



License requirements : nx_visual_reporting ("Visual Reporting")

Returns the custom message of this VisualReporting::GroupLabel .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Returns the VisualReporting::GroupLabel::DisplayStyleOption of the VisualReporting::GroupLabel
Created in NX7.0.0.



License requirements : nx_visual_reporting ("Visual Reporting")

Returns whether the VisualReporting::GroupLabel is manual.

It is manual if it either has a user-specified NXObject::Name or if its VisualReporting::GroupLabel::DisplayStyle is not VisualReporting::GroupLabel::DisplayStyleOptionAutomaticColor . You can change a VisualReporting::GroupLabel from automatic to manual, but you cannot change VisualReporting::GroupLabel from manual to automatic.


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Returns whether the VisualReporting::GroupLabel has a user-specified NXObject::Name .

If it isn't user-specified, then the system will generate its name automatically.


Created in NX7.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Returns the lower bound value of the VisualReporting::GroupLabel (if it is being grouped by range)
Created in NX8.0.0.



License requirements : nx_visual_reporting ("Visual Reporting")

Sets the bitmap name of this VisualReporting::GroupLabel .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
bitmapNamebitmapname

Sets the color of the VisualReporting::GroupLabel
Created in NX7.5.0.



License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
colorcolor

Sets the custom message of this VisualReporting::GroupLabel .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
customMessagecustommessage

Sets the VisualReporting::GroupLabel::DisplayStyleOption of the VisualReporting::GroupLabel
Created in NX7.5.0.



License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
displayStyledisplaystyle

Sets the lower bound value of the VisualReporting::GroupLabel (if it is being grouped by range)
Created in NX8.0.0.



License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
fromValuefromvalue

Sets whether the VisualReporting::GroupLabel is manual.

It is manual if it either has a user-specified NXObject::Name or if its VisualReporting::GroupLabel::DisplayStyle is not VisualReporting::GroupLabel::DisplayStyleOptionAutomaticColor . You can change a VisualReporting::GroupLabel from automatic to manual, but you cannot change VisualReporting::GroupLabel from manual to automatic.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
isManualismanual

Sets whether the VisualReporting::GroupLabel has a user-specified NXObject::Name .

If it isn't user-specified, then the system will generate its name automatically.


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
isNameUserSpecifiedisnameuserspecified

Sets the Tag Priority of this VisualReporting::GroupLabel .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
tagPrioritytagpriority

Sets the upper bound value of the VisualReporting::GroupLabel (if it is being grouped by range)
Created in NX8.0.0.



License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
upperBoundupperbound
void NXOpen::VisualReporting::GroupLabel::SetValue ( const NXString groupLabelValue)

Sets the value of the VisualReporting::GroupLabel (if it is being grouped by value)
Created in NX8.0.0.



License requirements : nx_visual_reporting ("Visual Reporting")

Parameters:
groupLabelValuegrouplabelvalue

Returns the Tag Priority of this VisualReporting::GroupLabel .


Created in NX8.0.0.

License requirements : nx_visual_reporting ("Visual Reporting")

Returns the upper bound value of the VisualReporting::GroupLabel (if it is being grouped by range)
Created in NX8.0.0.



License requirements : nx_visual_reporting ("Visual Reporting")

Returns the value of the VisualReporting::GroupLabel (if it is being grouped by value)
Created in NX7.0.0.



License requirements : nx_visual_reporting ("Visual Reporting")


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