Revit API Docs

https://revapidocs.com/2022.htm
Admin
Official Autodesk Revit API documentation covering namespaces, API changes, deprecations, and new...
Tokens:15,445
Snippets:169
Trust Score:5.2
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get All Built-In Parameters

Source: https://revapidocs.com/2022.htm

Returns all available built-in parameters. This is a static utility function.

```csharp
ParameterUtils.GetAllBuiltInParameters()
```

--------------------------------

### Get All Specs

Source: https://revapidocs.com/2022.htm

Returns all available spec identifiers. Renamed to GetAllMeasurableSpecs() to clarify applicability to measurable specs only.

```csharp
SpecUtils.GetAllSpecs()
```

--------------------------------

### Get All Built-In Groups

Source: https://revapidocs.com/2022.htm

Returns all available built-in parameter groups. This is a static utility function.

```csharp
ParameterUtils.GetAllBuiltInGroups()
```

--------------------------------

### Get All Measurable Specs

Source: https://revapidocs.com/2022.htm

Returns all available measurable spec identifiers. This clarifies that they apply only to measurable specs.

```csharp
UnitUtils.GetAllMeasurableSpecs()
```

--------------------------------

### Get All Disciplines

Source: https://revapidocs.com/2022.htm

Provides a list of all available Revit disciplines, suitable for iteration. Previously, iteration would have used members of the UnitGroup enumeration.

```csharp
UnitUtils.GetAllDisciplines()
```

--------------------------------

### Get Built-In Parameter (Deprecated for Porting)

Source: https://revapidocs.com/2022.htm

Deprecated: Offered only for porting assistance from BuiltInParameter to ForgeTypeId. Use ParameterUtils.IsBuiltInParameter instead.

```csharp
ParameterUtils.GetBuiltInParameter(ForgeTypeId)
```

--------------------------------

### Get Label for Discipline

Source: https://revapidocs.com/2022.htm

Returns the user-visible name for a Revit discipline in the current Revit language. Requires a ForgeTypeId argument.

```csharp
LabelUtils.GetLabelForDiscipline(ForgeTypeId)
```

--------------------------------

### Get Built-In Parameter Group (Deprecated for Porting)

Source: https://revapidocs.com/2022.htm

Deprecated: Offered only for porting assistance from BuiltInParameterGroup to ForgeTypeId. Use ParameterUtils.IsBuiltInGroup instead.

```csharp
ParameterUtils.GetBuiltInParameterGroup(ForgeTypeId)
```

--------------------------------

### GenericZone Property

Source: https://revapidocs.com/2022.htm

Property to get or set the offset distance from a zone to its associated level.

```APIDOC
## GenericZone Property

### Description
Gets or sets the offset distance from this zone to the associated level.

### Property
- `GenericZone.LevelOffset`
```

--------------------------------

### Get Parameter Type (Deprecated for Porting)

Source: https://revapidocs.com/2022.htm

Deprecated: Offered only for porting assistance from ParameterType to ForgeTypeId.

```csharp
SpecUtils.GetParameterType(ForgeTypeId)
```

--------------------------------

### Get Label for Built-In Parameter (Deprecated)

Source: https://revapidocs.com/2022.htm

Deprecated: Use LabelUtils.GetLabelForBuiltInParameter(ForgeTypeId) instead. This method previously accepted BuiltInParameter.

```csharp
LabelUtils.GetLabelFor(BuiltInParameter)
```

--------------------------------

### Get Label for Built-In Parameter with Language (Deprecated)

Source: https://revapidocs.com/2022.htm

Deprecated: Use LabelUtils.GetLabelForBuiltInParameter(ForgeTypeId, LanguageType) instead. This method previously accepted BuiltInParameter and LanguageType.

```csharp
LabelUtils.GetLabelFor(BuiltInParameter, LanguageType)
```

--------------------------------

### Get Parameter Type ID (Deprecated for Porting)

Source: https://revapidocs.com/2022.htm

Deprecated: Offered only for porting assistance from BuiltInParameter to ForgeTypeId.

```csharp
ParameterUtils.GetParameterTypeId(BuiltInParameter)
```

--------------------------------

### Get Label for Spec (Deprecated)

Source: https://revapidocs.com/2022.htm

Deprecated: Use LabelUtils.GetLabelForSpec(ForgeTypeId) instead. This method previously accepted ParameterType.

```csharp
LabelUtils.GetLabelFor(ParameterType)
```

--------------------------------

### Get Label for Group (Deprecated)

Source: https://revapidocs.com/2022.htm

Deprecated: Use LabelUtils.GetLabelForGroup(ForgeTypeId) instead. This method previously accepted BuiltInParameterGroup.

```csharp
LabelUtils.GetLabelFor(BuiltInParameterGroup)
```

--------------------------------

### Get Spec Type ID (Deprecated for Porting)

Source: https://revapidocs.com/2022.htm

Deprecated: Offered only for porting assistance from ParameterType to ForgeTypeId.

```csharp
SpecUtils.GetSpecTypeId(ParameterType)
```

--------------------------------

### Editing Sketches with SketchEditScope

Source: https://revapidocs.com/2022.htm

Enables editing of sketch-based elements while preserving unchanged elements, with methods to start, check support, and manage the editing session.

```APIDOC
## Autodesk.Revit.DB.SketchEditScope constructor

### Description
Creates a new SketchEditScope.

### Method
`new SketchEditScope()`
```

```APIDOC
## SketchEditScope.Start()

### Description
Starts editing a particular sketch, including starting the associated transaction. After this is started only elements owned by the Sketch and new elements to be added to the Sketch may be modified.

### Method
`SketchEditScope.Start`
```

```APIDOC
## SketchEditScope.IsSketchEditingSupported()

### Description
Checks if a particular sketch can be edited with a SketchEditScope.

### Method
`SketchEditScope.IsSketchEditingSupported`
```

--------------------------------

### Get Parameter Group Type ID (Deprecated for Porting)

Source: https://revapidocs.com/2022.htm

Deprecated: Offered only for porting assistance from BuiltInParameterGroup to ForgeTypeId.

```csharp
ParameterUtils.GetParameterGroupTypeId(BuiltInParameterGroup)
```

--------------------------------

### Get Unit Group (Deprecated)

