Represents a NXOpen::Annotations::MasterSymbolListItemBuilder
To create a new instance of this class, use NXOpen::Annotations::CustomSymbolCollection::CreateMasterSymbolListItemBuilder

Created in NX7.5.0. More...

Inheritance diagram for NXOpen::Annotations::MasterSymbolListItemBuilder:

Public Types
enum	TextTypes { TextTypesMandatory, TextTypesArbitrary, TextTypesControlled, TextTypesPartiallyControlled, TextTypesInteger, TextTypesReal, TextTypesRule }
	The Enum for Text Types. More...

Public Member Functions
double	DoubleDefault ()
	Returns the double default, this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesReal Created in NX7.5.0. More...

double	DoubleMax ()
	Returns the double max, this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesReal Created in NX7.5.0. More...

double	DoubleMin ()
	Returns the double min, this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesReal Created in NX7.5.0. More...

std::vector< NXString >	GetMultilineString ()
	Returns the multiple notes for a given Text Type. More...

int	IntegerDefault ()
	Returns the integer default, this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesInteger Created in NX7.5.0. More...

int	IntegerMax ()
	Returns the integer max ,this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesInteger Created in NX7.5.0. More...

int	IntegerMin ()
	Returns the integer min , this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesInteger Created in NX7.5.0. More...

NXString	NoteText ()
	Returns the first line of note text Created in NX7.5.0. More...

NXString	NoteTitle ()
	Returns the note title Created in NX7.5.0. More...

NXString	Rule ()
	Returns the note rule Created in NX8.0.0. More...

void	SetDoubleDefault (double doubleDefault)
	Sets the double default, this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesReal Created in NX7.5.0. More...

void	SetDoubleMax (double doubleMax)
	Sets the double max, this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesReal Created in NX7.5.0. More...

void	SetDoubleMin (double doubleMin)
	Sets the double min, this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesReal Created in NX7.5.0. More...

void	SetIntegerDefault (int integerDefault)
	Sets the integer default, this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesInteger Created in NX7.5.0. More...

void	SetIntegerMax (int integerMax)
	Sets the integer max ,this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesInteger Created in NX7.5.0. More...

void	SetIntegerMin (int integerMin)
	Sets the integer min , this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesInteger Created in NX7.5.0. More...

void	SetMultilineString (const std::vector< NXString > &multilineString)
	Sets the multiple notes for the given Text Type Created in NX7.5.0. More...

void	SetNoteText (const NXString &noteText)
	Sets the first line of note text Created in NX7.5.0. More...

void	SetNoteText (const char *noteText)
	Sets the first line of note text Created in NX7.5.0. More...

void	SetNoteTitle (const NXString &noteTitle)
	Sets the note title Created in NX7.5.0. More...

void	SetNoteTitle (const char *noteTitle)
	Sets the note title Created in NX7.5.0. More...

void	SetRule (const NXString &rule)
	Sets the note rule Created in NX8.0.0. More...

void	SetRule (const char *rule)
	Sets the note rule Created in NX8.0.0. More...

void	SetTextType (NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypes textType)
	Sets the text type Created in NX7.5.0. More...

NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypes	TextType ()
	Returns the text type Created in NX7.5.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::MasterSymbolListItemBuilder
To create a new instance of this class, use NXOpen::Annotations::CustomSymbolCollection::CreateMasterSymbolListItemBuilder

Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypes

The Enum for Text Types.

Enumerator
TextTypesMandatory	mandatory
TextTypesArbitrary	arbitrary
TextTypesControlled	controlled
TextTypesPartiallyControlled	partially controlled
TextTypesInteger	integer
TextTypesReal	real
TextTypesRule	rule

Member Function Documentation

double NXOpen::Annotations::MasterSymbolListItemBuilder::DoubleDefault ( )

Returns the double default, this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesReal
Created in NX7.5.0.

License requirements : None

double NXOpen::Annotations::MasterSymbolListItemBuilder::DoubleMax ( )

Returns the double max, this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesReal
Created in NX7.5.0.

License requirements : None

double NXOpen::Annotations::MasterSymbolListItemBuilder::DoubleMin ( )

