Namespace: Autodesk.Revit.DB Class: GlobalParametersManager

GlobalParametersManager.FindByName

Method

Description:
Finds whether a global parameter with the given name exists in the input document.

Remarks:
No exception is thrown when no parameter with such a name exists in the document; instead, the method returns an ElementId.InvalidElementId.

Syntax

public static ElementId FindByName(
	Document document,
	string name
)

Public Shared Function FindByName ( 
	document As Document,
	name As String
) As ElementId

public:
static ElementId^ FindByName(
	Document^ document, 
	String^ name
)

static member FindByName : 
        document : Document * 
        name : string -> ElementId

Examples

/// <summary>
/// Tries to find a global parameter by its name. 
/// </summary>
/// <param name="document">Revit project document.</param>
/// <param name="name">Name of a global parameter.</param>
/// <returns>An Element Id of the global parameter, or InvalidElementId if none found</returns>
public ElementId GetGlobalParameterByName(Document document, String name)
{
    // Global parameters are not available in all documents.
    // They are available in projects, but not in families.
    if (GlobalParametersManager.AreGlobalParametersAllowed(document))
    {
        return GlobalParametersManager.FindByName(document, name);
    }

    // return an empty set if global parameters are not available in the document
    return ElementId.InvalidElementId;
}

' <summary>
' Tries to find a global parameter by its name. 
' </summary>
' <param name="document">Revit project document.</param>
' <param name="name">Name of a global parameter.</param>
' <returns>An Element Id of the global parameter, or InvalidElementId if none found</returns>
Public Function GetGlobalParameterByName(document As Document, name As [String]) As ElementId
    ' Global parameters are not available in all documents.
    ' They are available in projects, but not in families.
    If GlobalParametersManager.AreGlobalParametersAllowed(document) Then
        Return GlobalParametersManager.FindByName(document, name)
    End If

    ' return an empty set if global parameters are not available in the document
    Return ElementId.InvalidElementId
End Function

Parameters

Parameter	Type	Description
document	Document	The document expected to contain the global parameter.
name	String	Name of the global parameter

Return Value

Type	Description
ElementId	ElementId of the parameter element, or InvalidElementId if it was not found.

Exceptions

Exception	Condition
ArgumentNullException	A non-optional argument was null