Namespace: Autodesk.Revit.DB Class: FamilyManager

FamilyManager.SetDescription

Method

Description:
Set the description for an existing family parameter. The description will be used as tooltip in the Revit UI including in the properties palette.

Syntax

public void SetDescription(
	FamilyParameter familyParameter,
	string description
)

Public Sub SetDescription ( 
	familyParameter As FamilyParameter,
	description As String
)

public:
void SetDescription(
	FamilyParameter^ familyParameter, 
	String^ description
)

member SetDescription : 
        familyParameter : FamilyParameter * 
        description : string -> unit

Parameters

Parameter	Type	Description
familyParameter	FamilyParameter	The family parameter.
description	String	The description of the family parameter.

Return Value

Exceptions

Exception	Condition
ArgumentNullException	Thrown when the input argument-"familyParameter"-is.
ArgumentException	Thrown when the input argument-"familyParameter"-is an invalid parameter or a builtIn parameter.