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

Represents a property table More...

Inheritance diagram for NXOpen.BasePropertyTable:
NXOpen.NXObject NXOpen.TaggedObject NXOpen.INXObject NXOpen.Utilities.NXRemotableObject IMessageSink NXOpen.CAE.PropertyTable NXOpen.CAE.AeroStructures.PropTable

Public Types

enum  BasePropertyType {
  Unknown, String, Boolean, Integer,
  Double, FieldWrapper, ScalarFieldWrapper, CoordinateSystem,
  DoubleArray, IntegerArray, PhysicalMaterial, Matrix,
  ScalarTable, ScalarFieldTableWrapper, ComplexScalarFieldWrapper, ComplexVectorFieldWrapper
}
 Property Types 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 void AddRowScalarFieldTable (string propertyName)
 Add row operation for scalar field table More...
 
unsafe void ClearTablePropertyOverride (string propertyName)
 Clear property override flag. More...
 
unsafe void CopyProperties (NXOpen.BasePropertyTable sourceTable)
 Copies the values from the input table into this table, the table descriptor neutral names must match More...
 
unsafe void CopyProperty (string propertyName, NXOpen.BasePropertyTable sourcePropertyTable)
 Copy the value of one property from the source table into this table More...
 
unsafe void DeleteRowScalarFieldTable (string propertyName)
 Delete row operation for scalar field table More...
 
unsafe
NXOpen.BasePropertyTable.BasePropertyType 
GetBasePropertyType (string propertyName)
 Returns the type of the property More...
 
unsafe
NXOpen.Fields.FieldExpression 
GetBaseScalarFieldPropertyValue (string propertyName)
 Returns the field expression NXOpen.Fields.FieldExpression value of the property More...
 
unsafe void GetBaseScalarWithDataPropertyValue (string propertyName, out double propertyValue, out NXOpen.Unit unitType)
 Returns the double value of the property with units More...
 
unsafe bool GetBooleanPropertyValue (string propertyName)
 Returns the boolean value of the property More...
 
unsafe
NXOpen.Fields.ComplexScalarFieldWrapper 
GetComplexScalarFieldWrapperPropertyValue (string propertyName)
 Returns the complex scalar field wrapper NXOpen.Fields.ComplexScalarFieldWrapper More...
 
unsafe
NXOpen.Fields.ComplexVectorFieldWrapper 
GetComplexVectorFieldWrapperPropertyValue (string propertyName)
 Returns the complex vector field wrapper NXOpen.Fields.ComplexScalarFieldWrapper More...
 
unsafe NXOpen.CoordinateSystem GetCoordinateSystemPropertyValue (string propertyName)
 Returns the coordinate system NXOpen.CoordinateSystem More...
 
unsafe double GetDoublePropertyValue (string propertyName)
 Returns the double value of the property More...
 
unsafe NXOpen.Fields.FieldWrapper GetFieldWrapperPropertyValue (string propertyName)
 Returns the field wrapper NXOpen.Fields.FieldWrapper More...
 
unsafe string GetFileReferencePropertyValue (string propertyName)
 Returns the file reference value of the property More...
 
unsafe int[] GetIntegerArrayPropertyValue (string propertyName)
 Returns the integer array value of the property More...
 
unsafe int GetIntegerPropertyValue (string propertyName)
 Returns the integer value of the property More...
 
unsafe void GetMaterialPropertyValue (string propertyName, out bool materialInherited, out NXOpen.PhysicalMaterial material)
 Gets the material value More...
 
unsafe NXOpen.ScalarMatrixValue GetMatrixPropertyValue (string propertyName)
 Returns a matrix cell value from the matrix value of the property More...
 
unsafe int GetPropertyCount ()
 The count of properties in the table More...
 
unsafe string GetPropertyNameByIndex (int index)
 Returns the name of the property More...
 
unsafe double[] GetScalarArrayPropertyValue (string propertyName)
 Returns the scalar array value of the property. More...
 
unsafe void GetScalarArrayWithUnitsPropertyValue (string propertyName, out double[] propertyValue, out NXOpen.Unit unitType)
 Returns the scalar array and unit value of the property More...
 
