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

Represents a On Path Dimension block
Created in NX8.5.0. More...

Inheritance diagram for NXOpen::BlockStyler::OnPathDimension:
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...
 
NXOpen::TaggedObjectExpressionObject ()
 Returns the ExpressionObject
Created in NX8.5.0. More...
 
NXString Formula ()
 Returns the Formula
Created in NX8.5.0. More...
 
std::vector< NXStringGetBalloonTooltipLayoutMembers ()
 Gets the BalloonTooltipLayout members. More...
 
std::vector< NXStringGetLocationOptionMembers ()
 Gets the LocationOption members. More...
 
double LineIncrement ()
 Returns the LineIncrement value. More...
 
NXString LocationOptionAsString ()
 Returns the LocationOption as string
Created in NX8.5.0. 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...
 
int OptionMask ()
 Returns the OptionMask
Created in NX8.5.0. More...
 
NXString OptionMenuTitle ()
 Returns the OptionMenuTitle
Created in NX8.5.0. More...
 
double PageIncrement ()
 Returns the PageIncrement value. More...
 
NXOpen::TaggedObjectPath ()
 Returns the Path
Created in NX8.5.0. 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 SetExpressionObject (NXOpen::TaggedObject *expressionObj)
 Sets the ExpressionObject
Created in NX8.5.0. More...
 
void SetFormula (const NXString &formula)
 Sets the Formula
Created in NX8.5.0. More...
 
void SetFormula (const char *formula)
 Sets the Formula
Created in NX8.5.0. More...
 
void SetLineIncrement (double lineIncrement)
 Sets the LineIncrement value. More...
 
void SetLocationOptionAsString (const NXString &enumString)
 Sets the LocationOption as string
Created in NX8.5.0. More...
 
void SetLocationOptionAsString (const char *enumString)
 Sets the LocationOption as string
Created in NX8.5.0. 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 SetOptionMask (int maskVal)
 Sets the OptionMask
Created in NX8.5.0. More...
 
void SetOptionMenuTitle (const NXString &menuTitleText)
 Sets the OptionMenuTitle
Created in NX8.5.0. More...
 
void SetOptionMenuTitle (const char *menuTitleText)
 Sets the OptionMenuTitle
Created in NX8.5.0. More...
 
void SetPageIncrement (double pageIncrement)
 Sets the PageIncrement value. More...
 
void SetPath (NXOpen::TaggedObject *path)
 Sets the Path
Created in NX8.5.0. More...
 
void SetShowFocusHandle (bool showFocus)
 Sets the ShowFocusHandle
Created in NX8.5.0. More...
 
void SetSnapPointTypesOnByDefault (int pointType)
 Sets the SnapPointTypesOnByDefault
More...
 
void SetUnits (NXOpen::TaggedObject *units)
 Sets the Units
Created in NX8.5.0. More...
 
void SetValue (double dimensionValue)
 Sets the Value. More...
 
void SetWithScale (bool withScale)
 Sets the WithScale. More...
 
bool ShowFocusHandle ()
 Returns the ShowFocusHandle
Created in NX8.5.0. More...
 
int SnapPointTypesOnByDefault ()
 Returns the SnapPointTypesOnByDefault
More...
 
NXOpen::TaggedObjectUnits ()
 Returns the Units
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 a On Path Dimension block
Created in NX8.5.0.


Member Function Documentation

bool NXOpen::BlockStyler::OnPathDimension::AdaptiveScaleLimits ( )

Returns the AdaptiveScaleLimits.

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

License requirements : None

NXString NXOpen::BlockStyler::OnPathDimension::BalloonTooltipImage ( )

Returns the BalloonTooltipImage
Created in NX8.5.0.



License requirements : None

NXString NXOpen::BlockStyler::OnPathDimension::BalloonTooltipLayoutAsString ( )

Returns the BalloonTooltipLayout as string
Created in NX8.5.0.



License requirements : None

NXString NXOpen::BlockStyler::OnPathDimension::BalloonTooltipText ( )

Returns the BalloonTooltipText
Created in NX8.5.0.



License requirements : None

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

Returns the ExpressionObject
Created in NX8.5.0.



License requirements : None

NXString NXOpen::BlockStyler::OnPathDimension::Formula ( )

Returns the Formula
Created in NX8.5.0.



License requirements : None

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

Gets the BalloonTooltipLayout members.

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

License requirements : None
std::vector<NXString> NXOpen::BlockStyler::OnPathDimension::GetLocationOptionMembers ( )

Gets the LocationOption members.

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

License requirements : None
double NXOpen::BlockStyler::OnPathDimension::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

NXString NXOpen::BlockStyler::OnPathDimension::LocationOptionAsString ( )

Returns the LocationOption as string
Created in NX8.5.0.



License requirements : None

double NXOpen::BlockStyler::OnPathDimension::MaximumValue ( )

Returns the MaximumValue
Created in NX8.5.0.



License requirements : None

bool NXOpen::BlockStyler::OnPathDimension::MaxInclusive ( )

Returns the MaxInclusive
Created in NX8.5.0.



License requirements : None

double NXOpen::BlockStyler::OnPathDimension::MinimumValue ( )

Returns the MinimumValue
Created in NX8.5.0.



License requirements : None

bool NXOpen::BlockStyler::OnPathDimension::MinInclusive ( )

Returns the MinInclusive
Created in NX8.5.0.



License requirements : None

int NXOpen::BlockStyler::OnPathDimension::OptionMask ( )

Returns the OptionMask
Created in NX8.5.0.



License requirements : None

