Interface IParameters

Gives access to parameter entities.

Namespace: TopSolid.Kernel.Automating

Assembly: cs.temp.dll.dll

Syntax

[AvailableSinceVersion(7, 6, 0, 0)]
public interface IParameters

Remarks

This interface is available since v7.6.

Methods

AreColorParameterPossibleValuesStrict(ElementId)

Tells wether the possible values of the color parameter are strict.

Declaration

[AvailableSinceVersion(7, 18, 0, 0)]
bool AreColorParameterPossibleValuesStrict(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.

Returns

Type	Description
System.Boolean	Wether the parameter has strict possible values.

Remarks

This method is available since v7.18

AreRealParameterPossibleValuesStrict(ElementId)

Tells wether the possible values of the real parameter are strict.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
bool AreRealParameterPossibleValuesStrict(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.

Returns

Type	Description
System.Boolean	Wether the parameter has strict possible values.

Remarks

This method is available since v7.17.000.000.

ClearValue(ElementId)

Clears the value of a parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
void ClearValue(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to modify.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.

CreateBooleanParameter(DocumentId, Boolean)

Creates a Boolean parameter entity in a document.

Declaration

[AvailableSinceVersion(7, 6, 301, 40)]
ElementId CreateBooleanParameter(DocumentId inDocumentId, bool inValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
System.Boolean	inValue	Value.

Returns

Type	Description
ElementId	Identifier of the created parameter entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.301.40.

CreateBooleanRelayedParameter(DocumentId, ElementId, ParameterRelayType)

Creates a boolean relayed parameter entity in a document.

Declaration

[AvailableSinceVersion(7, 18, 400, 100)]
ElementId CreateBooleanRelayedParameter(DocumentId inDocumentId, ElementId inElementId, ParameterRelayType inRelayParameterType)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
ElementId	inElementId	Identifier of the boolean parameter entity to relay.
ParameterRelayType	inRelayParameterType	Type of relay.

Returns

Type	Description
ElementId

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.400.100.

CreateColorParameter(DocumentId, Color)

Creates a color parameter entity in a document.

Declaration

[AvailableSinceVersion(7, 18, 0, 0)]
ElementId CreateColorParameter(DocumentId inDocumentId, Color inValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
Color	inValue	Color

Returns

Type	Description
ElementId	Identifier of the created parameter entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.

CreateColorRelayedParameter(DocumentId, ElementId, ParameterRelayType)

Creates a color relayed parameter entity in a document.

Declaration

[AvailableSinceVersion(7, 18, 400, 100)]
ElementId CreateColorRelayedParameter(DocumentId inDocumentId, ElementId inElementId, ParameterRelayType inRelayParameterType)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
ElementId	inElementId	Identifier of the color parameter entity to relay.
ParameterRelayType	inRelayParameterType	Type of relay.

Returns

Type	Description
ElementId

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.400.100.

CreateColorTableParameter(DocumentId, SmartReal, List<SmartReal>, List<SmartColor>)

Creates a smart color table parameter creation operation in a document.

Declaration

[AvailableSinceVersion(7, 18, 0, 0)]
ElementId CreateColorTableParameter(DocumentId inDocumentId, SmartReal inSmartReal, List<SmartReal> inSourceSmartRealList, List<SmartColor> inResultSmartColorList)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
SmartReal	inSmartReal	Smart real value.
List<SmartReal>	inSourceSmartRealList	Smart real source values.
List<SmartColor>	inResultSmartColorList	Smart color result values.

Returns

Type	Description
ElementId	Identifier of the created operation

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.

CreateDateTimeParameter(DocumentId, DateTime)

Creates a date time parameter entity in a document.

Declaration

[AvailableSinceVersion(7, 6, 301, 40)]
ElementId CreateDateTimeParameter(DocumentId inDocumentId, DateTime inValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
System.DateTime	inValue	Value.

Returns

Type	Description
ElementId	Identifier of the created parameter entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.301.40.

CreateIntegerParameter(DocumentId, Int32)

Creates an integer parameter entity in a document.

Declaration

[AvailableSinceVersion(7, 6, 301, 40)]
ElementId CreateIntegerParameter(DocumentId inDocumentId, int inValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
System.Int32	inValue	Value.

Returns

Type	Description
ElementId	Identifier of the created parameter entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.301.40.

CreateIntegerRelayedParameter(DocumentId, ElementId, ParameterRelayType)

Creates an integer relayed parameter entity in a document.

Declaration

[AvailableSinceVersion(7, 18, 400, 100)]
ElementId CreateIntegerRelayedParameter(DocumentId inDocumentId, ElementId inElementId, ParameterRelayType inRelayParameterType)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
ElementId	inElementId	Identifier of the integer parameter entity to relay.
ParameterRelayType	inRelayParameterType	Type of relay.

Returns

Type	Description
ElementId

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.400.100.

CreateRealParameter(DocumentId, UnitType, Double)

Creates a real parameter entity in a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
ElementId CreateRealParameter(DocumentId inDocumentId, UnitType inUnitType, double inValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
UnitType	inUnitType	Type of units.
System.Double	inValue	Value in SI units.

Returns

Type	Description
ElementId	Identifier of the created parameter entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.

CreateRealRelayedParameter(DocumentId, ElementId, ParameterRelayType)

Creates a real relayed parameter entity in a document.

Declaration

[AvailableSinceVersion(7, 18, 400, 100)]
ElementId CreateRealRelayedParameter(DocumentId inDocumentId, ElementId inElementId, ParameterRelayType inRelayParameterType)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
ElementId	inElementId	Identifier of the real parameter entity to relay.
ParameterRelayType	inRelayParameterType	Type of relay.

Returns

Type	Description
ElementId

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.400.100.

CreateRealTableParameter(DocumentId, SmartReal, List<SmartReal>, List<SmartReal>)

Creates a smart real table parameter creation operation in a document.

Declaration

[AvailableSinceVersion(7, 18, 0, 0)]
ElementId CreateRealTableParameter(DocumentId inDocumentId, SmartReal inSmartReal, List<SmartReal> inSourceSmartRealList, List<SmartReal> inResultSmartRealList)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
SmartReal	inSmartReal	Smart real value.
List<SmartReal>	inSourceSmartRealList	Smart real source values.
List<SmartReal>	inResultSmartRealList	Smart real result values.

Returns

Type	Description
ElementId	Identifier of the created operation

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.

CreateSmartBooleanParameter(DocumentId, SmartBoolean)

Creates a smart boolean parameter creation operation in a document.

Declaration

[AvailableSinceVersion(7, 17, 400, 220)]
ElementId CreateSmartBooleanParameter(DocumentId inDocumentId, SmartBoolean inSmartBoolean)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
SmartBoolean	inSmartBoolean	Smart boolean value.

Returns

Type	Description
ElementId	Identifier of the created operation child parameter entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.17.

CreateSmartIntegerParameter(DocumentId, SmartInteger)

Creates a smart integer parameter creation operation in a document.

Declaration

[AvailableSinceVersion(7, 17, 400, 220)]
ElementId CreateSmartIntegerParameter(DocumentId inDocumentId, SmartInteger inSmartInteger)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
SmartInteger	inSmartInteger	Smart integer value.

Returns

Type	Description
ElementId	Identifier of the created operation child parameter entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.17.

CreateSmartRealParameter(DocumentId, SmartReal)

Creates a smart real parameter creation operation in a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
ElementId CreateSmartRealParameter(DocumentId inDocumentId, SmartReal inSmartReal)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
SmartReal	inSmartReal	Smart real value.

Returns

Type	Description
ElementId	Identifier of the created operation child parameter entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

The smart real parameter creation operation created is in "unit auto" mode set to false, it may be changed using the SetSmartRealParameterCreationUnitAuto(ElementId, Boolean) method.

This method is available since v7.6.

CreateSmartTextParameter(DocumentId, SmartText)

Creates a smart text parameter creation operation in a document.

Declaration

[AvailableSinceVersion(7, 10, 0, 0)]
ElementId CreateSmartTextParameter(DocumentId inDocumentId, SmartText inSmartText)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
SmartText	inSmartText	Smart text value.

Returns

Type	Description
ElementId	Identifier of the created operation child parameter entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.10.

Examples

How to create a text parameter made by concatenating the values of two existing text parameters named "t1" and "t2":

 SmartText smartText = new SmartText(SmartTextType.Formula, null, ElementId.Empty, ItemLabel.Empty, "t1 & t2");
    ElementId eltId = TopSolidHost.Parameters.CreateSmartTextParameter(docId, smartText);

CreateTextParameter(DocumentId, String)

Creates a text parameter entity in a document.

Declaration

[AvailableSinceVersion(7, 6, 301, 40)]
ElementId CreateTextParameter(DocumentId inDocumentId, string inValue)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
System.String	inValue	Value.

Returns

Type	Description
ElementId	Identifier of the created parameter entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.301.40.

CreateTextRelayedParameter(DocumentId, ElementId, ParameterRelayType)

Creates a text relayed parameter entity in a document.

Declaration

[AvailableSinceVersion(7, 18, 400, 100)]
ElementId CreateTextRelayedParameter(DocumentId inDocumentId, ElementId inElementId, ParameterRelayType inRelayParameterType)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
ElementId	inElementId	Identifier of the text parameter entity to relay.
ParameterRelayType	inRelayParameterType	Type of relay.

Returns

Type	Description
ElementId

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.400.100.

CreateTextTableParameter(DocumentId, SmartReal, List<SmartReal>, List<SmartText>)

Creates a smart text table parameter creation operation in a document.

Declaration

[AvailableSinceVersion(7, 18, 0, 0)]
ElementId CreateTextTableParameter(DocumentId inDocumentId, SmartReal inSmartReal, List<SmartReal> inSourceSmartRealList, List<SmartText> inResultSmartTextList)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
SmartReal	inSmartReal	Smart real value.
List<SmartReal>	inSourceSmartRealList	Smart real source values.
List<SmartText>	inResultSmartTextList	Smart text result values.

Returns

Type	Description
ElementId	Identifier of the created operation

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.

CreateToleranceParameter(DocumentId, UnitType, String, Real, Real)

Creates a tolerance parameter entity in a document.

Declaration

[AvailableSinceVersion(7, 14, 0, 0)]
ElementId CreateToleranceParameter(DocumentId inDocumentId, UnitType inUnitType, string inName, Real inUpperDeviation, Real inLowerDeviation)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
UnitType	inUnitType	Unit type.
System.String	inName	Name of the tolerance parameter.
Real	inUpperDeviation	Upper value.
Real	inLowerDeviation	Lower value.

Returns

Type	Description
ElementId	Identifier of the created parameter entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.14.

CreateToleranceParameterFromDocument(DocumentId, DocumentId, String, String)

Creates a tolerance parameter entity corresponding to a class in a tolerance document.

Declaration

[AvailableSinceVersion(7, 14, 0, 0)]
ElementId CreateToleranceParameterFromDocument(DocumentId inDocumentId, DocumentId inToleranceDocumentId, string inName, string inClass)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
DocumentId	inToleranceDocumentId	Identifier of the tolerance document.
System.String	inName	Name of the tolerance parameter.
System.String	inClass	Class tolerance.

Returns

Type	Description
ElementId	Identifier of the created parameter entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.14.

CreateUserPropertyParameter(DocumentId, DocumentId)

Creates a parameter entity corresponding to a user property in a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
ElementId CreateUserPropertyParameter(DocumentId inDocumentId, DocumentId inUserPropertyDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
DocumentId	inUserPropertyDocumentId	Identifier of the user propserty definition document.

Returns

Type	Description
ElementId	Identifier of the created parameter entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.

GetAuthorParameter(DocumentId)

Gets the author name parameter entity of a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
ElementId GetAuthorParameter(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
ElementId	Identifier of the author name parameter entity found.

Remarks

The author name parameter is a text parameter, its value may be obtained and modified using the GetTextValue(ElementId) and SetTextValue(ElementId, String) methods.

This method is available since v7.6.

GetBooleanPublishingDefinition(ElementId)

Gets the definition of a Boolean publishing entity.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
SmartBoolean GetBooleanPublishingDefinition(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the publishing entity to analyze.

Returns

Type	Description
SmartBoolean

Remarks

The value of the publishing entity may be obtained with the GetBooleanValue(ElementId) method.

This method is available since v7.8.

GetBooleanValue(ElementId)

Gets the value of a Boolean parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
bool GetBooleanValue(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
System.Boolean	Value of the parameter.

Remarks

This method is available since v7.6.

GetCodeFamily(ElementId)

Gets the family of a code parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
DocumentId GetCodeFamily(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
DocumentId	Family of the code parameter, as a family definition document identifier.

Remarks

This method is available since v7.6.

GetCodeParameter(DocumentId)

Gets the code parameter entity of a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
ElementId GetCodeParameter(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
ElementId	Identifier of the code parameter entity found.

Remarks

The code parameter is a text parameter, its value may be obtained and modified using the GetTextValue(ElementId) and SetTextValue(ElementId, String) methods.

This method is available since v7.6.

GetCodePossibleValues(ElementId)

Gets the code parameter possibles values.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
List<CodeProperty> GetCodePossibleValues(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.

Returns

Type	Description
List<CodeProperty>	The possibles values.

Remarks

This method is available since v7.17.000.000.

GetCodeValue(ElementId)

Gets the value of a code parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
string GetCodeValue(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
System.String	Value of the parameter.

Remarks

This method is available since v7.6.

GetColorParameterPossibleValues(ElementId)

Gets the color parameter possibles values.

Declaration

[AvailableSinceVersion(7, 18, 0, 0)]
List<ColorWithDescriptionProperty> GetColorParameterPossibleValues(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.

Returns

Type	Description
List<ColorWithDescriptionProperty>	The possibles values.

Remarks

This method is available since v7.18

GetColorTableParameterCreation(ElementId, out SmartReal)

Gets a smart color table parameter creation operation.

Declaration

[AvailableSinceVersion(7, 18, 0, 0)]
void GetColorTableParameterCreation(ElementId inElementId, out SmartReal outSmartReal)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the smart color table parameter creation operation to analyze.
SmartReal	outSmartReal	Smart real value.

Remarks

This method is available since v7.18.

GetColorTableParameterPossibleValues(ElementId, out List<SmartReal>, out List<SmartColor>)

Gets possible values from color table parameter creation operation.

Declaration

[AvailableSinceVersion(7, 18, 0, 0)]
void GetColorTableParameterPossibleValues(ElementId inElementId, out List<SmartReal> outSourceSmartRealList, out List<SmartColor> outResultSmartColorList)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the smart color table parameter creation operation.
List<SmartReal>	outSourceSmartRealList	Source values.
List<SmartColor>	outResultSmartColorList	Result values.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.

GetColorValue(ElementId)

Gets the value of a Color parameter.

Declaration

[AvailableSinceVersion(7, 15, 400, 100)]
Color GetColorValue(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
Color	Value of the parameter.

Remarks

This method is available since v7.15.400.100.

GetCommentParameter(DocumentId)

Gets the comment parameter entity of a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
ElementId GetCommentParameter(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
ElementId	Identifier of the comment parameter entity found.

Remarks

The comment parameter is a text parameter, its value may be obtained and modified using the GetTextValue(ElementId) and SetTextValue(ElementId, String) methods.

This method is available since v7.6.

GetComplementaryPartNumberParameter(DocumentId)

Gets the complementary part number parameter entity of a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
ElementId GetComplementaryPartNumberParameter(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
ElementId	Identifier of the complementary part number parameter entity found.

Remarks

The complementary part number parameter is a text parameter, its value may be obtained and modified using the GetTextValue(ElementId) and SetTextValue(ElementId, String) methods.

This method is available since v7.6.

GetCreationDateParameter(DocumentId)

Gets the creation date parameter entity of a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
ElementId GetCreationDateParameter(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
ElementId	Identifier of the creation date parameter entity found.

Remarks

The creation date parameter is a date parameter, its value may be obtained and modified using the GetDateTimeValue(ElementId) and SetDateTimeValue(ElementId, DateTime) methods.

This method is available since v7.6.

GetDateTimeValue(ElementId)

Gets the value of a date time parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
DateTime GetDateTimeValue(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
System.DateTime	Value of the parameter.

Remarks

This method is available since v7.6.

GetDescriptionParameter(DocumentId)

Gets the description parameter entity of a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
ElementId GetDescriptionParameter(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
ElementId	Identifier of the description parameter entity found.

Remarks

The description parameter is a text parameter, its value may be obtained and modified using the GetTextValue(ElementId) and SetTextValue(ElementId, String) methods.

This method is available since v7.6.

GetDocumentParameterPossibleValues(ElementId)

Gets the document parameter possibles values.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
List<DocumentProperty> GetDocumentParameterPossibleValues(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.

Returns

Type	Description
List<DocumentProperty>	The possibles values.

Remarks

This method must be used for Document parameter such as Material or Coating documents.

This method is available since v7.17.000.000.

GetEnumerationDefinition(ElementId)

Gets the GUID of the class defining the enumeration of an enumeration parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
Guid GetEnumerationDefinition(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
System.Guid	Enumeration GUID.

Remarks

This method is available since v7.6.

GetEnumerationDefinitions(out List<Guid>, out List<String>)

Gets the available enumeration definitions.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
void GetEnumerationDefinitions(out List<Guid> outGuids, out List<string> outNames)

Parameters

Type	Name	Description
List<System.Guid>	outGuids	GUIDs of the available classes defining an enumeration.
List<System.String>	outNames	Localized names of the classes.

Remarks

This method is available since v7.6.

GetEnumerationPublishingDefinition(ElementId)

Gets the definition of an enumeration publishing entity.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
SmartEnumeration GetEnumerationPublishingDefinition(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the publishing entity to analyze.

Returns

Type	Description
SmartEnumeration

Remarks

The value of the publishing entity may be obtained with the GetEnumerationValue(ElementId) method.

This method is available since v7.8.

GetEnumerationText(ElementId)

Gets the text corresponding to the value of an enumeration parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
string GetEnumerationText(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
System.String	Text corresponding to the value of the parameter.

Remarks

This method is available since v7.6.

GetEnumerationValue(ElementId)

Gets the value of an enumeration parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
int GetEnumerationValue(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
System.Int32	Value of the parameter.

Remarks

This method is available since v7.6.

GetEnumerationValues(Guid, out List<Int32>, out List<String>)

Gets the possible values of an enumeration.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
void GetEnumerationValues(Guid inGuid, out List<int> outValues, out List<string> outTexts)

Parameters

Type	Name	Description
System.Guid	inGuid	GUID of the enumeration definition to analyze.
List<System.Int32>	outValues	Possible values.
List<System.String>	outTexts	Texts of the possible values.

Remarks

This method is available since v7.6.

GetFamilyValue(ElementId)

Gets the value of a family parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
DocumentId GetFamilyValue(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
DocumentId	Value of the parameter, as a family definition document identifier.

Remarks

This method is available since v7.6.

GetIntegerPublishingDefinition(ElementId)

Gets the definition of an integer publishing entity.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
SmartInteger GetIntegerPublishingDefinition(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the publishing entity to analyze.

Returns

Type	Description
SmartInteger

Remarks

The value of the publishing entity may be obtained with the GetIntegerValue(ElementId) method.

This method is available since v7.8.

GetIntegerValue(ElementId)

Gets the value of an integer parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
int GetIntegerValue(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
System.Int32	Value of the parameter.

Remarks

This method is available since v7.6.

GetMajorRevisionParameter(DocumentId)

Gets the major revision parameter entity of a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
ElementId GetMajorRevisionParameter(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
ElementId	Identifier of the major revision parameter entity found.

Remarks

The major revision parameter is a text parameter, its value may be obtained and modified using the GetTextValue(ElementId) and SetTextValue(ElementId, String) methods.

This method is available since v7.6.

GetManufacturerParameter(DocumentId)

Gets the manufacturer parameter entity of a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
ElementId GetManufacturerParameter(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
ElementId	Identifier of the manufacturer parameter entity found.

Remarks

The manufacturer parameter is a text parameter, its value may be obtained and modified using the GetTextValue(ElementId) and SetTextValue(ElementId, String) methods.

This method is available since v7.6.

GetManufacturerPartNumberParameter(DocumentId)

Gets the manufacturer part number parameter entity of a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
ElementId GetManufacturerPartNumberParameter(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
ElementId	Identifier of the manufacturer part number parameter entity found.

Remarks

The manufacturer part number parameter is a text parameter, its value may be obtained and modified using the GetTextValue(ElementId) and SetTextValue(ElementId, String) methods.

This method is available since v7.6.

GetMinorRevisionParameter(DocumentId)

Gets the minor revision parameter entity of a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
ElementId GetMinorRevisionParameter(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
ElementId	Identifier of the minor revision parameter entity found.

Remarks

The minor revision parameter is a text parameter, its value may be obtained and modified using the GetTextValue(ElementId) and SetTextValue(ElementId, String) methods.

This method is available since v7.6.

GetModificationDateParameter(DocumentId)

Gets the modification date parameter entity of a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
ElementId GetModificationDateParameter(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
ElementId	Identifier of the modification date parameter entity found.

Remarks

The modification date parameter is a date parameter, its value may be obtained and modified using the GetDateTimeValue(ElementId) and SetDateTimeValue(ElementId, DateTime) methods.

This method is available since v7.6.

GetNameParameter(DocumentId)

Gets the name parameter entity of a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
ElementId GetNameParameter(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
ElementId	Identifier of the name parameter entity found.

Remarks

The name parameter is a text parameter, its value may be obtained and modified using the GetTextValue(ElementId) and SetTextValue(ElementId, String) methods.

This method is available since v7.6.

GetParameters(DocumentId)

Gets the parameters entities that are in the parameters folder of a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
List<ElementId> GetParameters(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
List<ElementId>	Parameters entities found.

Remarks

This method is available since v7.6.

GetParametersFolder(DocumentId)

Gets the parameters folder entity of a document.

Declaration

[AvailableSinceVersion(7, 10, 0, 0)]
ElementId GetParametersFolder(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
ElementId	Identifier of the parameters folder entity found.

Remarks

This method is available since v7.10.

GetParameterType(ElementId)

Gets the type of a parameter entity.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
ParameterType GetParameterType(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the element to analyze.

Returns

Type	Description
ParameterType	Type of the parameter, or None if the element is not a parameter entity.

Remarks

This method is available since v7.6.

GetPartNumberParameter(DocumentId)

Gets the part number parameter entity of a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
ElementId GetPartNumberParameter(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
ElementId	Identifier of the part number parameter entity found.

Remarks

The part number parameter is a text parameter, its value may be obtained and modified using the GetTextValue(ElementId) and SetTextValue(ElementId, String) methods.

This method is available since v7.6.

GetRealParameterConstraintsDiscretizationMode(ElementId)

Gets the real parameter constraints discretization mode.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
RealParameterDiscretizationMode GetRealParameterConstraintsDiscretizationMode(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.

Returns

Type	Description
RealParameterDiscretizationMode	The parameter constraints discretization mode.

Remarks

This method is available since v7.17.000.000.

GetRealParameterConstraintsDiscretizationOrigin(ElementId)

Gets the real parameter constraint discretization origin.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
RealProperty GetRealParameterConstraintsDiscretizationOrigin(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.

Returns

Type	Description
RealProperty	The parameter constraints discretization origin.

Remarks

This method is available since v7.17.000.000.

GetRealParameterConstraintsDiscretizationStep(ElementId)

Gets the real parameter constraint discretization step.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
RealProperty GetRealParameterConstraintsDiscretizationStep(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.

Returns

Type	Description
RealProperty	The parameter constraints discretization step.

Remarks

This method is available since v7.17.000.000.

GetRealParameterConstraintsMaximumLimit(ElementId)

Gets the real parameter constraint maximum limit.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
RealProperty GetRealParameterConstraintsMaximumLimit(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.

Returns

Type	Description
RealProperty	The minimum limit.

Remarks

This method is available since v7.17.000.000.

GetRealParameterConstraintsMinimumLimit(ElementId)

Gets the real parameter constraint minimum limite.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
RealProperty GetRealParameterConstraintsMinimumLimit(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.

Returns

Type	Description
RealProperty	The minimum limit.

Remarks

This method is available since v7.17.000.000.

GetRealParameterConstraintsMode(ElementId)

Gets the real parameter constraints mode.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
RealParameterConstraintsMode GetRealParameterConstraintsMode(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.

Returns

Type	Description
RealParameterConstraintsMode	The parameter constraints mode.

Remarks

This method is available since v7.17.000.000.

GetRealParameterPossibleValues(ElementId)

Gets the real parameter possibles values.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
List<RealProperty> GetRealParameterPossibleValues(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.

Returns

Type	Description
List<RealProperty>	The possibles values.

Remarks

This method is available since v7.17.000.000.

GetRealPublishingDefinition(ElementId)

Gets the definition of a real publishing entity.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
SmartReal GetRealPublishingDefinition(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the publishing entity to analyze.

Returns

Type	Description
SmartReal

Remarks

The value of the publishing entity may be obtained with the GetRealValue(ElementId) method.

This method is available since v7.8.

GetRealTableParameterCreation(ElementId, out SmartReal)

Gets a smart real table parameter creation operation.

Declaration

[AvailableSinceVersion(7, 18, 0, 0)]
void GetRealTableParameterCreation(ElementId inElementId, out SmartReal outSmartReal)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the smart real table parameter creation operation to analyze.
SmartReal	outSmartReal	Smart real value.

Remarks

This method is available since v7.18.

GetRealTableParameterPossibleValues(ElementId, out List<SmartReal>, out List<SmartReal>)

Gets possible values from real table parameter creation operation.

Declaration

[AvailableSinceVersion(7, 18, 0, 0)]
void GetRealTableParameterPossibleValues(ElementId inElementId, out List<SmartReal> outSourceSmartRealList, out List<SmartReal> outResultSmartRealList)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the smart real table parameter creation operation.
List<SmartReal>	outSourceSmartRealList	Source values.
List<SmartReal>	outResultSmartRealList	Result values.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.

GetRealUnit(ElementId, out UnitType, out String)

Gets the unit of a real parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
void GetRealUnit(ElementId inElementId, out UnitType outUnitType, out string outUnitSymbol)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.
UnitType	outUnitType	Unit type.
System.String	outUnitSymbol	Unit symbol in English.

Remarks

This method is available since v7.6.

GetRealValue(ElementId)

Gets the value of a real parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
double GetRealValue(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
System.Double	Value of the parameter in SI units.

Remarks

This method is available since v7.6.

GetRelayedParameter(ElementId)

Gets the parameter entity relayed by a relay parameter entity.

Declaration

[AvailableSinceVersion(7, 8, 303, 120)]
ElementId GetRelayedParameter(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the relay parameter entity to analyze.

Returns

Type	Description
ElementId	Parameter entity relayed by the specified relay parameter entity.

Remarks

This method is available since v7.8.303.120.

GetRelayType(ElementId)

Gets the type of relay of the parameter.

Declaration

[AvailableSinceVersion(7, 8, 303, 120)]
ParameterRelayType GetRelayType(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the element to analyze.

Returns

Type	Description
ParameterRelayType	Type of relay of the parameter, or None if the element is not a relay parameter entity.

Remarks

This method is available since v7.8.303.120.

GetSmartBooleanParameterCreation(ElementId, out SmartBoolean)

Gets a smart boolean parameter creation operation.

Declaration

[AvailableSinceVersion(7, 17, 400, 220)]
void GetSmartBooleanParameterCreation(ElementId inElementId, out SmartBoolean outSmartBoolean)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the smart boolean parameter creation operation to analyze.
SmartBoolean	outSmartBoolean	Smart boolean value.

Remarks

This method is available since v7.17.

GetSmartIntegerParameterCreation(ElementId, out SmartInteger)

Gets a smart integer parameter creation operation.

Declaration

[AvailableSinceVersion(7, 17, 400, 220)]
void GetSmartIntegerParameterCreation(ElementId inElementId, out SmartInteger outSmartInteger)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the smart integer parameter creation operation to analyze.
SmartInteger	outSmartInteger	Smart integer value.

Remarks

This method is available since v7.17.

GetSmartRealParameterCreation(ElementId, out SmartReal)

Gets a smart real parameter creation operation.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
void GetSmartRealParameterCreation(ElementId inElementId, out SmartReal outSmartReal)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the smart real parameter creation operation to analyze.
SmartReal	outSmartReal	Smart real value.

Remarks

This method is available since v7.8.

GetSmartTextParameterCreation(ElementId, out SmartText)

Gets a smart text parameter creation operation.

Declaration

[AvailableSinceVersion(7, 10, 0, 0)]
void GetSmartTextParameterCreation(ElementId inElementId, out SmartText outSmartText)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the smart text parameter creation operation to analyze.
SmartText	outSmartText	Smart text value.

Remarks

This method is available since v7.10.

GetStandardParameter(DocumentId)

Gets the standard parameter entity of a document.

Declaration

[AvailableSinceVersion(7, 7, 201, 100)]
ElementId GetStandardParameter(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
ElementId	Identifier of the standard parameter entity found.

Remarks

The standard parameter is an enumeration parameter, its value may be obtained and modified using the GetEnumerationValue(ElementId) and SetEnumerationValue(ElementId, Int32) methods.

This method is available since v7.7.201.100.

GetSystemParametersFolder(DocumentId)

Gets the system parameters folder entity of a document.

Declaration

[AvailableSinceVersion(7, 10, 0, 0)]
ElementId GetSystemParametersFolder(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
ElementId	Identifier of the system parameters folder entity found.

Remarks

This method is available since v7.10.

GetTextLocalizedValue(ElementId)

Gets the localized value of a text parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
string GetTextLocalizedValue(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
System.String	Localized value of the parameter.

Remarks

If the text is not localized, this method returns the same value than GetTextValue(ElementId).

This method is available since v7.6.

GetTextParameterizedValue(ElementId)

Gets the parameterized value of a parameterized text parameter.

Declaration

[AvailableSinceVersion(7, 7, 201, 200)]
string GetTextParameterizedValue(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
System.String	Parameterized value of the parameter (ex: "Hexagon Bolt ISO 4014 - [$Code]").

Remarks

If the text is not parameterized, this method returns null.

This method is available since v7.7.201.200.

GetTextPublishingDefinition(ElementId)

Gets the definition of a text publishing entity.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
SmartText GetTextPublishingDefinition(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the publishing entity to analyze.

Returns

Type	Description
SmartText

Remarks

The value of the publishing entity may be obtained with the GetTextValue(ElementId) method.

This method is available since v7.8.

GetTextTableParameterCreation(ElementId, out SmartReal)

Gets a smart text table parameter creation operation.

Declaration

[AvailableSinceVersion(7, 18, 0, 0)]
void GetTextTableParameterCreation(ElementId inElementId, out SmartReal outSmartReal)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the smart text table parameter creation operation to analyze.
SmartReal	outSmartReal	Smart real value.

Remarks

This method is available since v7.18.

GetTextTableParameterPossibleValues(ElementId, out List<SmartReal>, out List<SmartText>)

Gets possible values from text table parameter creation operation.

Declaration

[AvailableSinceVersion(7, 18, 0, 0)]
void GetTextTableParameterPossibleValues(ElementId inElementId, out List<SmartReal> outSourceSmartRealList, out List<SmartText> outResultSmartTextList)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the smart text table parameter creation operation.
List<SmartReal>	outSourceSmartRealList	Source values.
List<SmartText>	outResultSmartTextList	Result values.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.

GetTextValue(ElementId)

Gets the value of a text parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
string GetTextValue(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
System.String	Value of the parameter.

Remarks

If the text parameter is localized (as told by IsTextLocalized(ElementId)), the returned value is the unlocalized value.

To get the localized value of a localized text, GetTextLocalizedValue(ElementId) must be used.

This method is available since v7.6.

GetToleranceClass(ElementId)

Gets the tolerance class of a Tolerance parameter.

Declaration

[AvailableSinceVersion(7, 14, 0, 0)]
string GetToleranceClass(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
System.String	Tolerance class of the parameter.

Remarks

This method is available since v7.14.

GetToleranceDefinition(ElementId)

Gets the tolerance definition of a Tolerance parameter.

Declaration

[AvailableSinceVersion(7, 14, 0, 0)]
DocumentId GetToleranceDefinition(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
DocumentId	Tolerance definition of the parameter, as a tolerance document identifier.

Remarks

This method is available since v7.14.

GetToleranceLowerDeviation(ElementId)

Gets the lower deviation value of a Tolerance parameter.

Declaration

[AvailableSinceVersion(7, 14, 0, 0)]
Real GetToleranceLowerDeviation(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
Real	Lower deviation value of the parameter.

Remarks

This method is available since v7.14.

GetToleranceUnit(ElementId)

Gets the unit of a Tolerance parameter.

Declaration

[AvailableSinceVersion(7, 14, 0, 0)]
UnitType GetToleranceUnit(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
UnitType	Unit of the parameter.

Remarks

This method is available since v7.14.

GetToleranceUpperDeviation(ElementId)

Gets the upper deviation value of a Tolerance parameter.

Declaration

[AvailableSinceVersion(7, 14, 0, 0)]
Real GetToleranceUpperDeviation(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
Real	Upper deviation value of the parameter.

Remarks

This method is available since v7.14.

GetUserEnumerationDefinition(ElementId)

Gets the user enumeration definition of a user enumeration parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
DocumentId GetUserEnumerationDefinition(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
DocumentId	User enumeration definition of the parameter, as a user enumeration definition document identifier.

Remarks

This method is available since v7.6.

GetUserEnumerationPossibleValues(ElementId)

Gets the user enumeration parameter possibles values.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
List<UserEnumerationProperty> GetUserEnumerationPossibleValues(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.

Returns

Type	Description
List<UserEnumerationProperty>	The possibles values.

Remarks

This method is available since v7.17.000.000.

GetUserEnumerationPublishingDefinition(ElementId)

Gets the definition of a user enumeration publishing entity.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
SmartUserEnumeration GetUserEnumerationPublishingDefinition(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the publishing entity to analyze.

Returns

Type	Description
SmartUserEnumeration

Remarks

The value of the publishing entity may be obtained with the GetUserEnumerationValue(ElementId) method.

This method is available since v7.8.

GetUserEnumerationText(ElementId)

Gets the text corresponding to the value of a user enumeration parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
string GetUserEnumerationText(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
System.String	Text corresponding to the value of the parameter.

Remarks

This method is available since v7.6.

GetUserEnumerationValue(ElementId)

Gets the value of a user enumeration parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
int GetUserEnumerationValue(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
System.Int32	Value of the parameter.

Remarks

This method is available since v7.6.

GetUserEnumerationValues(DocumentId, out List<Int32>, out List<String>)

Gets the possible values of a user enumeration.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
void GetUserEnumerationValues(DocumentId inDocumentId, out List<int> outValues, out List<string> outTexts)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the user enumeration definition document to analyze.
List<System.Int32>	outValues	Possible values.
List<System.String>	outTexts	Texts of the possible values.

Remarks

This method is available since v7.6.

GetUserPropertyDefinition(ElementId)

Gets the user property definition of a parameter entity corresponding to a user property.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
DocumentId GetUserPropertyDefinition(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
DocumentId	Identifier of the user propserty definition document, or Empty if the parameter does not correspond to a user property.

Remarks

This method is available since v7.6.

HasCodePossibleValues(ElementId)

Tells wether the code parameter has possible values.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
bool HasCodePossibleValues(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.

Returns

Type	Description
System.Boolean	Wether the parameter has possible values.

Remarks

This method is available since v7.17.000.000.

HasColorParameterPossibleValues(ElementId)

Tells wether the color parameter has possible values.

Declaration

[AvailableSinceVersion(7, 18, 0, 0)]
bool HasColorParameterPossibleValues(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.

Returns

Type	Description
System.Boolean	Wether the parameter has possible values.

Remarks

This method is available since v7.18

HasDocumentParameterPossibleValues(ElementId)

Tells wether the document parameter has possible values.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
bool HasDocumentParameterPossibleValues(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.

Returns

Type	Description
System.Boolean	Wether the parameter has possible values.

Remarks

This method must be used for Document parameter such as Material or Coating documents.

This method is available since v7.17.000.000.

HasRealParameterConstraints(ElementId)

Determines whether the paramter has contraints.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
bool HasRealParameterConstraints(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.

Returns

Type	Description
System.Boolean	Whether the parameter has constraints.

Remarks

This method is available since v7.17.000.000.

HasRealParameterPossibleValues(ElementId)

Tells wether the real parameter has possible values.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
bool HasRealParameterPossibleValues(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.

Returns

Type	Description
System.Boolean	Wether the parameter has possible values.

Remarks

This method is available since v7.17.000.000.

HasUserEnumerationPossibleValues(ElementId)

Tells wether the user enumeration parameter has possible values.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
bool HasUserEnumerationPossibleValues(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.

Returns

Type	Description
System.Boolean	Wether the parameter has possible values.

Remarks

This method is available since v7.17.000.000.

HasValue(ElementId)

Tells whether a parameter has a value.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
bool HasValue(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
System.Boolean	The parameter has a value.

Remarks

This method is available since v7.6.

IsSmartRealParameterCreationUnitAuto(ElementId)

Tells whether a smart real parameter creation operation is in unit auto mode.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
bool IsSmartRealParameterCreationUnitAuto(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the smart real parameter creation operation to analyze.

Returns

Type	Description
System.Boolean	Whether the unit of the child parameter entity is automatically set to the unit of the smart real.

Remarks

This method is available since v7.8.

IsTextLocalized(ElementId)

Tells whether a text parameter is localized.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
bool IsTextLocalized(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
System.Boolean	Whether the text parameter is localized.

Remarks

This method is available since v7.6.

IsTextParameterized(ElementId)

Tells whether a text parameter is parameterized.

Declaration

[AvailableSinceVersion(7, 7, 201, 200)]
bool IsTextParameterized(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to analyze.

Returns

Type	Description
System.Boolean	Whether the text parameter is parameterized.

Remarks

This method is available since v7.7.201.200.

PublishBoolean(DocumentId, String, SmartBoolean)

Creates a Boolean publishing entity in a document.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
ElementId PublishBoolean(DocumentId inDocumentId, string inDescription, SmartBoolean inDefinition)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
System.String	inDescription	Publishing description.
SmartBoolean	inDefinition	Publishing definition.

Returns

Type	Description
ElementId	Identifier of the created publishing entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.8.

PublishEnumeration(DocumentId, String, SmartEnumeration)

Creates an enumeration publishing entity in a document.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
ElementId PublishEnumeration(DocumentId inDocumentId, string inDescription, SmartEnumeration inDefinition)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
System.String	inDescription	Publishing description.
SmartEnumeration	inDefinition	Publishing definition.

Returns

Type	Description
ElementId	Identifier of the created publishing entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.8.

PublishInteger(DocumentId, String, SmartInteger)

Creates an integer publishing entity in a document.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
ElementId PublishInteger(DocumentId inDocumentId, string inDescription, SmartInteger inDefinition)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
System.String	inDescription	Publishing description.
SmartInteger	inDefinition	Publishing definition.

Returns

Type	Description
ElementId	Identifier of the created publishing entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.8.

PublishReal(DocumentId, String, SmartReal)

Creates a real publishing entity in a document.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
ElementId PublishReal(DocumentId inDocumentId, string inDescription, SmartReal inDefinition)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
System.String	inDescription	Publishing description.
SmartReal	inDefinition	Publishing definition.

Returns

Type	Description
ElementId	Identifier of the created publishing entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.8.

PublishText(DocumentId, String, SmartText)

Creates a text publishing entity in a document.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
ElementId PublishText(DocumentId inDocumentId, string inDescription, SmartText inDefinition)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
System.String	inDescription	Publishing description.
SmartText	inDefinition	Publishing definition.

Returns

Type	Description
ElementId	Identifier of the created publishing entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.8.

PublishUserEnumeration(DocumentId, String, SmartUserEnumeration)

Creates a user enumeration publishing entity in a document.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
ElementId PublishUserEnumeration(DocumentId inDocumentId, string inDescription, SmartUserEnumeration inDefinition)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to modify.
System.String	inDescription	Publishing description.
SmartUserEnumeration	inDefinition	Publishing definition.

Returns

Type	Description
ElementId	Identifier of the created publishing entity.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.8.

SearchUserPropertyParameter(DocumentId, DocumentId)

Searches for a parameter entity corresponding to a user property in a document.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
ElementId SearchUserPropertyParameter(DocumentId inDocumentId, DocumentId inUserPropertyDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.
DocumentId	inUserPropertyDocumentId	Identifier of the user propserty definition document.

Returns

Type	Description
ElementId	Identifier of the parameter entity found, or Empty if not found.

Remarks

This method is available since v7.6.

SetBooleanPublishingDefinition(ElementId, SmartBoolean)

Sets the definition of a Boolean publishing entity.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
void SetBooleanPublishingDefinition(ElementId inElementId, SmartBoolean inDefinition)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the publishing entity to modify.
SmartBoolean	inDefinition	Publishing new definition.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.8.

SetBooleanValue(ElementId, Boolean)

Sets the value of a Boolean parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
void SetBooleanValue(ElementId inElementId, bool inValue)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to modify.
System.Boolean	inValue	New value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.

SetCodePossibleValues(ElementId, List<CodeProperty>)

Sets the code parameter possibles values.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
void SetCodePossibleValues(ElementId inElementId, List<CodeProperty> inProperties)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.
List<CodeProperty>	inProperties	The wanted possibles values.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.17.000.000.

SetCodeValue(ElementId, String)

Sets the value of a code parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
void SetCodeValue(ElementId inElementId, string inValue)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to modify.
System.String	inValue	New value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.

SetColorParameterPossibleValues(ElementId, List<ColorWithDescriptionProperty>)

Sets the color parameter possibles values.

Declaration

[AvailableSinceVersion(7, 18, 0, 0)]
void SetColorParameterPossibleValues(ElementId inElementId, List<ColorWithDescriptionProperty> inProperties)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.
List<ColorWithDescriptionProperty>	inProperties	The wanted possibles values.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18

SetColorParameterPossibleValuesStrictMode(ElementId, Boolean)

Sets the color parameter possible values strict mode.

Declaration

[AvailableSinceVersion(7, 18, 0, 0)]
void SetColorParameterPossibleValuesStrictMode(ElementId inElementId, bool isOn)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.
System.Boolean	isOn	Wether the strict mode is activated.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18

SetColorTableParameterCreation(ElementId, SmartReal)

Sets a smart color table parameter creation operation.

Declaration

[AvailableSinceVersion(7, 18, 0, 0)]
void SetColorTableParameterCreation(ElementId inElementId, SmartReal inSmartReal)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the smart color table parameter creation operation to modify.
SmartReal	inSmartReal	Smart real value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.

SetColorTableParameterPossibleValues(ElementId, DocumentId, List<SmartReal>, List<SmartColor>)

Sets possible values for color table parameter creation operation.

Declaration

[AvailableSinceVersion(7, 18, 0, 0)]
void SetColorTableParameterPossibleValues(ElementId inElementId, DocumentId inDocumentId, List<SmartReal> inSourceSmartRealList, List<SmartColor> inResultSmartColorList)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the smart color table parameter creation operation to modify.
DocumentId	inDocumentId	Identifier of the document.
List<SmartReal>	inSourceSmartRealList	Source values.
List<SmartColor>	inResultSmartColorList	Result values.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.

SetColorValue(ElementId, Color)

Sets the value of a Color parameter.

Declaration

[AvailableSinceVersion(7, 15, 400, 100)]
void SetColorValue(ElementId inElementId, Color inValue)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to modify.
Color	inValue	New value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.15.400.100.

SetDateTimeValue(ElementId, DateTime)

Sets the value of a date time parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
void SetDateTimeValue(ElementId inElementId, DateTime inValue)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to modify.
System.DateTime	inValue	New value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.

SetDocumentParameterPossibleValues(ElementId, List<DocumentProperty>)

Sets the document parameter possibles values.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
void SetDocumentParameterPossibleValues(ElementId inElementId, List<DocumentProperty> inProperties)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.
List<DocumentProperty>	inProperties	The wanted possibles values.

Remarks

This method must be used for Document parameter such as Material or Coating documents.

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.17.000.000.

SetEnumerationPublishingDefinition(ElementId, SmartEnumeration)

Sets the definition of an enumeration publishing entity.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
void SetEnumerationPublishingDefinition(ElementId inElementId, SmartEnumeration inDefinition)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the publishing entity to modify.
SmartEnumeration	inDefinition	Publishing new definition.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.8.

SetEnumerationValue(ElementId, Int32)

Sets the value of an enumeration parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
void SetEnumerationValue(ElementId inElementId, int inValue)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to modify.
System.Int32	inValue	New value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.

SetFamilyValue(ElementId, DocumentId)

Sets the value of a family parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
void SetFamilyValue(ElementId inElementId, DocumentId inValue)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to modify.
DocumentId	inValue	New value, as a family definition document identifier.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.

SetIntegerPublishingDefinition(ElementId, SmartInteger)

Sets the definition of an integer publishing entity.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
void SetIntegerPublishingDefinition(ElementId inElementId, SmartInteger inDefinition)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the publishing entity to modify.
SmartInteger	inDefinition	Publishing new definition.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.8.

SetIntegerValue(ElementId, Int32)

Sets the value of an integer parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
void SetIntegerValue(ElementId inElementId, int inValue)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to modify.
System.Int32	inValue	New value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.

SetRealParameterConstraintsDiscretizationOrigin(ElementId, RealProperty)

Sets the real parameter constraint discretization origin.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
void SetRealParameterConstraintsDiscretizationOrigin(ElementId inElementId, RealProperty inProperty)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.
RealProperty	inProperty	The new value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.17.000.000.

SetRealParameterConstraintsDiscretizationStep(ElementId, RealProperty)

Sets the real parameter constraint discretization step.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
void SetRealParameterConstraintsDiscretizationStep(ElementId inElementId, RealProperty inProperty)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.
RealProperty	inProperty	The new value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.17.000.000.

SetRealParameterConstraintsMaximumLimit(ElementId, RealProperty)

Sets the real parameter constraint maximum limit.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
void SetRealParameterConstraintsMaximumLimit(ElementId inElementId, RealProperty inProperty)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.
RealProperty	inProperty	The new value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.17.000.000.

SetRealParameterConstraintsMinimumLimit(ElementId, RealProperty)

Sets the real parameter constraint minimum limite.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
void SetRealParameterConstraintsMinimumLimit(ElementId inElementId, RealProperty inProperty)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.
RealProperty	inProperty	The new value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.17.000.000.

SetRealParameterConstraintsMode(ElementId, RealParameterConstraintsMode)

Sets the real parameter constraints mode.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
void SetRealParameterConstraintsMode(ElementId inElementId, RealParameterConstraintsMode inConstraintsMode)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.
RealParameterConstraintsMode	inConstraintsMode	Wanted constraints mode.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.17.000.000.

SetRealParameterDiscretizationMode(ElementId, RealParameterDiscretizationMode)

Sets the real parameter constraints discretization mode.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
void SetRealParameterDiscretizationMode(ElementId inElementId, RealParameterDiscretizationMode inDiscretizationMode)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.
RealParameterDiscretizationMode	inDiscretizationMode	Wanted discretization mode.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.17.000.000.

SetRealParameterPossibleValues(ElementId, List<RealProperty>)

Sets the real parameter possibles values.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
void SetRealParameterPossibleValues(ElementId inElementId, List<RealProperty> inProperties)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.
List<RealProperty>	inProperties	The wanted possibles values.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.17.000.000.

SetRealParameterPossibleValuesStrictMode(ElementId, Boolean)

Sets the real parameter possible values strict mode.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
void SetRealParameterPossibleValuesStrictMode(ElementId inElementId, bool isOn)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.
System.Boolean	isOn	Wether the strict mode is activated.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.17.000.000.

SetRealPublishingDefinition(ElementId, SmartReal)

Sets the definition of a real publishing entity.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
void SetRealPublishingDefinition(ElementId inElementId, SmartReal inDefinition)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the publishing entity to modify.
SmartReal	inDefinition	Publishing new definition.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.8.

SetRealTableParameterCreation(ElementId, SmartReal)

Sets a smart real table parameter creation operation.

Declaration

[AvailableSinceVersion(7, 18, 0, 0)]
void SetRealTableParameterCreation(ElementId inElementId, SmartReal inSmartReal)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the smart real table parameter creation operation to modify.
SmartReal	inSmartReal	Smart real value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.

SetRealTableParameterPossibleValues(ElementId, DocumentId, List<SmartReal>, List<SmartReal>)

Sets possible values for real table parameter creation operation.

Declaration

[AvailableSinceVersion(7, 18, 0, 0)]
void SetRealTableParameterPossibleValues(ElementId inElementId, DocumentId inDocumentId, List<SmartReal> inSourceSmartRealList, List<SmartReal> inResultSmartRealList)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the smart real table parameter creation operation to modify.
DocumentId	inDocumentId	Identifier of the document.
List<SmartReal>	inSourceSmartRealList	Source values.
List<SmartReal>	inResultSmartRealList	Result values.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.

SetRealUnit(ElementId, UnitType, String)

Sets the unit of a real parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
void SetRealUnit(ElementId inElementId, UnitType inUnitType, string inUnitSymbol)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to modify.
UnitType	inUnitType	Unit type.
System.String	inUnitSymbol	Unit symbol in English.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.

SetRealValue(ElementId, Double)

Sets the value of a real parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
void SetRealValue(ElementId inElementId, double inValue)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to modify.
System.Double	inValue	New value in SI units.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.

SetRelayedParameter(ElementId, ElementId)

Sets the parameter entity relayed by a relay parameter entity.

Declaration

[AvailableSinceVersion(7, 8, 303, 120)]
void SetRelayedParameter(ElementId inElementId, ElementId inRelayedId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the relay parameter entity to modify.
ElementId	inRelayedId	Identifier of the parameter entity to relay.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.8.303.120.

SetSmartBooleanParameterCreation(ElementId, SmartBoolean)

Sets a smart boolean parameter creation operation.

Declaration

[AvailableSinceVersion(7, 17, 400, 220)]
void SetSmartBooleanParameterCreation(ElementId inElementId, SmartBoolean inSmartBoolean)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the smart boolean parameter creation operation to modify.
SmartBoolean	inSmartBoolean	Smart boolean value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.17.

SetSmartIntegerParameterCreation(ElementId, SmartInteger)

Sets a smart integer parameter creation operation.

Declaration

[AvailableSinceVersion(7, 17, 400, 220)]
void SetSmartIntegerParameterCreation(ElementId inElementId, SmartInteger inSmartInteger)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the smart integer parameter creation operation to modify.
SmartInteger	inSmartInteger	Smart integer value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.17.

SetSmartRealParameterCreation(ElementId, SmartReal)

Sets a smart real parameter creation operation.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
void SetSmartRealParameterCreation(ElementId inElementId, SmartReal inSmartReal)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the smart real parameter creation operation to modify.
SmartReal	inSmartReal	Smart real value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.8.

SetSmartRealParameterCreationUnitAuto(ElementId, Boolean)

Sets a smart real parameter creation operation unit auto mode.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
void SetSmartRealParameterCreationUnitAuto(ElementId inElementId, bool inIsUnitAuto)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the smart real parameter creation operation to modify.
System.Boolean	inIsUnitAuto	Whether the unit of the child parameter entity is automatically set to the unit of the smart real.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.8.

SetSmartTextParameterCreation(ElementId, SmartText)

Sets a smart text parameter creation operation.

Declaration

[AvailableSinceVersion(7, 10, 0, 0)]
void SetSmartTextParameterCreation(ElementId inElementId, SmartText inSmartText)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the smart text parameter creation operation to modify.
SmartText	inSmartText	Smart text value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.10.

SetTextParameterizedValue(ElementId, String)

Sets the parameterized value of a parameterized text parameter.

Declaration

[AvailableSinceVersion(7, 7, 201, 200)]
void SetTextParameterizedValue(ElementId inElementId, string inValue)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to modify.
System.String	inValue	New parameterized value (ex: "Hexagon Bolt ISO 4014 - [$Code]").

Remarks

The text parameter is made parameterized if it was not already parameterized.

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.7.201.200.

SetTextPublishingDefinition(ElementId, SmartText)

Sets the definition of a text publishing entity.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
void SetTextPublishingDefinition(ElementId inElementId, SmartText inDefinition)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the publishing entity to modify.
SmartText	inDefinition	Publishing new definition.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.8.

SetTextTableParameterCreation(ElementId, SmartReal)

Sets a smart text table parameter creation operation.

Declaration

[AvailableSinceVersion(7, 18, 0, 0)]
void SetTextTableParameterCreation(ElementId inElementId, SmartReal inSmartReal)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the smart text table parameter creation operation to modify.
SmartReal	inSmartReal	Smart real value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.

SetTextTableParameterPossibleValues(ElementId, DocumentId, List<SmartReal>, List<SmartText>)

Sets possible values for text table parameter creation operation.

Declaration

[AvailableSinceVersion(7, 18, 0, 0)]
void SetTextTableParameterPossibleValues(ElementId inElementId, DocumentId inDocumentId, List<SmartReal> inSourceSmartRealList, List<SmartText> inResultSmartTextList)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the smart text table parameter creation operation to modify.
DocumentId	inDocumentId	Identifier of the document.
List<SmartReal>	inSourceSmartRealList	Source values.
List<SmartText>	inResultSmartTextList	Result values.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.18.

SetTextValue(ElementId, String)

Sets the value of a text parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
void SetTextValue(ElementId inElementId, string inValue)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to modify.
System.String	inValue	New value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.

SetTolerance(ElementId, UnitType, Real, Real)

Sets the tolerance values of a Tolerance parameter.

Declaration

[AvailableSinceVersion(7, 14, 0, 0)]
void SetTolerance(ElementId inElementId, UnitType inUnitType, Real inUpperDeviation, Real inLowerDeviation)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to modify.
UnitType	inUnitType	Unit type.
Real	inUpperDeviation	Upper value.
Real	inLowerDeviation	Lower value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.14.

SetToleranceFromDocument(ElementId, DocumentId, String)

Sets the tolerance values of a Tolerance parameter from a tolerance document.

Declaration

[AvailableSinceVersion(7, 14, 0, 0)]
void SetToleranceFromDocument(ElementId inElementId, DocumentId inToleranceDocumentId, string inClass)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to modify.
DocumentId	inToleranceDocumentId	Identifier of the tolerance document.
System.String	inClass	Class tolerance.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.14.

SetUserEnumerationPossibleValues(ElementId, List<UserEnumerationProperty>)

Sets the user enumeration parameter possibles values.

Declaration

[AvailableSinceVersion(7, 17, 0, 0)]
void SetUserEnumerationPossibleValues(ElementId inElementId, List<UserEnumerationProperty> inProperties)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter.
List<UserEnumerationProperty>	inProperties	The wanted possibles values.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.17.000.000.

SetUserEnumerationPublishingDefinition(ElementId, SmartUserEnumeration)

Sets the definition of a user enumeration publishing entity.

Declaration

[AvailableSinceVersion(7, 8, 0, 0)]
void SetUserEnumerationPublishingDefinition(ElementId inElementId, SmartUserEnumeration inDefinition)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the publishing entity to modify.
SmartUserEnumeration	inDefinition	Publishing new definition.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.8.

SetUserEnumerationValue(ElementId, Int32)

Sets the value of a user enumeration parameter.

Declaration

[AvailableSinceVersion(7, 6, 0, 0)]
void SetUserEnumerationValue(ElementId inElementId, int inValue)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the parameter to modify.
System.Int32	inValue	New value.

Remarks

StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.

This method is available since v7.6.

SetUserEnumerationValues(DocumentId, List<Int32>, List<String>)

Sets the possible values of a user enumeration.

Declaration

[AvailableSinceVersion(7, 10, 0, 0)]
void SetUserEnumerationValues(DocumentId inDocumentId, List<int> inValues, List<string> inTexts)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the user enumeration definition document to modify.
List<System.Int32>	inValues	Possible values.
List<System.String>	inTexts	Texts of the possible values.

Remarks

This method is available since v7.10.