Returns the double min, this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesReal
Created in NX7.5.0.

License requirements : None

std::vector<NXString> NXOpen::Annotations::MasterSymbolListItemBuilder::GetMultilineString ( )

Returns the multiple notes for a given Text Type.

this property is valid for NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesArbitrary , NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesControlled , NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesPartiallyControlled

Returns: Created in NX7.5.0.

License requirements : None

int NXOpen::Annotations::MasterSymbolListItemBuilder::IntegerDefault ( )

Returns the integer default, this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesInteger
Created in NX7.5.0.

License requirements : None

int NXOpen::Annotations::MasterSymbolListItemBuilder::IntegerMax ( )

Returns the integer max ,this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesInteger
Created in NX7.5.0.

License requirements : None

int NXOpen::Annotations::MasterSymbolListItemBuilder::IntegerMin ( )

Returns the integer min , this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesInteger
Created in NX7.5.0.

License requirements : None

NXString NXOpen::Annotations::MasterSymbolListItemBuilder::NoteText ( )

Returns the first line of note text
Created in NX7.5.0.

License requirements : None

NXString NXOpen::Annotations::MasterSymbolListItemBuilder::NoteTitle ( )

Returns the note title
Created in NX7.5.0.

License requirements : None

NXString NXOpen::Annotations::MasterSymbolListItemBuilder::Rule ( )

Returns the note rule
Created in NX8.0.0.

License requirements : None

void NXOpen::Annotations::MasterSymbolListItemBuilder::SetDoubleDefault ( double doubleDefault )

Sets the double default, this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesReal
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

doubleDefault doubledefault

void NXOpen::Annotations::MasterSymbolListItemBuilder::SetDoubleMax ( double doubleMax )

Sets the double max, this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesReal
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

doubleMax doublemax

void NXOpen::Annotations::MasterSymbolListItemBuilder::SetDoubleMin ( double doubleMin )

Sets the double min, this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesReal
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

doubleMin doublemin

void NXOpen::Annotations::MasterSymbolListItemBuilder::SetIntegerDefault ( int integerDefault )

Sets the integer default, this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesInteger
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

integerDefault integerdefault

void NXOpen::Annotations::MasterSymbolListItemBuilder::SetIntegerMax ( int integerMax )

Sets the integer max ,this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesInteger
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

integerMax integermax

void NXOpen::Annotations::MasterSymbolListItemBuilder::SetIntegerMin ( int integerMin )

Sets the integer min , this property is valid if text type is NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypesInteger
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

integerMin integermin

void NXOpen::Annotations::MasterSymbolListItemBuilder::SetMultilineString ( const std::vector< NXString > & multilineString )

Sets the multiple notes for the given Text Type
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

multilineString array of notes

void NXOpen::Annotations::MasterSymbolListItemBuilder::SetNoteText ( const NXString & noteText )

Sets the first line of note text
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

noteText notetext

void NXOpen::Annotations::MasterSymbolListItemBuilder::SetNoteText ( const char * noteText )

Sets the first line of note text
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

noteText notetext

void NXOpen::Annotations::MasterSymbolListItemBuilder::SetNoteTitle ( const NXString & noteTitle )

Sets the note title
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

noteTitle notetitle

void NXOpen::Annotations::MasterSymbolListItemBuilder::SetNoteTitle ( const char * noteTitle )

Sets the note title
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

noteTitle notetitle

void NXOpen::Annotations::MasterSymbolListItemBuilder::SetRule ( const NXString & rule )

Sets the note rule
Created in NX8.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

rule rule

void NXOpen::Annotations::MasterSymbolListItemBuilder::SetRule ( const char * rule )

Sets the note rule
Created in NX8.0.0.

License requirements : nx_layout ("NX Layout")

Parameters

rule rule

void NXOpen::Annotations::MasterSymbolListItemBuilder::SetTextType ( NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypes textType )

Sets the text type
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

textType texttype

NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypes NXOpen::Annotations::MasterSymbolListItemBuilder::TextType ( )

Returns the text type
Created in NX7.5.0.

License requirements : None

virtual bool NXOpen::Annotations::MasterSymbolListItemBuilder::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_MasterSymbolListItemBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation