### ElectricalSetting.GetCircuitNamingSchemeSettings Source: https://revapidocs.com/2021.htm Gets the circuit naming scheme settings of the project. ```APIDOC ## ElectricalSetting.GetCircuitNamingSchemeSettings ### Description Retrieves the circuit naming scheme settings that are configured for the current Revit project. ``` -------------------------------- ### ColorOptions Source: https://revapidocs.com/2021.htm Provides access to color settings that affect specific views. Includes static method to get current options and properties for various colors. ```APIDOC ## ColorOptions ### static ColorOptions.GetColorOptions() Retrieves the ColorOptions for the current Revit session. ### ColorOptions.BackgroundColor Gets or sets the background color applied to views. ### ColorOptions.SelectionColor Gets or sets the color used to highlight selected elements. ### ColorOptions.SelectionSemitransparent Indicates if selections are shown semi-transparently. ### ColorOptions.PreselectionColor Gets or sets the color used for pre-selection highlighting. ### ColorOptions.AlertColor Gets or sets the color used for alert highlighting. ### ColorOptions.CalculatingColor Gets or sets the color used when recalculating element properties. ### ColorOptions.EditingColor Gets or sets the color used during editing. ``` -------------------------------- ### FabricSheet Visibility Methods Source: https://revapidocs.com/2021.htm Methods to get and set visibility options for fabric sheets in a 3D view. ```APIDOC ## FabricSheet Visibility Methods ### Description Get and set the visibility options for a given fabric sheet instance as applied to a particular 3D view. ### Methods - `FabricSheet.IsSolidInView()`: Checks if the fabric sheet is solid in the view. - `FabricSheet.SetSolidInView()`: Sets the fabric sheet to be solid in the view. - `FabricSheet.IsUnobscuredInView()`: Checks if the fabric sheet is unobscured in the view. - `FabricSheet.SetUnobscuredInView()`: Sets the fabric sheet to be unobscured in the view. ``` -------------------------------- ### GenericZone.GetBoundaries() Method Source: https://revapidocs.com/2021.htm Gets the boundaries for the given GenericZone. ```APIDOC ## GenericZone.GetBoundaries() Gets the boundaries for the given GenericZone. ``` -------------------------------- ### RebarConstraintsManager Methods Source: https://revapidocs.com/2021.htm Methods to get constraint candidates for a rebar handle. ```APIDOC ## RebarConstraintsManager Methods ### Description Methods to retrieve possible `RebarConstraints` for a `RebarConstrainedHandle`. ### Methods - `RebarConstraintsManager.GetConstraintCandidatesForHandle(RebarConstrainedHandle, ElementId)`: Returns constraint candidates for a handle and element ID. - `RebarConstraintsManager.GetConstraintCandidatesForHandle(RebarConstrainedHandle, Reference)`: Returns constraint candidates for a handle and a reference. ``` -------------------------------- ### BasePoint.Clipped Property Source: https://revapidocs.com/2021.htm Gets or sets the clipped state of the survey point BasePoint based on the active ProjectLocation. ```APIDOC ## Clipped state of BasePoint ### Description The `BasePoint.Clipped` property gets or sets the clipped state of the survey point BasePoint, which is determined by the active ProjectLocation of its Document. For the project base point, the get method always returns false, and the set method will throw an exception. ### Property `bool BasePoint.Clipped` ``` -------------------------------- ### Autodesk.Revit.DB.ExtensibleStorage.Entity Deprecations Source: https://revapidocs.com/2021.htm Details deprecated methods in Entity for getting and setting field values with unit type information. ```APIDOC ## Autodesk.Revit.DB.ExtensibleStorage.Entity ### Description Methods for retrieving and setting entity field values that previously used `DisplayUnitType` are now updated to use `ForgeTypeId`. ### Deprecated Methods and Replacements #### Get (Field overload) - **Deprecated:** `FieldType Get(Field, DisplayUnitType)` - **Replacement:** `FieldType Get(Field, ForgeTypeId unitTypeId)` #### Get (string overload) - **Deprecated:** `FieldType Get(string, DisplayUnitType)` - **Replacement:** `FieldType Get(string, ForgeTypeId unitTypeId)` #### Set (Field overload) - **Deprecated:** `void Set(Field, FieldType, DisplayUnitType)` - **Replacement:** `void Set(Field, FieldType, ForgeTypeId unitTypeId)` #### Set (string overload) - **Deprecated:** `void Set(string, FieldType, DisplayUnitType)` - **Replacement:** `void Set(string, FieldType, ForgeTypeId unitTypeId)` ``` -------------------------------- ### Rebar Hook Rotation Angle Management Source: https://revapidocs.com/2021.htm Methods to get and set the out-of-plane hook rotation angle for Rebar and RebarShape objects. ```APIDOC ## Rebar.GetHookRotationAngle() ### Description Gets the out-of-plane hook rotation angle for a Rebar. ### Method Rebar.GetHookRotationAngle() ``` ```APIDOC ## Rebar.SetHookRotationAngle() ### Description Sets the out-of-plane hook rotation angle for a Rebar. ### Method Rebar.SetHookRotationAngle() ``` ```APIDOC ## RebarShape.GetHookRotationAngle() ### Description Gets the out-of-plane hook rotation angle for a RebarShape. ### Method RebarShape.GetHookRotationAngle() ``` ```APIDOC ## RebarShape.SetHookRotationAngle() ### Description Sets the out-of-plane hook rotation angle for a RebarShape. ### Method RebarShape.SetHookRotationAngle() ``` -------------------------------- ### ImageType Options and Constructors Source: https://revapidocs.com/2021.htm New options and constructors for ImageType to handle image sources as links or imports. ```APIDOC ## ImageType Options and Constructors ### Description New options and constructors for ImageType to handle image sources as links or imports. ### Properties - `ImageTypeOptions.SourceType`: Specifies the source type for an image. ### Enumeration Values - `ImageTypeSource`: An enumerated value indicating the source type of an image. ### Constructors - `ImageTypeOptions(String, Boolean, ImageTypeSource)`: Creates an ImageTypeOptions object with a specified source type. - `ImageTypeOptions(ExternalReference, ImageTypeSource)`: Creates an ImageTypeOptions object from an external reference and a specified source type. ``` -------------------------------- ### ElectricalEquipment Methods and Properties Source: https://revapidocs.com/2021.htm Provides methods and properties for managing circuit naming schemes and distribution systems for Electrical Equipment. ```APIDOC ## ElectricalEquipment Methods and Properties ### Description These members allow for the management and validation of circuit naming schemes and distribution systems associated with Electrical Equipment. ### Properties - **CircuitNamingSchemeId** (Guid): The ID of the circuit naming scheme used by the Electrical Equipment. - **MaxNumberOfCircuits** (int): The maximum number of circuits that can be connected to a switchboard. ### Methods - **IsValidDistributionSystem()** (bool): Verifies if a distribution system can be assigned to the Electrical Equipment. - **IsValidCircuitNamingSchemeId()** (bool): Verifies if the specified circuit naming scheme ID is valid for the Electrical Equipment. - **GetCircuitNamingSchemeType()** (CircuitNamingSchemeType): Gets the enumerated type of the circuit naming scheme used. - **SetCircuitNamingSchemeType(CircuitNamingSchemeType type)**: Sets the circuit naming scheme for the Electrical Equipment. ``` -------------------------------- ### GenericZone.Create() Method Source: https://revapidocs.com/2021.htm Supports creation of a zone using the specified domain data, level, and curves to represent the intersection/outline of the related spaces. ```APIDOC ## GenericZone.Create(Document doc, String name, GenericZoneDomainData domainData, ElementId levelId, IList curves) Supports creation of a zone using the specified domain data, level and curves to represent the intersection/outline of the related spaces. ``` -------------------------------- ### ZoneEquipment.GetAssociatedZoneEquipment() Method Source: https://revapidocs.com/2021.htm Returns the set of zone equipment that is associated with the specified analytical space or spaces. ```APIDOC ## ZoneEquipment.GetAssociatedZoneEquipment(ElementId spaceId) Returns the set of zone equipment that is associated with the specified analytical space or spaces. ``` -------------------------------- ### Rebar Creation Methods Source: https://revapidocs.com/2021.htm New static methods for creating Rebar elements, considering out-of-plane hook rotation angles and end treatment types. ```APIDOC ## Rebar.CreateFromCurves() ### Description Creates a new instance of a shape driven Rebar element within the project, given an array of curves and properties. ### Method static Rebar.CreateFromCurves() ``` ```APIDOC ## Rebar.CreateFromCurvesAndShape() ### Description Creates a new instance of a shape driven Rebar element within the project, given an array of curves, a RebarShape and some properties. ### Method static Rebar.CreateFromCurvesAndShape() ``` -------------------------------- ### ZoneEquipment.MoveSpaceToEquipment() Method Source: https://revapidocs.com/2021.htm Moves a set of spaces from the original zone equipment to the targeted zone equipment. Handles InvalidElementId for original or target. ```APIDOC ## ZoneEquipment.MoveSpaceToEquipment(ElementId originalZoneEquipmentId, ElementId targetZoneEquipmentId) Moves a set of spaces from the original zone equipment to the targeted zone equipment. Either zone equipment id may be InvalidElementId. If the original is InvalidElementId, the association is copied to the target zone equipment. If the target is InvalidElementId, the original association is removed. ``` -------------------------------- ### GBXMLExportOptions.ExportAnalyticalSystems Source: https://revapidocs.com/2021.htm A new property to enable the export of analytical system related items when exporting to gbXML. ```APIDOC ## GBXMLExportOptions.ExportAnalyticalSystems ### Description Set this property to `true` to export the analytical system related items when exporting to gbXML format. ``` -------------------------------- ### Application Systems Analysis Workflows Source: https://revapidocs.com/2021.htm Methods to manage systems analysis workflows, including reading and specifying names and paths. ```APIDOC ## Application Systems Analysis Workflows ### Description These methods allow you to read and specify the name and path information for systems analysis workflows. ### Methods - **GetSystemsAnalysisWorkflowNames()**: Retrieves the names of available systems analysis workflows. - **GetSystemsAnalysisWorkflows()**: Retrieves the paths for systems analysis workflows. - **SetSystemsAnalysisWorkflows()**: Sets the systems analysis workflows. ``` -------------------------------- ### StructuralConnectionHandler Create Method Source: https://revapidocs.com/2021.htm Creates connections that require additional input points. ```APIDOC ## StructuralConnectionHandler Create Method ### Description Provides a way to create connections that require additional input points. ### Method Signature `static Autodesk.Revit.DB.Structure.StructuralConnectionHandler.Create(Document, IList, ElementId, IList)` ``` -------------------------------- ### Structural Connection InputPointInfo Class Source: https://revapidocs.com/2021.htm Contains information about structural connection input point requirements. ```APIDOC ## Structural Connection InputPointInfo Class ### Description Contains information about connection input points requirements, such as the number of required points, a user-visible description for each point, and potential location restrictions. ### Class - `Autodesk.Revit.DB.Structure.ConnectionInputPointInfo` ``` -------------------------------- ### PanelScheduleView Methods Source: https://revapidocs.com/2021.htm Methods for renumbering circuit naming indexes and switching phases in panel schedules. ```APIDOC ## PanelScheduleView Methods ### Description Provides functionality to renumber circuit naming indexes and switch circuit phases within a panel schedule view. ### Methods - **RenumberIndexes()**: Renumbers the Circuit Naming Index for all circuits displayed in the panel schedule. - **SwitchPhases()**: Switches the circuit phases at a specified slot within the panel schedule. ``` -------------------------------- ### SystemsAnalysisOptions Source: https://revapidocs.com/2021.htm Contains properties that affect the systems analysis, such as WeatherFile, WorkflowFile, and OutputFolder. ```APIDOC ## Autodesk.Revit.DB.Analysis.SystemsAnalysisOptions ### Description Contains properties that affect the systems analysis. Properties like WeatherFile, WorkflowFile, and OutputFolder can be set here. If left empty, default values from the ViewSystemsAnalsisReport element will be used. The weather file influences energy simulation results. ``` -------------------------------- ### Project Base and Survey Point Access Source: https://revapidocs.com/2021.htm Static methods to retrieve the project base point and survey point. ```APIDOC ## BasePoint.GetProjectBasePoint() ### Description Retrieves the project base point. ### Method static BasePoint.GetProjectBasePoint() ``` ```APIDOC ## BasePoint.GetSurveyPoint() ### Description Retrieves the survey point. ### Method static BasePoint.GetSurveyPoint() ``` -------------------------------- ### EdgeEndPoint and SolidUtils Source: https://revapidocs.com/2021.htm Introduces EdgeEndPoint for representing edge endpoints and a utility method to find all edge endpoints at a vertex. ```APIDOC ## EdgeEndPoint and SolidUtils ### SolidUtils.FindAllEdgeEndPointsAtVertex(EdgeEndPoint endpoint) Finds all EdgeEndPoints at a vertex identified by the input EdgeEndPoint. ``` -------------------------------- ### SystemZoneData Class Source: https://revapidocs.com/2021.htm Represents the domain data for system-zone elements, including a reference to the zone equipment for the spaces in this system-zone. ```APIDOC ## Autodesk.Revit.DB.SystemZoneData This data includes a reference to the zone equipment for the spaces in this system-zone: * SystemZoneData.ZoneEquipmentId ``` -------------------------------- ### RebarShape Creation Source: https://revapidocs.com/2021.htm Method to create a new RebarShape instance. ```APIDOC ## RebarShape.Create() ### Description Creates a new instance of a RebarShape, which defines the shape of a Rebar. ### Method static RebarShape.Create() ``` -------------------------------- ### GenericZone.GetDomainData() Method Source: https://revapidocs.com/2021.htm Returns the domain data for the given GenericZone. ```APIDOC ## GenericZone.GetDomainData() Returns the domain data for the given GenericZone. ``` -------------------------------- ### Analysis Visualization Framework Settings Source: https://revapidocs.com/2021.htm Property to control interactive settings access for the Analysis Visualization Framework (AVF). ```APIDOC ## SpatialFieldManager.AllowInteractiveSettings ### Description Toggles the ability to access the Analysis Visualization Framework (AVF) settings for a particular set of results. This property is true by default. If set to false, AVF dialogs are unreachable, and deletion of related elements is prohibited. ### Property SpatialFieldManager.AllowInteractiveSettings ``` -------------------------------- ### DGNExportOptions API Change Source: https://revapidocs.com/2021.htm The DGNExportOptions.MasterUnits property has been deprecated and replaced by DGNExportOptions.WorkingUnits. ```APIDOC ## Export API Change ### Description The `DGNExportOptions.MasterUnits` property is deprecated and has been replaced by `DGNExportOptions.WorkingUnits`. ### Deprecated Member `DGNExportOptions.MasterUnits` ### Replacement `DGNExportOptions.WorkingUnits` ``` -------------------------------- ### Geometry Utilities Source: https://revapidocs.com/2021.htm Introduces a unique ID for GeometryObjects and mathematical comparison utilities using Revit's internal tolerance. ```APIDOC ## Geometry Utilities ### GeometryObject.Id Returns a unique integer identifying the GeometryObject. ### Autodesk.Revit.DB.MathComparisonUtils Contains mathematical utilities for comparing doubles with Revit's internal tolerance. ``` -------------------------------- ### BoundingBoxUV Source: https://revapidocs.com/2021.htm Provides a property to check if a BoundingBoxUV has been set. ```APIDOC ## BoundingBoxUV ### BoundingBoxUV.IsSet Indicates whether the BoundingBoxUV is set. ``` -------------------------------- ### ZoneEquipmentData Class Source: https://revapidocs.com/2021.htm Represents the data associated with a zone equipment, obtainable from ZoneEquipment.GetZoneEquipmentData(). ```APIDOC ## Autodesk.Revit.DB.Mechanical.ZoneEquipmentData Represents the data associated with a zone equipment. It can be obtained from the ZoneEquipment.GetZoneEquipmentData() method. It offers the following properties: * ZoneEquipmentData.EquipmentType * ZoneEquipmentData.EquipmentBehavior * ZoneEquipmentData.HotWaterLoopId * ZoneEquipmentData.ChilledWaterLoopId * ZoneEquipmentData.AirSystemId ``` -------------------------------- ### Path of Travel - Path Finding Analysis Source: https://revapidocs.com/2021.htm Perform path finding analysis for Path of Travel, calculating longest paths from rooms and shortest paths between points. ```APIDOC ## PathOfTravel.FindStartsOfLongestPathsFromRooms(View view, List destinationPoints) ### Description For a floor plan view, calculates paths from points inside rooms to the closest destinations and returns the start points of the longest path(s). If multiple paths have the same longest length, multiple start points are returned. ### Parameters - **view** (View) - Required - The floor plan view to perform the calculation in. - **destinationPoints** (List) - Required - A list of destination points. ### Returns (List) - A list of start points for the longest path(s). ``` ```APIDOC ## PathOfTravel.FindEndsOfShortestPaths(View view, List destinationPoints, List startPoints) ### Description For a floor plan view, calculates the shortest paths from each start point to its closest destination and returns the path end points. ### Parameters - **view** (View) - Required - The floor plan view to perform the calculation in. - **destinationPoints** (List) - Required - A list of destination points. - **startPoints** (List) - Required - A list of start points. ### Returns (List) - A list of end points for the shortest paths. ``` ```APIDOC ## PathOfTravel.FindShortestPaths(View view, List destinationPoints, List startPoints) ### Description For a floor plan view, calculates paths from each start point to its closest destinations and returns the path represented by an array of XYZ points. ### Parameters - **view** (View) - Required - The floor plan view to perform the calculation in. - **destinationPoints** (List) - Required - A list of destination points. - **startPoints** (List) - Required - A list of start points. ### Returns (List>) - A list of paths, where each path is a list of XYZ points. ``` -------------------------------- ### CircuitNamingSchemeSettings Source: https://revapidocs.com/2021.htm Represents the circuit naming scheme settings object in a project document. ```APIDOC ## Autodesk.Revit.DB.Electrical.CircuitNamingSchemeSettings ### Description Represents the circuit naming scheme settings object within a Revit project document. It allows access to project-level settings for circuit naming. ### Properties - **CircuitNamingSchemeId**: Gets or sets the ID of the circuit naming scheme. ### Methods - **GetCircuitNamingSchemeSettings()**: Retrieves the circuit naming scheme settings for the project. ``` -------------------------------- ### Edge Methods Source: https://revapidocs.com/2021.htm Provides methods to determine if an edge is flipped on a face and to calculate its UV representation. ```APIDOC ## Edge Methods ### Edge.IsFlippedOnFace(int index) Determines if the edge's topological direction on a face is opposite to its parametric direction. ### Edge.IsFlippedOnFace(Face face) Determines if the edge's topological direction on the specified face is opposite to its parametric direction. ### Edge.GetCurveUV() Calculates and optionally transforms a 2D curve representing the edge in the UV-parameter plane of one of its faces. ``` -------------------------------- ### ModelPathUtils Cloud Region Properties Source: https://revapidocs.com/2021.htm Static properties for BIM 360 cloud service region names. ```APIDOC ## ModelPathUtils Cloud Region Properties ### Description Static properties for BIM 360 cloud service region names, usable with `ConvertCloudGUIDsToCloudPath()`. ### Properties - `ModelPathUtils.CloudRegionUS`: Returns the region name for BIM 360 US cloud services. - `ModelPathUtils.CloudRegionEMEA`: Returns the region name for BIM 360 EMEA cloud services. ``` -------------------------------- ### ZoneEquipment Class Source: https://revapidocs.com/2021.htm Represents a zone equipment element used for Mechanical Systems Analysis, acting as an early-stage equipment placeholder. ```APIDOC ## Autodesk.Revit.DB.Mechanical.ZoneEquipment Represents a zone equipment element used for Mechanical Systems Analysis. Zone equipment is an early-stage equipment placeholder that provides heating or cooling to part of the air system or water loop. One zone equipment element may be mapped to multiple pieces of physical equipment depending on the zoning behavior type. ``` -------------------------------- ### StructuralConnectionHandlerType Create Method Source: https://revapidocs.com/2021.htm Creates a structural connection handler type using input points. ```APIDOC ## StructuralConnectionHandlerType Create Method ### Description Creates a structural connection handler type that uses input points. ### Method Signature `static Autodesk.Revit.DB.Structure.StructuralConnectionHandlerType.Create(Document, string, Guid, string, ElementId, IList)` ``` -------------------------------- ### StructuralConnectionHandler GetInputPoints Method Source: https://revapidocs.com/2021.htm Retrieves the input points for a structural connection handler. ```APIDOC ## StructuralConnectionHandler GetInputPoints Method ### Description Retrieves the input points for a structural connection handler. ### Method Signature `Autodesk.Revit.DB.Structure.StructuralConnectionHandler.GetInputPoints()` ``` -------------------------------- ### ImageType Methods and Properties Source: https://revapidocs.com/2021.htm New methods and properties for ImageType to manage image source, status, and unloading. ```APIDOC ## ImageType Methods and Properties ### Description New methods and properties for ImageType to manage image source, status, and unloading. ### Properties - `ImageType.Source`: Indicates how the image is created (link, import, or internally-generated). - `ImageType.Status`: Indicates whether the image is loaded or unloaded. ### Methods - `ImageType.Unload()`: Unloads a linked image. ``` -------------------------------- ### Temporary View Modes API Source: https://revapidocs.com/2021.htm Customize and manage temporary view modes, including setting titles, colors, and resetting customizations. ```APIDOC ## TemporaryViewModes.CustomTitle ### Description Gets or sets the custom title for a temporary view mode. Setting this title causes the view to display the customized frame. ### Properties - **CustomTitle** (string) - The custom title for the temporary view mode. ``` ```APIDOC ## TemporaryViewModes.CustomColor ### Description Gets or sets the custom color associated with a temporary view mode. ### Properties - **CustomColor** (Color) - The custom color for the temporary view mode. ``` ```APIDOC ## TemporaryViewModes.ResetCustomization() ### Description Resets the customization settings for the temporary view mode. ### Method Signature ResetCustomization() ``` ```APIDOC ## TemporaryViewModes.IsCustomized() ### Description Checks if the temporary view mode has been customized. ### Returns (bool) - True if customized, false otherwise. ### Method Signature IsCustomized() ``` -------------------------------- ### Inclusive TLS Protocol Setting in Revit Add-ons Source: https://revapidocs.com/2021.htm When specifying a security protocol version for internet communications in Revit add-ons, use bitwise OR to inclusively set the protocol. This avoids overriding Revit's native TLS configuration, which is crucial for Autodesk cloud services. ```csharp System.Net.ServicePointManager.SecurityProtocol |= System.Net.SecurityProtocolType.Tls12; ``` -------------------------------- ### ElectricalEquipment.IsSwitchboard Source: https://revapidocs.com/2021.htm Verifies if the electrical equipment is a switchboard. ```APIDOC ## ElectricalEquipment.IsSwitchboard ### Description Verifies whether the current electrical equipment instance is a switchboard. ``` -------------------------------- ### Autodesk.Revit.DB.UnitUtils Deprecations Source: https://revapidocs.com/2021.htm Details the deprecated methods in UnitUtils and their replacements. ```APIDOC ## Autodesk.Revit.DB.UnitUtils ### Description This section details deprecated methods in the UnitUtils class and their modern equivalents. ### Deprecated Methods and Replacements #### Convert - **Deprecated:** `static double Convert(double, DisplayUnitType, DisplayUnitType)` - **Replacement:** `static double Convert(double, ForgeTypeId currentUnitTypeId, ForgeTypeId desiredUnitTypeId)` #### ConvertFromInternalUnits - **Deprecated:** `static double ConvertFromInternalUnits(double, DisplayUnitType)` - **Replacement:** `static double ConvertFromInternalUnits(double, ForgeTypeId unitTypeId)` #### ConvertToInternalUnits - **Deprecated:** `static double ConvertToInternalUnits(double, DisplayUnitType)` - **Replacement:** `static double ConvertToInternalUnits(double, ForgeTypeId unitTypeId)` #### IsValidDisplayUnit - **Deprecated:** `static bool IsValidDisplayUnit(DisplayUnitType)` - **Replacement:** `static bool IsUnit(ForgeTypeId unitTypeId)` #### GetValidDisplayUnits - **Deprecated:** `static List GetValidDisplayUnits()` - **Replacement:** `static List GetAllUnits()` #### IsValidDisplayUnit (overload) - **Deprecated:** `static bool IsValidDisplayUnit(UnitType, DisplayUnitType)` - **Replacement:** `static bool IsValidUnit(ForgeTypeId specTypeId, ForgeTypeId unitTypeId)` #### GetValidDisplayUnits (overload) - **Deprecated:** `static List GetValidDisplayUnits(UnitType)` - **Replacement:** `static List GetValidUnits(ForgeTypeId specTypeId)` #### GetTypeCatalogString (DisplayUnitType overload) - **Deprecated:** `static string GetTypeCatalogString(DisplayUnitType)` - **Replacement:** `static string GetTypeCatalogStringForUnit(ForgeTypeId unitTypeId)` #### IsValidUnitType - **Deprecated:** `static bool IsValidUnitType(UnitType)` - **Replacement:** `static bool IsSpec(ForgeTypeId specTypeId)` #### GetValidUnitTypes - **Deprecated:** `static List GetValidUnitTypes()` - **Replacement:** `static List GetAllSpecs()` #### GetUnitGroup (UnitType overload) - **Deprecated:** `static UnitGroup GetUnitGroup(UnitType)` - **Replacement:** `static UnitGroup GetUnitGroup(ForgeTypeId specTypeId)` #### GetTypeCatalogString (UnitType overload) - **Deprecated:** `static string GetTypeCatalogString(UnitType)` - **Replacement:** `static string GetTypeCatalogStringForSpec(ForgeTypeId specTypeId)` ``` -------------------------------- ### ImageType Properties Source: https://revapidocs.com/2021.htm Provides read access to image size and resolution properties. ```APIDOC ## ImageType Properties ### ImageType.Resolution Gets the resolution of the image. ### ImageType.WidthInPixels Gets the width of the image in pixels. ### ImageType.HeightInPixels Gets the height of the image in pixels. ### ImageType.Width Gets the width of the image. ### ImageType.Height Gets the height of the image. ``` -------------------------------- ### ViewSchedule API - Striped Rows Source: https://revapidocs.com/2021.htm Configure striped row display and color for schedules, including options for sheet display. ```APIDOC ## ViewSchedule.HasStripedRows ### Description Gets or sets whether a given schedule is using a striped row display. ### Properties - **HasStripedRows** (bool) - True to enable striped rows, false otherwise. ``` ```APIDOC ## ViewSchedule.UseStripedRowsOnSheets ### Description Gets or sets whether the striped row display will be used on a sheet that displays this schedule. ### Properties - **UseStripedRowsOnSheets** (bool) - True to use striped rows on sheets, false otherwise. ``` ```APIDOC ## ViewSchedule.GetStripedRowsColor() ### Description Gets the color applied to the indicated part of the pattern for a schedule with striped rows. ### Returns (Color) - The color used for striped rows. ### Method Signature GetStripedRowsColor() ``` ```APIDOC ## ViewSchedule.SetStripedRowsColor() ### Description Sets the color applied to the indicated part of the pattern for a schedule with striped rows. ### Parameters - **color** (Color) - Required - The color to set for striped rows. ``` -------------------------------- ### GenericZone Class Source: https://revapidocs.com/2021.htm Represents a system-zone in Revit, used to specify parts of a building served by specific equipment, air systems, and water loops. ```APIDOC ## Autodesk.Revit.DB.GenericZone Provides for a method of selecting elements that somehow come in contact with the zone object. A zone is a non-hierarchical structure of geometric information, area or volume definitions for the purpose of analysis. A generic zone will contain specific domain requirements provided at creation of the element. Currently, all GenericZones will represent system-zone elements used for MEP design. ``` -------------------------------- ### Civil Alignments API Source: https://revapidocs.com/2021.htm Introduces support for Civil Alignments and their associated annotations, allowing read of alignment properties and geometric information, along with read/write and create of associated annotations. ```APIDOC ## Civil Alignments API ### Description Revit now supports Civil Alignments imported from InfraWorks. The API allows reading alignment properties and geometric information, as well as reading, writing, and creating associated annotations. ### New Classes - `Autodesk.Revit.DB.Infrastructure.Alignment`: Represents an alignment. Can be used to find alignments in a document, query properties, and analyze geometry. This is not an Element, but the underlying Element can be obtained. - `Autodesk.Revit.DB.Infrastructure.AlignmentStationLabel`: Represents an alignment station label annotation. Can be used to find, create, and modify these labels. This is not an Element, but the underlying Element (a SpotDimension instance) can be obtained. - `Autodesk.Revit.DB.Infrastructure.AlignmentStationLabelOptions`: Provides options for creating a single alignment label. - `Autodesk.Revit.DB.Infrastructure.AlignmentStationLabelSetOptions`: Provides options for creating a set of alignment labels. ### Assembly Location `AddinsCivilAlignmentsAutodesk.CivilAlignments.DBApplication.dll` ``` -------------------------------- ### DocumentSavingAsEventArgs API Change Source: https://revapidocs.com/2021.htm The DocumentSavingAsEventArgs.IsSavingAsMasterFile property has been deprecated and replaced by DocumentSavingAsEventArgs.IsSavingAsCentralFile. ```APIDOC ## Save As API Change (SavingEventArgs) ### Description The `DocumentSavingAsEventArgs.IsSavingAsMasterFile` property is deprecated and has been replaced by `DocumentSavingAsEventArgs.IsSavingAsCentralFile`. ### Deprecated Member `DocumentSavingAsEventArgs.IsSavingAsMasterFile` ### Replacement `DocumentSavingAsEventArgs.IsSavingAsCentralFile` ``` -------------------------------- ### ViewsExportingByContextEventArgs Source: https://revapidocs.com/2021.htm Provides information when Revit is about to export views via a CustomExporter. Includes a method to retrieve the IDs of the views being exported. ```APIDOC ## ViewsExportingByContextEventArgs ### ViewsExportingByContextEventArgs.GetViewIds() Gets the IDs of the views that are about to be exported by the CustomExporter. ``` -------------------------------- ### ElectricalSystem Properties Source: https://revapidocs.com/2021.htm Provides access to various properties of an Electrical System related to its panel location and naming. ```APIDOC ## ElectricalSystem Properties ### Description These properties provide detailed information about an Electrical System's configuration within its panel and its naming conventions. ### Properties - **SlotIndex** (int): The slot number where the Electrical System is located in its panel. - **CircuitNamingIndex** (int): The index used for circuit naming within the panel. - **PhaseLabel** (string): The label representing the circuit phase (e.g., 'A', 'B', 'C'). - **Ways** (int): The number of ways the circuit occupies in the panel. - **LoadClassificationAbbreviations** (List): A list of abbreviations for the load classifications applied to the Electrical System. - **Frame** (object): Retrieves the Frame value of the Electrical System. ``` -------------------------------- ### Structural Connection InputPoint Class Source: https://revapidocs.com/2021.htm Represents the 3D location and unique ID for a structural connection input point. ```APIDOC ## Structural Connection InputPoint Class ### Description Represents the 3D location and unique ID for a structural connection input point. ### Class - `Autodesk.Revit.DB.Structure.ConnectionInputPoint` ``` -------------------------------- ### WaterLoopData Class Source: https://revapidocs.com/2021.htm Contains data for a water loop system, obtainable from MEPAnalyticalSystem.GetWaterLoopData(). ```APIDOC ## Autodesk.Revit.DB.Mechanical.WaterLoopData Contains the data for a water loop system. It can be obtained from the MEPAnalyticalSystem.GetWaterLoopData() method. It offers the following properties: * WaterLoopData.WaterLoopType * WaterLoopData.ChillerType * WaterLoopData.CondenserWaterLoopId ``` -------------------------------- ### RebarConstraint Methods Source: https://revapidocs.com/2021.htm Methods for controlling distances and spacing for rebar constraints. ```APIDOC ## RebarConstraint Methods ### Description Methods allowing control over distances and spacing for rebar constraints. ### Methods - `RebarConstraint.GetDistanceToTargetRebar()`: Gets the distance to the target rebar. - `RebarConstraint.SetDistanceToTargetRebar()`: Sets the distance to the target rebar. - `RebarConstraint.IsBindingHandleWithTarget()`: Checks if the handle is binding with the target. - `RebarConstraint.SetToBindHandleWithTarget()`: Sets the handle to bind with the target. - `RebarConstraint.IsUsingClearBarSpacing()`: Checks if clear bar spacing is being used. - `RebarConstraint.SetToUseClearBarSpacing()`: Sets the rebar to use clear bar spacing. - `RebarConstraint.FlipHandleOverTarget()`: Flips the handle over the target. ``` -------------------------------- ### Autodesk.Revit.DB.FormatOptions Deprecations Source: https://revapidocs.com/2021.htm Details deprecated constructors and properties in FormatOptions related to unit and symbol types. ```APIDOC ## Autodesk.Revit.DB.FormatOptions ### Description Constructors and properties for `FormatOptions` that previously used `DisplayUnitType` and `UnitSymbolType` have been updated to use `ForgeTypeId`. ### Deprecated Constructors and Replacements #### Constructor (DisplayUnitType) - **Deprecated:** `FormatOptions(DisplayUnitType)` - **Replacement:** `FormatOptions(ForgeTypeId unitTypeId)` #### Constructor (DisplayUnitType, UnitSymbolType) - **Deprecated:** `FormatOptions(DisplayUnitType, UnitSymbolType)` - **Replacement:** `FormatOptions(ForgeTypeId unitTypeId, ForgeTypeId symbolTypeId)` #### Constructor (DisplayUnitType, double) - **Deprecated:** `FormatOptions(DisplayUnitType, double)` - **Replacement:** This constructor has not been replaced. Please use property assignment to set the accuracy. #### Constructor (DisplayUnitType, UnitSymbolType, double) - **Deprecated:** `FormatOptions(DisplayUnitType, UnitSymbolType, double)` - **Replacement:** This constructor has not been replaced. Please use property assignment to set the accuracy. ### Deprecated Properties and Replacements #### DisplayUnits Property - **Deprecated:** `property DisplayUnitType DisplayUnitType (get/set)` - **Replacement:** - `ForgeTypeId GetUnitTypeId()` - `void SetUnitTypeId(ForgeTypeId unitTypeId)` #### UnitSymbol Property - **Deprecated:** `property UnitSymbolType UnitSymbol (get/set)` - **Replacement:** - `ForgeTypeId GetSymbolTypeId()` - `void SetSymbolTypeId(ForgeTypeId symbolTypeId)` ### Deprecated Static Methods and Replacements #### CanHaveUnitSymbol - **Deprecated:** `static bool CanHaveUnitSymbol(DisplayUnitType)` - **Replacement:** `static bool CanHaveSymbol(ForgeTypeId unitTypeId)` #### CanHaveUnitSymbol (instance method) - **Deprecated:** `bool CanHaveUnitSymbol()` - **Replacement:** `bool CanHaveSymbol()` ``` -------------------------------- ### Transform Classes Source: https://revapidocs.com/2021.htm Represents affine transformations in 1D and 2D Euclidean space. ```APIDOC ## Transform Classes ### Autodesk.Revit.DB.Transform1D Represents an affine transform of 1D Euclidean space. ### Autodesk.Revit.DB.Transform2D Represents an affine transform of 2D Euclidean space. ``` -------------------------------- ### ImageTypeStatus Enumeration Source: https://revapidocs.com/2021.htm Enumeration for the load status of an ImageType. ```APIDOC ## ImageTypeStatus Enumeration ### Description Enumeration for the load status of an ImageType. ### Values - `ImageTypeStatus`: Contains possible values for the load status of an ImageType. ``` -------------------------------- ### OpenConflictScenario Enumeration Value Source: https://revapidocs.com/2021.htm Indicates that the last central version merged into the local model has been archived. ```APIDOC ## OpenConflictScenario Enumeration Value ### Description Indicates that the last central version merged into the local model to open has been archived in the central model. ### Value - `OpenConflictScenario.VersionArchived` ``` -------------------------------- ### View Section API Source: https://revapidocs.com/2021.htm Identify if a section view is split and retrieve the offset for its crop region. ```APIDOC ## DBViewSection.IsSplitSection() ### Description Identifies if a section view is split. ### Returns (bool) - True if the section view is split, false otherwise. ``` ```APIDOC ## ViewCropRegionShapeManager.GetSplitRegionOffset() ### Description Returns the offset for a specified split crop region within a section view. ### Returns (XYZ) - The offset of the split crop region. ``` -------------------------------- ### Path of Travel - Reveal Obstacles Mode Source: https://revapidocs.com/2021.htm Enable or disable the 'Reveal Obstacles' mode for Path of Travel calculations, which highlights elements obstructing the path. ```APIDOC ## PathOfTravel.IsInRevealObstaclesMode() ### Description Checks if the view is currently displaying the 'Reveal Obstacles' mode for Path of Travel. ### Returns (bool) - True if the mode is active, false otherwise. ### Method Signature IsInRevealObstaclesMode() ``` ```APIDOC ## PathOfTravel.SetRevealObstaclesMode() ### Description Sets whether the view is displaying the 'Reveal Obstacles' mode for Path of Travel. ### Parameters - **enabled** (bool) - Required - True to enable the mode, false to disable. ``` -------------------------------- ### ConnectorType API Change Source: https://revapidocs.com/2021.htm The ConnectorType.MasterSurface() method has been deprecated and replaced by ConnectorType.MainSurface(). ```APIDOC ## ConnectorType API Change ### Description The `ConnectorType.MasterSurface()` method is deprecated and has been replaced by `ConnectorType.MainSurface()`. ### Deprecated Member `ConnectorType.MasterSurface()` ### Replacement `ConnectorType.MainSurface()` ``` -------------------------------- ### StructuralConnectionHandler GetInputPoint Method Source: https://revapidocs.com/2021.htm Retrieves a specific input point for a structural connection handler. ```APIDOC ## StructuralConnectionHandler GetInputPoint Method ### Description Retrieves a specific input point for a structural connection handler. ### Method Signature `Autodesk.Revit.DB.Structure.StructuralConnectionHandler.GetInputPoint()` ``` -------------------------------- ### Exclusive TLS Protocol Setting (Incorrect) Source: https://revapidocs.com/2021.htm Avoid hard-coding security protocol versions exclusively, as this can override Revit's native TLS configuration and cause issues with Autodesk cloud services. ```csharp System.Net.ServicePointManager.SecurityProtocol = System.Net.SecurityProtocolType.Tls12; ``` -------------------------------- ### ViewSchedule API - Frozen Header Source: https://revapidocs.com/2021.htm Control whether the header of a schedule is frozen. ```APIDOC ## ViewSchedule.IsHeaderFrozen ### Description Gets or sets whether the header is frozen on a given schedule. ### Properties - **IsHeaderFrozen** (bool) - True to freeze the header, false otherwise. ``` -------------------------------- ### CircuitNamingScheme Source: https://revapidocs.com/2021.htm Represents a scheme used for electrical circuit naming. Supports creation and management of combined parameters. ```APIDOC ## Autodesk.Revit.DB.Electrical.CircuitNamingScheme ### Description Represents a scheme used for electrical circuit naming. This class allows for the creation of naming schemes and provides access to the list of combined parameters associated with a scheme. ### Methods - **Create()**: Creates a new circuit naming scheme. - **GetCombinedParameters()**: Retrieves the combined parameters associated with the scheme. - **SetCombinedParameters()**: Sets the combined parameters for the scheme. ``` -------------------------------- ### Dimension API Additions Source: https://revapidocs.com/2021.htm Several new properties have been added to access positioning for various parts of a dimension. ```APIDOC ## Dimension API Additions ### Description New properties are available to access positioning for different parts of a dimension. ### New Properties - `Dimension.TextPosition` - `Dimension.LeaderEndPosition` - `Dimension.HasLeader` - `SpotDimension.LeaderElbowPosition` - `SpotDimension.LeaderHasElbow` ``` -------------------------------- ### AirSystemData Class Source: https://revapidocs.com/2021.htm Contains data for an air system, obtainable from MEPAnalyticalSystem.GetAirSystemData(). ```APIDOC ## Autodesk.Revit.DB.Mechanical.AirSystemData Contains the data for an air system. It can be obtained from the MEPAnalyticalSystem.GetAirSystemData() method. It offers the following properties: * AirSystemData.HeatExchangerType * AirSystemData.PreheatCoilType * AirSystemData.HeatingCoilType * AirSystemData.AirSystemCoolingCoilType * AirSystemData.AirFanType ``` -------------------------------- ### CurveUV Source: https://revapidocs.com/2021.htm Represents a curve in the 2D parameter space of a surface. Includes a utility method to convert the curve to a 3D curve in the XY plane. ```APIDOC ## CurveUV ### CurveUV.As3DCurveInXYPlane() Returns a 3D curve in the XY plane representing the 2D UV curve. ``` -------------------------------- ### Autodesk.Revit.DB.ExtensibleStorage.Field Deprecations Source: https://revapidocs.com/2021.htm Details deprecated methods and properties in Field related to unit compatibility and type. ```APIDOC ## Autodesk.Revit.DB.ExtensibleStorage.Field ### Description Methods and properties related to unit compatibility and type have been updated to use `ForgeTypeId`. ### Deprecated Methods and Properties and Replacements #### CompatibleDisplayUnitType - **Deprecated:** `bool CompatibleDisplayUnitType(DisplayUnitType)` - **Replacement:** `bool CompatibleUnit(ForgeTypeId unitTypeId)` #### UnitType Property - **Deprecated:** `property UnitType UnitType (get)` - **Replacement:** `ForgeTypeId GetSpecTypeId()` ``` -------------------------------- ### DocumentSavedAsEventArgs API Change Source: https://revapidocs.com/2021.htm The DocumentSavedAsEventArgs.IsSavingAsMasterFile property has been deprecated and replaced by DocumentSavedAsEventArgs.IsSavingAsCentralFile. ```APIDOC ## Save As API Change (SavedEventArgs) ### Description The `DocumentSavedAsEventArgs.IsSavingAsMasterFile` property is deprecated and has been replaced by `DocumentSavedAsEventArgs.IsSavingAsCentralFile`. ### Deprecated Member `DocumentSavedAsEventArgs.IsSavingAsMasterFile` ### Replacement `DocumentSavedAsEventArgs.IsSavingAsCentralFile` ``` -------------------------------- ### Deprecated Enumerations in Autodesk.Revit.DB Source: https://revapidocs.com/2021.htm Lists deprecated enumerations and their corresponding replacements. ```APIDOC ## Deprecated Enumerations ### Description These enumerations have been deprecated and replaced with newer types. ### Deprecated - DisplayUnitType - UnitSymbolType - UnitType ### Replacement - UnitTypeId - SymbolTypeId - SpecTypeId ``` -------------------------------- ### Document Reload Events Source: https://revapidocs.com/2021.htm Subscribe to new document events to react to document reloading processes, with access to the central model path. ```APIDOC ## Application.DocumentReloadingLatest ### Description Event triggered just before the latest version of a document is reloaded. Document changes are permitted during this event. ### Event Arguments Provides an argument object containing the path to the central model. ``` ```APIDOC ## Application.DocumentReloadedLatest ### Description Event triggered after the latest version of a document has been reloaded. Document changes are permitted during this event. ### Event Arguments Provides an argument object containing the path to the central model. ``` -------------------------------- ### Element Filters Source: https://revapidocs.com/2021.htm Utilize new filter classes for efficient element collection based on IDs or visibility in a view. ```APIDOC ## Autodesk.Revit.DB.ElementIdSetFilter ### Description A quick filter that wraps a set of element IDs for efficient filtering. ### Usage Instantiate with a set of ElementIds to filter by. ``` ```APIDOC ## Autodesk.Revit.DB.VisibleInViewFilter ### Description A quick filter that passes elements that are likely visible in a given view. ### Usage Instantiate with view-specific parameters to filter visible elements. ``` -------------------------------- ### ViewSystemsAnalysisReport Source: https://revapidocs.com/2021.htm Represents a view instance of the systems analysis report. Allows creation of a new report, requesting analysis, and checking completion status. ```APIDOC ## Autodesk.Revit.DB.Analysis.ViewSystemsAnalysisReport ### Description Represents a view instance of the systems analysis report. Users can create a new view instance for systems analysis and request the analysis to run in the background. The related views are automatically updated upon completion. ### Methods - **Create()**: Creates a new view instance for systems analysis. - **RequestSystemsAnalysis()**: Requests the systems analysis to run in the background. - **IsAnalysisCompleted()**: Indicates if the background systems analysis has completed. - **GetLatestSystemsAnalysisReport()**: Returns the latest report of systems analysis. ``` -------------------------------- ### ModelPath Region Property Source: https://revapidocs.com/2021.htm Retrieves the region of the BIM 360 account and project for a model. ```APIDOC ## ModelPath Region Property ### Description Retrieves the region of the BIM 360 account and project for a model. ### Property - `ModelPath.Region`: Returns the region of the BIM 360 account and project which contains this model. ``` -------------------------------- ### View Filter API Source: https://revapidocs.com/2021.htm Control the enabled state and retrieve the ordered list of filters applied to a view. ```APIDOC ## View.GetIsFilterEnabled() ### Description Identifies if filters are currently enabled in this view. ### Returns (bool) - True if filters are enabled, false otherwise. ### Method Signature GetIsFilterEnabled() ``` ```APIDOC ## View.SetIsFilterEnabled() ### Description Sets whether filters are enabled in this view. ### Parameters - **enabled** (bool) - Required - True to enable filters, false to disable. ``` ```APIDOC ## View.GetOrderedFilters() ### Description Retrieves the filters applied to the view in the order they are applied. ### Returns (List) - A list of filters in their applied order. ### Method Signature GetOrderedFilters() ``` -------------------------------- ### Internal Origin Access Source: https://revapidocs.com/2021.htm Class and methods to access the Revit project's internal coordinate system origin. ```APIDOC ## InternalOrigin.Get() ### Description Returns the internal origin of the project. There is one InternalOrigin per document. ### Method static InternalOrigin.Get(Document doc) ``` ```APIDOC ## InternalOrigin.Position ### Description Read-only property which returns the XYZ value of the internal coordinates. ### Property InternalOrigin.Position ``` ```APIDOC ## InternalOrigin.SharedPosition ### Description Read-only property which returns the shared position of the internal origin based on the active ProjectLocation of its Document. ### Property InternalOrigin.SharedPosition ``` -------------------------------- ### ViewsExportedByContextEventArgs Source: https://revapidocs.com/2021.htm Provides information when Revit has just exported views via a CustomExporter. Includes a method to retrieve the IDs of the exported views. ```APIDOC ## ViewsExportedByContextEventArgs ### ViewsExportedByContextEventArgs.GetViewIds() Gets the IDs of the views that have been exported by the CustomExporter. ``` -------------------------------- ### CustomExporter Events Source: https://revapidocs.com/2021.htm Allows subscription to events that notify when Revit is about to export or has just exported views via a CustomExporter. Handlers can modify documents, except read-only ones. ```APIDOC ## CustomExporter Events ### Application.ViewsExportingByContext Event triggered just before views are exported by a CustomExporter. ### Application.ViewsExportedByContext Event triggered just after views have been exported by a CustomExporter. ``` -------------------------------- ### PanelScheduleData.IsUnusedPhaseHidden Source: https://revapidocs.com/2021.htm Indicates whether the unused phase column in a single-phase panel schedule should be hidden. ```APIDOC ## PanelScheduleData.IsUnusedPhaseHidden ### Description Gets or sets a boolean value indicating if the user wishes to hide the unused phase column in a single-phase panel schedule. `true` hides the column, `false` displays it. ``` -------------------------------- ### OffsetSurface Source: https://revapidocs.com/2021.htm Encapsulates the mathematical representation of a surface offset at a normal distance from an originating surface. ```APIDOC ## OffsetSurface ### Surface.GetBoundingBoxUV() Gets the UV bounding box of the surface. ``` -------------------------------- ### MEPAnalyticalSystem Class Source: https://revapidocs.com/2021.htm Represents an HVAC analytical system element for air or water circulation. Its AnalyticalSystemDomain property indicates whether it's a water loop or air system. ```APIDOC ## Autodesk.Revit.DB.Mechanical.MEPAnalyticalSystem Represents an HVAC analytical system element where the air or water is circulated to satisfy building energy requirements. Its AnalyticalSystemDomain property indicates whether the element represents a water loop or air system. ``` -------------------------------- ### OpenConflictResult Enumeration Value Source: https://revapidocs.com/2021.htm Provides the option to detach the local model from its central model while preserving worksets. ```APIDOC ## OpenConflictResult Enumeration Value ### Description Provides the option to detach the local model from its central model, with worksets preserved. ### Value - `OpenConflictResult.DetachFromCentral` ```