NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Properties | List of all members
NXOpen.FileNew Class Reference

Represents a NXOpen.FileNew More...

Inheritance diagram for NXOpen.FileNew:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Member Functions

unsafe bool GetAddMasterFlag ()
 Returns logical value to indicate whether master to be added as child component More...
 
unsafe string[] GetApplicationNames ()
 Returns all registered application names. More...
 
unsafe string[] GetAvailableTemplates ()
 Returns the available templates for this builder More...
 
unsafe bool GetCanCreateAltrep ()
 Gets the flag specifying if the current template customization allows Alternate representation creation using the template More...
 
unsafe NXOpen.FileNewTemplate[] GetTemplates ()
 Gets the NXOpen.FileNewTemplate objects associated with the input file new object. More...
 
unsafe void SetAddMasterFlag (bool addMaster)
 Sets addMaster flag More...
 
unsafe void SetCanCreateAltrep (bool createAltrep)
 Sets the flag specifying if the current template customization allows Alternate representation creation using the template More...
 
unsafe void SetPartOperationCreateBuilder (NXOpen.PDM.PartOperationBuilder partOperationBuilder)
 Sets NXOpen.PDM.PartOperationBuilder More...
 
unsafe void SetProjectsData (string[] projectName, int[] assignmentState)
 Teamcenter projects data More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe NXOpen.FileNewApplication Application [get, set]
 Returns or sets the application type for the new file being created More...
 
unsafe string ApplicationName [get, set]
 Returns or sets the application type for the new file being created Use NXOpen.FileNew.GetApplicationNames to get valid application names. More...
 
unsafe string DesignElementState [get, set]
 Returns or sets the state for the new design element. More...
 
unsafe string DesignElementType [get, set]
 Returns or sets the design element type for the new design element. More...
 
unsafe NXOpen.DisplayPartOption DisplayPartOption [get, set]
 Returns or sets the display part option. More...
 
unsafe string ItemType [get, set]
 Returns or sets the item type for the new file. More...
 
unsafe bool MakeDisplayedPart [get, set]
 Returns or sets the property that controls if the new file should be made the displayed part More...
 
unsafe string MasterFileName [get, set]
 Returns or sets the name of the master model part to be referenced. More...
 
unsafe string NewFileName [get, set]
 Returns or sets the name of the new file being created More...
 
unsafe string RelationType [get, set]
 Returns or sets the relation type of the underlying template which is used for the new file being created. More...
 
unsafe string Specialization [get, set]
 Returns or sets the specialization for the new file More...
 
unsafe string TemplateFileName [get, set]
 Returns or sets the name of the template part from which to create the new file More...
 
unsafe string TemplatePresentationName [get, set]
 Returns or sets the presentation name of the underlying template which is used for the new file being created More...
 
unsafe NXOpen.FileNewTemplateType TemplateType [get, set]
 Returns or sets the template type for the new file being created More...
 
unsafe NXOpen.Part.Units Units [get, set]
 Returns or sets the units for the new file being created More...
 
unsafe bool UseBlankTemplate [get, set]
 Returns or sets the property that controls if the new file should be created using a blank template. More...
 
unsafe string UsesMasterModel [get, set]
 Returns or sets the uses master model flag of the underlying template which is used for the new file being created. More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a NXOpen.FileNew

To create an instance of this class, use NXOpen.PartCollection.FileNew .

Created in NX5.0.0

Member Function Documentation

unsafe bool NXOpen.FileNew.GetAddMasterFlag ( )
inline

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

Created in NX6.0.0

Deprecated in NX10.0.0. Use NXOpen.PDM.PartOperationCreateBuilder.GetAddMaster to get addMaster flag.

License requirements: None.

Returns
whether master to be added as child component
unsafe string [] NXOpen.FileNew.GetApplicationNames ( )
inline

Returns all registered application names.

These name should be used while setting the application name in ApplicationName .

Created in NX9.0.0

License requirements: None.

Returns
All registered application names
unsafe string [] NXOpen.FileNew.GetAvailableTemplates ( )
inline

Returns the available templates for this builder

Created in NX6.0.0

License requirements: None.

Returns
array of available template names
unsafe bool NXOpen.FileNew.GetCanCreateAltrep ( )
inline

