Settings

Public Class

The settings object provides access to general components of the Autodesk Revit application, such as Categories.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.APIObject
Autodesk.Revit.DB.Settings

Namespace: Autodesk.Revit.DB

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class Settings : APIObject

The Settings type exposes the following members.

Properties

Name

Description

---

Public Property

Categories

Retrieves an object that provides access to all the categories contained in the Autodesk Revit application and project.

---

Public Property

ElectricalSetting

Retrieves an object that provides access to all the electrical settings include voltage type, distribution system type, demand factor, wire type in the Autodesk Revit application and project.

---

Public Property
Code Example

IsReadOnly

Identifies if the object is read-only or modifiable.
(Inherited from APIObject)

---

Public Property

TilePatterns

Retrieves an object that provides access to the TilePattern objects in the document.

---

Methods

Name

Description

---

Public Method
Dispose

Causes the object to release immediately any resources it may be utilizing.
(Inherited from APIObject)

---

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

---

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

---

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

---

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

---

Example

// Get some of the settings information, including categories and FillPatterns
Settings settings = document.Settings;

// Format the prompt information string
String prompt = "Setting information: ";
prompt += "\nNumber of Categories: " + settings.Categories.Size;
FilteredElementCollector fillPatternCollector = new FilteredElementCollector(document);
prompt += "\nNumber of Fill Patterns: " + fillPatternCollector.OfClass(typeof(FillPatternElement)).Count();
FilteredElementCollector linePatternCollector = new FilteredElementCollector(document);
prompt += "\nNumber of Line Patterns: " + linePatternCollector.OfClass(typeof(LinePatternElement)).Count();

// Give the user some information
TaskDialog.Show("Revit",prompt);