unsafe void GetScalarFieldTableRowCol (string propertyName, out int nRows, out int nCols)
 Sets the scalar field wrapper NXOpen.Fields.ScalarFieldWrapper More...
 
unsafe
NXOpen.Fields.ScalarFieldWrapper 
GetScalarFieldWrapperByIndex (int iRow, int iCol, string propertyName)
 Returns the scalar field wrapper NXOpen.Fields.FieldWrapper More...
 
unsafe
NXOpen.Fields.ScalarFieldWrapper 
GetScalarFieldWrapperPropertyValue (string propertyName)
 Returns the scalar field wrapper NXOpen.Fields.ScalarFieldWrapper More...
 
unsafe NXOpen.Expression GetScalarPropertyValue (string propertyName)
 Returns the expression NXOpen.Expression value of the property Use NXOpen.BasePropertyTable.SetBaseScalarWithDataPropertyValue for a constant value when an expression NXOpen.Expression is not needed. More...
 
unsafe NXOpen.ScalarTableValue GetScalarTablePropertyValue (string propertyName)
 Returns a scalar table value value from the scalar table value of the property More...
 
unsafe string GetStringPropertyValue (string propertyName)
 Returns the string value of the property More...
 
unsafe void SetBaseScalarFieldPropertyValue (string propertyName, NXOpen.Fields.FieldExpression propertyValue)
 Sets the field expression NXOpen.Fields.FieldExpression value of the property More...
 
unsafe void SetBaseScalarWithDataPropertyValue (string propertyName, double propertyValue, NXOpen.Unit unitType)
 Sets the the Scalar property as a constant double value with units. More...
 
unsafe void SetBaseScalarWithDataPropertyValue (string propertyName, string propertyValue, NXOpen.Unit unitType)
 Sets the the Scalar property as a string value with units. More...
 
unsafe void SetBooleanPropertyValue (string propertyName, bool propertyValue)
 Sets the boolean value of the property More...
 
unsafe void SetComplexScalarFieldWrapperPropertyValue (string propertyName, NXOpen.Fields.ComplexScalarFieldWrapper propertyValue)
 Sets the complex scalar field wrapper NXOpen.Fields.ComplexScalarFieldWrapper More...
 
unsafe void SetComplexVectorFieldWrapperPropertyValue (string propertyName, NXOpen.Fields.ComplexVectorFieldWrapper propertyValue)
 Sets the complex vector field wrapper NXOpen.Fields.ComplexVectorFieldWrapper More...
 
unsafe void SetCoordinateSystemPropertyValue (string propertyName, NXOpen.CoordinateSystem propertyValue)
 Sets the coordinate system NXOpen.CoordinateSystem More...
 
unsafe void SetDoublePropertyValue (string propertyName, double propertyValue)
 Sets the double value of the property More...
 
unsafe void SetFieldWrapperPropertyValue (string propertyName, NXOpen.Fields.FieldWrapper propertyValue)
 Sets the field wrapper NXOpen.Fields.FieldWrapper More...
 
unsafe void SetFileReferencePropertyValue (string propertyName, string propertyValue)
 Sets the file reference value of the property More...
 
unsafe void SetIntegerArrayPropertyValue (string propertyName, int[] propertyValue)
 Sets the integer array value of the property More...
 
unsafe void SetIntegerPropertyValue (string propertyName, int propertyValue)
 Sets the integer value of the property More...
 
unsafe void SetMaterialPropertyValue (string propertyName, bool materialInherited, NXOpen.PhysicalMaterial material)
 Sets the material value More...
 
unsafe void SetMatrixPropertyValue (string propertyName, NXOpen.ScalarMatrixValue matrix)
 Set a matrix cell value from the matrix value of the property More...
 
unsafe void SetScalarArrayPropertyValue (string propertyName, double[] propertyValue)
 Sets the scalar array value of the property. More...
 
unsafe void SetScalarArrayWithUnitsPropertyValue (string propertyName, double[] propertyValue, NXOpen.Unit unitType)
 Sets the scalar array and unit value of the property More...
 
