NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Annotations::MasterSymbolListItemBuilder Class Reference

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

Created in NX7.5.0. More...

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

List of all members.

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 Annotations::MasterSymbolListItemBuilder::TextTypesReal
Created in NX7.5.0.
double DoubleMax ()
 Returns the double max, this property is valid if text type is Annotations::MasterSymbolListItemBuilder::TextTypesReal
Created in NX7.5.0.
double DoubleMin ()
 Returns the double min, this property is valid if text type is Annotations::MasterSymbolListItemBuilder::TextTypesReal
Created in NX7.5.0.
std::vector< NXStringGetMultilineString ()
 Returns the multiple notes for a given Text Type.
int IntegerDefault ()
 Returns the integer default, this property is valid if text type is Annotations::MasterSymbolListItemBuilder::TextTypesInteger
Created in NX7.5.0.
int IntegerMax ()
 Returns the integer max ,this property is valid if text type is Annotations::MasterSymbolListItemBuilder::TextTypesInteger
Created in NX7.5.0.
int IntegerMin ()
 Returns the integer min , this property is valid if text type is Annotations::MasterSymbolListItemBuilder::TextTypesInteger
Created in NX7.5.0.
NXString NoteText ()
 Returns the note text
Created in NX7.5.0.
NXString NoteTitle ()
 Returns the note title
Created in NX7.5.0.
NXString Rule ()
 Returns the note rule
Created in NX8.0.0.
void SetDoubleDefault (double doubleDefault)
 Sets the double default, this property is valid if text type is Annotations::MasterSymbolListItemBuilder::TextTypesReal
Created in NX7.5.0.
void SetDoubleMax (double doubleMax)
 Sets the double max, this property is valid if text type is Annotations::MasterSymbolListItemBuilder::TextTypesReal
Created in NX7.5.0.
void SetDoubleMin (double doubleMin)
 Sets the double min, this property is valid if text type is Annotations::MasterSymbolListItemBuilder::TextTypesReal
Created in NX7.5.0.
void SetIntegerDefault (int integerDefault)
 Sets the integer default, this property is valid if text type is Annotations::MasterSymbolListItemBuilder::TextTypesInteger
Created in NX7.5.0.
void SetIntegerMax (int integerMax)
 Sets the integer max ,this property is valid if text type is Annotations::MasterSymbolListItemBuilder::TextTypesInteger
Created in NX7.5.0.
void SetIntegerMin (int integerMin)
 Sets the integer min , this property is valid if text type is Annotations::MasterSymbolListItemBuilder::TextTypesInteger
Created in NX7.5.0.
void SetMultilineString (const std::vector< NXString > &multilineString)
 Sets the multiple notes for the given Text Type
Created in NX7.5.0.
void SetNoteText (const NXString &noteText)
 Sets the note text
Created in NX7.5.0.
void SetNoteTitle (const NXString &noteTitle)
 Sets the note title
Created in NX7.5.0.
void SetRule (const NXString &rule)
 Sets the note rule
Created in NX8.0.0.
void SetTextType (NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypes textType)
 Sets the text type
Created in NX7.5.0.
NXOpen::Annotations::MasterSymbolListItemBuilder::TextTypes TextType ()
 Returns the text type
Created in NX7.5.0.
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.

Detailed Description

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

Created in NX7.5.0.



Member Enumeration Documentation

The Enum for Text Types.

Enumerator:
TextTypesMandatory 

mandatory

TextTypesArbitrary 

arbitrary

TextTypesControlled 

controlled

TextTypesPartiallyControlled 

partially controlled

TextTypesInteger 

integer

TextTypesReal 

real

TextTypesRule 

rule


Member Function Documentation

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



License requirements : None

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



License requirements : None

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



License requirements : None

Returns the multiple notes for a given Text Type.

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

Returns:

Created in NX7.5.0.

License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

Returns the note text
Created in NX7.5.0.



License requirements : None

Returns the note title
Created in NX7.5.0.



License requirements : None

Returns the note rule
Created in NX8.0.0.



License requirements : None

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



License requirements : drafting ("DRAFTING")

Parameters:
doubleDefaultdoubledefault

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



License requirements : drafting ("DRAFTING")

Parameters:
doubleMaxdoublemax

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



License requirements : drafting ("DRAFTING")

Parameters:
doubleMindoublemin

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



License requirements : drafting ("DRAFTING")

Parameters:
integerDefaultintegerdefault

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



License requirements : drafting ("DRAFTING")

Parameters:
integerMaxintegermax

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



License requirements : drafting ("DRAFTING")

Parameters:
integerMinintegermin
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:
multilineStringarray of notes

Sets the note text
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
noteTextnotetext

Sets the note title
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
noteTitlenotetitle

Sets the note rule
Created in NX8.0.0.



License requirements : nx_drafting_plus ("Drafting Plus")

Parameters:
rulerule

Sets the text type
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
textTypetexttype

Returns the text type
Created in NX7.5.0.



License requirements : None

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 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.