NXString NXOpen::BlockStyler::OnPathDimension::OptionMenuTitle ( )

Returns the OptionMenuTitle
Created in NX8.5.0.



License requirements : None

double NXOpen::BlockStyler::OnPathDimension::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

NXOpen::TaggedObject* NXOpen::BlockStyler::OnPathDimension::Path ( )

Returns the Path
Created in NX8.5.0.



License requirements : None

void NXOpen::BlockStyler::OnPathDimension::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::OnPathDimension::SetBalloonTooltipImage ( const NXString imageString)

Sets the BalloonTooltipImage
Created in NX8.5.0.



License requirements : None

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

Sets the BalloonTooltipImage
Created in NX8.5.0.



License requirements : None

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

Sets the BalloonTooltipLayout as string
Created in NX8.5.0.



License requirements : None

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

Sets the BalloonTooltipLayout as string
Created in NX8.5.0.



License requirements : None

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

Sets the BalloonTooltipText
Created in NX8.5.0.



License requirements : None

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

Sets the BalloonTooltipText
Created in NX8.5.0.



License requirements : None

Parameters
balloonTooltipTextballoon tooltip text
void NXOpen::BlockStyler::OnPathDimension::SetExpressionObject ( NXOpen::TaggedObject expressionObj)

Sets the ExpressionObject
Created in NX8.5.0.



License requirements : None

Parameters
expressionObjexpression obj
void NXOpen::BlockStyler::OnPathDimension::SetFormula ( const NXString formula)

Sets the Formula
Created in NX8.5.0.



License requirements : None

Parameters
formulaformula
void NXOpen::BlockStyler::OnPathDimension::SetFormula ( const char *  formula)

Sets the Formula
Created in NX8.5.0.



License requirements : None

Parameters
formulaformula
void NXOpen::BlockStyler::OnPathDimension::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::OnPathDimension::SetLocationOptionAsString ( const NXString enumString)

Sets the LocationOption as string
Created in NX8.5.0.



License requirements : None

Parameters
enumStringenumstring
void NXOpen::BlockStyler::OnPathDimension::SetLocationOptionAsString ( const char *  enumString)

Sets the LocationOption as string
Created in NX8.5.0.



License requirements : None

Parameters
enumStringenumstring
void NXOpen::BlockStyler::OnPathDimension::SetMaximumValue ( double  maxValue)

Sets the MaximumValue
Created in NX8.5.0.



License requirements : None

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

Sets the MaxInclusive
Created in NX8.5.0.



License requirements : None

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

Sets the MinimumValue
Created in NX8.5.0.



License requirements : None

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

Sets the MinInclusive
Created in NX8.5.0.



License requirements : None

Parameters
minInclusivemin inclusive
void NXOpen::BlockStyler::OnPathDimension::SetOptionMask ( int  maskVal)

Sets the OptionMask
Created in NX8.5.0.



License requirements : None

Parameters
maskValmaskval
void NXOpen::BlockStyler::OnPathDimension::SetOptionMenuTitle ( const NXString menuTitleText)

Sets the OptionMenuTitle
Created in NX8.5.0.



License requirements : None

Parameters
menuTitleTextmenutitletext
void NXOpen::BlockStyler::OnPathDimension::SetOptionMenuTitle ( const char *  menuTitleText)

Sets the OptionMenuTitle
Created in NX8.5.0.



License requirements : None

Parameters
menuTitleTextmenutitletext
void NXOpen::BlockStyler::OnPathDimension::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::OnPathDimension::SetPath ( NXOpen::TaggedObject path)

Sets the Path
Created in NX8.5.0.



License requirements : None

Parameters
pathpath
void NXOpen::BlockStyler::OnPathDimension::SetShowFocusHandle ( bool  showFocus)

Sets the ShowFocusHandle
Created in NX8.5.0.



License requirements : None

Parameters
showFocusshow focus
void NXOpen::BlockStyler::OnPathDimension::SetSnapPointTypesOnByDefault ( int  pointType)

Sets the SnapPointTypesOnByDefault

Deprecated:
Deprecated in NX9.0.0.

This call can be safely removed as this is now a no-op.


Created in NX8.5.0.

License requirements : None

Parameters
pointTypepoint type
void NXOpen::BlockStyler::OnPathDimension::SetUnits ( NXOpen::TaggedObject units)

Sets the Units
Created in NX8.5.0.



License requirements : None

Parameters
unitsunits
void NXOpen::BlockStyler::OnPathDimension::SetValue ( double  dimensionValue)

Sets the Value.


Created in NX8.5.0.

License requirements : None

Parameters
dimensionValuedimension value
void NXOpen::BlockStyler::OnPathDimension::SetWithScale ( bool  withScale)

Sets the WithScale.

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

License requirements : None

Parameters
withScalewith scale
bool NXOpen::BlockStyler::OnPathDimension::ShowFocusHandle ( )

Returns the ShowFocusHandle
Created in NX8.5.0.



License requirements : None

int NXOpen::BlockStyler::OnPathDimension::SnapPointTypesOnByDefault ( )

Returns the SnapPointTypesOnByDefault

Deprecated:
Deprecated in NX9.0.0.

This call can be safely removed as this is now a no-op.


Created in NX8.5.0.

License requirements : None

NXOpen::TaggedObject* NXOpen::BlockStyler::OnPathDimension::Units ( )

Returns the Units
Created in NX8.5.0.



License requirements : None

double NXOpen::BlockStyler::OnPathDimension::Value ( )

Returns the Value.


Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::OnPathDimension::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.