unsafe void SetScalarFieldWrapperByIndex (int iRow, int iCol, string propertyName, NXOpen.Fields.ScalarFieldWrapper propertyValue)
 Sets the scalar field wrapper NXOpen.Fields.ScalarFieldWrapper More...
 
unsafe void SetScalarFieldWrapperPropertyValue (string propertyName, NXOpen.Fields.ScalarFieldWrapper propertyValue)
 Sets the scalar field wrapper NXOpen.Fields.ScalarFieldWrapper More...
 
unsafe void SetScalarPropertyValue (string propertyName, NXOpen.Expression propertyValue)
 Sets the expression NXOpen.Expression value of the property Use NXOpen.BasePropertyTable.SetBaseScalarWithDataPropertyValue for a constant value when an expression NXOpen.Expression is not needed. More...
 
unsafe void SetScalarTablePropertyValue (string propertyName, NXOpen.ScalarTableValue table)
 Set a scalar table value from the scalar table value of the property More...
 
unsafe void SetStringPropertyValue (string propertyName, string propertyValue)
 Sets the string value of the property More...
 
unsafe void SetTablePropertyOverride (string propertyName)
 Set property override flag. More...
 
unsafe void SetTablePropertyWithoutValue (string propertyName)
 Unset a property. 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 string DescriptorNeutralName [get]
 Returns the neutral name of the property table's descriptor More...
 
unsafe string DescriptorSpecificName [get]
 Returns the language specific name of the property table's descriptor 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 a property table

This is a sub object

Created in NX9.0.0

Member Enumeration Documentation

Property Types

Enumerator
Unknown 
String 
Boolean 
Integer 
Double 
FieldWrapper 
ScalarFieldWrapper 
CoordinateSystem 
DoubleArray 
IntegerArray 
PhysicalMaterial 
Matrix 
ScalarTable 
ScalarFieldTableWrapper 
ComplexScalarFieldWrapper 
ComplexVectorFieldWrapper 

Member Function Documentation

unsafe void NXOpen.BasePropertyTable.AddRowScalarFieldTable ( string  propertyName)
inline

Add row operation for scalar field table

Created in NX11.0.0

License requirements: None.

Parameters
propertyNamename of the property
unsafe void NXOpen.BasePropertyTable.ClearTablePropertyOverride ( string  propertyName)
inline

Clear property override flag.

Created in NX9.0.0

License requirements: None.

Parameters
propertyNamename of the property
unsafe void NXOpen.BasePropertyTable.CopyProperties ( NXOpen.BasePropertyTable  sourceTable)
inline

Copies the values from the input table into this table, the table descriptor neutral names must match

Created in NX9.0.0

License requirements: None.

Parameters
sourceTable
unsafe void NXOpen.BasePropertyTable.CopyProperty ( string  propertyName,
NXOpen.BasePropertyTable  sourcePropertyTable 
)
inline

Copy the value of one property from the source table into this table

Created in NX10.0.0

License requirements: None.

Parameters
propertyNamename of the property
sourcePropertyTablesource property table
unsafe void NXOpen.BasePropertyTable.DeleteRowScalarFieldTable ( string  propertyName)
inline

Delete row operation for scalar field table

Created in NX11.0.0

License requirements: None.

Parameters
propertyNamename of the property
unsafe NXOpen.BasePropertyTable.BasePropertyType NXOpen.BasePropertyTable.GetBasePropertyType ( string  propertyName)
inline

Returns the type of the property

Created in NX9.0.0

License requirements: None.

Parameters
propertyNamename of the property
Returns
type of the property
unsafe NXOpen.Fields.FieldExpression NXOpen.BasePropertyTable.GetBaseScalarFieldPropertyValue ( string  propertyName)
inline

Returns the field expression NXOpen.Fields.FieldExpression value of the property

Created in NX9.0.0

License requirements: None.

Parameters
propertyNamename of the property
Returns
value of the property
unsafe void NXOpen.BasePropertyTable.GetBaseScalarWithDataPropertyValue ( string  propertyName,
out double  propertyValue,
out NXOpen.Unit  unitType 
)
inline