Source: https://revapidocs.com/2022.htm

Deprecated: Use UnitUtils.GetDiscipline(ForgeTypeId) instead. This method previously returned the unit group for a ForgeTypeId.

```csharp
UnitUtils.GetUnitGroup(ForgeTypeId)
```

--------------------------------

### Get Label for Spec with ForgeTypeId

Source: https://revapidocs.com/2022.htm

Expanded to accept a ForgeTypeId argument identifying any parameter data type. For a category identifier input, it returns the label of the Family Type spec for that category.

```csharp
LabelUtils.GetLabelForSpec(ForgeTypeId)
```

--------------------------------

### ParameterUtils.GetAllBuiltInParameters

Source: https://revapidocs.com/2022.htm

Retrieves all built-in parameters.

```APIDOC
## ParameterUtils.GetAllBuiltInParameters()

### Description
Returns a list of all built-in parameters.

### Method
static method
```

--------------------------------

### Floor Creation API Replacements

Source: https://revapidocs.com/2022.htm

Deprecated overloads for creating floors have been replaced with a new, more specific method.

```APIDOC
## Floor.Create Overloads

### Description
Replaces deprecated `Autodesk.Revit.Creation.Document.NewFloor()`, `NewSlab()`, and `NewFoundationSlab()` methods for creating floors.

### Method
Floor.Create(Document document, IList<CurveLoop> profile, ElementId floorTypeId, ElementId levelId)

### Parameters
- **document** (Document) - The current Revit document.
- **profile** (IList<CurveLoop>) - The profile of the floor.
- **floorTypeId** (ElementId) - The ID of the floor type.
- **levelId** (ElementId) - The ID of the level for the floor.
```

```APIDOC
## Floor.Create with Structural and Slope Options

### Description
This overload of `Floor.Create` allows for the creation of structural floors with specified slope.

### Method
Floor.Create(Document document, IList<CurveLoop> profile, ElementId floorTypeId, ElementId levelId, bool isStructural, Line slopeArrow, double slope)

### Parameters
- **document** (Document) - The current Revit document.
- **profile** (IList<CurveLoop>) - The profile of the floor.
- **floorTypeId** (ElementId) - The ID of the floor type.
- **levelId** (ElementId) - The ID of the level for the floor.
- **isStructural** (bool) - Indicates if the floor is structural.
- **slopeArrow** (Line) - The slope arrow defining the direction of the slope.
- **slope** (double) - The slope value.
```

--------------------------------

### UnitUtils.GetAllDisciplines

Source: https://revapidocs.com/2022.htm

Provides a list of all available Revit disciplines.

```APIDOC
## UnitUtils.GetAllDisciplines()

### Description
Provides a list of all available Revit disciplines, suitable for iteration.

### Method
static method
```

--------------------------------

### SpecUtils.GetAllSpecs

Source: https://revapidocs.com/2022.htm

Retrieves all measurable specs.

```APIDOC
## SpecUtils.GetAllMeasurableSpecs()

### Description
Returns a list of all measurable specs. These apply only to measurable specs, describing floating-point values associated with units of measurement.

### Method
static method
```

--------------------------------

### ParameterUtils.GetAllBuiltInGroups

Source: https://revapidocs.com/2022.htm

Retrieves all built-in parameter groups.

```APIDOC
## ParameterUtils.GetAllBuiltInGroups()

### Description
Returns a list of all built-in parameter groups.

### Method
static method
```

--------------------------------

### Rebar Conversion Methods

Source: https://revapidocs.com/2022.htm

Methods to convert RebarInSystem elements into Rebar elements.

```APIDOC
## Rebar Conversion Methods

### Description
Converts all RebarInSystem elements owned by the input element into equivalent Rebar elements.

### Methods
- `AreaReinforcement.ConvertRebarInSystemToRebars()`
- `PathReinforcement.ConvertRebarInSystemToRebars()`
```

--------------------------------

### Ceiling Creation API

Source: https://revapidocs.com/2022.htm

New methods for creating ceiling instances in a Revit project, including support for sloped ceilings.

```APIDOC
## Sketched Elements API
### Ceiling creation
The new methods:
  * Ceiling.Create(Document document, IList<CurveLoop> curveLoops, ElementId ceilingTypeId, ElementId level)
  * Ceiling.Create(Document document, IList<CurveLoop> curveLoops, ElementId ceilingTypeId, ElementId levelId, Line slopeArrow, double slope)

create a new instance of a ceiling in a Revit project, with one overload supporting a sloped ceiling.
```

--------------------------------

### MEPHiddenLineSettings Class and Methods

Source: https://revapidocs.com/2022.htm

Represents settings for mechanical hidden line display and provides a method to obtain these settings.

```APIDOC
## MEPHiddenLineSettings Class and Methods

### Description
Represents the settings of the mechanical hidden line display (e.g., ducts and pipes). It can be obtained from the static method `MEPHiddenLineSettings.GetMEPHiddenLineSettings(Document)`.

### Class
- `Autodesk.Revit.DB.Mechanical.MEPHiddenLineSettings`

### Static Method
- `MEPHiddenLineSettings.GetMEPHiddenLineSettings(Document)`

### Properties
- `MEPHiddenLineSettings.DrawHiddenLine`
- `MEPHiddenLineSettings.LineStyle`
- `MEPHiddenLineSettings.InsideGap`
- `MEPHiddenLineSettings.OutsideGap`
- `MEPHiddenLineSettings.SingleLineGap`
```

--------------------------------

### Floor APIs

Source: https://revapidocs.com/2022.htm

Provides methods for interacting with floor elements, including retrieving default floor types.

```APIDOC
## Floor.GetDefaultFloorType(Document document, bool isFoundation)

### Description
Returns the id of the default floor or foundation type for a document.

### Method
`Floor.GetDefaultFloorType`

### Parameters
#### Path Parameters
- **document** (Document) - Required - The document to retrieve the floor type from.
- **isFoundation** (bool) - Required - Specifies whether to get the default foundation type.
```

--------------------------------

### Wall APIs

Source: https://revapidocs.com/2022.htm

Offers methods for managing profile sketches associated with wall elements.

```APIDOC
## Wall.CreateProfileSketch()

### Description
Provides access to add profile sketches to wall elements that support them.

### Method
`Wall.CreateProfileSketch`
```

