This builder allows you to define one parameter for a symbol
To create a new instance of this class, use NXOpen::Annotations::SymbolCatalogBuilder::NewParameter
Created in NX8.0.0.
More...
Public Member Functions | |
| NXString | Label () |
| Returns the label string of the parameter, NOTE: Client must free the returned char* with SM_free. More... | |
| NXString | LogicalName () |
| Returns the logical name of the parameter, NOTE: Client must free the returned char* with SM_free. More... | |
| void | SetLabel (const NXString &label) |
| Sets the label string of the parameter, NOTE: Client must free the returned char* with SM_free. More... | |
| void | SetLabel (const char *label) |
| Sets the label string of the parameter, NOTE: Client must free the returned char* with SM_free. More... | |
| void | SetLogicalName (const NXString &name) |
| Sets the logical name of the parameter, NOTE: Client must free the returned char* with SM_free. More... | |
| void | SetLogicalName (const char *name) |
| Sets the logical name of the parameter, NOTE: Client must free the returned char* with SM_free. More... | |
| void | SetValue (const NXString ¶Value) |
| Sets the value string of the parameter, NOTE: Client must free the returned char* with SM_free. More... | |
| void | SetValue (const char *paraValue) |
| Sets the value string of the parameter, NOTE: Client must free the returned char* with SM_free. More... | |
| NXString | Value () |
| Returns the value string of the parameter, NOTE: Client must free the returned char* with SM_free. More... | |
 Public Member Functions inherited from NXOpen::Builder | |
| NXOpen::NXObject * | Commit () |
| Commits any edits that have been applied to the builder. More... | |
| void | Destroy () |
| Deletes the builder, and cleans up any objects created by the builder. More... | |
| std::vector< NXOpen::NXObject * > | GetCommittedObjects () |
| For builders that create more than one object, this method returns the objects that are created by commit. More... | |
| NXOpen::NXObject * | GetObject () |
| Returns the object currently being edited by this builder. More... | |
| void | ShowResults () |
| Updates the model to reflect the result of an edit to the model for all builders that support showing results. 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
This builder allows you to define one parameter for a symbol
To create a new instance of this class, use NXOpen::Annotations::SymbolCatalogBuilder::NewParameter
Created in NX8.0.0.
Member Function Documentation
| NXString NXOpen::Annotations::SymbolCatalogParameterBuilder::Label | ( | ) |
Returns the label string of the parameter, NOTE: Client must free the returned char* with SM_free.
Created in NX8.0.0.
License requirements : None
| NXString NXOpen::Annotations::SymbolCatalogParameterBuilder::LogicalName | ( | ) |
Returns the logical name of the parameter, NOTE: Client must free the returned char* with SM_free.
Created in NX8.0.0.
License requirements : None
| void NXOpen::Annotations::SymbolCatalogParameterBuilder::SetLabel | ( | const NXString & | label | ) |
Sets the label string of the parameter, NOTE: Client must free the returned char* with SM_free.
Created in NX8.0.0.
License requirements : nx_layout ("NX Layout")
- Parameters
-
label label
| void NXOpen::Annotations::SymbolCatalogParameterBuilder::SetLabel | ( | const char * | label | ) |
Sets the label string of the parameter, NOTE: Client must free the returned char* with SM_free.
Created in NX8.0.0.
License requirements : nx_layout ("NX Layout")
- Parameters
-
label label
| void NXOpen::Annotations::SymbolCatalogParameterBuilder::SetLogicalName | ( | const NXString & | name | ) |
Sets the logical name of the parameter, NOTE: Client must free the returned char* with SM_free.
Created in NX8.0.0.
License requirements : nx_layout ("NX Layout")
- Parameters
-
name name
| void NXOpen::Annotations::SymbolCatalogParameterBuilder::SetLogicalName | ( | const char * | name | ) |
Sets the logical name of the parameter, NOTE: Client must free the returned char* with SM_free.
Created in NX8.0.0.
License requirements : nx_layout ("NX Layout")
- Parameters
-
name name
| void NXOpen::Annotations::SymbolCatalogParameterBuilder::SetValue | ( | const NXString & | paraValue | ) |
Sets the value string of the parameter, NOTE: Client must free the returned char* with SM_free.
Created in NX8.0.0.
License requirements : nx_layout ("NX Layout")
- Parameters
-
paraValue paravalue
| void NXOpen::Annotations::SymbolCatalogParameterBuilder::SetValue | ( | const char * | paraValue | ) |
Sets the value string of the parameter, NOTE: Client must free the returned char* with SM_free.
Created in NX8.0.0.
License requirements : nx_layout ("NX Layout")
- Parameters
-
paraValue paravalue
| NXString NXOpen::Annotations::SymbolCatalogParameterBuilder::Value | ( | ) |
Returns the value string of the parameter, NOTE: Client must free the returned char* with SM_free.
Created in NX8.0.0.
License requirements : None
The documentation for this class was generated from the following file:
- Annotations_SymbolCatalogParameterBuilder.hxx