GlobalParametersManager

Description:
A class to access and query information about global parameters in Revit models.

Remarks:

This class provides access to general information and data of Global Parameter elements in a particular model. First of all, it is important to know that global parameters can be had in main project document; there are not supported in family documents. Availability of global parameters in a document can be tested by calling AreGlobalParametersAllowed(Document) method.

Global Parameter in a document can be obtained by calling either GetAllGlobalParameters(Document) or FindByName(Document, String). The former returns a set of all global parameters in the document, while the latter returns just the requested one, providing it exists.

Each global parameters must be created with a valid name that is unique in the scope of the document. To test whether a particular name is unique, programmer can use the IsUniqueName(Document, String) method.

More details about creating and manipulating global parameters can be found in the description of the GlobalParameter class.

Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.GlobalParametersManager

public class GlobalParametersManager : IDisposable

Public Class GlobalParametersManager _
	Implements IDisposable

public ref class GlobalParametersManager : IDisposable

/// <summary>
/// Counts all global parameter elements defined in the given document. 
/// </summary>
/// <param name="document">Revit project document.</param>
/// <returns>Total number of all global parameter elements in the document</returns>
public int CountAllGlobalParameters(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).Count;
    }

    return 0;   // no global parameters in this document
}

' <summary>
' Counts all global parameter elements defined in the given document. 
' </summary>
' <param name="document">Revit project document.</param>
' <returns>Total number of all global parameter elements in the document</returns>
Public Function CountAllGlobalParameters(document As Document) As Integer
    ' 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).Count
    End If

    Return 0
    ' no global parameters in this document
End Function

Name	Return Type	Description
M AreGlobalParametersAllowed(Document)	bool	Tests whether global parameters are allowed in the given document.
M Dispose()	None	Releases all resources used by the
M FindByName(Document, String)	ElementId	Finds whether a global parameter with the given name exists in the input document.
M GetAllGlobalParameters(Document)	ISet<ElementId>	Returns all global parameters available in the given document.
M GetGlobalParametersOrdered(Document)	IList<ElementId>	Returns all global paramters in an ordered array.
M IsUniqueName(Document, String)	bool	Tests whether a name is unique among existing global parameters of a given document.
M IsValidGlobalParameter(Document, ElementId)	bool	Tests whether an ElementId is of a global parameter in the given document.
M MoveParameterDownOrder(Document, ElementId)	bool	Moves given paramerer Down in the current order.
M MoveParameterUpOrder(Document, ElementId)	bool	Moves given paramerer Up in the current order.
M SortParameters(Document, ParametersOrder)	None	Sorts global parameters in the desired order.

Name	Return Type	Description
P IsValidObject	bool	Specifies whether the .NET object represents a valid Revit entity.