```APIDOC
## Wall.RemoveProfileSketch()

### Description
Provides access to remove profile sketches from wall elements that support them.

### Method
`Wall.RemoveProfileSketch`
```

```APIDOC
## Wall.CanHaveProfileSketch()

### Description
Checks if a wall element can have a profile sketch.

### Method
`Wall.CanHaveProfileSketch`
```

--------------------------------

### OpenOptions API

Source: https://revapidocs.com/2022.htm

Allows ignoring schema conflict errors on open.

```APIDOC
## OpenOptions.IgnoreExtensibleStorageSchemaConflict

### Description
Allows your application to ignore a schema conflict error on open. The default is false. Setting this to true will ignore the exception of schema conflict while opening the model. Data in the existing schema with the conflicting ID will be erased from the model.

### Type
- bool
```

--------------------------------

### RebarInSystem Methods

Source: https://revapidocs.com/2022.htm

Methods for manipulating individual bars within a RebarInSystem owned by PathReinforcement.

```APIDOC
## RebarInSystem Methods

### Description
Provides access to move, include, or remove individual bars within RebarInSystem elements owned by PathReinforcement. This functionality is not supported for RebarInSystem owned by AreaReinforcement.

### Methods
- `RebarInSystem.SetBarIncluded()`
- `RebarInSystem.MoveBarInSet()`
- `RebarInSystem.GetMovedBarTransform()`
- `RebarInSystem.ResetMovedBarTransform()`
- `RebarInSystem.CanEditIndividualBars()`
```

--------------------------------

### DirectShape API Additions - Reference Curves, Planes, and Points

Source: https://revapidocs.com/2022.htm

Enables the creation of reference curves, planes, and points inside DirectShape elements.

```APIDOC
## DirectShape API Additions - Reference Curves, Planes, and Points

### Description
Enables the creation of reference curves, planes and points inside DirectShape elements. Explicit bounds can be provided for direct shape reference curves and planes. Revit tools that can use named references within families will also be able to select the references inside the DirectShape elements.

### Methods
- `DirectShape.AddReferenceCurve()`
- `DirectShape.AddReferencePlane()`
- `DirectShape.AddReferencePoint()`
- `DirectShapeType.AddReferenceCurve()`
- `DirectShapeType.AddReferencePlane()`
- `DirectShapeType.AddReferencePoint()`

### DirectShapeReferenceOptions
- `DirectShapeReferenceOptions.Name`: Sets the assigned name for the reference. If specified, it is visible when picking the reference's geometry; otherwise, the default DirectShape element name is displayed.
- `DirectShapeReferenceOptions.IsValidReferenceName()`: Validates the name assigned to `DirectShapeReferenceOptions.Name`.

### Validators
- `DirectShape.IsValidReferenceCurve()`
- `DirectShape.IsValidReferencePlaneBoundingBoxUV()`
- `DirectShapeType.IsValidReferenceCurve()`
- `DirectShapeType.IsValidReferencePlaneBoundingBoxUV()`

### Validator Description
Validates the inputs needed for specifying a plane or curve explicit reference in the DirectShape.
```

--------------------------------

### RevitLinkType Enhancements for Cloud Models

Source: https://revapidocs.com/2022.htm

Methods for creating and managing Revit links to cloud models have been enhanced. ModelPathUtils.ConvertCloudGUIDsToCloudPath() can be used to construct cloud paths for these methods.

```APIDOC
## RevitLinkType.Create

### Description
Creates a new Revit link to a cloud model.

### Method
RevitLinkType.Create

### Parameters
- **Document** (Document) - The current Revit document.
- **ModelPath** (ModelPath) - The path to the cloud model.
- **RevitLinkOptions** (RevitLinkOptions) - Options for creating the Revit link.
```

```APIDOC
## RevitLinkType.LoadFrom

### Description
Loads a Revit link from a specified cloud model path.

### Method
RevitLinkType.LoadFrom

### Parameters
- **ModelPath** (ModelPath) - The path to the cloud model.
- **WorksetConfiguration** (WorksetConfiguration) - Configuration for worksets.
```

```APIDOC
## RevitLinkType.IsLoaded

### Description
Checks if a Revit link is currently loaded.

### Method
RevitLinkType.IsLoaded
```

```APIDOC
## RevitLinkType.Load

### Description
Loads a Revit link.

### Method
RevitLinkType.Load
```

```APIDOC
## RevitLinkType.Reload

### Description
Reloads an existing Revit link.

### Method
RevitLinkType.Reload
```

```APIDOC
## RevitLinkType.Unload

### Description
Unloads a Revit link.

### Method
RevitLinkType.Unload
```

--------------------------------

### RebarFreeFormAccessor Properties and Methods

Source: https://revapidocs.com/2022.htm

Access to properties and methods for freeform rebar elements.

```APIDOC
## RebarFreeFormAccessor Properties and Methods

### Description
Provides read and write access to properties of freeform rebar elements and allows changing the rebar shape.

### Properties
- `RebarFreeFormAccessor.RebarStyle`
- `RebarFreeFormAccessor.StirrupTieAttachmentType`

### Methods
- `RebarFreeFormAccessor.SetReportedShape()`
```

--------------------------------

### Export to PDF

Source: https://revapidocs.com/2022.htm

Exports one or more views and sheets in PDF format with various configuration options.

```APIDOC
## Export to PDF

### Description
Exports one or more views and sheets in PDF format.

### Method
`Document.Export(String, IList<ElementId>, PDFExportOptions)`

### Options Class
`Autodesk.Revit.DB.PDFExportOptions`

### Options Description
Includes graphical options, paper and output format options, and the option to combine output views and sheets into a single PDF or to produce a different PDF for each view and sheet with a specific naming convention.
```

--------------------------------

### Callout View API Additions

Source: https://revapidocs.com/2022.htm

Methods and properties for callout views.

```APIDOC
## View.GetCalloutParentId()

### Description
Returns the ID of a view which this callout references, or InvalidElementId if there is not parent.

### Returns
- ElementId: The ID of the parent view, or InvalidElementId.
```

```APIDOC
## View.IsCallout

### Description
Identifies if the view is a callout view.

### Type
- bool
```

--------------------------------

