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

Represents a NXOpen.Weld.DatumIconBuilder class used to control the part navigator icon for Datum Pin and Surface Locators. More...

Inheritance diagram for NXOpen.Weld.DatumIconBuilder:
NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Member Functions

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.Weld.DatumCommonBuilder.CustomTypes 
CustomType [get]
 Returns the custom datum type from the customer defaults that was used. More...
 
unsafe NXOpen.Weld.DatumPin DatumPin [get]
 Returns the DatumPin feature. More...
 
unsafe NXOpen.Weld.DatumSurface DatumSurface [get]
 Returns the DatumSurface feature. More...
 
unsafe bool Derived [get]
 Returns the indicator if this datum was derived from another datum. More...
 
unsafe string IconName [get, set]
 Returns or sets the bit map name for the icon to be used. 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.Weld.DatumIconBuilder class used to control the part navigator icon for Datum Pin and Surface Locators.

This class is used to set the Datum Surface or Datum Pin icon, but never both at the same time. If the icon is not being set for a feature, that feature will be set to a null reference (Nothing in Visual Basic). See example in DatumIconCallback.cxx in ugweld/samples kit.

Created in NX9.0.0

Member Function Documentation

unsafe bool NXOpen.Weld.DatumIconBuilder.Validate ( )
inline

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.

Created in NX3.0.1

License requirements: None.

Returns
Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe NXOpen.Weld.DatumCommonBuilder.CustomTypes NXOpen.Weld.DatumIconBuilder.CustomType
get

Returns the custom datum type from the customer defaults that was used.

Created in NX9.0.0

License requirements: None.

unsafe NXOpen.Weld.DatumPin NXOpen.Weld.DatumIconBuilder.DatumPin
get

Returns the DatumPin feature.

This will be a null reference (Nothing in Visual Basic) if setting the icon for a DatumSurface

Created in NX9.0.0

License requirements: None.

unsafe NXOpen.Weld.DatumSurface NXOpen.Weld.DatumIconBuilder.DatumSurface
get

Returns the DatumSurface feature.

This will be a null reference (Nothing in Visual Basic) if setting the icon for a DatumPin.

Created in NX9.0.0

License requirements: None.

unsafe bool NXOpen.Weld.DatumIconBuilder.Derived
get

Returns the indicator if this datum was derived from another datum.

Created in NX9.0.0

License requirements: None.

unsafe string NXOpen.Weld.DatumIconBuilder.IconName
getset

Returns or sets the bit map name for the icon to be used.

If the bit map cannot be found a default one will be used.

Created in NX9.0.0

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.