Returns the double value of the property with units

Created in NX9.0.0

License requirements: None.

Parameters
propertyNamename of the Scalar
propertyValueThe current double value of the Scalar
unitTypeUnit type for the Scalar a null reference (Nothing in Visual Basic) if the Scalar has no units
unsafe bool NXOpen.BasePropertyTable.GetBooleanPropertyValue ( string  propertyName)
inline

Returns the boolean value of the property

Created in NX4.0.0

License requirements: None.

Parameters
propertyNamename of the property
Returns
value of the property
unsafe NXOpen.Fields.ComplexScalarFieldWrapper NXOpen.BasePropertyTable.GetComplexScalarFieldWrapperPropertyValue ( string  propertyName)
inline

Returns the complex scalar field wrapper NXOpen.Fields.ComplexScalarFieldWrapper

Created in NX11.0.0

License requirements: None.

Parameters
propertyNamename of the property
Returns
value of the property
unsafe NXOpen.Fields.ComplexVectorFieldWrapper NXOpen.BasePropertyTable.GetComplexVectorFieldWrapperPropertyValue ( string  propertyName)
inline

Returns the complex vector field wrapper NXOpen.Fields.ComplexScalarFieldWrapper

Created in NX12.0.0

License requirements: None.

Parameters
propertyNamename of the property
Returns
value of the property
unsafe NXOpen.CoordinateSystem NXOpen.BasePropertyTable.GetCoordinateSystemPropertyValue ( string  propertyName)
inline

Returns the coordinate system NXOpen.CoordinateSystem

Created in NX4.0.0

License requirements: None.

Parameters
propertyNamename of the property
Returns
value of the property
unsafe double NXOpen.BasePropertyTable.GetDoublePropertyValue ( string  propertyName)
inline

Returns the double value of the property

Created in NX4.0.0

License requirements: None.

Parameters
propertyNamename of the property
Returns
value of the property
unsafe NXOpen.Fields.FieldWrapper NXOpen.BasePropertyTable.GetFieldWrapperPropertyValue ( string  propertyName)
inline

Returns the field wrapper NXOpen.Fields.FieldWrapper

Created in NX6.0.0

License requirements: None.

Parameters
propertyNamename of the property
Returns
value of the property
unsafe string NXOpen.BasePropertyTable.GetFileReferencePropertyValue ( string  propertyName)
inline

Returns the file reference value of the property

Created in NX12.0.0

License requirements: None.

Parameters
propertyNamename of the property
Returns
value of the property
unsafe int [] NXOpen.BasePropertyTable.GetIntegerArrayPropertyValue ( string  propertyName)
inline

Returns the integer array value of the property

Created in NX5.0.0

License requirements: None.

Parameters
propertyName
Returns
unsafe int NXOpen.BasePropertyTable.GetIntegerPropertyValue ( string  propertyName)
inline

Returns the integer value of the property

Created in NX4.0.0

License requirements: None.

Parameters
propertyNamename of the property
Returns
value of the property
unsafe void NXOpen.BasePropertyTable.GetMaterialPropertyValue ( string  propertyName,
out bool  materialInherited,
out NXOpen.PhysicalMaterial  material 
)
inline

Gets the material value

Created in NX9.0.0

License requirements: None.

Parameters
propertyNamename of the property
materialInheritedtrue indicate the material is inherited from referenced object assignments such as geometry
materialthe material value to assign
unsafe NXOpen.ScalarMatrixValue NXOpen.BasePropertyTable.GetMatrixPropertyValue ( string  propertyName)
inline

Returns a matrix cell value from the matrix value of the property

Created in NX6.0.0

License requirements: None.

Parameters
propertyNamename of the property
Returns
NxM Scalar matrix
unsafe int NXOpen.BasePropertyTable.GetPropertyCount ( )
inline

The count of properties in the table

Created in NX4.0.0

License requirements: None.

Returns
count of properties
unsafe string NXOpen.BasePropertyTable.GetPropertyNameByIndex ( int  index)
inline