### Area Reinforcement Layers Methods

Source: https://revapidocs.com/2022.htm

Methods for accessing and manipulating layers within Area Reinforcement elements.

```APIDOC
## Area Reinforcement Layers Methods

### Description
Provides access to the layers of Area Reinforcement elements, and allows manipulation (moving and removing) of individual lines exposed through those layers.

### Methods
- `AreaReinforcement.GetNumberOfLines()`
- `AreaReinforcement.GetLineFromLayerAtIndex()`
- `AreaReinforcement.SetLineIncluded()`
- `AreaReinforcement.IsLineIncluded()`
- `AreaReinforcement.MoveLine()`
- `AreaReinforcement.GetMovedLineTransform()`
- `AreaReinforcement.ResetMovedLineTransform()`
- `AreaReinforcement.SetLayerActive()`
- `AreaReinforcement.IsLayerActive()`
- `AreaReinforcement.GetLayerDirection()`
```

--------------------------------

### DesignToFabricationConverter Method

Source: https://revapidocs.com/2022.htm

Method to set a map for converting family symbols to fabrication part types.

```APIDOC
## DesignToFabricationConverter Method

### Description
Sets a map used when the design to fabrication tool is running. The map relationships will be used to replace any family instance that is based upon the family symbols found in the map with the corresponding fabrication part for the fabrication part type set in the mapping.

### Method
- `DesignToFabricationConverter.SetMapForFamilySymbolToFabricationPartType()`
```

--------------------------------

### Document.SaveAsCloudModel

Source: https://revapidocs.com/2022.htm

Enhanced to support upload of local workshared file into BIM 360 Design as a Revit Cloud Worksharing central model.

```APIDOC
## Document.SaveAsCloudModel(Guid, Guid, String, String)

### Description
Supports the save of a new Revit Cloud Worksharing central model by uploading a local workshared file into BIM 360 Design.

### Method
static method

### Parameters
#### Path Parameters
- **Guid1** (Guid) - Required - Description
- **Guid2** (Guid) - Required - Description
- **String1** (String) - Required - Description
- **String2** (String) - Required - Description

### Exceptions
- UnauthenticatedUserException (removed from documented exceptions)
```

--------------------------------

### Grids in 3D Views API Additions

Source: https://revapidocs.com/2022.htm

Methods to control grid visibility in 3D Views.

```APIDOC
## View3D.GetLevelsThatShowGrids()

### Description
Returns the levels that currently show grids in the 3D view.

### Returns
- ElementIdset: A set of ElementIds representing the levels.
```

```APIDOC
## View3D.ShowGridsOnLevel()

### Description
Shows grids on a specific level in the 3D view.

### Parameters
- **levelId** (ElementId) - The ID of the level on which to show grids.
```

```APIDOC
## View3D.HideGridsOnLevel()

### Description
Hides grids on a specific level in the 3D view.

### Parameters
- **levelId** (ElementId) - The ID of the level on which to hide grids.
```

```APIDOC
## View3D.ShowGridsOnLevels()

### Description
Shows grids on multiple specified levels in the 3D view.

### Parameters
- **levelIds** (ElementIdset) - A set of ElementIds representing the levels on which to show grids.
```

--------------------------------

### Cloud Model API Additions

Source: https://revapidocs.com/2022.htm

Methods to access identifying Forge IDs for Cloud Models.

```APIDOC
## Document.GetHubId()

### Description
Returns the ForgeDM hub id where the model locates.

### Returns
- string: The ForgeDM hub id. Empty if not a cloud model.
```

```APIDOC
## Document.GetProjectId()

### Description
Returns the ForgeDM project id where the model locates.

### Returns
- string: The ForgeDM project id. Empty if not a cloud model.
```

```APIDOC
## Document.GetCloudFolderId()

### Description
Returns the ForgeDM folder id where the model locates.

### Parameters
- **forceRefresh** (bool) - Whether to force a refresh of the folder ID.

### Returns
- string: The ForgeDM folder id. Empty if not a cloud model.
```

```APIDOC
## Document.GetCloudModelUrn()

### Description
Returns a ForgeDM Urn identifying the model.

### Returns
- string: The ForgeDM Urn. Empty if not a cloud model.
```

--------------------------------

### Save As Cloud Model

Source: https://revapidocs.com/2022.htm

Enhanced to support upload of a local workshared file into BIM 360 Design as a Revit Cloud Worksharing central model. The UnauthenticatedUserException is removed from documented exceptions.

```csharp
Document.SaveAsCloudModel(Guid, Guid, String, String)
```

--------------------------------

### LabelUtils.GetLabelForDiscipline

Source: https://revapidocs.com/2022.htm

Returns the user-visible name corresponding to a Revit discipline in the current Revit language.

```APIDOC
## LabelUtils.GetLabelForDiscipline(ForgeTypeId)

### Description
Returns the user visible name corresponding to a Revit discipline in the current Revit language.

### Method
static method

### Parameters
#### Path Parameters
- **ForgeTypeId** (ForgeTypeId) - Required - Identifier for the discipline.
```

--------------------------------

### Viewport API Additions

Source: https://revapidocs.com/2022.htm

Properties to control viewport labels on sheets.

```APIDOC
## Viewport.LabelOffset

### Description
Controls the two-dimensional label offset from the left bottom corner of the viewport to the left end of the viewport label line.

### Type
- XYZ (or similar 2D/3D point type)
```

```APIDOC
## Viewport.LabelLineLength

### Description
Controls the length of the viewport label line in sheet space.

### Type
- float (or similar length type)
```

--------------------------------

### Sketch APIs

Source: https://revapidocs.com/2022.htm

Provides methods to retrieve sketch IDs for various elements and manage sketch ownership and elements.

```APIDOC
## Ceiling.SketchId

### Description
Returns the id of the element's sketch.

### Property
`Ceiling.SketchId`
```

```APIDOC
## Floor.SketchId

### Description
Returns the id of the element's sketch.

### Property
`Floor.SketchId`
```

```APIDOC
## Wall.SketchId

### Description
Returns the id of the element's sketch.

### Property
`Wall.SketchId`
```

```APIDOC
## Opening.SketchId

### Description
Returns the id of the element's sketch.

### Property
`Opening.SketchId`
```

