Represents the set of WorkPlanePreferences preferences applicable to part. More...

Inheritance diagram for NXOpen.Preferences.WorkPlane:

Classes
struct	GridSize
	Grid size parameters More...

struct	NonuniformGridSize
	Nonuniform grid size parameters More...

struct	PolarGridSize
	Polar grid size parameters More...

Public Types
enum	Grid { Polar, Rectangular }
	Describes whether the Grid type selected is Polar or Rectangular More...

Public Types inherited from NXOpen.NXObject
enum	AttributeType { Invalid, Null, Boolean, Integer, Real, String, Time, Reference, Any = 100 }
	Specifies attribute type. More...

enum	DateAndTimeFormat { Numeric, Textual }
	Specifies the format of the date and time attribute. More...

Public Member Functions
unsafe NXOpen.Preferences.WorkPlane.PolarGridSize	GetPolarGridSize ()
	Query the polar grid size parameters. More...

unsafe NXOpen.Preferences.WorkPlane.NonuniformGridSize	GetRectangularNonuniformGridSize ()
	Query the rectangular nonuniform grid size parameters. More...

unsafe NXOpen.Preferences.WorkPlane.GridSize	GetRectangularUniformGridSize ()
	Query the rectangular uniform grid size parameters. More...

unsafe void	SetPolarGridSize (NXOpen.Preferences.WorkPlane.PolarGridSize polarGridSize)
	Set the polar grid size parameters. More...

unsafe void	SetRectangularNonuniformGridSize (NXOpen.Preferences.WorkPlane.NonuniformGridSize nonuniformGridSize)
	Set the rectangular nonuniform grid size parameters. More...

unsafe void	SetRectangularUniformGridSize (NXOpen.Preferences.WorkPlane.GridSize gridSize)
	Set the rectangular uniform grid size parameters. More...

Public Member Functions inherited from NXOpen.NXObject
unsafe NXOpen.AttributeIterator	CreateAttributeIterator ()
	Create an attribute iterator More...

unsafe void	DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type)
	Deletes all attributes of a specific type. More...

unsafe void	DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
	Deletes all attributes of a specific type with the option to update or not. More...

unsafe void	DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title)
	Deletes an attribute by type and title. More...

unsafe void	DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option)
	Deletes an attribute by type and title with the option to update or not. More...

unsafe void	DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option)
	Deletes the first attribute encountered with the given Type, Title. More...

unsafe void	DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option)
	Deletes the attributes on the object, if any, that satisfy the given iterator More...

unsafe void	DeleteUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
	Deletes the attributes encountered with the given Type with option to update or not. More...

unsafe NXOpen.INXObject	FindObject (string journalIdentifier)
	Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
	Gets all the attribute titles of a specific type. More...

unsafe bool	GetBooleanUserAttribute (string title, int index)
	Gets a boolean attribute by Title and array Index. More...

unsafe NXOpen.NXObject.ComputationalTime	GetComputationalTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. More...

unsafe int	GetIntegerAttribute (string title)
	Gets an integer attribute by title. More...

unsafe int	GetIntegerUserAttribute (string title, int index)
	Gets an integer attribute by Title and array Index. More...

unsafe bool	GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info)
	Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...

