2022 Class
Changes 8
C

ExternalDefinitionCreationOptions

Description:
An option class used for creating a new shared parameter definition, including options such as name, type, visibility, Guid description and modifiable flag.
Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.ExternalDefinitionCreationOptions
public class ExternalDefinitionCreationOptions : IDisposable
Name Return Type Description
C ExternalDefinitionCreationOptions(String, ForgeTypeId) None Constructs the options using a specified name and type.
C ExternalDefinitionCreationOptions(String, ParameterType) the Constructs the options using a specified name and type.
Name Return Type Description
M Dispose() None Releases all resources used by the
M GetDataType() ForgeTypeId Gets the identifier describing the parameter's data type. The identifier may belong to either a spec or a category. If it is a category, the parameter is a Family Type parameter of that category.
M SetDataType(ForgeTypeId) None Sets the parameter's data type.
Name Return Type Description
P Description string The description of the parameter definition to be created. The description will be used as tooltip in the Revit UI including in the properties palette. The default is an empty string.
P GUID Guid The GUID to use for this parameter definition. If not explicitly set, a random GUID is used.
P HideWhenNoValue bool This property indicates whether this parameter should be hidden from the properties palette when it doesn't have a value.
P IsValidObject bool Specifies whether the .NET object represents a valid Revit entity.
P Name string The name of the parameter definition to be created.
P Type ParameterType The type of the parameter definition to be created.
P UserModifiable bool This property indicates whether this parameter can be modified by UI user or not.
P Visible bool True if the parameter is visible to the user, false if it is hidden and accessible only via the API. The default is true.