NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::BlockStyler::ExpressionBlock Class Reference

Represents an Expression block
Created in NX8.5.0. More...

Inheritance diagram for NXOpen::BlockStyler::ExpressionBlock:
NXOpen::BlockStyler::UIBlock NXOpen::TaggedObject

Public Member Functions

bool AdaptiveScaleLimits ()
 Returns the AdaptiveScaleLimits. More...
 
NXString BalloonTooltipImage ()
 Returns the BalloonTooltipImage
Created in NX8.5.0. More...
 
NXString BalloonTooltipLayoutAsString ()
 Returns the BalloonTooltipLayout as string
Created in NX8.5.0. More...
 
NXString BalloonTooltipText ()
 Returns the BalloonTooltipText
Created in NX8.5.0. More...
 
NXString DimensionalityAsString ()
 Returns the Dimensionality as string. More...
 
NXOpen::TaggedObjectExpressionObject ()
 Returns the ExpressionObject
Created in NX8.5.0. More...
 
NXString Formula ()
 Returns the Formula for the expression
Created in NX8.5.0. More...
 
std::vector< NXStringGetBalloonTooltipLayoutMembers ()
 Gets the BalloonTooltipLayout members. More...
 
std::vector< NXStringGetDimensionalityMembers ()
 Gets the members of Dimensionality enum. More...
 
bool HasUnitsMenu ()
 Returns the HasUnitsMenu. More...
 
double LineIncrement ()
 Returns the LineIncrement value. More...
 
double MaximumValue ()
 Returns the MaximumValue
Created in NX8.5.0. More...
 
bool MaxInclusive ()
 Returns the MaxInclusive
Created in NX8.5.0. More...
 
double MinimumValue ()
 Returns the MinimumValue
Created in NX8.5.0. More...
 
bool MinInclusive ()
 Returns the MinInclusive
Created in NX8.5.0. More...
 
double PageIncrement ()
 Returns the PageIncrement value. More...
 
bool RetainValue ()
 Returns the RetainValue. More...
 
void SetAdaptiveScaleLimits (bool scaleLimits)
 Sets the AdaptiveScaleLimits. More...
 
void SetBalloonTooltipImage (const NXString &imageString)
 Sets the BalloonTooltipImage
Created in NX8.5.0. More...
 
void SetBalloonTooltipImage (const char *imageString)
 Sets the BalloonTooltipImage
Created in NX8.5.0. More...
 
void SetBalloonTooltipLayoutAsString (const NXString &enumString)
 Sets the BalloonTooltipLayout as string
Created in NX8.5.0. More...
 
void SetBalloonTooltipLayoutAsString (const char *enumString)
 Sets the BalloonTooltipLayout as string
Created in NX8.5.0. More...
 
void SetBalloonTooltipText (const NXString &balloonTooltipText)
 Sets the BalloonTooltipText
Created in NX8.5.0. More...
 
void SetBalloonTooltipText (const char *balloonTooltipText)
 Sets the BalloonTooltipText
Created in NX8.5.0. More...
 
void SetDimensionalityAsString (const NXString &enumString)
 Sets the Dimensionality as string. More...
 
void SetDimensionalityAsString (const char *enumString)
 Sets the Dimensionality as string. More...
 
void SetExpressionObject (NXOpen::TaggedObject *expressionObject)
 Sets the ExpressionObject
Created in NX8.5.0. More...
 
void SetFormula (const NXString &formulaString)
 Sets the Formula for the expression
Created in NX8.5.0. More...
 
void SetFormula (const char *formulaString)
 Sets the Formula for the expression
Created in NX8.5.0. More...
 
void SetHasUnitsMenu (bool hasMenu)
 Sets the HasUnitsMenu. More...
 
void SetLineIncrement (double lineIncrement)
 Sets the LineIncrement value. More...
 
void SetMaximumValue (double maxValue)
 Sets the MaximumValue
Created in NX8.5.0. More...
 
void SetMaxInclusive (bool maxInclusive)
 Sets the MaxInclusive
Created in NX8.5.0. More...
 
void SetMinimumValue (double minValue)
 Sets the MinimumValue
