Settings

Settings

The following table identifies the commands in the Revit Platform UI Manage tab, and corresponding APIs.

Table 7: Settings in API and UI

UI command	Associated API	Reference
Settings Project Information	Document.ProjectInformation	See the following note
Settings Project Parameters	Document.ParameterBindings (Only for Shared Parameter)	See Shared Parameters
Project Location panel	Document.ProjectLocations Document.ActiveProjectLocation	See Place and Locations
Settings Additional Settings Fill Patterns	FilteredElementCollector filtering on class FillPatternElement	See the following note
Settings Materials	FilteredElementCollector filtering on class Material	See Materials Management
Settings Object Styles	Document.Settings.Categories	See the following note
Phasing Phases	Document.Phases	See the following note
Settings Structural Settings	Loads and related structural settings are available in the API	See Revit Structure
Settings Project Units	Document.GetUnits()	See Units
Area and Volume Calculations (on the Room & Area panel)	AreaVolumeSettings.GetAreaVolumeSettings()	See the following note

• Note: Project Information - The API provides the ProjectInfo class which is retrieved using Document.ProjectInformation to represent project information in the Revit project. The following table identifies the corresponding APIs for the Project Information parameters.

  Table 8: ProjectInformation

  Parameters	Corresponding API	Built-in Parameters
  Project Issue Date	ProjectInfo.IssueDate	PROJECT_ISSUE_DATE
  Project Status	ProjectInfo.Status	PROJECT_STATUS
  Client Name	ProjectInfo.ClientName	CLIENT_NAME
  Project Address	ProjectInfo.Address	PROJECT_ADDRESS
  Project Name	ProjectInfo.Name	PROJECT_NAME
  Project Number	ProjectInfo.Number	PROJECT_NUMBER

  Use the properties exposed by ProjectInfo to retrieve and set all strings. These properties are implemented by the corresponding built-in parameters. You can get or set the values through built-in parameters directly. For more information about how to gain access to these parameters through the built-in parameters, see Parameter in the Elements Essential section. The recommended way to get project information is to use the ProjectInfo properties.

• Fill Patterns - Retrieve all Fill Patterns in the current document using a FilteredElementCollector filtering on class FillPatternElement. Specific FillPatterns can be retrieved using the static methods FillPatternElement.GetFillPattern(Document, ElementId) or FillPatternElement.GetFillPatternByName (Document, string).
• Object Styles - Use Settings.Categories to retrieve all information in Category objects except for Line Style. For more details, see Categories in the Elements Essentialand Material sections.
• Phases - Revit maintains the element lifetime by phases, which are distinct time periods in the project lifecycle. All phases in a document are retrieved using the Document.Phases property. The property returns an array containing Phase class instances. However, the Revit API does not expose functions from the Phase class.
• Options - The Options command configures project global settings. You can retrieve an Options.Application instance using the Application.Options property. Currently, the Options.Application class only supports access to library paths and shared parameters file.
• Area and Volume Calculations - The AreaVolumeSettings class allows you to enable or disable volume calculations, and to change the room boundary location.