```APIDOC
## Sketch.OwnerId

### Description
Returns the id of the element that owns this sketch.

### Property
`Sketch.OwnerId`
```

```APIDOC
## Sketch.GetAllElements()

### Description
Returns the ids of all the elements owned by the sketch, including elements of type: ModelCurve, ReferencePlane, Dimension.

### Method
`Sketch.GetAllElements`

### Returns
- List of ElementIds representing the elements owned by the sketch.
```

--------------------------------

### Category API Additions

Source: https://revapidocs.com/2022.htm

Provides methods for accessing BuiltInCategories.

```APIDOC
## Category Built-in Methods

### Description
New methods allow access to BuiltInCategories.

### Methods
- **Category.GetBuiltInCategoryTypeId(BuiltInCategory category)**: Returns the ForgeTypeId for a given BuiltInCategory.
- **Category.GetBuiltInCategory(ForgeTypeId forgeTypeId)**: Returns the BuiltInCategory for a given ForgeTypeId.
- **Category.IsBuiltInCategory(ForgeTypeId forgeTypeId)**: Checks if a ForgeTypeId represents a BuiltInCategory.
```

--------------------------------

### View Access to Color Fills

Source: https://revapidocs.com/2022.htm

Provides access to read and apply the color fill scheme associated with a particular category in the view.

```APIDOC
## View Access to Color Fills

### Description
Provides access to read and apply the color fill scheme associated with a particular category in the view.

### Methods
- `View.GetColorFillSchemeId()`
- `View.SetColorFillSchemeId()`
```

--------------------------------

### PDF Export Settings

Source: https://revapidocs.com/2022.htm

Represents a named stored PDF export option available in a document.

```APIDOC
## PDF Export Settings

### Description
Represents a named stored PDF export option available in a document. Use this class to extract, modify, or create stored settings for PDF export.

### Class
`Autodesk.Revit.DB.ExportPDFSettings`
```

--------------------------------

### Worksharing API Exception Changes

Source: https://revapidocs.com/2022.htm

Updates to exceptions thrown by Document.SaveAsCloudModel() and ModelPathUtils.ConvertCloudGUIDsToCloudPath().

```APIDOC
## Document.SaveAsCloudModel Exception Changes

### Description
This method now throws specific exceptions for various error conditions during saving to a cloud model.

### Method
Document.SaveAsCloudModel
```

```APIDOC
## ModelPathUtils.ConvertCloudGUIDsToCloudPath Exception Changes

### Description
This method has updated exception handling for scenarios involving non-existent regions, projects, or models, and permission issues.

### Method
ModelPathUtils.ConvertCloudGUIDsToCloudPath
```

--------------------------------

### Rebar Geometry Methods

Source: https://revapidocs.com/2022.htm

Methods to retrieve transformed centerline curves for Rebar and RebarInSystem.

```APIDOC
## Rebar Geometry Methods

### Description
Returns the centerline curves for a given bar, with geometry in the actual transformed position. The `BarPositionTransform` and `MovedBarTransform` will be applied to the returned curves.

### Methods
- `Rebar.GetTransformedCenterlineCurves()`
- `RebarInSystem.GetTransformedCenterlineCurves()`
```

--------------------------------

### FilterStringRule Constructor Change

Source: https://revapidocs.com/2022.htm

The FilterStringRule constructor has been updated to remove the unused case sensitivity boolean argument.

```APIDOC
## Filter API change

The constructor for the class FilterStringRule has been obsoleted and replaced. The previous constructor has a Boolean argument for case sensitivity that was not used in View Filters and could not be used properly from the API, as all string comparisons in filters are case-insensitive:

Obsoleted member | Replacement member  
---|---  
FilterStringRule(FilterableValueProvider, FilterStringRuleEvaluator, String, boolean) |  FilterStringRule(FilterableValueProvider, FilterStringRuleEvaluator, String)

The method FilterStringRuleEvaluator.Evaluate() still has an argument "caseSensitive", but it's never called by filter code with this argument set to true.
```

--------------------------------

### Slanted and Tapered Walls

Source: https://revapidocs.com/2022.htm

Enables assignment of cross-section types to walls and validation of these assignments, along with related enumerations.

```APIDOC
## Wall.CrossSection

### Description
Allows assignment of a cross section type to a given wall.

### Property
`Wall.CrossSection`
```

```APIDOC
## Wall.IsWallCrossSectionValid()

### Description
Determines if a given cross-section type can be assigned to a wall.

### Method
`Wall.IsWallCrossSectionValid`
```

--------------------------------

### Temporary Graphics Management

Source: https://revapidocs.com/2022.htm

Manages the creation and manipulation of temporary graphics within the canvas, useful for in-canvas controls.

```APIDOC
## TemporaryGraphicsManager

### Description
Allows the creation of temporary graphics in the canvas and can be used to create in-canvas controls.

### Methods
- **GetTemporaryGraphicsManager()**: Retrieves the singleton instance of the TemporaryGraphicsManager.
- **AddControl(InCanvasControlData controlData)**: Adds a new control to the temporary graphics.
- **UpdateControl(InCanvasControlData controlData)**: Updates an existing control.
- **RemoveControl(InCanvasControlData controlData)**: Removes a control.
- **SetVisibility(InCanvasControlData controlData, bool visible)**: Sets the visibility of a control.
- **GetAll()**: Returns a collection of all temporary graphics controls.
- **Clear()**: Removes all temporary graphics controls.
```

```APIDOC
## InCanvasControlData

### Description
Stores a reference to the image used in the temporary graphics.

### Properties
- **ImagePath** (string): The path to the image file for the control.
- **Position** (XYZ): The position of the control in the canvas.
```

--------------------------------

### Civil Alignments API

Source: https://revapidocs.com/2022.htm

Provides support for Civil Alignments and their associated annotations, including read/write capabilities.