Created in NX8.5.0. More...
 
void SetMinInclusive (bool minInclusive)
 Sets the MinInclusive
Created in NX8.5.0. More...
 
void SetPageIncrement (double pageIncrement)
 Sets the PageIncrement value. More...
 
void SetRetainValue (bool retain)
 Sets the RetainValue. More...
 
void SetUnits (NXOpen::TaggedObject *units)
 Sets the Units for the expression
Created in NX8.5.0. More...
 
void SetValue (double expressionValue)
 Sets the Value. More...
 
void SetWithScale (bool withScale)
 Sets the WithScale. More...
 
NXOpen::TaggedObjectUnits ()
 Returns the Units for the expression
Created in NX8.5.0. More...
 
double Value ()
 Returns the Value. More...
 
bool WithScale ()
 Returns the WithScale. More...
 
- Public Member Functions inherited from NXOpen::BlockStyler::UIBlock
bool Enable ()
 Returns the Enable. More...
 
bool Expanded ()
 Returns the Expanded
Created in NX8.5.0. More...
 
void Focus ()
 Focuses on the block. More...
 
NXOpen::BlockStyler::PropertyListGetProperties ()
 Returns the properties of the block. More...
 
bool Group ()
 Returns the Group
Created in NX8.5.0. More...
 
NXString Label ()
 Returns the Label
Created in NX8.5.0. More...
 
NXString Name ()
 Returns the name of the block or BlockID
Created in NX6.0.0. More...
 
void SetEnable (bool enable)
 Sets the Enable. More...
 
void SetExpanded (bool expanded)
 Sets the Expanded
Created in NX8.5.0. More...
 
void SetGroup (bool group)
 Sets the Group
Created in NX8.5.0. More...
 
void SetLabel (const NXString &label)
 Sets the Label
Created in NX8.5.0. More...
 
void SetLabel (const char *label)
 Sets the Label
Created in NX8.5.0. More...
 
void SetShow (bool show)
 Sets the Visibility of block. More...
 
bool Show ()
 Returns the Visibility of block. More...
 
NXString Type ()
 Returns the type of block
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents an Expression block
Created in NX8.5.0.


Member Function Documentation

bool NXOpen::BlockStyler::ExpressionBlock::AdaptiveScaleLimits ( )

Returns the AdaptiveScaleLimits.

If true, indicates that the scale should be adaptive.
Created in NX9.0.0.

License requirements : None

NXString NXOpen::BlockStyler::ExpressionBlock::BalloonTooltipImage ( )

Returns the BalloonTooltipImage
Created in NX8.5.0.



License requirements : None

NXString NXOpen::BlockStyler::ExpressionBlock::BalloonTooltipLayoutAsString ( )

Returns the BalloonTooltipLayout as string
Created in NX8.5.0.



License requirements : None

NXString NXOpen::BlockStyler::ExpressionBlock::BalloonTooltipText ( )

Returns the BalloonTooltipText
Created in NX8.5.0.



License requirements : None

NXString NXOpen::BlockStyler::ExpressionBlock::DimensionalityAsString ( )

Returns the Dimensionality as string.

It specifies the type of quantity that the expression represents.
Created in NX8.5.0.

License requirements : None

NXOpen::TaggedObject* NXOpen::BlockStyler::ExpressionBlock::ExpressionObject ( )

Returns the ExpressionObject
Created in NX8.5.0.



License requirements : None

NXString NXOpen::BlockStyler::ExpressionBlock::Formula ( )

Returns the Formula for the expression
Created in NX8.5.0.



License requirements : None

std::vector<NXString> NXOpen::BlockStyler::ExpressionBlock::GetBalloonTooltipLayoutMembers ( )

Gets the BalloonTooltipLayout members.

Returns
Value to get from the property.
Created in NX8.5.0.

License requirements : None
std::vector<NXString> NXOpen::BlockStyler::ExpressionBlock::GetDimensionalityMembers ( )

Gets the members of Dimensionality enum.

Returns
Value to get from the property.
Created in NX8.5.0.

License requirements : None
bool NXOpen::BlockStyler::ExpressionBlock::HasUnitsMenu ( )