unsafe string	GetPdmReferenceAttributeValue (string attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...

unsafe double	GetRealAttribute (string title)
	Gets a real attribute by title. More...

unsafe double	GetRealUserAttribute (string title, int index)
	Gets a real attribute by Title and array Index. More...

unsafe string	GetReferenceAttribute (string title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...

unsafe string	GetStringAttribute (string title)
	Gets a string attribute value by title. More...

unsafe string	GetStringUserAttribute (string title, int index)
	Gets a string attribute by Title and array Index. More...

unsafe string	GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
	Gets a time attribute by title. More...

unsafe string	GetTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. More...

unsafe NXOpen.NXObject.AttributeInformation	GetUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...

unsafe string	GetUserAttributeAsString (string title, NXOpen.NXObject.AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...

unsafe int	GetUserAttributeCount (NXOpen.AttributeIterator iterator)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

unsafe int	GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

unsafe int	GetUserAttributeCount (NXOpen.NXObject.AttributeType type)
	Gets the count of set attributes on the object, if any, of the given type. More...

unsafe int	GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
	Gets the count of attributes on the object, if any, of the given type. More...

unsafe bool	GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
	Determine the lock of the given attribute. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (NXOpen.AttributeIterator iterator)
	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes ()
	Gets all the attributes that have been set on the given object. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset)
	Gets all the attributes of the given object. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes of the given object. More...

unsafe string[]	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object. More...

unsafe int	GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...

unsafe NXOpen.NXObject[]	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes. More...

unsafe bool	HasUserAttribute (NXOpen.AttributeIterator iterator)
	Determines if an attribute exists on the object, that satisfies the given iterator More...

unsafe bool	HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...

unsafe void	Print ()
	Prints a representation of this object to the system log file. More...

unsafe void	SetAttribute (string title, int value)
	Creates or modifies an integer attribute. More...

unsafe void	SetAttribute (string title, int value, NXOpen.Update.Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

unsafe void	SetAttribute (string title, double value)
	Creates or modifies a real attribute. More...

unsafe void	SetAttribute (string title, double value, NXOpen.Update.Option option)
	Creates or modifies a real attribute with the option to update or not. More...

unsafe void	SetAttribute (string title, string value)
	Creates or modifies a string attribute. More...

unsafe void	SetAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute with the option to update or not. More...

unsafe void	SetAttribute (string title)
	Creates or modifies a null attribute which is an attribute with a title and no value. More...

unsafe void	SetAttribute (string title, NXOpen.Update.Option option)
	Creates or modifies a null attribute with the option to update or not. More...

unsafe void	SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option)
	Creates or modifies a boolean attribute with the option to update or not. More...

unsafe void	SetName (string name)
	Sets the custom name of the object. More...

unsafe void	SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
	Sets the value of PDM Reference attribute on the object. More...

unsafe void	SetReferenceAttribute (string title, string value)
	Creates or modifies a string attribute which uses a reference string. More...

unsafe void	SetReferenceAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...

unsafe void	SetTimeAttribute (string title, string value)
	Creates or modifies a time attribute. More...

unsafe void	SetTimeAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option)
	Creates or modifies an attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option)
	Creates or modifies a real attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, NXOpen.Update.Option option)
	Creates or modifies a null attribute with the option to update or not. More...

unsafe void	SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
	Lock or unlock the given attribute. 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	GridColor `[get, set]`
	Returns or sets the grid color. More...

unsafe bool	GridIsNonUniform `[get, set]`
	Returns or sets the grid non uniform flag. More...

unsafe bool	GridOnTop `[get, set]`
	Returns or sets the grid on top flag. More...

unsafe NXOpen.Preferences.WorkPlane.Grid	GridType `[get, set]`
	Returns or sets the grid type. More...

unsafe bool	PolarShowMajorLines `[get, set]`
	Returns or sets the show major lines flag for polar grid More...

unsafe bool	RectangularShowMajorLines `[get, set]`
	Returns or sets the show major lines flag for rectangular grid More...

unsafe bool	ShowGrid `[get, set]`
	Returns or sets the show and hide grid flag. More...

unsafe bool	ShowLabels `[get, set]`
	Returns or sets the show and hide grid labels flag. More...

unsafe bool	SnapToGrid `[get, set]`
	Returns or sets the snap to grid flag. More...

Properties inherited from NXOpen.NXObject
unsafe bool	IsOccurrence `[get]`
	Returns whether this object is an occurrence or not. More...

unsafe string	JournalIdentifier `[get]`
	Returns the identifier that would be recorded in a journal for this object. More...

unsafe string	Name `[get]`
	Returns the custom name of the object. More...

unsafe NXOpen.Assemblies.Component	OwningComponent `[get]`
	Returns the owning component, if this object is an occurrence. More...

unsafe NXOpen.BasePart	OwningPart `[get]`
	Returns the owning part of this object More...

unsafe NXOpen.INXObject	Prototype `[get]`
	Returns the prototype of this object if it is an occurrence. 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...

Properties inherited from NXOpen.INXObject
bool	IsOccurrence `[get]`
	Returns whether this object is an occurrence or not. More...

string	JournalIdentifier `[get]`
	Returns the identifier that would be recorded in a journal for this object. More...

