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:

Public Member Functions
NXOpen::DisplayableObject *	Cell ()
	Returns the tabular note cell corresponding to this title block cell Created in NX10.0.2. More...
NXString	EditableText ()
	Returns the editable text of the cell Created in NX8.0.0. More...
void	EditCell (bool lockStatus, int contentType, const NXString &value, const NXString &label, bool canChangeLockStatus)
	Edits the title block cell attributes such as lock status, content type, value, label etc. More...
void	EditCell (bool lockStatus, int contentType, const char *value, const char *label, bool canChangeLockStatus)
	Edits the title block cell attributes such as lock status, content type, value, label etc. 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...
NXString	Text ()
	Returns the evaluated text of the cell. 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

NXOpen::DisplayableObject* NXOpen::Annotations::TitleBlockCellBuilder::Cell

(

)

Returns the tabular note cell corresponding to this title block cell
Created in NX10.0.2.

License requirements : None

NXString NXOpen::Annotations::TitleBlockCellBuilder::EditableText

(

)

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

License requirements : None

void NXOpen::Annotations::TitleBlockCellBuilder::EditCell	(	bool	lockStatus,
		int	contentType,
		const NXString &	value,
		const NXString &	label,
		bool	canChangeLockStatus
	)

Edits the title block cell attributes such as lock status, content type, value, label etc.

Created in NX10.0.2.

License requirements : drafting ("DRAFTING")

Parameters

lockStatus	cell lock status
contentType	cell content type
value	cell value
label	cell label
canChangeLockStatus	can change lock status of cell

void NXOpen::Annotations::TitleBlockCellBuilder::EditCell	(	bool	lockStatus,
		int	contentType,
		const char *	value,
		const char *	label,
		bool	canChangeLockStatus
	)

Edits the title block cell attributes such as lock status, content type, value, label etc.

Created in NX10.0.2.

License requirements : drafting ("DRAFTING")

Parameters

lockStatus	cell lock status
contentType	cell content type
value	cell value
label	cell label
canChangeLockStatus	can change lock status of cell

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

text

text

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

text

text

void NXOpen::Annotations::TitleBlockCellBuilder::SetLabel

(

const NXString &

label

)

Sets the cell label
Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

label

label

void NXOpen::Annotations::TitleBlockCellBuilder::SetLabel

(

const char *

label

)

Sets the cell label
Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

label

label

void NXOpen::Annotations::TitleBlockCellBuilder::SetLock

(

bool

lockStatus

)

Sets the lock status
Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

lockStatus

lockstatus

NXString NXOpen::Annotations::TitleBlockCellBuilder::Text

(

)

Returns the evaluated text of the cell.

If the cell cannot be evaluated then its raw text is returned.
Created in NX10.0.2.

License requirements : None

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:

• Annotations_TitleBlockCellBuilder.hxx