```APIDOC
## Civil Alignments API

### Description
Provides support for Civil Alignments and their associated annotations. API supports read of alignment properties and geometric information, along with read/write and create of associated annotations.

### Assembly Location
`AddinsCivilAlignmentsAutodesk.CivilAlignments.DBApplication.dll`

### Alignment Class
`Autodesk.Revit.DB.Infrastructure.Alignment`

### Alignment Description
Represents an alignment. Can be used to find alignments in a document, query properties, and analyze geometry. This object is not an Element, but the underlying Element can be obtained.

### Alignment Station Label Class
`Autodesk.Revit.DB.Infrastructure.AlignmentStationLabel`

### Alignment Station Label Description
Represents an alignment station label annotation. Can be used to find, create, and modify such labels. This object is not an Element, but the underlying Element (a SpotDimension instance) can be obtained.

### Options Classes for Labels
- `Autodesk.Revit.DB.Infrastructure.AlignmentStationLabelOptions`
- `Autodesk.Revit.DB.Infrastructure.AlignmentStationLabelSetOptions`

### Options Description
Provide options for creating a single alignment label or a set of alignment labels.
```

--------------------------------

### CompoundStructure API

Source: https://revapidocs.com/2022.htm

Offers a method to check if split and merge regions operations can be used for a compound structure.

```APIDOC
## CompoundStructure.CanSplitAndMergeRegionsBeUsed()

### Description
Checks whether split and merge regions operations can be used for this compound structure. This validator is associated with the use of the existing MergeRegionsAdjacentToSegment() and SplitRegion() methods.

### Method
`CompoundStructure.CanSplitAndMergeRegionsBeUsed`
```

--------------------------------

### MultipleValuesIndicationSettings

Source: https://revapidocs.com/2022.htm

Provides access to custom value settings for parameters when multiple elements are referenced with differing values.

```APIDOC
## Autodesk.Revit.DB.MultipleValuesIndicationSettings

### Description
Allows access to the custom value used in instances of the Properties Palette, Tags and Schedules when multiple elements are referenced and the value of the parameter is different.

### Methods
- **GetMultipleValuesIndicationSettings()**: Retrieves the current settings for multiple values indication.

### Properties
- **Custom** (bool): Gets or sets a value indicating whether a custom value is used.
- **CustomValue** (string): Gets or sets the custom value to be used.
- **Value** (string): Gets the value that will be used (either the custom value or the default).
```

--------------------------------

### Boundary validation for sketched elements

Source: https://revapidocs.com/2022.htm

Provides a method to validate if input curves form a valid horizontal boundary for Ceiling or Floor creation.

```APIDOC
## BoundaryValidation.IsValidHorizontalBoundary()

### Description
Validates input curves form a valid horizontal boundary for Ceiling or Floor creation.

### Method
`BoundaryValidation.IsValidHorizontalBoundary`
```

--------------------------------

### Color Fill Schemes

Source: https://revapidocs.com/2022.htm

Represents a color scheme that can be applied to plan and section views, with methods to manage its entries and properties.

```APIDOC
## Autodesk.Revit.DB.ColorFillScheme

### Description
Represents a color scheme that can be applied to plan and section views. Key new members of this class include methods to add, remove, update, get, and set entries, as well as properties for scheme configuration.

### Members
- **AddEntry()**: Adds an entry to the color scheme.
- **RemoveEntry()**: Removes an entry from the color scheme.
- **UpdateEntry()**: Updates an existing entry in the color scheme.
- **GetEntries()**: Retrieves all entries in the color scheme.
- **SetEntries()**: Sets the entries for the color scheme.
- **SortEntries()**: Sorts the entries in the color scheme.
- **AreaSchemeId**: Gets or sets the AreaSchemeId.
- **CategoryId**: Gets or sets the CategoryId.
- **ParameterDefinition**: Gets or sets the ParameterDefinition.
- **StorageType**: Gets or sets the StorageType.
- **Title**: Gets or sets the Title.
- **Duplicate**: Duplicates the color scheme.
- **GetFormatOptions()**: Retrieves the format options for the color scheme.
- **SetFormatOptions()**: Sets the format options for the color scheme.
- **GetSupportedParameterIds()**: Retrieves the supported parameter IDs for the color scheme.
```

--------------------------------

### HVAC Load Type Properties

Source: https://revapidocs.com/2022.htm

Properties for setting heating, cooling, humidification, and dehumidification set points.

```APIDOC
## HVAC Load Type Properties

### Description
Provides access to heating temperature, cooling temperature, humidification, and dehumidification set point values. Temperature set points are in Kelvin, while humidity set points are percentages ranging from 0 to 1.

### Properties
- `HVACLoadType.HeatingSetPoint` (K)
- `HVACLoadType.CoolingSetPoint` (K)
- `HVACLoadType.HumidificationSetPoint` (0-1)
- `HVACLoadType.DehumidificationSetPoint` (0-1)
```

--------------------------------

### Custom Family Names for DirectShapeType

Source: https://revapidocs.com/2022.htm

Allows setting and checking custom family names for DirectShapeType.

```APIDOC
## DirectShapeType.SetFamilyName()

### Description
Provides the ability to set a custom Family name for a DirectShapeType.

### Parameters
- **familyName** (string) - The custom family name to set.
```

```APIDOC
## DirectShapeType.CanChangeFamilyName()

### Description
Provides the ability to check if a DirectShapeType supports a custom Family name. Certain categories do not support custom Family names.
```

--------------------------------

### Color Fill Scheme Entries

Source: https://revapidocs.com/2022.htm

Represents an entry within a color scheme, with properties and methods to manage its color, fill pattern, caption, and value.

```APIDOC
## Autodesk.Revit.DB.ColorFillSchemeEntry

### Description
Represents an entry in a color scheme. Key new members of this class include properties for color, fill pattern, caption, visibility, and methods to get and set integer, double, string, and ElementId values.

### Members
- **Color**: Gets or sets the color of the entry.
- **FillPatternId**: Gets or sets the FillPatternId.
- **Caption**: Gets or sets the caption of the entry.
- **StorageType**: Gets or sets the StorageType.
- **IsVisible**: Gets or sets whether the entry is visible.
- **IsInUse**: Gets or sets whether the entry is in use.
- **GetIntegerValue()**: Retrieves the integer value of the entry.
- **GetDoubleValue()**: Retrieves the double value of the entry.
- **GetStringValue()**: Retrieves the string value of the entry.
- **GetElementIdValue()**: Retrieves the ElementId value of the entry.
- **SetIntegerValue()**: Sets the integer value of the entry.
- **SetDoubleValue()**: Sets the double value of the entry.
- **SetStringValue()**: Sets the string value of the entry.
- **SetElementIdValue()**: Sets the ElementId value of the entry.
```

