2025.3 Members
Changes 2
M

ParameterUtils Methods

Name Return Type Description
M DownloadCompanyName(Document, ForgeTypeId) String Downloads the name of the given parameter's owning account and records it in the given document. If the owning account's name is already recorded in the given document, this method returns the name without downloading it again.
M DownloadParameter(Document, ParameterDownloadOptions, ForgeTypeId) SharedParameterElement Create a shared parameter element in the given document according to a parameter definition downloaded from the Parameters Service.
M DownloadParameterOptions(ForgeTypeId) ParameterDownloadOptions Retrieves settings associated with the given parameter from the Parameters Service.
M GetAllBuiltInGroups() IList<ForgeTypeId> Gets the identifiers of all built-in parameter groups.
M GetAllBuiltInParameters() IList<ForgeTypeId> Gets the identifiers of all built-in parameters.
M GetBuiltInParameter(ForgeTypeId) BuiltInParameter Gets the BuiltInParameter value corresponding to built-in parameter identified by the given ForgeTypeId.
M GetParameterTypeId(BuiltInParameter) ForgeTypeId Gets the ForgeTypeId identifying the built-in parameter corresponding to the given BuiltInParameter value.
M IsBuiltInGroup(ForgeTypeId) Boolean Checks whether a ForgeTypeId identifies a built-in parameter group.
M IsBuiltInParameter(ElementId) Boolean Checks whether an ElementId identifies a built-in parameter.
M IsBuiltInParameter(ForgeTypeId) Boolean Checks whether a ForgeTypeId identifies a built-in parameter.