NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Drawings::ViewStyleFPCalloutConfigBuilder Class Reference

Represents the Callout section of the Flat Pattern tab on the View Style Dialog (Drawings.ViewStyleFPCalloutsBuilder) More...

Inheritance diagram for NXOpen::Drawings::ViewStyleFPCalloutConfigBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  OrientationType { OrientationTypeLeadered, OrientationTypeAligned }
 This enum represents orientation types for the flat pattern callouts. More...
 

Public Member Functions

std::vector< NXStringGetContents (const NXString &calloutType)
 Returns the contents for a Flat Pattern callout type. More...
 
std::vector< NXStringGetContents (const char *calloutType)
 Returns the contents for a Flat Pattern callout type. More...
 
NXOpen::Drawings::ViewStyleFPCalloutConfigBuilder::OrientationType GetOrientationType ()
 Returns the orientation type for flat pattern callouts. More...
 
void SetContents (const NXString &calloutType, std::vector< NXString > &contents)
 Sets the contents for a Flat Pattern callout type
Created in NX9.0.0. More...
 
void SetContents (const char *calloutType, std::vector< NXString > &contents)
 Sets the contents for a Flat Pattern callout type
Created in NX9.0.0. More...
 
void SetOrientationType (NXOpen::Drawings::ViewStyleFPCalloutConfigBuilder::OrientationType orientation)
 Sets the orientation type for flat pattern callouts. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents the Callout section of the Flat Pattern tab on the View Style Dialog (Drawings.ViewStyleFPCalloutsBuilder)


Created in NX9.0.0.

Member Enumeration Documentation

This enum represents orientation types for the flat pattern callouts.

Enumerator
OrientationTypeLeadered 

Leadered.

OrientationTypeAligned 

Aligned.

Member Function Documentation

std::vector<NXString> NXOpen::Drawings::ViewStyleFPCalloutConfigBuilder::GetContents ( const NXString calloutType)

Returns the contents for a Flat Pattern callout type.

Returns
The contents for the callout type.
Created in NX9.0.0.

License requirements : None
Parameters
calloutTypeThe name of the callout for which to get the content.
std::vector<NXString> NXOpen::Drawings::ViewStyleFPCalloutConfigBuilder::GetContents ( const char *  calloutType)

Returns the contents for a Flat Pattern callout type.

Returns
The contents for the callout type.
Created in NX9.0.0.

License requirements : None
Parameters
calloutTypeThe name of the callout for which to get the content.
NXOpen::Drawings::ViewStyleFPCalloutConfigBuilder::OrientationType NXOpen::Drawings::ViewStyleFPCalloutConfigBuilder::GetOrientationType ( )

Returns the orientation type for flat pattern callouts.

Returns
The orientation type for the flat pattern callouts.
Created in NX9.0.0.

License requirements : None
void NXOpen::Drawings::ViewStyleFPCalloutConfigBuilder::SetContents ( const NXString calloutType,
std::vector< NXString > &  contents 
)

Sets the contents for a Flat Pattern callout type
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
calloutTypeThe name of the callout for which to set the content.
contentsThe contents for the callout type.
void NXOpen::Drawings::ViewStyleFPCalloutConfigBuilder::SetContents ( const char *  calloutType,
std::vector< NXString > &  contents 
)

Sets the contents for a Flat Pattern callout type
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
calloutTypeThe name of the callout for which to set the content.
contentsThe contents for the callout type.
void NXOpen::Drawings::ViewStyleFPCalloutConfigBuilder::SetOrientationType ( NXOpen::Drawings::ViewStyleFPCalloutConfigBuilder::OrientationType  orientation)

Sets the orientation type for flat pattern callouts.


Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters
orientationThe orientation type for the flat pattern callouts.
virtual bool NXOpen::Drawings::ViewStyleFPCalloutConfigBuilder::Validate ( )
virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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