Returns the HasUnitsMenu.

If true, indicates that a menu will be displayed allowing the user to change units. This property is relevant only when the Dimensionality property is set to a value that is not without units.
Created in NX8.5.0.

License requirements : None

double NXOpen::BlockStyler::ExpressionBlock::LineIncrement ( )

Returns the LineIncrement value.

Specifies the increment/decrement when the user presses the arrow keys on the keyboard. Only available when PresentationStyle is set to Scale or ScaleKeyin.
Created in NX9.0.0.

License requirements : None

double NXOpen::BlockStyler::ExpressionBlock::MaximumValue ( )

Returns the MaximumValue
Created in NX8.5.0.



License requirements : None

bool NXOpen::BlockStyler::ExpressionBlock::MaxInclusive ( )

Returns the MaxInclusive
Created in NX8.5.0.



License requirements : None

double NXOpen::BlockStyler::ExpressionBlock::MinimumValue ( )

Returns the MinimumValue
Created in NX8.5.0.



License requirements : None

bool NXOpen::BlockStyler::ExpressionBlock::MinInclusive ( )

Returns the MinInclusive
Created in NX8.5.0.



License requirements : None

double NXOpen::BlockStyler::ExpressionBlock::PageIncrement ( )

Returns the PageIncrement value.

Specifies the increment/decrement when the user presses the Page Up or Page Down keys on the keyboard. Only available when PresentationStyle is set to Scale or ScaleKeyin.
Created in NX9.0.0.

License requirements : None

bool NXOpen::BlockStyler::ExpressionBlock::RetainValue ( )

Returns the RetainValue.

If true, indicates that the values in the block would be stored in dialog memory upon OK, Apply or Close.
Created in NX10.0.0.

License requirements : None

void NXOpen::BlockStyler::ExpressionBlock::SetAdaptiveScaleLimits ( bool  scaleLimits)

Sets the AdaptiveScaleLimits.

If true, indicates that the scale should be adaptive.
Created in NX9.0.0.

License requirements : None

Parameters
scaleLimitsscale limits
void NXOpen::BlockStyler::ExpressionBlock::SetBalloonTooltipImage ( const NXString imageString)

Sets the BalloonTooltipImage
Created in NX8.5.0.



License requirements : None

Parameters
imageStringimage string
void NXOpen::BlockStyler::ExpressionBlock::SetBalloonTooltipImage ( const char *  imageString)

Sets the BalloonTooltipImage
Created in NX8.5.0.



License requirements : None

Parameters
imageStringimage string
void NXOpen::BlockStyler::ExpressionBlock::SetBalloonTooltipLayoutAsString ( const NXString enumString)

Sets the BalloonTooltipLayout as string
Created in NX8.5.0.



License requirements : None

Parameters
enumStringenumstring
void NXOpen::BlockStyler::ExpressionBlock::SetBalloonTooltipLayoutAsString ( const char *  enumString)

Sets the BalloonTooltipLayout as string
Created in NX8.5.0.



License requirements : None

Parameters
enumStringenumstring
void NXOpen::BlockStyler::ExpressionBlock::SetBalloonTooltipText ( const NXString balloonTooltipText)

Sets the BalloonTooltipText
Created in NX8.5.0.



License requirements : None

Parameters
balloonTooltipTextballoon tooltip text
void NXOpen::BlockStyler::ExpressionBlock::SetBalloonTooltipText ( const char *  balloonTooltipText)

Sets the BalloonTooltipText
Created in NX8.5.0.



License requirements : None

Parameters
balloonTooltipTextballoon tooltip text
void NXOpen::BlockStyler::ExpressionBlock::SetDimensionalityAsString ( const NXString enumString)

Sets the Dimensionality as string.

It specifies the type of quantity that the expression represents.
Created in NX8.5.0.

License requirements : None

Parameters
enumStringenum string
void NXOpen::BlockStyler::ExpressionBlock::SetDimensionalityAsString ( const char *  enumString)

Sets the Dimensionality as string.

It specifies the type of quantity that the expression represents.
Created in NX8.5.0.

