NXOpen.Display.LayerSettingsBuilder Class Reference

Represents a builder for object layer settings. More...

Inheritance diagram for NXOpen.Display.LayerSettingsBuilder:

Public Types
enum	LayerOptionType { Maintain, Original, Work, UserDefined }
	Specifies the layer options. More...

Public Member Functions
unsafe bool	IsValidLayerOption (NXOpen.Display.LayerSettingsBuilder.LayerOptionType layerOption)
	Determines if the layer option is supported. 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 int	Layer [get, set]
	Returns or sets the layer. More...
unsafe NXOpen.Display.LayerSettingsBuilder.LayerOptionType	LayerOption [get, set]
	Returns or sets the layer option. 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 builder for object layer settings.

Created in NX9.0.0

Member Enumeration Documentation

enum NXOpen.Display.LayerSettingsBuilder.LayerOptionType

Specifies the layer options.

Enumerator
Maintain	Maintain layer
Original	Original layer
Work	Work layer
UserDefined	User specified layer

Member Function Documentation

unsafe bool NXOpen.Display.LayerSettingsBuilder.IsValidLayerOption ( NXOpen.Display.LayerSettingsBuilder.LayerOptionType  layerOption )

inline

Determines if the layer option is supported.

The parent builder determines the validity of the layer options. For example, following layer options are not relevant when the layer is not being derived from another displayable object.

• Display.LayerSettingsBuilder.LayerOptionType.Maintain
• Display.LayerSettingsBuilder.LayerOptionType.Original

Created in NX9.0.0

License requirements: None.

Parameters

layerOption

Returns

unsafe bool NXOpen.Display.LayerSettingsBuilder.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 int NXOpen.Display.LayerSettingsBuilder.Layer

getset

Returns or sets the layer.

Used when the layer option is set to Display.LayerSettingsBuilder.LayerOptionType.UserDefined . See NXOpen.Layer.Constants for valid layer values.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.LayerSettingsBuilder.LayerOptionType NXOpen.Display.LayerSettingsBuilder.LayerOption

getset

Returns or sets the layer option.

Note that all layer options may not be supported by the builder. Refer Display.LayerSettingsBuilder.IsValidLayerOption to determine supported options.

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:

• Display_LayerSettingsBuilder.cs