Gets the flag specifying if the current template customization allows Alternate representation creation using the template

Created in NX10.0.0

License requirements: None.

Returns
unsafe NXOpen.FileNewTemplate [] NXOpen.FileNew.GetTemplates ( )
inline

Gets the NXOpen.FileNewTemplate objects associated with the input file new object.

Created in NX1847.0.0

License requirements: None.

Returns
Need to free it.
unsafe void NXOpen.FileNew.SetAddMasterFlag ( bool  addMaster)
inline

Sets addMaster flag

Created in NX6.0.0

Deprecated in NX10.0.0. Use NXOpen.PDM.PartOperationCreateBuilder.SetAddMaster to set addMaster flag.

License requirements: None.

Parameters
addMasterwhether master to be added as child component
unsafe void NXOpen.FileNew.SetCanCreateAltrep ( bool  createAltrep)
inline

Sets the flag specifying if the current template customization allows Alternate representation creation using the template

Created in NX10.0.0

License requirements: None.

Parameters
createAltrep
unsafe void NXOpen.FileNew.SetPartOperationCreateBuilder ( NXOpen.PDM.PartOperationBuilder  partOperationBuilder)
inline

Sets NXOpen.PDM.PartOperationBuilder

Created in NX10.0.0

License requirements: None.

Parameters
partOperationBuilder
unsafe void NXOpen.FileNew.SetProjectsData ( string[]  projectName,
int[]  assignmentState 
)
inline

Teamcenter projects data

Created in NX6.0.0

Deprecated in NX10.0.0. Use NXOpen.Session.AssignRemoveProjects to assign/remove projects.

License requirements: None.

Parameters
projectNamename of the project
assignmentStateassignment state

Property Documentation

unsafe NXOpen.FileNewApplication NXOpen.FileNew.Application
getset

Returns or sets the application type for the new file being created

Created in NX5.0.0

Deprecated in NX9.0.0. Use NXOpen.FileNew.ApplicationName that takes a string name instead.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.FileNew.ApplicationName
getset

Returns or sets the application type for the new file being created Use NXOpen.FileNew.GetApplicationNames to get valid application names.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.FileNew.DesignElementState
getset

Returns or sets the state for the new design element.

It can be a comma separated string in case the underlying template supports multiple design element states

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.FileNew.DesignElementType
getset

Returns or sets the design element type for the new design element.

It can be a comma separated string in case the underlying template supports multiple design element types

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.DisplayPartOption NXOpen.FileNew.DisplayPartOption
getset

Returns or sets the display part option.

See NXOpen.DisplayPartOption .

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.FileNew.ItemType
getset

Returns or sets the item type for the new file.

It can be a comma separated string in case the underlying template supports multiple item types

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.FileNew.MakeDisplayedPart
getset

Returns or sets the property that controls if the new file should be made the displayed part

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.FileNew.MasterFileName
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.FileNew.NewFileName
getset

Returns or sets the name of the new file being created

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.FileNew.RelationType
getset

Returns or sets the relation type of the underlying template which is used for the new file being created.

If set to 'Specification', this means non-master template is used for part creation and it will require NXOpen.FileNew.UsesMasterModel to be set to 'Yes'

Created in NX8.5.3

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.FileNew.Specialization
getset

Returns or sets the specialization for the new file

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.FileNew.TemplateFileName
getset

Returns or sets the name of the template part from which to create the new file

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.FileNew.TemplatePresentationName
getset

Returns or sets the presentation name of the underlying template which is used for the new file being created

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.FileNewTemplateType NXOpen.FileNew.TemplateType
getset

Returns or sets the template type for the new file being created

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Part.Units NXOpen.FileNew.Units
getset

Returns or sets the units for the new file being created

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.FileNew.UseBlankTemplate
getset

Returns or 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 NXOpen.FileNew.TemplateFileName . If set to True, this means that no template is used during creation.

Note: This property should be set to True only while creating traditional items with template type set as FileNewTemplateType.Item

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.FileNew.UsesMasterModel
getset

Returns or sets the uses master model flag of the underlying template which is used for the new file being created.

If set to 'No', this means that master template is used for part creation. If set to 'Yes', this means non-master template is used and it will require master model part to be specified for part creation

Created in NX8.5.3

License requirements to get this property: None.

License requirements to set this property: None.


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