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

This class is responsible for setting and getting NX Manager database attribute. More...

Inheritance diagram for NXOpen.PDM.DatabaseAttributeManager:
NXOpen.TransientObject NXOpen.Utilities.NXRemotableObject IDisposable IMessageSink

Public Member Functions

unsafe string GetAttribute (string attributeTitle)
 Gets the value of a writable database attribute. More...
 
unsafe void LoadAttributes (bool reload)
 Load the Database Attributes from Teamcenter. More...
 
unsafe void LoadAttributesRecursively (bool reload)
 Recursively load the Database Attributes of this part and all its partially or fully loaded components from Teamcenter. More...
 
unsafe void RefreshAttributes ()
 Force load the Database Attributes from Teamcenter. More...
 
unsafe void SetAttribute (string attributeTitle, string attributeValue)
 Sets the value of a writable database attribute. More...
 
unsafe void StoreAttributes ()
 Register DB_PART_NAME and DB_PART_DESC attributes with values set in the attribute_manager More...
 
- Public Member Functions inherited from NXOpen.TransientObject
void Dispose ()
 Frees the object from memory. More...
 
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
new 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...
 

Protected Member Functions

override void FreeResource ()
 Free resources associated with the instance. More...
 

Additional Inherited Members

- Properties inherited from NXOpen.TransientObject
IntPtr Handle [get]
 Handle of the internal object represented by this object. More...
 

Detailed Description

This class is responsible for setting and getting NX Manager database attribute.

Use PDM.PartBuilder.NewDatabaseAttributeManager or PDM.PdmPart.NewDatabaseAttributeManager to get the instance of this class.

Created in NX4.0.0

Member Function Documentation

override void NXOpen.PDM.DatabaseAttributeManager.FreeResource ( )
inlineprotectedvirtual

Free resources associated with the instance.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.

Created in NX4.0.0

License requirements: None.

Implements NXOpen.TransientObject.

unsafe string NXOpen.PDM.DatabaseAttributeManager.GetAttribute ( string  attributeTitle)
inline

Gets the value of a writable database attribute.

Created in NX4.0.0

License requirements: None.

Parameters
attributeTitlethe title of the attribute
Returns
the value of the attribute
unsafe void NXOpen.PDM.DatabaseAttributeManager.LoadAttributes ( bool  reload)
inline

Load the Database Attributes from Teamcenter.

This operation will not discard any changes made in this session that aren't committed to Teamcenter. If 'reload' is set to 'true', attributes that have already been loaded will be loaded again, if otherwise allowed.

Created in NX8.0.0

License requirements: None.

Parameters
reloadReload attributes that have already been loaded, if otherwise allowed.
unsafe void NXOpen.PDM.DatabaseAttributeManager.LoadAttributesRecursively ( bool  reload)
inline

Recursively load the Database Attributes of this part and all its partially or fully loaded components from Teamcenter.

This operation will not discard any changes made in this session that aren't committed to Teamcenter.

Created in NX8.0.0

License requirements: None.

Parameters
reloadReload attributes that have already been loaded, if otherwise allowed.
unsafe void NXOpen.PDM.DatabaseAttributeManager.RefreshAttributes ( )
inline

Force load the Database Attributes from Teamcenter.

This removes changes to values made in NX.

Created in NX6.0.0

License requirements: None.

unsafe void NXOpen.PDM.DatabaseAttributeManager.SetAttribute ( string  attributeTitle,
string  attributeValue 
)
inline

Sets the value of a writable database attribute.

Created in NX4.0.0

License requirements: None.

Parameters
attributeTitlethe title of the attribute to be set
attributeValuethe new value the attribute is to be set to
unsafe void NXOpen.PDM.DatabaseAttributeManager.StoreAttributes ( )
inline

Register DB_PART_NAME and DB_PART_DESC attributes with values set in the attribute_manager

Created in NX4.0.0

License requirements: None.


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