string	Name `[get]`
	Returns the custom name of the object. More...

NXOpen.Assemblies.Component	OwningComponent `[get]`
	Returns the owning component, if this object is an occurrence. More...

NXOpen.BasePart	OwningPart `[get]`
	Returns the owning part of this object More...

NXOpen.INXObject	Prototype `[get]`
	Returns the prototype of this object if it is an occurrence. More...

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

Detailed Description

Represents the set of WorkPlanePreferences preferences applicable to part.

Sets parameters for the Graphics Window grid and the Work Plane Emphasis mode.

An instance of this class can be obtained using Preferences.SessionPreferences.WorkPlane or Preferences.PartPreferences.Workplane

Created in NX3.0.0

Member Enumeration Documentation

enum NXOpen.Preferences.WorkPlane.Grid

Describes whether the Grid type selected is Polar or Rectangular

Enumerator
Polar	Polar Grid
Rectangular	Rectangular Grid

Member Function Documentation

unsafe NXOpen.Preferences.WorkPlane.PolarGridSize NXOpen.Preferences.WorkPlane.GetPolarGridSize ( )

inline

Query the polar grid size parameters.

Created in NX6.0.0

License requirements: None.

Returns

unsafe NXOpen.Preferences.WorkPlane.NonuniformGridSize NXOpen.Preferences.WorkPlane.GetRectangularNonuniformGridSize ( )

inline

Query the rectangular nonuniform grid size parameters.

Created in NX6.0.0

License requirements: None.

Returns

unsafe NXOpen.Preferences.WorkPlane.GridSize NXOpen.Preferences.WorkPlane.GetRectangularUniformGridSize ( )

inline

Query the rectangular uniform grid size parameters.

Created in NX6.0.0

License requirements: None.

Returns

unsafe void NXOpen.Preferences.WorkPlane.SetPolarGridSize ( NXOpen.Preferences.WorkPlane.PolarGridSize polarGridSize )

inline

Set the polar grid size parameters.

Created in NX6.0.0

License requirements: None.

Parameters

polarGridSize

unsafe void NXOpen.Preferences.WorkPlane.SetRectangularNonuniformGridSize ( NXOpen.Preferences.WorkPlane.NonuniformGridSize nonuniformGridSize )

inline

Set the rectangular nonuniform grid size parameters.

Created in NX6.0.0

License requirements: None.

Parameters

nonuniformGridSize

unsafe void NXOpen.Preferences.WorkPlane.SetRectangularUniformGridSize ( NXOpen.Preferences.WorkPlane.GridSize gridSize )

inline

Set the rectangular uniform grid size parameters.

Created in NX6.0.0

License requirements: None.

Parameters

gridSize

Property Documentation

unsafe int NXOpen.Preferences.WorkPlane.GridColor

getset

Returns or sets the grid color.

Specifies the color of grid.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Preferences.WorkPlane.GridIsNonUniform

getset

Returns or sets the grid non uniform flag.

If true grid is non uniform. A uniform grid has the same spacing in X and Y. A non-uniform grid allows for different spacing in X and Y.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Preferences.WorkPlane.GridOnTop

getset

Returns or sets the grid on top flag.

If true displays the grid on top of other graphics in the scene.

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Preferences.WorkPlane.Grid NXOpen.Preferences.WorkPlane.GridType

getset

Returns or sets the grid type.

It may be polar or rectangular

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Preferences.WorkPlane.PolarShowMajorLines

getset

Returns or sets the show major lines flag for polar grid

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Preferences.WorkPlane.RectangularShowMajorLines

getset

Returns or sets the show major lines flag for rectangular grid

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Preferences.WorkPlane.ShowGrid

getset

Returns or sets the show and hide grid flag.

If true displays the grid pattern in the graphics window else hides

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Preferences.WorkPlane.ShowLabels

getset

Returns or sets the show and hide grid labels flag.

If true displays the grid labels in the graphics window else hides

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Preferences.WorkPlane.SnapToGrid

getset

Returns or sets the snap to grid flag.

If true enables snapping (moves an indicated screen position point to the nearest grid point). Points snap to the grid even when Show Grid is off.

Created in NX3.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:

Preferences_WorkPlane.cs

Classes

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation