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

Inheritance diagram for NXOpen::BlockStyler::OnPathDimension:

Public Member Functions
bool	AdaptiveScaleLimits ()
	Returns the AdaptiveScaleLimits.

NXString	BalloonTooltipImage ()
	Returns the BalloonTooltipImage Created in NX8.5.0.

NXString	BalloonTooltipLayoutAsString ()
	Returns the BalloonTooltipLayout as string Created in NX8.5.0.

NXString	BalloonTooltipText ()
	Returns the BalloonTooltipText Created in NX8.5.0.

NXOpen::TaggedObject *	ExpressionObject ()
	Returns the ExpressionObject Created in NX8.5.0.

NXString	Formula ()
	Returns the Formula Created in NX8.5.0.

std::vector< NXString >	GetBalloonTooltipLayoutMembers ()
	Gets the BalloonTooltipLayout members.

std::vector< NXString >	GetLocationOptionMembers ()
	Gets the LocationOption members.

double	LineIncrement ()
	Returns the LineIncrement value.

NXString	LocationOptionAsString ()
	Returns the LocationOption as string Created in NX8.5.0.

double	MaximumValue ()
	Returns the MaximumValue Created in NX8.5.0.

bool	MaxInclusive ()
	Returns the MaxInclusive Created in NX8.5.0.

double	MinimumValue ()
	Returns the MinimumValue Created in NX8.5.0.

bool	MinInclusive ()
	Returns the MinInclusive Created in NX8.5.0.

int	OptionMask ()
	Returns the OptionMask Created in NX8.5.0.

NXString	OptionMenuTitle ()
	Returns the OptionMenuTitle Created in NX8.5.0.

double	PageIncrement ()
	Returns the PageIncrement value.

NXOpen::TaggedObject *	Path ()
	Returns the Path Created in NX8.5.0.

void	SetAdaptiveScaleLimits (bool scaleLimits)
	Sets the AdaptiveScaleLimits.

void	SetBalloonTooltipImage (const NXString &imageString)
	Sets the BalloonTooltipImage Created in NX8.5.0.

void	SetBalloonTooltipImage (const char *imageString)
	Sets the BalloonTooltipImage Created in NX8.5.0.

void	SetBalloonTooltipLayoutAsString (const NXString &enumString)
	Sets the BalloonTooltipLayout as string Created in NX8.5.0.

void	SetBalloonTooltipLayoutAsString (const char *enumString)
	Sets the BalloonTooltipLayout as string Created in NX8.5.0.

void	SetBalloonTooltipText (const NXString &balloonTooltipText)
	Sets the BalloonTooltipText Created in NX8.5.0.

void	SetBalloonTooltipText (const char *balloonTooltipText)
	Sets the BalloonTooltipText Created in NX8.5.0.

void	SetExpressionObject (NXOpen::TaggedObject *expressionObj)
	Sets the ExpressionObject Created in NX8.5.0.

void	SetFormula (const NXString &formula)
	Sets the Formula Created in NX8.5.0.

void	SetFormula (const char *formula)
	Sets the Formula Created in NX8.5.0.

void	SetLineIncrement (double lineIncrement)
	Sets the LineIncrement value.

void	SetLocationOptionAsString (const NXString &enumString)
	Sets the LocationOption as string Created in NX8.5.0.

void	SetLocationOptionAsString (const char *enumString)
	Sets the LocationOption as string Created in NX8.5.0.

void	SetMaximumValue (double maxValue)
	Sets the MaximumValue Created in NX8.5.0.

void	SetMaxInclusive (bool maxInclusive)
	Sets the MaxInclusive Created in NX8.5.0.

void	SetMinimumValue (double minValue)
	Sets the MinimumValue Created in NX8.5.0.

void	SetMinInclusive (bool minInclusive)
	Sets the MinInclusive Created in NX8.5.0.

void	SetOptionMask (int maskVal)
	Sets the OptionMask Created in NX8.5.0.

void	SetOptionMenuTitle (const NXString &menuTitleText)
	Sets the OptionMenuTitle Created in NX8.5.0.

void	SetOptionMenuTitle (const char *menuTitleText)
	Sets the OptionMenuTitle Created in NX8.5.0.

void	SetPageIncrement (double pageIncrement)
	Sets the PageIncrement value.

void	SetPath (NXOpen::TaggedObject *path)
	Sets the Path Created in NX8.5.0.

void	SetShowFocusHandle (bool showFocus)
	Sets the ShowFocusHandle Created in NX8.5.0.

void	SetSnapPointTypesOnByDefault (int pointType)
	Sets the SnapPointTypesOnByDefault

void	SetUnits (NXOpen::TaggedObject *units)
	Sets the Units Created in NX8.5.0.

void	SetValue (double dimensionValue)
	Sets the Value.

void	SetWithScale (bool withScale)
	Sets the WithScale.

bool	ShowFocusHandle ()
	Returns the ShowFocusHandle Created in NX8.5.0.

int	SnapPointTypesOnByDefault ()
	Returns the SnapPointTypesOnByDefault

NXOpen::TaggedObject *	Units ()
	Returns the Units Created in NX8.5.0.

double	Value ()
	Returns the Value.

bool	WithScale ()
	Returns the WithScale.

