Interface IParameters

Gives access to parameter entities.

Namespace: TopSolid.Kernel.Automating

Assembly: TopSolid.Kernel.Automating.dll

Syntax

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

Remarks

This interface is available since v7.6.

Methods

Name	Description
AreColorParameterPossibleValuesStrict(ElementId)	Tells wether the possible values of the color parameter are strict.
AreRealParameterPossibleValuesStrict(ElementId)	Tells wether the possible values of the real parameter are strict.
ClearValue(ElementId)	Clears the value of a parameter.
CreateBooleanParameter(DocumentId, bool)	Creates a Boolean parameter entity in a document.
CreateBooleanRelayedParameter(DocumentId, ElementId, ParameterRelayType)	Creates a boolean relayed parameter entity in a document.
CreateColorParameter(DocumentId, Color)	Creates a color parameter entity in a document.
CreateColorRelayedParameter(DocumentId, ElementId, ParameterRelayType)	Creates a color relayed parameter entity in a document.
CreateColorTableParameter(DocumentId, SmartReal, List<SmartReal>, List<SmartColor>)	Creates a smart color table parameter creation operation in a document.
CreateDateTimeParameter(DocumentId, DateTime)	Creates a date time parameter entity in a document.
CreateIntegerParameter(DocumentId, int)	Creates an integer parameter entity in a document.
CreateIntegerRelayedParameter(DocumentId, ElementId, ParameterRelayType)	Creates an integer relayed parameter entity in a document.
CreateRealParameter(DocumentId, UnitType, double)	Creates a real parameter entity in a document.
CreateRealRelayedParameter(DocumentId, ElementId, ParameterRelayType)	Creates a real relayed parameter entity in a document.
CreateRealTableParameter(DocumentId, SmartReal, List<SmartReal>, List<SmartReal>)	Creates a smart real table parameter creation operation in a document.
CreateSmartBooleanParameter(DocumentId, SmartBoolean)	Creates a smart boolean parameter creation operation in a document.
CreateSmartIntegerParameter(DocumentId, SmartInteger)	Creates a smart integer parameter creation operation in a document.
CreateSmartRealParameter(DocumentId, SmartReal)	Creates a smart real parameter creation operation in a document.
CreateSmartTextParameter(DocumentId, SmartText)	Creates a smart text parameter creation operation in a document.
CreateTextParameter(DocumentId, string)	Creates a text parameter entity in a document.
CreateTextRelayedParameter(DocumentId, ElementId, ParameterRelayType)	Creates a text relayed parameter entity in a document.
CreateTextTableParameter(DocumentId, SmartReal, List<SmartReal>, List<SmartText>)	Creates a smart text table parameter creation operation in a document.
CreateToleranceParameter(DocumentId, UnitType, string, Real, Real)	Creates a tolerance parameter entity in a document.
CreateToleranceParameterFromDocument(DocumentId, DocumentId, string, string)	Creates a tolerance parameter entity corresponding to a class in a tolerance document.
CreateUserPropertyParameter(DocumentId, DocumentId)	Creates a parameter entity corresponding to a user property in a document.
GetAuthorParameter(DocumentId)	Gets the author name parameter entity of a document.
GetBooleanPublishingDefinition(ElementId)	Gets the definition of a Boolean publishing entity.
GetBooleanValue(ElementId)	Gets the value of a Boolean parameter.
GetCodeFamily(ElementId)	Gets the family of a code parameter.
GetCodeParameter(DocumentId)	Gets the code parameter entity of a document.
GetCodePossibleValues(ElementId)	Gets the code parameter possibles values.
GetCodeValue(ElementId)	Gets the value of a code parameter.
GetColorParameterPossibleValues(ElementId)	Gets the color parameter possibles values.
GetColorTableParameterCreation(ElementId, out SmartReal)	Gets a smart color table parameter creation operation.
GetColorTableParameterPossibleValues(ElementId, out List<SmartReal>, out List<SmartColor>)	Gets possible values from color table parameter creation operation.
GetColorValue(ElementId)	Gets the value of a Color parameter.
GetCommentParameter(DocumentId)	Gets the comment parameter entity of a document.
GetComplementaryPartNumberParameter(DocumentId)	Gets the complementary part number parameter entity of a document.
GetCreationDateParameter(DocumentId)	Gets the creation date parameter entity of a document.
GetDateTimeValue(ElementId)	Gets the value of a date time parameter.
GetDescriptionParameter(DocumentId)	Gets the description parameter entity of a document.
GetDocumentParameterPossibleValues(ElementId)	Gets the document parameter possibles values.
GetEnumerationDefinition(ElementId)	Gets the GUID of the class defining the enumeration of an enumeration parameter.
GetEnumerationDefinitions(out List<Guid>, out List<string>)	Gets the available enumeration definitions.
GetEnumerationPublishingDefinition(ElementId)	Gets the definition of an enumeration publishing entity.
GetEnumerationText(ElementId)	Gets the text corresponding to the value of an enumeration parameter.
GetEnumerationValue(ElementId)	Gets the value of an enumeration parameter.
GetEnumerationValues(Guid, out List<int>, out List<string>)	Gets the possible values of an enumeration.
GetFamilyValue(ElementId)	Gets the value of a family parameter.
GetIntegerPublishingDefinition(ElementId)	Gets the definition of an integer publishing entity.
GetIntegerValue(ElementId)	Gets the value of an integer parameter.
GetMajorRevisionParameter(DocumentId)	Gets the major revision parameter entity of a document.
GetManufacturerParameter(DocumentId)	Gets the manufacturer parameter entity of a document.
GetManufacturerPartNumberParameter(DocumentId)	Gets the manufacturer part number parameter entity of a document.
GetMinorRevisionParameter(DocumentId)	Gets the minor revision parameter entity of a document.
GetModificationDateParameter(DocumentId)	Gets the modification date parameter entity of a document.
GetNameParameter(DocumentId)	Gets the name parameter entity of a document.
GetParameterType(ElementId)	Gets the type of a parameter entity.
GetParameters(DocumentId)	Gets the parameters entities that are in the parameters folder of a document.
GetParametersFolder(DocumentId)	Gets the parameters folder entity of a document.
GetPartNumberParameter(DocumentId)	Gets the part number parameter entity of a document.
GetRealParameterConstraintsDiscretizationMode(ElementId)	Gets the real parameter constraints discretization mode.
GetRealParameterConstraintsDiscretizationOrigin(ElementId)	Gets the real parameter constraint discretization origin.
GetRealParameterConstraintsDiscretizationStep(ElementId)	Gets the real parameter constraint discretization step.
GetRealParameterConstraintsMaximumLimit(ElementId)	Gets the real parameter constraint maximum limit.
GetRealParameterConstraintsMinimumLimit(ElementId)	Gets the real parameter constraint minimum limite.
GetRealParameterConstraintsMode(ElementId)	Gets the real parameter constraints mode.
GetRealParameterPossibleValues(ElementId)	Gets the real parameter possibles values.
GetRealPublishingDefinition(ElementId)	Gets the definition of a real publishing entity.
GetRealTableParameterCreation(ElementId, out SmartReal)	Gets a smart real table parameter creation operation.
GetRealTableParameterPossibleValues(ElementId, out List<SmartReal>, out List<SmartReal>)	Gets possible values from real table parameter creation operation.
GetRealUnit(ElementId, out UnitType, out string)	Gets the unit of a real parameter.
GetRealValue(ElementId)	Gets the value of a real parameter.
GetRelayType(ElementId)	Gets the type of relay of the parameter.
GetRelayedParameter(ElementId)	Gets the parameter entity relayed by a relay parameter entity.
GetSmartBooleanParameterCreation(ElementId, out SmartBoolean)	Gets a smart boolean parameter creation operation.
GetSmartIntegerParameterCreation(ElementId, out SmartInteger)	Gets a smart integer parameter creation operation.
GetSmartRealParameterCreation(ElementId, out SmartReal)	Gets a smart real parameter creation operation.
GetSmartTextParameterCreation(ElementId, out SmartText)	Gets a smart text parameter creation operation.
GetStandardParameter(DocumentId)	Gets the standard parameter entity of a document.
GetSystemParametersFolder(DocumentId)	Gets the system parameters folder entity of a document.
GetTextLocalizedValue(ElementId)	Gets the localized value of a text parameter.
GetTextParameterizedValue(ElementId)	Gets the parameterized value of a parameterized text parameter.
GetTextPublishingDefinition(ElementId)	Gets the definition of a text publishing entity.
GetTextTableParameterCreation(ElementId, out SmartReal)	Gets a smart text table parameter creation operation.
GetTextTableParameterPossibleValues(ElementId, out List<SmartReal>, out List<SmartText>)	Gets possible values from text table parameter creation operation.
GetTextValue(ElementId)	Gets the value of a text parameter.
GetToleranceClass(ElementId)	Gets the tolerance class of a Tolerance parameter.
GetToleranceDefinition(ElementId)	Gets the tolerance definition of a Tolerance parameter.
GetToleranceLowerDeviation(ElementId)	Gets the lower deviation value of a Tolerance parameter.
GetToleranceUnit(ElementId)	Gets the unit of a Tolerance parameter.
GetToleranceUpperDeviation(ElementId)	Gets the upper deviation value of a Tolerance parameter.
GetUserEnumerationDefinition(ElementId)	Gets the user enumeration definition of a user enumeration parameter.
GetUserEnumerationPossibleValues(ElementId)	Gets the user enumeration parameter possibles values.
GetUserEnumerationPublishingDefinition(ElementId)	Gets the definition of a user enumeration publishing entity.
GetUserEnumerationText(ElementId)	Gets the text corresponding to the value of a user enumeration parameter.
GetUserEnumerationValue(ElementId)	Gets the value of a user enumeration parameter.
GetUserEnumerationValues(DocumentId, out List<int>, out List<string>)	Gets the possible values of a user enumeration.
GetUserPropertyDefinition(ElementId)	Gets the user property definition of a parameter entity corresponding to a user property.
HasCodePossibleValues(ElementId)	Tells wether the code parameter has possible values.
HasColorParameterPossibleValues(ElementId)	Tells wether the color parameter has possible values.
HasDocumentParameterPossibleValues(ElementId)	Tells wether the document parameter has possible values.
HasRealParameterConstraints(ElementId)	Determines whether the paramter has contraints.
HasRealParameterPossibleValues(ElementId)	Tells wether the real parameter has possible values.
HasUserEnumerationPossibleValues(ElementId)	Tells wether the user enumeration parameter has possible values.
HasValue(ElementId)	Tells whether a parameter has a value.
IsSmartRealParameterCreationUnitAuto(ElementId)	Tells whether a smart real parameter creation operation is in unit auto mode.
IsTextLocalized(ElementId)	Tells whether a text parameter is localized.
IsTextParameterized(ElementId)	Tells whether a text parameter is parameterized.
PublishBoolean(DocumentId, string, SmartBoolean)	Creates a Boolean publishing entity in a document.
PublishEnumeration(DocumentId, string, SmartEnumeration)	Creates an enumeration publishing entity in a document.
PublishInteger(DocumentId, string, SmartInteger)	Creates an integer publishing entity in a document.
PublishReal(DocumentId, string, SmartReal)	Creates a real publishing entity in a document.
PublishText(DocumentId, string, SmartText)	Creates a text publishing entity in a document.
PublishUserEnumeration(DocumentId, string, SmartUserEnumeration)	Creates a user enumeration publishing entity in a document.
SearchUserPropertyParameter(DocumentId, DocumentId)	Searches for a parameter entity corresponding to a user property in a document.
SetBooleanPublishingDefinition(ElementId, SmartBoolean)	Sets the definition of a Boolean publishing entity.
SetBooleanValue(ElementId, bool)	Sets the value of a Boolean parameter.
SetCodePossibleValues(ElementId, List<CodeProperty>)	Sets the code parameter possibles values.
SetCodeValue(ElementId, string)	Sets the value of a code parameter.
SetColorParameterPossibleValues(ElementId, List<ColorWithDescriptionProperty>)	Sets the color parameter possibles values.
SetColorParameterPossibleValuesStrictMode(ElementId, bool)	Sets the color parameter possible values strict mode.
SetColorTableParameterCreation(ElementId, SmartReal)	Sets a smart color table parameter creation operation.
SetColorTableParameterPossibleValues(ElementId, DocumentId, List<SmartReal>, List<SmartColor>)	Sets possible values for color table parameter creation operation.
SetColorValue(ElementId, Color)	Sets the value of a Color parameter.
SetDateTimeValue(ElementId, DateTime)	Sets the value of a date time parameter.
SetDocumentParameterPossibleValues(ElementId, List<DocumentProperty>)	Sets the document parameter possibles values.
SetEnumerationPublishingDefinition(ElementId, SmartEnumeration)	Sets the definition of an enumeration publishing entity.
SetEnumerationValue(ElementId, int)	Sets the value of an enumeration parameter.
SetFamilyValue(ElementId, DocumentId)	Sets the value of a family parameter.
SetIntegerPublishingDefinition(ElementId, SmartInteger)	Sets the definition of an integer publishing entity.
SetIntegerValue(ElementId, int)	Sets the value of an integer parameter.
SetRealParameterConstraintsDiscretizationOrigin(ElementId, RealProperty)	Sets the real parameter constraint discretization origin.
SetRealParameterConstraintsDiscretizationStep(ElementId, RealProperty)	Sets the real parameter constraint discretization step.
SetRealParameterConstraintsMaximumLimit(ElementId, RealProperty)	Sets the real parameter constraint maximum limit.
SetRealParameterConstraintsMinimumLimit(ElementId, RealProperty)	Sets the real parameter constraint minimum limite.
SetRealParameterConstraintsMode(ElementId, RealParameterConstraintsMode)	Sets the real parameter constraints mode.
SetRealParameterDiscretizationMode(ElementId, RealParameterDiscretizationMode)	Sets the real parameter constraints discretization mode.
SetRealParameterPossibleValues(ElementId, List<RealProperty>)	Sets the real parameter possibles values.
SetRealParameterPossibleValuesStrictMode(ElementId, bool)	Sets the real parameter possible values strict mode.
SetRealPublishingDefinition(ElementId, SmartReal)	Sets the definition of a real publishing entity.
SetRealTableParameterCreation(ElementId, SmartReal)	Sets a smart real table parameter creation operation.
SetRealTableParameterPossibleValues(ElementId, DocumentId, List<SmartReal>, List<SmartReal>)	Sets possible values for real table parameter creation operation.
SetRealUnit(ElementId, UnitType, string)	Sets the unit of a real parameter.
SetRealValue(ElementId, double)	Sets the value of a real parameter.
SetRelayedParameter(ElementId, ElementId)	Sets the parameter entity relayed by a relay parameter entity.
SetSmartBooleanParameterCreation(ElementId, SmartBoolean)	Sets a smart boolean parameter creation operation.
SetSmartIntegerParameterCreation(ElementId, SmartInteger)	Sets a smart integer parameter creation operation.
SetSmartRealParameterCreation(ElementId, SmartReal)	Sets a smart real parameter creation operation.
SetSmartRealParameterCreationUnitAuto(ElementId, bool)	Sets a smart real parameter creation operation unit auto mode.
SetSmartTextParameterCreation(ElementId, SmartText)	Sets a smart text parameter creation operation.
SetTextParameterizedValue(ElementId, string)	Sets the parameterized value of a parameterized text parameter.
SetTextPublishingDefinition(ElementId, SmartText)	Sets the definition of a text publishing entity.
SetTextTableParameterCreation(ElementId, SmartReal)	Sets a smart text table parameter creation operation.
SetTextTableParameterPossibleValues(ElementId, DocumentId, List<SmartReal>, List<SmartText>)	Sets possible values for text table parameter creation operation.
SetTextValue(ElementId, string)	Sets the value of a text parameter.
SetTolerance(ElementId, UnitType, Real, Real)	Sets the tolerance values of a Tolerance parameter.
SetToleranceFromDocument(ElementId, DocumentId, string)	Sets the tolerance values of a Tolerance parameter from a tolerance document.
SetUserEnumerationPossibleValues(ElementId, List<UserEnumerationProperty>)	Sets the user enumeration parameter possibles values.
SetUserEnumerationPublishingDefinition(ElementId, SmartUserEnumeration)	Sets the definition of a user enumeration publishing entity.
SetUserEnumerationValue(ElementId, int)	Sets the value of a user enumeration parameter.
SetUserEnumerationValues(DocumentId, List<int>, List<string>)	Sets the possible values of a user enumeration.