GlobalParametersManager.GetAllGlobalParameters Method

GlobalParametersManagerGetAllGlobalParameters Method

Returns all global parameters available in the given document.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntax
public static ISet<ElementId> GetAllGlobalParameters(
	Document document
)
Public Shared Function GetAllGlobalParameters ( 
	document As Document
) As ISet(Of ElementId)
public:
static ISet<ElementId^>^ GetAllGlobalParameters(
	Document^ document
)
static member GetAllGlobalParameters : 
        document : Document -> ISet<ElementId>

Parameters

document  Document
The document containing the global parameters

Return Value

ISetElementId
A collection of Element Ids of global parameter elements.
Exceptions
ExceptionCondition
ArgumentException Global parameters are not supported in the given document. A possible cause is that it is not a project document, for global parameters are not supported in Revit families.
ArgumentNullException A non-optional argument was null
Example
Copy
/// <summary>
/// Returns all global parameter elements defined in the given document. 
/// </summary>
/// <param name="document">Revit project document.</param>
/// <returns>A set of ElementIds of global parameter elements</returns>
public ISet<ElementId> GetAllGlobalParameters(Document document)
{
    // Global parameters are not available in all documents.
    // They are available in projects, but not in families.
    if (GlobalParametersManager.AreGlobalParametersAllowed(document))
    {
        return GlobalParametersManager.GetAllGlobalParameters(document);
    }

    // return an empty set if global parameters are not available in the document
    return new HashSet<ElementId>();
}
' <summary>
' Returns all global parameter elements defined in the given document. 
' </summary>
' <param name="document">Revit project document.</param>
' <returns>A set of ElementIds of global parameter elements</returns>
Public Function GetAllGlobalParameters(document As Document) As ISet(Of 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.GetAllGlobalParameters(document)
    End If

    ' return an empty set if global parameters are not available in the document
    Return New HashSet(Of ElementId)()
End Function

No code example is currently available or this language may not be supported.

No code example is currently available or this language may not be supported.

See Also

M:Autodesk.Revit.DB.GlobalParametersManager.GetAllGlobalParameters(Autodesk.Revit.DB.Document)