--------------------------------

### Worksharing API Replacements

Source: https://revapidocs.com/2022.htm

Replaced members in the Worksharing API that require immediate application updates.

```APIDOC
## DocumentSavingAsEventArgs.IsSavingAsMasterFile Replacement

### Description
Replaced by DocumentSavingAsEventArgs.IsSavingAsCentralFile.

### Method
DocumentSavingAsEventArgs.IsSavingAsMasterFile
```

```APIDOC
## DocumentSavedAsEventArgs.IsSavingAsMasterFile Replacement

### Description
Replaced by DocumentSavedAsEventArgs.IsSavingAsCentralFile.

### Method
DocumentSavedAsEventArgs.IsSavingAsMasterFile
```

--------------------------------

### Dimension API Additions

Source: https://revapidocs.com/2022.htm

Provides access to positioning and text properties for dimensions.

```APIDOC
## Dimension Properties

### Description
Several new properties allow access to positioning for various parts of a dimension.

### Properties
- **Dimension.TextPosition** (XYZ): The position of the dimension text.
- **Dimension.LeaderEndPosition** (XYZ): The end position of the dimension leader.
- **Dimension.HasLeader** (bool): Indicates if the dimension has a leader.
- **SpotDimension.LeaderElbowPosition** (XYZ): The elbow position of the spot dimension leader.
- **SpotDimension.LeaderHasElbow** (bool): Indicates if the spot dimension leader has an elbow.
```

```APIDOC
## DimensionType Prefix/Suffix Properties

### Description
New properties allow access to the prefix and suffix values in the dimension type.

### Properties
- **DimensionType.Prefix** (string): The prefix value for the dimension type.
- **DimensionType.Suffix** (string): The suffix value for the dimension type.
```

--------------------------------

### IndependentTag API Changes

Source: https://revapidocs.com/2022.htm

New properties and methods for IndependentTag to manage rotation and multiple references.

```APIDOC
## IndependentTag.RotationAngle

### Description
Gets or sets the rotation angle of the tag relative to its view.

### Method
IndependentTag.RotationAngle
```

```APIDOC
## IndependentTag.GetTaggedLocalElementIds()

### Description
Retrieves the IDs of all local elements tagged by this IndependentTag. Replaces `IndependentTag.TaggedLocalElementId`.

### Method
IndependentTag.GetTaggedLocalElementIds
```

```APIDOC
## IndependentTag.GetTaggedElementIds()

### Description
Retrieves the IDs of all elements tagged by this IndependentTag. Replaces `IndependentTag.TaggedElementId`.

### Method
IndependentTag.GetTaggedElementIds
```

```APIDOC
## IndependentTag.GetTaggedLocalElements()

### Description
Retrieves all local elements tagged by this IndependentTag. Replaces `IndependentTag.GetTaggedLocalElement()`.

### Method
IndependentTag.GetTaggedLocalElements
```

```APIDOC
## IndependentTag.GetTaggedReferences()

### Description
Retrieves all references to elements tagged by this IndependentTag. Replaces `IndependentTag.GetTaggedReference()`.

### Method
IndependentTag.GetTaggedReferences
```

```APIDOC
## IndependentTag.HasLeaderElbow()

### Description
Checks if the tag has a leader elbow. Replaces `IndependentTag.HasElbow`.

### Method
IndependentTag.HasLeaderElbow
```

```APIDOC
## IndependentTag.GetLeaderElbow()

### Description
Retrieves the leader elbow of the tag. Replaces `IndependentTag.LeaderElbow`.

### Method
IndependentTag.GetLeaderElbow
```

```APIDOC
## IndependentTag.SetLeaderElbow()

### Description
Sets the leader elbow of the tag.

### Method
IndependentTag.SetLeaderElbow
```

```APIDOC
## IndependentTag.GetLeaderEnd()

### Description
Retrieves the leader end point of the tag. Replaces `IndependentTag.LeaderEnd`.

### Method
IndependentTag.GetLeaderEnd
```

```APIDOC
## IndependentTag.SetLeaderEnd()

### Description
Sets the leader end point of the tag.

### Method
IndependentTag.SetLeaderEnd
```

```APIDOC
## IndependentTag.AddReferences()

### Description
Adds multiple references to elements or sub-elements to the tag.

### Method
IndependentTag.AddReferences
```

```APIDOC
## IndependentTag.RemoveReferences()

### Description
Removes multiple references from the tag.

### Method
IndependentTag.RemoveReferences
```

```APIDOC
## IndependentTag.MultiLeader

### Description
Queries if the tag references multiple elements.

### Method
IndependentTag.MultiLeader
```

--------------------------------

### Removed Obsoleted APIs

Source: https://revapidocs.com/2022.htm

A list of previously obsoleted APIs that have been removed in this release.

```APIDOC
## Removal of obsoleted APIs
The following previously obsoleted APIs have been removed:
  * ModelPathUtils.ConvertCloudGUIDsToCloudPath(Guid projectId, Guid modelId)
  * Document.SaveAsCloudModel(String folderId, String modelName)
  * MEPModel.ElectricalSystems
  * MEPModel.AssignedElectricalSystems
  * StructuralConnectionHandler.Create(Document doc, List<ElementId> idsToConnect)
```

--------------------------------

### ViewSystemsAnalysisReport Property

Source: https://revapidocs.com/2022.htm

Property to access the report style used in a particular analysis report view.

```APIDOC
## ViewSystemsAnalysisReport Property

### Description
Accesses the report style used in a particular analysis report view.

### Property
- `ViewSystemsAnalysisReport.ReportStyle`
```

--------------------------------

### External Geometry Identifiers

Source: https://revapidocs.com/2022.htm

Provides classes and methods for managing external geometry identifiers and associating them with geometry objects.

```APIDOC
## ExternalGeometryId

### Description
Represents an identifier for geometry from external sources.

### Members
- **IsValidExternalGeometryId()**: Provides validation of an identifier.
- **Id**: Accesses the identifier as a String.
```

```APIDOC
## ExternallyTaggedGeometryObject

### Description
Serves as a base class for externally tagged geometry.

### Members
- **ExternalId**: Provides the ExternalGeometryId associated with the geometry.
```

