NXOpen.ExternalFileReferenceAdapter Class Reference

Represents a managed external file reference adapter object to communicate the external file reference information. More...

Inheritance diagram for NXOpen.ExternalFileReferenceAdapter:

Public Types
enum	Type { Native, Part, ImanFile, DatabaseObject }
	Indicates the type of external file reference. More...

Public Member Functions
unsafe void	EstablishReference (NXOpen.ExternalFileReferenceAdapter.Type referenceType, string externalFileSpec)
	Establish the managed reference to the given external file. More...
unsafe string	GetFileSpec ()
	Returns external filespec from external file reference adapter. More...
unsafe void	SetAssociatedFileReference ()
	Set whether to the external file is an associated file of the part referencing it and it is applicable only when connected to teamcenter More...
unsafe void	SetCandidateForSave (bool doSave)
	Set whether to upload the modified external file into Teamcenter when part is getting saved and it is applicable only when connected to teamcenter More...
unsafe void	SetExternalFileDefinitionKey (string externalFileDefkey)
	Set the ExternalFileDefinition which gives information about the TC data model and other managed mode specific aspects of this reference. 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...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...
Properties inherited from NXOpen.TaggedObject
Tag	Tag [get]
	Returns the tag of this object. More...

Detailed Description

Represents a managed external file reference adapter object to communicate the external file reference information.

Use NXOpen.IExternalFileReferencer.GetExternalFileReferenceAdapter to get instance of this class.

Created in NX1847.0.0

Member Enumeration Documentation

enum NXOpen.ExternalFileReferenceAdapter.Type

Indicates the type of external file reference.

Enumerator
Native	Represent a reference to file from native file system.
Part	Represent a reference to another NX part in Teamcenter database.
ImanFile	Represent a reference to named reference file from the Teamcenter database.
DatabaseObject	Represent a reference to Teamcenter database object.

Member Function Documentation

unsafe void NXOpen.ExternalFileReferenceAdapter.EstablishReference ( NXOpen.ExternalFileReferenceAdapter.Type  referenceType, string  externalFileSpec  )

inline

Establish the managed reference to the given external file.

Created in NX1847.0.0

License requirements: None.

Parameters

referenceType
externalFileSpec

unsafe string NXOpen.ExternalFileReferenceAdapter.GetFileSpec ( )

inline

Returns external filespec from external file reference adapter.

Created in NX1847.0.0

License requirements: None.

Returns

unsafe void NXOpen.ExternalFileReferenceAdapter.SetAssociatedFileReference ( )

inline

Set whether to the external file is an associated file of the part referencing it and it is applicable only when connected to teamcenter

Created in NX1847.0.0

License requirements: None.

unsafe void NXOpen.ExternalFileReferenceAdapter.SetCandidateForSave ( bool  doSave )

inline

Set whether to upload the modified external file into Teamcenter when part is getting saved and it is applicable only when connected to teamcenter

Created in NX1847.0.0

License requirements: None.

Parameters

doSave

unsafe void NXOpen.ExternalFileReferenceAdapter.SetExternalFileDefinitionKey ( string  externalFileDefkey )

inline

Set the ExternalFileDefinition which gives information about the TC data model and other managed mode specific aspects of this reference.

Created in NX1847.0.0

License requirements: None.

Parameters

externalFileDefkey

---

The documentation for this class was generated from the following file:

• ExternalFileReferenceAdapter.cs