NXOpen .NET Reference Guide
|
Represents a list of properties. More...
Public Types | |
enum | ListMode { Indexed, Named } |
Indicates whether the properties in the list are named. More... | |
enum | PropertyType { String, Double, Logical, Integer, Enum, Strings, UIBlock, Point, Vector, Bits, TaggedObject, Array, IntegerMatrix2d, DoubleMatrix2d, TaggedObjectMatrix2d, IntegerVector, DoubleVector, TaggedObjectVector, File, SelectionFilter, Undefined } |
Represents the property types. More... | |
Public Member Functions | |
unsafe NXOpen.PropertyContainer | GetArray (string propertyName) |
Gets the value for the given property name. More... | |
unsafe NXOpen.PropertyContainer | GetArray (int propertyIndex) |
Gets the value for the given index. More... | |
unsafe int | GetBits (string propertyName) |
Gets the bits value for the given property name. More... | |
unsafe int | GetBits (int propertyIndex) |
Gets the bits value for the given index. More... | |
unsafe double | GetDouble (string propertyName) |
Gets the double value for the given property name. More... | |
unsafe double | GetDouble (int propertyIndex) |
Gets the double value for the given index. More... | |
unsafe double[] | GetDoubleMatrix (string propertyName, out int nRows, out int nColumns) |
Gets the double matrix for the given property name. More... | |
unsafe double[] | GetDoubleMatrix (int propertyIndex, out int nRows, out int nColumns) |
Gets the double matrix for the given index. More... | |
unsafe double[] | GetDoubleVector (string propertyName) |
Gets the double vector for the given property name. More... | |
unsafe double[] | GetDoubleVector (int propertyIndex) |
Gets the double vector for the given index. More... | |
unsafe int | GetEnum (string propertyName) |
Gets the value for the given property name. More... | |
unsafe int | GetEnum (int propertyIndex) |
Gets the value for the given index. More... | |
unsafe string | GetEnumAsString (string propertyName) |
Gets the value for the given property name. More... | |
unsafe string | GetEnumAsString (int propertyIndex) |
Gets the value for the given index. More... | |
unsafe string[] | GetEnumMembers (string propertyName) |
Gets the enum members for the given property of type enum. More... | |
unsafe string[] | GetEnumMembers (int propertyIndex) |
Gets the enum members for the given property index. More... | |
unsafe string | GetFile (string propertyName) |
Gets the value for the given property name. More... | |
unsafe string | GetFile (int propertyIndex) |
Gets the value for the given index. More... | |
unsafe int | GetInteger (string propertyName) |
Gets the integer value for the given property name. More... | |
unsafe int | GetInteger (int propertyIndex) |
Gets the integer value for the given index. More... | |
unsafe int[] | GetIntegerMatrix (string propertyName, out int nRows, out int nColumns) |
Gets the integer matrix for the given property name. More... | |
unsafe int[] | GetIntegerMatrix (int propertyIndex, out int nRows, out int nColumns) |
Gets the integer matrix for the given index. More... | |
unsafe int[] | GetIntegerVector (string propertyName) |
Gets the integer vector for the given property name. More... | |
unsafe int[] | GetIntegerVector (int propertyIndex) |
Gets the integer vector for the given index. More... | |
unsafe bool | GetLogical (string propertyName) |
Gets the logical value for the given property name. More... | |
unsafe bool | GetLogical (int propertyIndex) |
Gets the logical value for the given index. More... | |
unsafe NXOpen.Point3d | GetPoint (string propertyName) |
Gets the point value for the given property name. More... | |
unsafe NXOpen.Point3d | GetPoint (int propertyIndex) |
Gets the point value for the given index. More... | |
unsafe string[] | GetPropertyNames () |
Returns a list of all the property names More... | |
unsafe NXOpen.PropertyContainer.PropertyType | GetPropertyType (string propertyName) |
Returns the property type for given property name More... | |
unsafe NXOpen.PropertyContainer.PropertyType | GetPropertyType (int propertyIndex) |
Returns the property type for the Indexed property list. More... | |
unsafe string | GetString (string propertyName) |
Gets the string value for the given property name. More... | |
unsafe string | GetString (int propertyIndex) |
Gets the string value for the given index. More... | |
unsafe string[] | GetStrings (string propertyName) |
Gets the strings value for the given property name. More... | |
unsafe string[] | GetStrings (int propertyIndex) |
Gets the strings value for the given index. More... | |
unsafe NXOpen.TaggedObject | GetTaggedObject (string propertyName) |
Gets the tagged object for the given property name. More... | |
unsafe NXOpen.TaggedObject | GetTaggedObject (int propertyIndex) |
Gets the tagged object for the given index. More... | |
unsafe NXOpen.TaggedObject[] | GetTaggedObjectVector (string propertyName) |
Gets the tagged object vector for the given property name. More... | |
unsafe NXOpen.TaggedObject[] | GetTaggedObjectVector (int propertyIndex) |
Gets the tagged object vector for the given index. More... | |
unsafe NXOpen.Vector3d | GetVector (string propertyName) |
Gets the vector value for the given property name. More... | |
unsafe NXOpen.Vector3d | GetVector (int propertyIndex) |
Gets the vector value for the given index. More... | |
unsafe void | SetBits (string propertyName, int bitsSc) |
Sets the bits value for the given property name. More... | |
unsafe void | SetDouble (string propertyName, double value) |
Sets the double value for the given property name. More... | |
unsafe void | SetDoubleMatrix (string propertyName, int nRows, int nColumns, double[] matrixValue) |
Sets the double matrix for the given property name. More... | |
unsafe void | SetDoubleVector (string propertyName, double[] doubleVector) |
Sets the double vector for the given property name. More... | |
unsafe void | SetEnum (string propertyName, int value) |
Sets the value for the given property name. More... | |
unsafe void | SetEnumAsString (string propertyName, string value) |
Sets the value for the given property name. More... | |
unsafe void | SetEnumMembers (string propertyName, string[] stringArray) |
Sets the enum members for the given property of type enum. More... | |
unsafe void | SetFile (string propertyName, string value) |
Sets the value for the given property name. More... | |
unsafe void | SetInteger (string propertyName, int value) |
Sets the integer value for the given property name. More... | |
unsafe void | SetIntegerMatrix (string propertyName, int nRows, int nColumns, int[] matrixValue) |
Sets the integer matrix for the given property name. More... | |
unsafe void | SetIntegerVector (string propertyName, int[] intVector) |
Sets the integer vector for the given property name. More... | |
unsafe void | SetLogical (string propertyName, bool value) |
Sets the logical value for the given property name. More... | |
unsafe void | SetPoint (string propertyName, NXOpen.Point3d pointSc) |
Sets the point value for the given property name. More... | |
unsafe void | SetString (string propertyName, string value) |
Sets the string value for the given property name. More... | |
unsafe void | SetStrings (string propertyName, string[] stringArray) |
Sets the strings value for the given property name. More... | |
unsafe void | SetTaggedObject (string propertyName, NXOpen.TaggedObject taggedSc) |
Sets the tagged object for the given property name. More... | |
unsafe void | SetTaggedObjectVector (string propertyName, NXOpen.TaggedObject[] tagVector) |
Sets the tagged object vector for the given property name. More... | |
unsafe void | SetVector (string propertyName, NXOpen.Vector3d vector) |
Sets the vector value for the given property name. 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 () |
Frees the object from memory. More... | |
Properties | |
unsafe int | Length [get] |
Returns the length of the list More... | |
unsafe NXOpen.PropertyContainer.ListMode | Mode [get] |
Returns the mode of the list More... | |
Properties inherited from NXOpen.TransientObject | |
IntPtr | Handle [get] |
Handle of the internal object represented by this object. More... | |
Properties inherited from NXOpen.Utilities.NXRemotableObject | |
IMessageSink | NextSink [get] |
Gets the next message sink in the sink chain. More... | |
Represents a list of properties.
The properties can be accessed and modified, but no new property can be added to existing list. Refer to NXOpen.DataContainer which allows to add new property to the list.
Created in NX7.5.0
Represents the property types.
|
inlineprotectedvirtual |
Frees the object from memory.
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 NX7.5.0
License requirements: None.
Implements NXOpen.TransientObject.
|
inline |
Gets the value for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
|
inline |
Gets the value for the given index.
Exception will be raised if invalid index is used.
Created in NX7.5.0
License requirements: None.
propertyIndex | Index |
|
inline |
Gets the bits value for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
|
inline |
Gets the bits value for the given index.
Exception will be raised if invalid index is used.
Created in NX7.5.0
License requirements: None.
propertyIndex | index |
|
inline |
Gets the double value for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
|
inline |
Gets the double value for the given index.
Exception will be raised if invalid index is used.
Created in NX7.5.0
License requirements: None.
propertyIndex | Index |
|
inline |
Gets the double matrix for the given property name.
Exception will be raised if invalid property name is used. This is a two dimensional array encoded into a single array.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
nRows | Number of Rows in the 2D matrix |
nColumns | Number of Columns in the 2D matrix |
|
inline |
Gets the double matrix for the given index.
Exception will be raised if invalid index is used. This is a two dimensional array encoded into a single array.
Created in NX7.5.0
License requirements: None.
propertyIndex | Index |
nRows | Number of Rows in the 2D matrix |
nColumns | Number of Columns in the 2D matrix |
|
inline |
Gets the double vector for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
|
inline |
Gets the double vector for the given index.
Exception will be raised if invalid index is used.
Created in NX7.5.0
License requirements: None.
propertyIndex | Index |
|
inline |
Gets the value for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
|
inline |
Gets the value for the given index.
Exception will be raised if invalid index is used.
Created in NX7.5.0
License requirements: None.
propertyIndex | Index |
|
inline |
Gets the value for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
|
inline |
Gets the value for the given index.
Exception will be raised if invalid index is used.
Created in NX7.5.0
License requirements: None.
propertyIndex | index |
|
inline |
Gets the enum members for the given property of type enum.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
|
inline |
Gets the enum members for the given property index.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyIndex | Index |
|
inline |
Gets the value for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
|
inline |
Gets the value for the given index.
Exception will be raised if invalid index is used.
Created in NX7.5.0
License requirements: None.
propertyIndex | Index |
|
inline |
Gets the integer value for the given property name.
Exception will be raised if invalid property name is used
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
|
inline |
Gets the integer value for the given index.
Exception will be raised if invalid index is used
Created in NX7.5.0
License requirements: None.
propertyIndex | Index |
|
inline |
Gets the integer matrix for the given property name.
Exception will be raised if invalid property name is used. This is a two dimensional array encoded into a single array.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
nRows | Number of Rows in the 2D matrix |
nColumns | Number of Columns in the 2D matrix |
|
inline |
Gets the integer matrix for the given index.
Exception will be raised if invalid index is used. This is a two dimensional array encoded into a single array.
Created in NX7.5.0
License requirements: None.
propertyIndex | Index |
nRows | Number of Rows in the 2D matrix |
nColumns | Number of Columns in the 2D matrix |
|
inline |
Gets the integer vector for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
|
inline |
Gets the integer vector for the given index.
Exception will be raised if invalid index is used.
Created in NX7.5.0
License requirements: None.
propertyIndex | Index |
|
inline |
Gets the logical value for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
|
inline |
Gets the logical value for the given index.
Exception will be raised if invalid index is used.
Created in NX7.5.0
License requirements: None.
propertyIndex | Index |
|
inline |
Gets the point value for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
|
inline |
Gets the point value for the given index.
Exception will be raised if invalid index is used.
Created in NX7.5.0
License requirements: None.
propertyIndex | Index |
|
inline |
Returns a list of all the property names
Created in NX7.5.0
License requirements: None.
|
inline |
Returns the property type for given property name
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
|
inline |
Returns the property type for the Indexed property list.
Don't use this method on Named property list
Created in NX7.5.0
License requirements: None.
propertyIndex | Index |
|
inline |
Gets the string value for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
|
inline |
Gets the string value for the given index.
Exception will be raised if invalid index is used.
Created in NX7.5.0
License requirements: None.
propertyIndex | Index |
|
inline |
Gets the strings value for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
|
inline |
Gets the strings value for the given index.
Exception will be raised if invalid index is used.
Created in NX7.5.0
License requirements: None.
propertyIndex | Index |
|
inline |
Gets the tagged object for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
|
inline |
Gets the tagged object for the given index.
Exception will be raised if invalid index is used.
Created in NX7.5.0
License requirements: None.
propertyIndex | Index |
|
inline |
Gets the tagged object vector for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
|
inline |
Gets the tagged object vector for the given index.
Exception will be raised if invalid index is used.
Created in NX7.5.0
License requirements: None.
propertyIndex | Index |
|
inline |
Gets the vector value for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
|
inline |
Gets the vector value for the given index.
Exception will be raised if invalid index is used.
Created in NX7.5.0
License requirements: None.
propertyIndex | Index |
|
inline |
Sets the bits value for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
bitsSc | Value to set for given property name. |
|
inline |
Sets the double value for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
value | Value to set for given property name. |
|
inline |
Sets the double matrix for the given property name.
Exception will be raised if invalid property name is used. This is a two dimensional array encoded into a single array.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
nRows | Number of Rows in the 2D matrix |
nColumns | Number of Columns in the 2D matrix |
matrixValue | Value to set for given property name. |
|
inline |
Sets the double vector for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.3
License requirements: None.
propertyName | Name of the property |
doubleVector | Value to set for given property name. |
|
inline |
Sets the value for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
value | Value to set for given property name. |
|
inline |
Sets the value for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
value | Value to set for given property name. |
|
inline |
Sets the enum members for the given property of type enum.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
stringArray | Value to set for given property name. |
|
inline |
Sets the value for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
value | Value to set for given property name. |
|
inline |
Sets the integer value for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
value | Value to set for given property name |
|
inline |
Sets the integer matrix for the given property name.
Exception will be raised if invalid property name is used. This is a two dimensional array encoded into a single array.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
nRows | Number of Rows in the 2D matrix |
nColumns | Number of Columns in the 2D matrix |
matrixValue | Value to set for given property name. |
|
inline |
Sets the integer vector for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
intVector | Value to set for given property name. |
|
inline |
Sets the logical value for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
value | Value to set for given property name. |
|
inline |
Sets the point value for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
pointSc | Value to set for given property name. |
|
inline |
Sets the string value for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
value | Value to set for given property name. |
|
inline |
Sets the strings value for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
stringArray | Value to set for given property name. |
|
inline |
Sets the tagged object for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
taggedSc | Value to set for given property name. |
|
inline |
Sets the tagged object vector for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
tagVector | Value to set for given property name. |
|
inline |
Sets the vector value for the given property name.
Exception will be raised if invalid property name is used.
Created in NX7.5.0
License requirements: None.
propertyName | Name of the property |
vector | Value to set for given property name. |
|
get |
Returns the length of the list
Created in NX7.5.0
License requirements: None.
|
get |
Returns the mode of the list
Created in NX7.5.0
License requirements: None.