Returns the name of the property

Created in NX4.0.0

License requirements: None.

Parameters
indexindex of the property
Returns
name of the property
unsafe double [] NXOpen.BasePropertyTable.GetScalarArrayPropertyValue ( string  propertyName)
inline

Returns the scalar array value of the property.

Use NXOpen.BasePropertyTable.GetScalarArrayWithUnitsPropertyValue when other than base units are set.

Created in NX5.0.0

License requirements: None.

Parameters
propertyNamename of the property
Returns
value of the property
unsafe void NXOpen.BasePropertyTable.GetScalarArrayWithUnitsPropertyValue ( string  propertyName,
out double[]  propertyValue,
out NXOpen.Unit  unitType 
)
inline

Returns the scalar array and unit value of the property

Created in NX7.5.0

License requirements: None.

Parameters
propertyNamename of the property
propertyValuearray of values of the property
unitTypeUnit type for the Array a null reference (Nothing in Visual Basic) if the Array has no units
unsafe void NXOpen.BasePropertyTable.GetScalarFieldTableRowCol ( string  propertyName,
out int  nRows,
out int  nCols 
)
inline

Sets the scalar field wrapper NXOpen.Fields.ScalarFieldWrapper

Created in NX11.0.0

License requirements: None.

Parameters
propertyNamename of the property
nRowsrow number
nColscol number
unsafe NXOpen.Fields.ScalarFieldWrapper NXOpen.BasePropertyTable.GetScalarFieldWrapperByIndex ( int  iRow,
int  iCol,
string  propertyName 
)
inline

Returns the scalar field wrapper NXOpen.Fields.FieldWrapper

Created in NX11.0.0

License requirements: None.

Parameters
iRowrow number
iColcol number
propertyNamename of the property
Returns
value of the property
unsafe NXOpen.Fields.ScalarFieldWrapper NXOpen.BasePropertyTable.GetScalarFieldWrapperPropertyValue ( string  propertyName)
inline

Returns the scalar field wrapper NXOpen.Fields.ScalarFieldWrapper

Created in NX6.0.0

License requirements: None.

Parameters
propertyNamename of the property
Returns
value of the property
unsafe NXOpen.Expression NXOpen.BasePropertyTable.GetScalarPropertyValue ( string  propertyName)
inline

Returns the expression NXOpen.Expression value of the property Use NXOpen.BasePropertyTable.SetBaseScalarWithDataPropertyValue for a constant value when an expression NXOpen.Expression is not needed.

Created in NX4.0.0

License requirements: None.

Parameters
propertyNamename of the property
Returns
value of the property
unsafe NXOpen.ScalarTableValue NXOpen.BasePropertyTable.GetScalarTablePropertyValue ( string  propertyName)
inline

Returns a scalar table value value from the scalar table value of the property

Created in NX6.0.0

License requirements: None.

Parameters
propertyNamename of the property
Returns
NxM Scalar table
unsafe string NXOpen.BasePropertyTable.GetStringPropertyValue ( string  propertyName)
inline

Returns the string value of the property

Created in NX4.0.0

License requirements: None.

Parameters
propertyNamename of the property
Returns
value of the property
unsafe void NXOpen.BasePropertyTable.SetBaseScalarFieldPropertyValue ( string  propertyName,
NXOpen.Fields.FieldExpression  propertyValue 
)
inline

Sets the field expression NXOpen.Fields.FieldExpression value of the property

Created in NX9.0.0

License requirements: None.

Parameters
propertyNamename of the property
propertyValuevalue of the property
unsafe void NXOpen.BasePropertyTable.SetBaseScalarWithDataPropertyValue ( string  propertyName,
double  propertyValue,
NXOpen.Unit  unitType 
)
inline

Sets the the Scalar property as a constant double value with units.

Use NXOpen.BasePropertyTable.SetScalarPropertyValue to enable Design Logic for this property.

Created in NX9.0.0

License requirements: None.

