NX Open C++ Reference Guide
Public Member Functions
NXOpen::FileNew Class Reference

Represents a FileNew
This class is not directly created. More...

Inheritance diagram for NXOpen::FileNew:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Member Functions

NXOpen::FileNewApplication Application ()
 Returns the application type for the new file being created
Created in NX5.0.0.
bool GetAddMasterFlag ()
 Returns logical value to indicate whether master to be added as child component.
std::vector< NXStringGetAvailableTemplates ()
 Returns the available templates for the session.
bool MakeDisplayedPart ()
 Returns the property that controls if the new file should be made the displayed part
Created in NX5.0.0.
NXString MasterFileName ()
 Returns the name of the master model part to be referenced.
NXString NewFileName ()
 Returns the name of the new file being created
Created in NX5.0.0.
void SetAddMasterFlag (bool addMaster)
 Sets addMaster flag
Created in NX6.0.0.
void SetApplication (NXOpen::FileNewApplication application)
 Sets the application type for the new file being created
Created in NX5.0.0.
void SetMakeDisplayedPart (bool makeDisplayedPart)
 Sets the property that controls if the new file should be made the displayed part
Created in NX5.0.0.
void SetMasterFileName (const NXString &masterFileName)
 Sets the name of the master model part to be referenced.
void SetNewFileName (const NXString &fileName)
 Sets the name of the new file being created
Created in NX5.0.0.
void SetProjectsData (std::vector< NXString > &projectName, const std::vector< int > &assignmentState)
 Teamcenter projects data
Created in NX6.0.0.
void SetTemplateFileName (const NXString &templateFileName)
 Sets the name of the template part from which to create the new file
Created in NX5.0.0.
void SetTemplateType (NXOpen::FileNewTemplateType templateType)
 Sets the template type for the new file being created
Created in NX8.0.0.
void SetUnits (NXOpen::Part::Units units)
 Sets the units for the new file being created
Created in NX5.0.0.
void SetUseBlankTemplate (bool useBlankTemplate)
 Sets the property that controls if the new file should be created using a blank template.
NXString TemplateFileName ()
 Returns the name of the template part from which to create the new file
Created in NX5.0.0.
NXOpen::FileNewTemplateType TemplateType ()
 Returns the template type for the new file being created
Created in NX8.0.0.
NXOpen::Part::Units Units ()
 Returns the units for the new file being created
Created in NX5.0.0.
bool UseBlankTemplate ()
 Returns the property that controls if the new file should be created using a blank template.

Detailed Description

Represents a FileNew
This class is not directly created.

The creator of the super class does the real work

Created in NX5.0.0.


Member Function Documentation

Returns the application type for the new file being created
Created in NX5.0.0.



License requirements : None

Returns logical value to indicate whether master to be added as child component.

Returns:
whether master to be added as child component
Created in NX6.0.0.

License requirements : None

Returns the available templates for the session.

Returns:
array of available template names
Created in NX6.0.0.

License requirements : None

Returns the property that controls if the new file should be made the displayed part
Created in NX5.0.0.



License requirements : None

Returns the name of the master model part to be referenced.

May be NULL if creating a master part


Created in NX5.0.0.

License requirements : None

Returns the name of the new file being created
Created in NX5.0.0.



License requirements : None

void NXOpen::FileNew::SetAddMasterFlag ( bool  addMaster)

Sets addMaster flag
Created in NX6.0.0.



License requirements : None

Parameters:
addMasterwhether master to be added as child component

Sets the application type for the new file being created
Created in NX5.0.0.



License requirements : None

Parameters:
applicationapplication
void NXOpen::FileNew::SetMakeDisplayedPart ( bool  makeDisplayedPart)

Sets the property that controls if the new file should be made the displayed part
Created in NX5.0.0.



License requirements : None

Parameters:
makeDisplayedPartmake displayed part
void NXOpen::FileNew::SetMasterFileName ( const NXString masterFileName)

Sets the name of the master model part to be referenced.

May be NULL if creating a master part


Created in NX5.0.0.

License requirements : None

Parameters:
masterFileNamemasterfilename
void NXOpen::FileNew::SetNewFileName ( const NXString fileName)

Sets the name of the new file being created
Created in NX5.0.0.



License requirements : None

Parameters:
fileNamefilename
void NXOpen::FileNew::SetProjectsData ( std::vector< NXString > &  projectName,
const std::vector< int > &  assignmentState 
)

Teamcenter projects data
Created in NX6.0.0.



License requirements : None

Parameters:
projectNamename of the project
NOTE: The full Unicode character set is not supported for this parameter.
assignmentStateassignment state
void NXOpen::FileNew::SetTemplateFileName ( const NXString templateFileName)

Sets the name of the template part from which to create the new file
Created in NX5.0.0.



License requirements : None

Parameters:
templateFileNametemplatefilename

Sets the template type for the new file being created
Created in NX8.0.0.



License requirements : None

Parameters:
templateTypewhether master to be added as child component

Sets the units for the new file being created
Created in NX5.0.0.



License requirements : None

Parameters:
unitsunits
void NXOpen::FileNew::SetUseBlankTemplate ( bool  useBlankTemplate)

Sets the property that controls if the new file should be created using a blank template.

If set to False, then a valid file name for an existing template part file must be supplied to FileNew::SetTemplateFileName . If set to True, this means that no template is used during creation.


Created in NX5.0.0.

License requirements : None

Parameters:
useBlankTemplateuse blank template

Returns the name of the template part from which to create the new file
Created in NX5.0.0.



License requirements : None

Returns the template type for the new file being created
Created in NX8.0.0.



License requirements : None

Returns the units for the new file being created
Created in NX5.0.0.



License requirements : None

Returns the property that controls if the new file should be created using a blank template.

If set to False, then a valid file name for an existing template part file must be supplied to FileNew::SetTemplateFileName . If set to True, this means that no template is used during creation.


Created in NX5.0.0.

License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.