Haven't found any descriptors for ALL the different DATATYPE
parameters. Would imagine this as part of a database describing what the
datatype is and how it is used and what disciplines are available would be
supremely useful…
Did find these tidbits… Good overview to describe them all
|
Kind of Parameter
|
Who Creates it
|
Where does it live
|
Appear in Tags
|
Appear in Schedules
|
Description
|
|
System Parameters
|
Built in
|
Project and Family
|
Yes
|
Yes
|
Built-in to Revit,
You cannot change it
|
|
Shared Parameters
|
User Defined
|
Project and Family
|
Yes
|
Yes
|
Custom Parameter
created for the highest portability and flexibility
|
|
Project Parameters
|
User Defined
|
Project
|
No
|
Yes
|
Custom Parameter
accessible to all objects in a Project
|
|
Family Parameters
|
User Defined
|
Family
|
No
|
No
|
Custom Parameter
accessible only to the Family
|
And this from Autodesk on the file format:
Definition
File
Like (0)
The DefinitionFile
object represents a shared parameter file which is a common text file.
Definition File Format
The shared parameter
definition file is a text file (.txt) with three blocks: META, GROUP and
PARAM. The GROUP and PARAM blocks are relevant to the shared parameter
functionality in the Revit API. Do not edit the definition file directly;
instead, edit it using the UI or the API.
Although the Revit API
takes care of reading and writing this file, the following section provides
information the format of the file, which closely corresponds to the API
objects and methods used to access shared parameters. The file uses tabs to
separate fields and can be difficult to read in a text editor. The code
region below shows the contents of a sample shared parameter text file.
·
The GROUP block contains group
entries that associate every parameter definition with a group. The following
fields appear in the GROUP block:
o ID
- Uniquely identifies the group and associates the parameter definition with
a group.
o Name
- The group name displayed in the UI.
·
The PARAM block contains parameter
definitions. The following fields appear in the PARAM block:
o GUID
- Identifies the parameter definition.
o NAME
- Parameter definition name.
o DATATYPE
- Parameter type. This field can be a common type (TEXT, INTEGER, etc.),
structural type (FORCE, MOMENT, etc.) or common family type (Area Tags, etc).
Common type and structural type parameters are specified in the text file
directly (e.g.: TEXT, FORCE). If the value of the DATATYPE field is
FAMILYTYPE, an extra number is added. For example, FAMILYTYPE followed by
-2005020 represents Family type: Area Tags.
o DATACATEGORY
- An optional field for parameters whose DATATYPE is FAMILYTYPE.
o GROUP
- A group ID used to identify the group that includes the current parameter
definition.
o
VISIBLE
- Identifies whether the parameter is visible. The value of this field is 0
or 1.
0 = invisible
1 = visible
o DESCRIPTION
- An optional field for a tooltip for this parameter.
o
USERMODIFIABLE
- Identifies whether the parameter is editable by the user.
0 = user cannot edit the parameter and it is greyed out
in the UI
1 = user can edit the parameter value in the UI
In the sample definition
file, there are two groups:
·
MyGroup - ID 1 - Contains the
parameter definition for MyParam which is a Text type parameter, and the
definition for areaTags which is a FamilyType parameter.
·
AnotherGroup - ID 2 - Contains the
parameter definition for Price which is an Integer type parameter.
Of the 3 parameters in
the sample file, only Price has a description. All of the parameters are
visible and user modifiable.
|
Comments
Post a Comment