Parameters
propertyNamename of the property
propertyValueThe double value for the Scalar
unitTypeUnit type for the Scalar a null reference (Nothing in Visual Basic) if the Scalar has no units
unsafe void NXOpen.BasePropertyTable.SetBaseScalarWithDataPropertyValue ( string  propertyName,
string  propertyValue,
NXOpen.Unit  unitType 
)
inline

Sets the the Scalar property as a string value with units.

When the string does not represent a constant number, then an expression is created. Once a property has an expression, subsequent set commands will retain the expression and edit the new string into it. The string must not be empty. To set this property to empty, use NXOpen.BasePropertyTable.SetTablePropertyWithoutValue .

Created in NX9.0.0

License requirements: None.

Parameters
propertyNamename of the property
propertyValueThe string value for the Scalar
unitTypeUnit type for the Scalar a null reference (Nothing in Visual Basic) if the Scalar has no units
unsafe void NXOpen.BasePropertyTable.SetBooleanPropertyValue ( string  propertyName,
bool  propertyValue 
)
inline

Sets the boolean value of the property

Created in NX4.0.0

License requirements: None.

Parameters
propertyNamename of the property
propertyValuevalue of the property
unsafe void NXOpen.BasePropertyTable.SetComplexScalarFieldWrapperPropertyValue ( string  propertyName,
NXOpen.Fields.ComplexScalarFieldWrapper  propertyValue 
)
inline

Sets the complex scalar field wrapper NXOpen.Fields.ComplexScalarFieldWrapper

Created in NX11.0.0

License requirements: None.

Parameters
propertyNamename of the property
propertyValuevalue of the property
unsafe void NXOpen.BasePropertyTable.SetComplexVectorFieldWrapperPropertyValue ( string  propertyName,
NXOpen.Fields.ComplexVectorFieldWrapper  propertyValue 
)
inline

Sets the complex vector field wrapper NXOpen.Fields.ComplexVectorFieldWrapper

Created in NX12.0.0

License requirements: None.

Parameters
propertyNamename of the property
propertyValuevalue of the property
unsafe void NXOpen.BasePropertyTable.SetCoordinateSystemPropertyValue ( string  propertyName,
NXOpen.CoordinateSystem  propertyValue 
)
inline

Sets the coordinate system NXOpen.CoordinateSystem

Created in NX4.0.0

License requirements: None.

Parameters
propertyNamename of the property
propertyValuevalue of the property
unsafe void NXOpen.BasePropertyTable.SetDoublePropertyValue ( string  propertyName,
double  propertyValue 
)
inline

Sets the double value of the property

Created in NX4.0.0

License requirements: None.

Parameters
propertyNamename of the property
propertyValuevalue of the property
unsafe void NXOpen.BasePropertyTable.SetFieldWrapperPropertyValue ( string  propertyName,
NXOpen.Fields.FieldWrapper  propertyValue 
)
inline

Sets the field wrapper NXOpen.Fields.FieldWrapper

Created in NX6.0.0

License requirements: None.

Parameters
propertyNamename of the property
propertyValuevalue of the property
unsafe void NXOpen.BasePropertyTable.SetFileReferencePropertyValue ( string  propertyName,
string  propertyValue 
)
inline

Sets the file reference value of the property

Created in NX12.0.0

License requirements: None.

Parameters
propertyNamename of the property
propertyValuevalue of the property
unsafe void NXOpen.BasePropertyTable.SetIntegerArrayPropertyValue ( string  propertyName,
int[]  propertyValue 
)
inline

Sets the integer array value of the property

Created in NX5.0.0

License requirements: None.

Parameters
propertyName
propertyValue
unsafe void NXOpen.BasePropertyTable.SetIntegerPropertyValue ( string  propertyName,
int  propertyValue 
)
inline

Sets the integer value of the property

Created in NX4.0.0

License requirements: None.

Parameters
propertyNamename of the property
propertyValuevalue of the property
unsafe void NXOpen.BasePropertyTable.SetMaterialPropertyValue ( string  propertyName,
bool  materialInherited,
NXOpen.PhysicalMaterial  material 
)
inline

Sets the material value

Created in NX6.0.3

License requirements: None.