```APIDOC
## ExternallyTaggedNonBRep

### Description
Represents non-BRep geometry with an external identifier.
```

```APIDOC
## ExternallyTaggedBRep

### Description
Represents BRep (Solid) geometry with external identifiers for the BRep itself and any subset of Faces or Edges.
```

```APIDOC
## BRepBuilderPersistentIds

### Description
Provides a mechanism to associate external identifiers with geometry created by a BRepBuilder.

### Members
- **AddSubTag()**: Associates tags with Faces and Edges.
- **IsValidExternalGeometryIdForNewCorrespondence()**: Validates external geometry IDs for new correspondence.
- **IsValidBRepBuilderGeometryIdForNewCorrespondence()**: Validates BRep builder geometry IDs for new correspondence.
- **IsAssociatedBRepBuilderValid()**: Checks if the associated BRep builder is valid.
- **IsBRepBuilderGeometryIdFaceOrEdge()**: Determines if a BRep builder geometry ID is a Face or Edge.
```

```APIDOC
## BRepBuilder.GetResult()

### Description
Returns an ExternallyTaggedBRep when accepting a BRepBuilderPersistentIds.

### Parameters
- **persistentIds** (BRepBuilderPersistentIds) - The persistent IDs to associate with the BRep.
```

```APIDOC
## ExternallyTaggedGeometryValidation

### Description
Provides validators to help determine the validity of a GeometryObject for use with externally tagged geometry.

### Members
- **IsValidGeometry**: Validator for geometry validity.
- **IsNonSolid**: Validator to check if geometry is non-solid.
- **IsSolid**: Validator to check if geometry is solid.
```

```APIDOC
## DirectShape.AddExternallyTaggedGeometry()

### Description
Adds an ExternallyTaggedGeometryObject to a DirectShape.

### Parameters
- **externallyTaggedGeometry** (ExternallyTaggedGeometryObject) - The geometry object to add.
```

```APIDOC
## DirectShape.GetExternallyTaggedGeometry()

### Description
Retrieves an ExternallyTaggedGeometryObject from a DirectShape.
```

```APIDOC
## DirectShape.HasExternallyTaggedGeometry()

### Description
Checks if a DirectShape has an ExternallyTaggedGeometryObject.
```

```APIDOC
## DirectShape.UpdateExternallyTaggedGeometry()

### Description
Updates an existing ExternallyTaggedGeometryObject in a DirectShape.
```

```APIDOC
## DirectShape.RemoveExternallyTaggedGeometry()

### Description
Removes an ExternallyTaggedGeometryObject from a DirectShape.
```

```APIDOC
## DirectShape.ResetExternallyTaggedGeometry()

### Description
Resets all ExternallyTaggedGeometryObjects in a DirectShape.
```

```APIDOC
## DirectShapeType.AddExternallyTaggedGeometry()

### Description
Adds an ExternallyTaggedGeometryObject to a DirectShapeType.

### Parameters
- **externallyTaggedGeometry** (ExternallyTaggedGeometryObject) - The geometry object to add.
```

```APIDOC
## DirectShapeType.GetExternallyTaggedGeometry()

### Description
Retrieves an ExternallyTaggedGeometryObject from a DirectShapeType.
```

```APIDOC
## DirectShapeType.HasExternallyTaggedGeometry()

### Description
Checks if a DirectShapeType has an ExternallyTaggedGeometryObject.
```

```APIDOC
## DirectShapeType.UpdateExternallyTaggedGeometry()

### Description
Updates an existing ExternallyTaggedGeometryObject in a DirectShapeType.
```

```APIDOC
## DirectShapeType.RemoveExternallyTaggedGeometry()

### Description
Removes an ExternallyTaggedGeometryObject from a DirectShapeType.
```

```APIDOC
## DirectShapeType.ResetExternallyTaggedGeometry()

### Description
Resets all ExternallyTaggedGeometryObjects in a DirectShapeType.
```

--------------------------------

### Shared Coordinates API Additions

Source: https://revapidocs.com/2022.htm

Provides functionality for resetting shared coordinates and managing the clipped state of BasePoints.

```APIDOC
## Document.ResetSharedCoordinates()

### Description
Resets the shared coordinates for the host model. This action erases the GIS coordinate system, eliminates shared coordinate relationships with other linked models, moves the Survey Point back to the startup location, and resets the angle between Project North and True North to 0.

### Method
- **ResetSharedCoordinates()**: Resets the shared coordinates of the document.
```

```APIDOC
## BasePoint.Clipped Property

### Description
Gets or sets the clipped state of the survey point BasePoint based on the active ProjectLocation of its Document.

### Properties
- **Clipped** (bool): Gets or sets the clipped state of the survey point. For the project base point, the get method will always return false, and the set method will throw an exception.
```

--------------------------------

### PanelScheduleData Property

Source: https://revapidocs.com/2022.htm

Property to indicate if a panel schedule will automatically display shading for Load cells.

```APIDOC
## PanelScheduleData Property

### Description
Indicates if a panel schedule will display shading for Load cells automatically.

### Property
- `PanelScheduleData.IsAutoShadingForLoadDisplay`
```

--------------------------------

### ParameterUtils.IsBuiltInParameter

Source: https://revapidocs.com/2022.htm

Checks if a ForgeTypeId represents a built-in parameter.

```APIDOC
## ParameterUtils.IsBuiltInParameter(ForgeTypeId)

### Description
Checks if the provided ForgeTypeId represents a built-in parameter.

### Method
static method

### Parameters
#### Path Parameters
- **ForgeTypeId** (ForgeTypeId) - Required - The identifier to check.
```

--------------------------------

### Is Spec

Source: https://revapidocs.com/2022.htm

Checks if a given ForgeTypeId represents a spec. Renamed to IsMeasurableSpec() to clarify applicability to measurable specs only.

```csharp
SpecUtils.IsSpec(ForgeTypeId)
```

--------------------------------

### Is Measurable Spec

Source: https://revapidocs.com/2022.htm

Checks if a given ForgeTypeId represents a measurable spec. This clarifies that they apply only to measurable specs.

```csharp
UnitUtils.IsMeasurableSpec(ForgeTypeId)
```
Tokens:
Raw