Public Member Functions inherited from NXOpen::BlockStyler::UIBlock
bool	Enable ()
	Returns the Enable.

bool	Expanded ()
	Returns the Expanded Created in NX8.5.0.

void	Focus ()
	Focuses on the block.

NXOpen::BlockStyler::PropertyList *	GetProperties ()
	Returns the properties of the block.

bool	Group ()
	Returns the Group Created in NX8.5.0.

NXString	Label ()
	Returns the Label Created in NX8.5.0.

NXString	Name ()
	Returns the name of the block or BlockID Created in NX6.0.0.

void	SetEnable (bool enable)
	Sets the Enable.

void	SetExpanded (bool expanded)
	Sets the Expanded Created in NX8.5.0.

void	SetGroup (bool group)
	Sets the Group Created in NX8.5.0.

void	SetLabel (const NXString &label)
	Sets the Label Created in NX8.5.0.

void	SetLabel (const char *label)
	Sets the Label Created in NX8.5.0.

void	SetShow (bool show)
	Sets the Visibility of block.

bool	Show ()
	Returns the Visibility of block.

NXString	Type ()
	Returns the type of block Created in NX6.0.0.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

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

scaleLimits scale limits

void NXOpen::BlockStyler::OnPathDimension::SetBalloonTooltipImage ( const NXString & imageString )

Sets the BalloonTooltipImage
Created in NX8.5.0.

License requirements : None

Parameters

imageString image string

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

Sets the BalloonTooltipImage
Created in NX8.5.0.

License requirements : None

Parameters

imageString image string

void NXOpen::BlockStyler::OnPathDimension::SetBalloonTooltipLayoutAsString ( const NXString & enumString )

Sets the BalloonTooltipLayout as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString enumstring

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

Sets the BalloonTooltipLayout as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString enumstring

void NXOpen::BlockStyler::OnPathDimension::SetBalloonTooltipText ( const NXString & balloonTooltipText )

Sets the BalloonTooltipText
Created in NX8.5.0.

License requirements : None

Parameters

balloonTooltipText balloon tooltip text

void NXOpen::BlockStyler::OnPathDimension::SetBalloonTooltipText ( const char * balloonTooltipText )

Sets the BalloonTooltipText
Created in NX8.5.0.

License requirements : None

Parameters

balloonTooltipText balloon tooltip text

void NXOpen::BlockStyler::OnPathDimension::SetExpressionObject ( NXOpen::TaggedObject * expressionObj )

Sets the ExpressionObject
Created in NX8.5.0.

License requirements : None

Parameters

expressionObj expression obj

void NXOpen::BlockStyler::OnPathDimension::SetFormula ( const NXString & formula )

Sets the Formula
Created in NX8.5.0.

License requirements : None

Parameters

formula formula

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

Sets the Formula
Created in NX8.5.0.

License requirements : None

Parameters

formula formula

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

lineIncrement line increment

void NXOpen::BlockStyler::OnPathDimension::SetLocationOptionAsString ( const NXString & enumString )

Sets the LocationOption as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString enumstring

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

Sets the LocationOption as string
Created in NX8.5.0.

License requirements : None

Parameters

enumString enumstring

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

Sets the MaximumValue
Created in NX8.5.0.

License requirements : None

Parameters

maxValue max value

void NXOpen::BlockStyler::OnPathDimension::SetMaxInclusive ( bool maxInclusive )

Sets the MaxInclusive
Created in NX8.5.0.

License requirements : None

Parameters

maxInclusive max inclusive

void NXOpen::BlockStyler::OnPathDimension::SetMinimumValue ( double minValue )

Sets the MinimumValue
Created in NX8.5.0.

License requirements : None

Parameters

minValue min value

void NXOpen::BlockStyler::OnPathDimension::SetMinInclusive ( bool minInclusive )

Sets the MinInclusive
Created in NX8.5.0.

License requirements : None

Parameters

minInclusive min inclusive

void NXOpen::BlockStyler::OnPathDimension::SetOptionMask ( int maskVal )

Sets the OptionMask
Created in NX8.5.0.

License requirements : None

Parameters

maskVal maskval

void NXOpen::BlockStyler::OnPathDimension::SetOptionMenuTitle ( const NXString & menuTitleText )

Sets the OptionMenuTitle
Created in NX8.5.0.

License requirements : None

Parameters

menuTitleText menutitletext

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

Sets the OptionMenuTitle
Created in NX8.5.0.

License requirements : None

Parameters

menuTitleText menutitletext

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

pageIncrement page increment

void NXOpen::BlockStyler::OnPathDimension::SetPath ( NXOpen::TaggedObject * path )

Sets the Path
Created in NX8.5.0.

License requirements : None

Parameters

path path

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

Sets the ShowFocusHandle
Created in NX8.5.0.

License requirements : None

Parameters

showFocus show 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

pointType point type

void NXOpen::BlockStyler::OnPathDimension::SetUnits ( NXOpen::TaggedObject * units )

Sets the Units
Created in NX8.5.0.

License requirements : None

Parameters

units units

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

Sets the Value.

Created in NX8.5.0.

License requirements : None

Parameters

dimensionValue dimension 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

withScale with 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:

BlockStyler_OnPathDimension.hxx

Public Member Functions

Detailed Description

Member Function Documentation