Extract Shared Parameter Description

[Chris_BLTSMRT]

Hi All,

This is the last hurdle for me in completing a rough V1.0 and so far I have not been able to determine whether or not the data I need is accessible.

I am working on a project where I need extract the description data from a shared parameter within a family instance. I have been able to access all of the other parameter information I need, but this one piece of data keeps eluding me.

The issue is that when I try to cast my parameter from an internal parameter to the external definition it comes back as 'null'  thus not allowing me to access the desired Description property.

Questions:

Can the Description of a shared parameter be accessed using only the family?

If so, what would be the best way to access and extract the data?

Version: Revit 2018

Language: C#

When the program gets to the "ExternalDefinition def" line it shows the property as 'null'.

foreach (Parameter p in sharedParams)
{
    ExternalDefinition def = p.Definition as ExternalDefinition
    file.WriteLine($"Parameter Name: {p.Definition.Name} Parameter Description: {def.Description}");
}

[Chris_BLTSMRT]

Hi All,

This is the last hurdle for me in completing a rough V1.0 and so far I have not been able to determine whether or not the data I need is accessible.

I am working on a project where I need extract the description data from a shared parameter within a family instance. I have been able to access all of the other parameter information I need, but this one piece of data keeps eluding me.

The issue is that when I try to cast my parameter from an internal parameter to the external definition it comes back as 'null'  thus not allowing me to access the desired Description property.

Questions:

Can the Description of a shared parameter be accessed using only the family?

If so, what would be the best way to access and extract the data?

Version: Revit 2018

Language: C#

When the program gets to the "ExternalDefinition def" line it shows the property as 'null'.

foreach (Parameter p in sharedParams)
{
    ExternalDefinition def = p.Definition as ExternalDefinition
    file.WriteLine($"Parameter Name: {p.Definition.Name} Parameter Description: {def.Description}");
}

[RPTHOMAS108]

It is null because ExternalDefinitions become InternalDefinitions once in the project or family document.

Not sure you can get this from the family either, there is FamilyManager.SetDescription not a get.

Would probably have to parse shared parameter file.

[RPTHOMAS108]

It is null because ExternalDefinitions become InternalDefinitions once in the project or family document.

Not sure you can get this from the family either, there is FamilyManager.SetDescription not a get.

Would probably have to parse shared parameter file.

[Chris_BLTSMRT]

I see, that makes sense.

Parsing the Description from the file is not an option in this case since the file is not available.

So far the only solution is to transpose that portion through manual means which isn't ideal.

[Chris_BLTSMRT]

I see, that makes sense.

Parsing the Description from the file is not an option in this case since the file is not available.

So far the only solution is to transpose that portion through manual means which isn't ideal.

[RPTHOMAS108]

No there was an idea related to this however it was misrepresented in terms of being about the assignment of a tooltip rather than getting one. Assignment of tooltip is now implemented (although it was always easy with a manual SP file creation approach). So perhaps new idea related to getting a tooltip is now warranted.

https://forums.autodesk.com/t5/revit-ideas/assign-family-parameter-tooltip-description-from-the-api/...

This was the original discussion which lead to that idea.

https://forums.autodesk.com/t5/revit-api-forum/how-to-get-set-non-shared-parameter-tooltip-in-revit-...

In UI you can export a shared parameter into a SP file and get a tooltip that way. Same may be possible via post command but I haven't looked to see if it is post-able (probably isn't since it is contextual).

[RPTHOMAS108]

No there was an idea related to this however it was misrepresented in terms of being about the assignment of a tooltip rather than getting one. Assignment of tooltip is now implemented (although it was always easy with a manual SP file creation approach). So perhaps new idea related to getting a tooltip is now warranted.

https://forums.autodesk.com/t5/revit-ideas/assign-family-parameter-tooltip-description-from-the-api/...

This was the original discussion which lead to that idea.

https://forums.autodesk.com/t5/revit-api-forum/how-to-get-set-non-shared-parameter-tooltip-in-revit-...

In UI you can export a shared parameter into a SP file and get a tooltip that way. Same may be possible via post command but I haven't looked to see if it is post-able (probably isn't since it is contextual).

[Chris_BLTSMRT]

@RPTHOMAS108I appreciate all your help on this so far.

In looking at the linked topics in your reply, it seems the way I am currently approaching the problem won't work due to the Revit not having a "Get" command. I have used the set command for tool tips in other projects. Could you elaborate on the ability to export a shared parameter through the UI?

Does that technique require a specific shared parameter file to be associated with the project prior to exporting?

Thanks,

Chris

[Chris_BLTSMRT]

@RPTHOMAS108I appreciate all your help on this so far.

In looking at the linked topics in your reply, it seems the way I am currently approaching the problem won't work due to the Revit not having a "Get" command. I have used the set command for tool tips in other projects. Could you elaborate on the ability to export a shared parameter through the UI?

Does that technique require a specific shared parameter file to be associated with the project prior to exporting?

Thanks,

Chris

[RPTHOMAS108]

In the UI of a family document if you go into 

Create > Family Types

Pick the parameter and edit it (pencil icon) 

If there is a shared parameter file set then you can use the 'Export...' button and it will add the definition to that parameter file (button will not be available if attached SP file already contains it).

I doubt you could easily replicate this workflow with the API.

Outside of API might be possible but would require some form of windows automation technique which I don't often get involved with. I see people give similar windows automation suggestions for other things i.e. finding windows by handle/title and sending messages to click buttons and give things focus etc.

[RPTHOMAS108]

In the UI of a family document if you go into 

Create > Family Types

Pick the parameter and edit it (pencil icon) 

If there is a shared parameter file set then you can use the 'Export...' button and it will add the definition to that parameter file (button will not be available if attached SP file already contains it).

I doubt you could easily replicate this workflow with the API.

Outside of API might be possible but would require some form of windows automation technique which I don't often get involved with. I see people give similar windows automation suggestions for other things i.e. finding windows by handle/title and sending messages to click buttons and give things focus etc.

[Chris_BLTSMRT]

@RPTHOMAS108Wow I never knew about the export option if the parameter doesn't exist in the loaded shared parameter file! I am always learning something new!

Well, I think I have hit a block on the final step at this point. Luckily it was a small project and nothing too critical.

Thank you for your time!

[Chris_BLTSMRT]

@RPTHOMAS108Wow I never knew about the export option if the parameter doesn't exist in the loaded shared parameter file! I am always learning something new!

Well, I think I have hit a block on the final step at this point. Luckily it was a small project and nothing too critical.

Thank you for your time!