LabelUtils.GetLabelForSymbol Method

LabelUtilsGetLabelForSymbol Method

Gets the user-visible name for a symbol.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntax
public static string GetLabelForSymbol(
	ForgeTypeId symbolTypeId
)
Public Shared Function GetLabelForSymbol ( 
	symbolTypeId As ForgeTypeId
) As String
public:
static String^ GetLabelForSymbol(
	ForgeTypeId^ symbolTypeId
)
static member GetLabelForSymbol : 
        symbolTypeId : ForgeTypeId -> string 

Parameters

symbolTypeId  ForgeTypeId
Identifier of the symbol to get the user-visible name.

Return Value

String
Exceptions
ExceptionCondition
ArgumentException Symbol must have a definition.
ArgumentNullException A non-optional argument was null
Remarks
The name is obtained in the current Revit language.
See Also