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

Represents a NXOpen::Annotations::TitleBlockCellBuilder
To create a new instance of this class, use NXOpen::Annotations::TitleBlockCollection::CreateCellBuilder

Created in NX8.0.0. More...

Inheritance diagram for NXOpen::Annotations::TitleBlockCellBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXString EditableText ()
 Returns the editable text of the cell
Created in NX8.0.0. More...
 
NXString Label ()
 Returns the cell label
Created in NX8.0.0. More...
 
bool Lock ()
 Returns the lock status
Created in NX8.0.0. More...
 
void SetEditableText (const NXString &text)
 Sets the editable text of the cell
Created in NX8.0.0. More...
 
void SetEditableText (const char *text)
 Sets the editable text of the cell
Created in NX8.0.0. More...
 
void SetLabel (const NXString &label)
 Sets the cell label
Created in NX8.0.0. More...
 
void SetLabel (const char *label)
 Sets the cell label
Created in NX8.0.0. More...
 
void SetLock (bool lockStatus)
 Sets the lock status
Created in NX8.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::Annotations::TitleBlockCellBuilder
To create a new instance of this class, use NXOpen::Annotations::TitleBlockCollection::CreateCellBuilder

Created in NX8.0.0.


Member Function Documentation

NXString NXOpen::Annotations::TitleBlockCellBuilder::EditableText ( )

Returns the editable text of the cell
Created in NX8.0.0.



License requirements : None

NXString NXOpen::Annotations::TitleBlockCellBuilder::Label ( )

Returns the cell label
Created in NX8.0.0.



License requirements : None

bool NXOpen::Annotations::TitleBlockCellBuilder::Lock ( )

Returns the lock status
Created in NX8.0.0.



License requirements : None

void NXOpen::Annotations::TitleBlockCellBuilder::SetEditableText ( const NXString text)

Sets the editable text of the cell
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters
texttext
void NXOpen::Annotations::TitleBlockCellBuilder::SetEditableText ( const char *  text)

Sets the editable text of the cell
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters
texttext
void NXOpen::Annotations::TitleBlockCellBuilder::SetLabel ( const NXString label)

Sets the cell label
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters
labellabel
void NXOpen::Annotations::TitleBlockCellBuilder::SetLabel ( const char *  label)

Sets the cell label
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters
labellabel
void NXOpen::Annotations::TitleBlockCellBuilder::SetLock ( bool  lockStatus)

Sets the lock status
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters
lockStatuslockstatus
virtual bool NXOpen::Annotations::TitleBlockCellBuilder::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 2012 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.