NX Open C++ Reference Guide
|
A group label corresponds to a group of objects in the results of an applied VisualReporting::VisualReport . More...
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. |
A group label corresponds to a group of objects in the results of an applied VisualReporting::VisualReport .
Created in NX7.0.0.
Represents the possible display style options for a VisualReporting::GroupLabel .
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 .
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")
NXOpen::VisualReporting::GroupLabel::DisplayStyleOption NXOpen::VisualReporting::GroupLabel::DisplayStyle | ( | ) |
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")
void NXOpen::VisualReporting::GroupLabel::SetBitmapName | ( | const NXString & | bitmapName | ) |
Sets the bitmap name of this VisualReporting::GroupLabel .
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
bitmapName | bitmapname |
void NXOpen::VisualReporting::GroupLabel::SetColor | ( | const NXOpen::NXColor::Rgb & | color | ) |
Sets the color of the VisualReporting::GroupLabel
Created in NX7.5.0.
License requirements : nx_visual_reporting ("Visual Reporting")
color | color |
void NXOpen::VisualReporting::GroupLabel::SetCustomMessage | ( | const NXString & | customMessage | ) |
Sets the custom message of this VisualReporting::GroupLabel .
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
customMessage | custommessage |
void NXOpen::VisualReporting::GroupLabel::SetDisplayStyle | ( | NXOpen::VisualReporting::GroupLabel::DisplayStyleOption | displayStyle | ) |
Sets the VisualReporting::GroupLabel::DisplayStyleOption of the VisualReporting::GroupLabel
Created in NX7.5.0.
License requirements : nx_visual_reporting ("Visual Reporting")
displayStyle | displaystyle |
void NXOpen::VisualReporting::GroupLabel::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.
License requirements : nx_visual_reporting ("Visual Reporting")
fromValue | fromvalue |
void NXOpen::VisualReporting::GroupLabel::SetManual | ( | bool | isManual | ) |
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")
isManual | ismanual |
void NXOpen::VisualReporting::GroupLabel::SetNameUserSpecified | ( | bool | isNameUserSpecified | ) |
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")
isNameUserSpecified | isnameuserspecified |
void NXOpen::VisualReporting::GroupLabel::SetTagPriority | ( | NXOpen::VisualReporting::GroupLabel::TagPriorityOption | tagPriority | ) |
Sets the Tag Priority of this VisualReporting::GroupLabel .
Created in NX8.0.0.
License requirements : nx_visual_reporting ("Visual Reporting")
tagPriority | tagpriority |
void NXOpen::VisualReporting::GroupLabel::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.
License requirements : nx_visual_reporting ("Visual Reporting")
upperBound | upperbound |
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")
groupLabelValue | grouplabelvalue |
NXOpen::VisualReporting::GroupLabel::TagPriorityOption NXOpen::VisualReporting::GroupLabel::TagPriority | ( | ) |
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")