License requirements : None

Parameters
enumStringenum string
void NXOpen::BlockStyler::ExpressionBlock::SetExpressionObject ( NXOpen::TaggedObject expressionObject)

Sets the ExpressionObject
Created in NX8.5.0.



License requirements : None

Parameters
expressionObjectexpression object
void NXOpen::BlockStyler::ExpressionBlock::SetFormula ( const NXString formulaString)

Sets the Formula for the expression
Created in NX8.5.0.



License requirements : None

Parameters
formulaStringformula string
void NXOpen::BlockStyler::ExpressionBlock::SetFormula ( const char *  formulaString)

Sets the Formula for the expression
Created in NX8.5.0.



License requirements : None

Parameters
formulaStringformula string
void NXOpen::BlockStyler::ExpressionBlock::SetHasUnitsMenu ( bool  hasMenu)

Sets the HasUnitsMenu.

If true, indicates that a menu will be displayed allowing the user to change units. This property is relevant only when the Dimensionality property is set to a value that is not without units.
Created in NX8.5.0.

License requirements : None

Parameters
hasMenuhas menu
void NXOpen::BlockStyler::ExpressionBlock::SetLineIncrement ( double  lineIncrement)

Sets the LineIncrement value.

Specifies the increment/decrement when the user presses the arrow keys on the keyboard. Only available when PresentationStyle is set to Scale or ScaleKeyin.
Created in NX9.0.0.

License requirements : None

Parameters
lineIncrementline increment
void NXOpen::BlockStyler::ExpressionBlock::SetMaximumValue ( double  maxValue)

Sets the MaximumValue
Created in NX8.5.0.



License requirements : None

Parameters
maxValuemax value
void NXOpen::BlockStyler::ExpressionBlock::SetMaxInclusive ( bool  maxInclusive)

Sets the MaxInclusive
Created in NX8.5.0.



License requirements : None

Parameters
maxInclusivemax inclusive
void NXOpen::BlockStyler::ExpressionBlock::SetMinimumValue ( double  minValue)

Sets the MinimumValue
Created in NX8.5.0.



License requirements : None

Parameters
minValuemin value
void NXOpen::BlockStyler::ExpressionBlock::SetMinInclusive ( bool  minInclusive)

Sets the MinInclusive
Created in NX8.5.0.



License requirements : None

Parameters
minInclusivemin inclusive
void NXOpen::BlockStyler::ExpressionBlock::SetPageIncrement ( double  pageIncrement)

Sets the PageIncrement value.

Specifies the increment/decrement when the user presses the Page Up or Page Down keys on the keyboard. Only available when PresentationStyle is set to Scale or ScaleKeyin.
Created in NX9.0.0.

License requirements : None

Parameters
pageIncrementpage increment
void NXOpen::BlockStyler::ExpressionBlock::SetRetainValue ( bool  retain)

Sets the RetainValue.

If true, indicates that the values in the block would be stored in dialog memory upon OK, Apply or Close.
Created in NX10.0.0.

License requirements : None

Parameters
retainretain
void NXOpen::BlockStyler::ExpressionBlock::SetUnits ( NXOpen::TaggedObject units)

Sets the Units for the expression
Created in NX8.5.0.



License requirements : None

Parameters
unitsunits
void NXOpen::BlockStyler::ExpressionBlock::SetValue ( double  expressionValue)

Sets the Value.


Created in NX8.5.0.

License requirements : None

Parameters
expressionValueexpression value
void NXOpen::BlockStyler::ExpressionBlock::SetWithScale ( bool  withScale)

Sets the WithScale.

If true, the slider bar is shown.
Created in NX8.5.0.

License requirements : None

Parameters
withScalewith scale
NXOpen::TaggedObject* NXOpen::BlockStyler::ExpressionBlock::Units ( )

Returns the Units for the expression
Created in NX8.5.0.



License requirements : None

double NXOpen::BlockStyler::ExpressionBlock::Value ( )

Returns the Value.


Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::ExpressionBlock::WithScale ( )

Returns the WithScale.

If true, the slider bar is shown.
Created in NX8.5.0.

License requirements : None


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