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

Represents a NXOpen::Drawings::ViewCommonViewLabelBuilder. More...

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

Public Types

enum  SecondaryAlignmentType { SecondaryAlignmentTypeInline, SecondaryAlignmentTypeSubscript }
 secondary Alignment Type More...
 
enum  SecondaryIndexingType { SecondaryIndexingTypeAlphabetic, SecondaryIndexingTypeNumeric }
 secondary Indexing Type More...
 

Public Member Functions

NXString Letter ()
 Returns the letter
Created in NX9.0.0. More...
 
NXOpen::Drawings::ViewCommonViewLabelBuilder::SecondaryAlignmentType SecondaryAlignment ()
 Returns the secondary alignment
Created in NX9.0.0. More...
 
NXOpen::Drawings::ViewCommonViewLabelBuilder::SecondaryIndexingType SecondaryIndexing ()
 Returns the secondary indexing
Created in NX9.0.0. More...
 
void SetLetter (const NXString &letter)
 Sets the letter
Created in NX9.0.0. More...
 
void SetLetter (const char *letter)
 Sets the letter
Created in NX9.0.0. More...
 
void SetSecondaryAlignment (NXOpen::Drawings::ViewCommonViewLabelBuilder::SecondaryAlignmentType secondaryAlignment)
 Sets the secondary alignment
Created in NX9.0.0. More...
 
void SetSecondaryIndexing (NXOpen::Drawings::ViewCommonViewLabelBuilder::SecondaryIndexingType secondaryIndexing)
 Sets the secondary indexing
Created in NX9.0.0. More...
 
void SetSubscriptSizeFactor (double subscriptSizeFactor)
 Sets the subscript size factor
Created in NX9.0.0. More...
 
double SubscriptSizeFactor ()
 Returns the subscript size factor
Created in NX9.0.0. 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 a NXOpen::Drawings::ViewCommonViewLabelBuilder.


Created in NX9.0.0.

Member Enumeration Documentation

secondary Alignment Type

Enumerator
SecondaryAlignmentTypeInline 

inline

SecondaryAlignmentTypeSubscript 

subscript

secondary Indexing Type

Enumerator
SecondaryIndexingTypeAlphabetic 

alphabetic

SecondaryIndexingTypeNumeric 

numeric

Member Function Documentation

NXString NXOpen::Drawings::ViewCommonViewLabelBuilder::Letter ( )

Returns the letter
Created in NX9.0.0.



License requirements : None

NXOpen::Drawings::ViewCommonViewLabelBuilder::SecondaryAlignmentType NXOpen::Drawings::ViewCommonViewLabelBuilder::SecondaryAlignment ( )

Returns the secondary alignment
Created in NX9.0.0.



License requirements : None

NXOpen::Drawings::ViewCommonViewLabelBuilder::SecondaryIndexingType NXOpen::Drawings::ViewCommonViewLabelBuilder::SecondaryIndexing ( )

Returns the secondary indexing
Created in NX9.0.0.



License requirements : None

void NXOpen::Drawings::ViewCommonViewLabelBuilder::SetLetter ( const NXString letter)

Sets the letter
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
letterletter
void NXOpen::Drawings::ViewCommonViewLabelBuilder::SetLetter ( const char *  letter)

Sets the letter
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
letterletter
void NXOpen::Drawings::ViewCommonViewLabelBuilder::SetSecondaryAlignment ( NXOpen::Drawings::ViewCommonViewLabelBuilder::SecondaryAlignmentType  secondaryAlignment)

Sets the secondary alignment
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
secondaryAlignmentsecondaryalignment
void NXOpen::Drawings::ViewCommonViewLabelBuilder::SetSecondaryIndexing ( NXOpen::Drawings::ViewCommonViewLabelBuilder::SecondaryIndexingType  secondaryIndexing)

Sets the secondary indexing
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
secondaryIndexingsecondaryindexing
void NXOpen::Drawings::ViewCommonViewLabelBuilder::SetSubscriptSizeFactor ( double  subscriptSizeFactor)

Sets the subscript size factor
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
subscriptSizeFactorsubscriptsizefactor
double NXOpen::Drawings::ViewCommonViewLabelBuilder::SubscriptSizeFactor ( )

Returns the subscript size factor
Created in NX9.0.0.



License requirements : None

virtual bool NXOpen::Drawings::ViewCommonViewLabelBuilder::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.