NXOpen .NET Reference  12.0.0
Public Member Functions | Properties | List of all members
NXOpen.Preferences.RoutingUserPreferences Class Reference

Allows access to the User Preferences section of the Routing Application View file. More...

Inheritance diagram for NXOpen.Preferences.RoutingUserPreferences:

Public Member Functions

unsafe bool GetStringPreference (string name, out string value)
 Returns the value of the named string user preference from the Application View file. More...
 
unsafe void SetStringPreference (string name, string value)
 Sets the value of the named string user preference in the current NX session. More...
 
unsafe bool GetStringArrayPreference (string name, out string[] values)
 Returns the values of the named string array user preference from the Application View file. More...
 
unsafe void SetStringArrayPreference (string name, string[] values)
 Sets the values of the named string array user preference in the current NX session. More...
 
unsafe bool GetIntegerPreference (string name, out int value)
 Returns the value of the named integer user preference from the Application View file. More...
 
unsafe void SetIntegerPreference (string name, int value)
 Sets the value of the named integer user preference in the current NX session. More...
 
unsafe bool GetIntegerArrayPreference (string name, out int[] values)
 Returns the values of the named integer array user preference from the Application View file. More...
 
unsafe void SetIntegerArrayPreference (string name, int[] values)
 Sets the values of the named integer array user preference in the current NX session. More...
 
unsafe bool GetDoublePreference (string name, out double value)
 Returns the value of the named double user preference from the Application View file. More...
 
unsafe void SetDoublePreference (string name, double value)
 Sets the value of the named double user preference in the current NX session. More...
 
unsafe bool GetDoubleArrayPreference (string name, out double[] values)
 Returns the values of the named double array user preference from the Application View file. More...
 
unsafe void SetDoubleArrayPreference (string name, double[] values)
 Sets the values of the named double array user preference in the current NX session. More...
 

Properties

Tag Tag [get]
 Returns the tag of this object. More...
 

Detailed Description

Allows access to the User Preferences section of the Routing Application View file.

To obtain an instance of this class, refer to NXOpen.Preferences.RoutingApplicationView

Created in NX11.0.1

Member Function Documentation

unsafe bool NXOpen.Preferences.RoutingUserPreferences.GetDoubleArrayPreference ( string  name,
out double[]  values 
)

Returns the values of the named double array user preference from the Application View file.

Created in NX11.0.1

License requirements: routing_base ("Routing Basic")

Parameters
nameThe name of the user preference.
valuesThe values of the preference, if found.
Returns
Was the preference found in the Application View file?
unsafe bool NXOpen.Preferences.RoutingUserPreferences.GetDoublePreference ( string  name,
out double  value 
)

Returns the value of the named double user preference from the Application View file.

Created in NX11.0.1

License requirements: routing_base ("Routing Basic")

Parameters
nameThe name of the user preference.
valueThe value of the preference, if found.
Returns
Was the preference found in the Application View file?
unsafe bool NXOpen.Preferences.RoutingUserPreferences.GetIntegerArrayPreference ( string  name,
out int[]  values 
)

Returns the values of the named integer array user preference from the Application View file.

Created in NX11.0.1

License requirements: routing_base ("Routing Basic")

Parameters
nameThe name of the user preference.
valuesThe values of the preference, if found.
Returns
Was the preference found in the Application View file?
unsafe bool NXOpen.Preferences.RoutingUserPreferences.GetIntegerPreference ( string  name,
out int  value 
)

Returns the value of the named integer user preference from the Application View file.

Created in NX11.0.1

License requirements: routing_base ("Routing Basic")

Parameters
nameThe name of the user preference.
valueThe value of the preference, if found.
Returns
Was the preference found in the Application View file?
unsafe bool NXOpen.Preferences.RoutingUserPreferences.GetStringArrayPreference ( string  name,
out string[]  values 
)

Returns the values of the named string array user preference from the Application View file.

Created in NX11.0.1

License requirements: routing_base ("Routing Basic")

Parameters
nameThe name of the user preference.
valuesThe values of the preference, if found.
Returns
Was the preference found in the Application View file?
unsafe bool NXOpen.Preferences.RoutingUserPreferences.GetStringPreference ( string  name,
out string  value 
)

Returns the value of the named string user preference from the Application View file.

Created in NX11.0.1

License requirements: routing_base ("Routing Basic")

Parameters
nameThe name of the user preference.
valueThe value of the preference, if found.
Returns
Was the preference found in the Application View file?
unsafe void NXOpen.Preferences.RoutingUserPreferences.SetDoubleArrayPreference ( string  name,
double[]  values 
)

Sets the values of the named double array user preference in the current NX session.

Created in NX11.0.2

License requirements: routing_base ("Routing Basic")

Parameters
nameThe name of the user preference.
valuesThe values of the preference. Overwrites any existing values.
unsafe void NXOpen.Preferences.RoutingUserPreferences.SetDoublePreference ( string  name,
double  value 
)

Sets the value of the named double user preference in the current NX session.

Created in NX11.0.2

License requirements: routing_base ("Routing Basic")

Parameters
nameThe name of the user preference.
valueThe value of the preference. Overwrites any existing values.
unsafe void NXOpen.Preferences.RoutingUserPreferences.SetIntegerArrayPreference ( string  name,
int[]  values 
)

Sets the values of the named integer array user preference in the current NX session.

Created in NX11.0.2

License requirements: routing_base ("Routing Basic")

Parameters
nameThe name of the user preference.
valuesThe values of the preference. Overwrites any existing values.
unsafe void NXOpen.Preferences.RoutingUserPreferences.SetIntegerPreference ( string  name,
int  value 
)

Sets the value of the named integer user preference in the current NX session.

Created in NX11.0.2

License requirements: routing_base ("Routing Basic")

Parameters
nameThe name of the user preference.
valueThe value of the preference. Overwrites any existing values.
unsafe void NXOpen.Preferences.RoutingUserPreferences.SetStringArrayPreference ( string  name,
string[]  values 
)

Sets the values of the named string array user preference in the current NX session.

Created in NX11.0.2

License requirements: routing_base ("Routing Basic")

Parameters
nameThe name of the user preference.
valuesThe values of the preference. Overwrites any existing values.
unsafe void NXOpen.Preferences.RoutingUserPreferences.SetStringPreference ( string  name,
string  value 
)

Sets the value of the named string user preference in the current NX session.

Created in NX11.0.2

License requirements: routing_base ("Routing Basic")

Parameters
nameThe name of the user preference.
valueThe value of the preference. Overwrites any existing value.

Property Documentation

Tag NXOpen.Preferences.RoutingUserPreferences.Tag
get

Returns the tag of this object.


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