Parameters
propertyNamename of the property
materialInheritedtrue indicate the material is inherited from referenced object assignments such as geometry
materialthe material value to assign
unsafe void NXOpen.BasePropertyTable.SetMatrixPropertyValue ( string  propertyName,
NXOpen.ScalarMatrixValue  matrix 
)
inline

Set a matrix cell value from the matrix value of the property

Created in NX6.0.0

License requirements: None.

Parameters
propertyNamename of the property
matrixNxM Scalar matrix
unsafe void NXOpen.BasePropertyTable.SetScalarArrayPropertyValue ( string  propertyName,
double[]  propertyValue 
)
inline

Sets the scalar array value of the property.

Use NXOpen.BasePropertyTable.SetScalarArrayWithUnitsPropertyValue when other than base units are set.

Created in NX5.0.0

License requirements: None.

Parameters
propertyNamename of the property
propertyValuevalue of the property
unsafe void NXOpen.BasePropertyTable.SetScalarArrayWithUnitsPropertyValue ( string  propertyName,
double[]  propertyValue,
NXOpen.Unit  unitType 
)
inline

Sets the scalar array and unit value of the property

Created in NX7.5.0

License requirements: None.

Parameters
propertyNamename of the property
propertyValuevalue of the property
unitTypeUnit type for the Array
unsafe void NXOpen.BasePropertyTable.SetScalarFieldWrapperByIndex ( int  iRow,
int  iCol,
string  propertyName,
NXOpen.Fields.ScalarFieldWrapper  propertyValue 
)
inline

Sets the scalar field wrapper NXOpen.Fields.ScalarFieldWrapper

Created in NX11.0.0

License requirements: None.

Parameters
iRowrow number
iColcol number
propertyNamename of the property
propertyValuevalue of the property
unsafe void NXOpen.BasePropertyTable.SetScalarFieldWrapperPropertyValue ( string  propertyName,
NXOpen.Fields.ScalarFieldWrapper  propertyValue 
)
inline

Sets the scalar field wrapper NXOpen.Fields.ScalarFieldWrapper

Created in NX6.0.0

License requirements: None.

Parameters
propertyNamename of the property
propertyValuevalue of the property
unsafe void NXOpen.BasePropertyTable.SetScalarPropertyValue ( string  propertyName,
NXOpen.Expression  propertyValue 
)
inline

Sets the expression NXOpen.Expression value of the property Use NXOpen.BasePropertyTable.SetBaseScalarWithDataPropertyValue for a constant value when an expression NXOpen.Expression is not needed.

Created in NX4.0.0

License requirements: None.

Parameters
propertyNamename of the property
propertyValuevalue of the property
unsafe void NXOpen.BasePropertyTable.SetScalarTablePropertyValue ( string  propertyName,
NXOpen.ScalarTableValue  table 
)
inline

Set a scalar table value from the scalar table value of the property

Created in NX6.0.0

License requirements: None.

Parameters
propertyNamename of the property
tableNxM Scalar table
unsafe void NXOpen.BasePropertyTable.SetStringPropertyValue ( string  propertyName,
string  propertyValue 
)
inline

Sets the string value of the property

Created in NX4.0.0

License requirements: None.

Parameters
propertyNamename of the property
propertyValuevalue of the property
unsafe void NXOpen.BasePropertyTable.SetTablePropertyOverride ( string  propertyName)
inline

Set property override flag.

Created in NX9.0.0

License requirements: None.

Parameters
propertyNamename of the property
unsafe void NXOpen.BasePropertyTable.SetTablePropertyWithoutValue ( string  propertyName)
inline

Unset a property.

Cause a property to be output to the solver as a blank so that the solver uses its default value

Created in NX7.5.0

License requirements: None.

Parameters
propertyNamename of the property

Property Documentation

unsafe string NXOpen.BasePropertyTable.DescriptorNeutralName
get

Returns the neutral name of the property table's descriptor

Created in NX8.5.0

License requirements: None.

unsafe string NXOpen.BasePropertyTable.DescriptorSpecificName
get

Returns the language specific name of the property table's descriptor

Created in NX8.5.0

License requirements: None.


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