Sign in
2023 Class
Changes 8
C

Application

Description:
Represents the Autodesk Revit Application, providing access to documents, options and other application wide data and settings.
Inheritance Hierarchy:
System.Object
  Autodesk.Revit.ApplicationServices.Application
    Autodesk.Revit.DB.Macros.ApplicationEntryPoint
public class Application : IDisposable
string versionInfo = application.VersionBuild + "\n"
                    + application.VersionName + "\n"
                    + application.VersionNumber;
Name Return Type Description
E ApplicationInitialized event Subscribe to this event to get notified after the Revit application has been initialized
E DocumentChanged event Subscribe to the DocumentChanged event to be notified when Revit document has changed.
E DocumentClosed event Subscribe to the DocumentClosing event to be notified when Revit is just about to close a document.
E DocumentClosing event Subscribe to the DocumentClosing event to be notified when Revit is just about to close a document.
E DocumentCreated event Subscribe to the DocumentCreated event to be notified immediately after Revit has finished creating a new document.
E DocumentCreating event Subscribe to the DocumentCreating event to be notified when Revit is just about to create a new document.
E DocumentOpened event Subscribe to the DocumentOpened event to be notified immediately after Revit has finished opening a document.
E DocumentOpening event Subscribe to the DocumentOpening event to be notified when Revit is just about to open a document.
E DocumentPrinted event Subscribe to the DocumentPrinted event to be notified immediately after Revit has finished printing a view or ViewSet of the document.
E DocumentPrinting event Subscribe to the DocumentPrinting event to be notified when Revit is just about to print a view or ViewSet of the document.
E DocumentReloadedLatest event Subscribe to the DocumentReloadedLatestEventArgs event to be notified immediately after Revit has finished reloading a document with central model.
E DocumentReloadingLatest event Subscribe to the DocumentReloadingLatestEventArgs event to be notified when Revit is just about to reload latest changes from a central model.
E DocumentSavedAs event Subscribe to the DocumentSavedAs event to be notified immediately after Revit has finished saving document with a new file name.
E DocumentSaved event Subscribe to the DocumentSaved event to be notified immediately after Revit has finished saving a document.
E DocumentSavingAs event Subscribe to the DocumentSavingAs event to be notified when Revit is just about to save the document with a new file name.
E DocumentSaving event Subscribe to the DocumentSaving event to be notified when Revit is just about to save a document.
E DocumentSynchronizedWithCentral event Subscribe to the DocumentSynchronizedWithCentral event to be notified immediately after Revit has finished synchronizing a document with central model.
E DocumentSynchronizingWithCentral event Subscribe to the DocumentSynchronizingWithCentral event to be notified when Revit is just about to synchronize a document with central model.
E DocumentWorksharingEnabled event Subscribe to the DocumentWorksharingEnabled event to be notified when a document has become workshared.
E ElementTypeDuplicated event Subscribe to the ElementTypeDuplicated event to be notified immediately after Revit has finished duplicating an element type.
E ElementTypeDuplicating event Subscribe to the ElementTypeDuplicating event to be notified when Revit is just about to duplicate an element type.
E FailuresProcessing event Subscribe to the FailuresProcessing event to be notified when failures are being processed at the end of transaction.
E FamilyLoadedIntoDocument event Subscribe to the FamilyLoadedInto event to be notified after Revit loaded a family into a document.
E FamilyLoadingIntoDocument event Subscribe to the FamilyLoadingInto event to be notified when Revit is just about to load a family into a document.
E FileExported event Subscribe to the FileExported event to be notified immediately after Revit has finished exporting files of formats supported by the API.
E FileExporting event Subscribe to the FileExporting event to be notified when Revit is just about to export files of formats supported by the API.
E FileImported event Subscribe to the FileImported event to be notified immediately after Revit has finished importing a file of format supported by the API.
E FileImporting event Subscribe to the FileImporting event to be notified when Revit is just about to import a file of format supported by the API.
E LinkedResourceOpened event Subscribe to the LinkedResourceOpened event to be notified immediately after Revit has finished opening a linked resource.
E LinkedResourceOpening event Subscribe to the LinkedResourceOpening event to be notified when Revit is just about to open a linked resource.
E ProgressChanged event Subscribe to the ProgressChanged event to be notified when an operation in Revit has progress bar data available.
E ViewExported event Subscribe to the ViewExported event to be notified immediately after Revit has finished exporting a view of the document.
E ViewExporting event Subscribe to the ViewExporting event to be notified when Revit is just about to export a view of the document.
E ViewPrinted event Subscribe to the ViewPrinted event to be notified immediately after Revit has finished printing a view of the document.
E ViewPrinting event Subscribe to the ViewPrinting event to be notified when Revit is just about to print a view of the document.
E ViewsExportedByContext event Subscribe to the ViewsExportedByContext event to be notified immediately after Revit has finished exporting one or more views of the document via an export context by CustomExporter.
E ViewsExportingByContext event Subscribe to the ViewsExportingByContext event to be notified when Revit is just about to export one or more views of the document via an export context by CustomExporter.
E WorksharedOperationProgressChanged event Subscribe to the WorksharedOperationProgressChanged to be notified when progress has changed during Collaboration for Revit's workshared operations: open model and synchronize with central.
Name Return Type Description
M CopyModel(ModelPath, String, Boolean) None Copies an existing model to a new file. Overwriting a file of the same name is allowed.
M Dispose() None Releases all resources used by the
M ExtractPartAtomFromFamilyFile(String, String) None Writes a PartAtom XML from the contents of a family file.
M GetAssets(AssetType) IList<Asset> Gets all the Assets of the specified type.
M GetFailureDefinitionRegistry() FailureDefinitionRegistry Returns the instance of FailureDefinitionRegistry.
M GetLibraryPaths() IDictionary Returns path information identifying where Revit searches for content.
M GetRevitServerNetworkHosts() IList<string> Gets the list of all Revit Server Network hosts in current session.
M GetSystemsAnalysisWorkflowNames() IList<string> Returns names for systems analysis workflows.
M GetSystemsAnalysisWorkflows() IDictionary Returns name and path information identifying systems analysis workflow files.
M GetWorksharingCentralGUID(ServerPath) Guid Gets the worksharing central GUID of the given server-based model.
M IsJournalPlaying() bool Determines if the application is currently in journal playback mode.
M IsValidThickness(Double) bool Checks if the input value is valid to be supplied as a thickness (for an extrusion, or blend, or wall layer, or similar geometric construct).
M NewAreaCreationData(ViewPlan, UV) AreaCreationData Creates an object which wraps the arguments of Area for batch creation.
M NewBoundingBoxUV() BoundingBoxUV Creates an empty two-dimensional rectangle.
M NewBoundingBoxUV(Double, Double, Double, Double) BoundingBoxUV Creates a two-dimensional rectangle with supplied values.
M NewBoundingBoxXYZ() BoundingBoxXYZ Creates a three-dimensional rectangular box.
M NewCategorySet() CategorySet Creates a new instance of a set specifically for holding category objects.
M NewColor() Color Returns a new color object.
M NewCombinableElementArray() CombinableElementArray Returns an array that can hold combinable element objects.
M NewCurveArrArray() CurveArrArray Creates an empty array that can store geometric curve loops.
M NewCurveArray() CurveArray Creates an empty array that can store geometric curves.
M NewCurveLoopsProfile(CurveArrArray) CurveLoopsProfile Creates a new CurveLoopsProfile object.
M NewDoubleArray() DoubleArray Creates a new instance of a double array.
M NewDWFExportOptions() DWFExportOptions Creates DWF Export options.
M NewDWFXExportOptions() DWFXExportOptions Creates DWFX Export options.
M NewElementId() ElementId Creates a new Autodesk::Revit::DB::ElementId^ object.
M NewElementSet() ElementSet Creates a new instance of a set specifically for holding elements.
M NewFaceArray() FaceArray Creates a new instance of a face array.
M NewFamilyDocument(String) Document New family document, including family, titleblock, and annotation symbol
M NewFamilyInstanceCreationData(Curve, FamilySymbol, Level, StructuralType) FamilyInstanceCreationData Creates an object which wraps the arguments of NewFamilyInstance() for batch creation.
M NewFamilyInstanceCreationData(Face, Line, FamilySymbol) FamilyInstanceCreationData Creates an object which wraps the arguments of NewFamilyInstance() for batch creation.
M NewFamilyInstanceCreationData(Face, XYZ, XYZ, FamilySymbol) FamilyInstanceCreationData Creates an object which wraps the arguments of NewFamilyInstance() for batch creation.
M NewFamilyInstanceCreationData(FamilySymbol, IList<XYZ>) FamilyInstanceCreationData Creates an object which wraps the arguments of NewFamilyInstance() for batch creation.
M NewFamilyInstanceCreationData(XYZ, FamilySymbol, Element, Level, StructuralType) FamilyInstanceCreationData Creates an object which wraps the arguments of NewFamilyInstance() for batch creation.
M NewFamilyInstanceCreationData(XYZ, FamilySymbol, Element, StructuralType) FamilyInstanceCreationData Creates an object which wraps the arguments of NewFamilyInstance() for batch creation.
M NewFamilyInstanceCreationData(XYZ, FamilySymbol, Level, StructuralType) FamilyInstanceCreationData Creates an object which wraps the arguments of NewFamilyInstance() for batch creation.
M NewFamilyInstanceCreationData(XYZ, FamilySymbol, StructuralType) FamilyInstanceCreationData Creates an object which wraps the arguments of NewFamilyInstance() for batch creation.
M NewFamilyInstanceCreationData(XYZ, FamilySymbol, XYZ, Element, StructuralType) FamilyInstanceCreationData Creates an object which wraps the arguments of NewFamilyInstance() for batch creation.
M NewFamilySymbolProfile(FamilySymbol) FamilySymbolProfile Creates a new FamilySymbolProfile object.
M NewFBXExportOptions() FBXExportOptions Creates 3D-Studio Max (FBX) Export options.
M NewGBXMLImportOptions() GBXMLImportOptions Creates Green-Building XML Import options.
M NewGeometryOptions() Options Creates an object to specify user preferences in parsing of geometry.
M NewInstanceBinding() InstanceBinding Creates a new empty instance binding object.
M NewInstanceBinding(CategorySet) InstanceBinding Creates a new instance binding object containing the categories passed as a parameter.
M NewIntersectionResultArray() IntersectionResultArray Creates a new instance of an IntersectionResult array.
M NewPointOnEdgeEdgeIntersection(Reference, Reference) PointOnEdgeEdgeIntersection Construct a PointOnEdgeEdgeIntersection object which is used to define the placement of a ReferencePoint given two references to edge.
M NewPointOnEdgeFaceIntersection(Reference, Reference, Boolean) PointOnEdgeFaceIntersection Construct a PointOnEdgeFaceIntersection object which is used to define the placement of a ReferencePoint given a references to edge and a reference to face.
M NewPointOnEdge(Reference, PointLocationOnCurve) PointOnEdge Create a PointOnEdge object which is used to define the placement of a ReferencePoint.
M NewPointOnFace(Reference, UV) PointOnFace Construct a PointOnFace object which is used to define the placement of a ReferencePoint given a reference and a location on the face.
M NewPointOnPlane(Reference, UV, UV, Double) PointOnPlane Construct a PointOnPlane object which is used to define the placement of a ReferencePoint from its property values.
M NewPointRelativeToPoint(Reference) PointRelativeToPoint Create a PointRelativeToPoint object, which is used to define the placement of a ReferencePoint relative to a host point.
M NewProjectDocument(String) Document New project document
M NewProjectDocument(UnitSystem) Document Creates a new project document with no template file specified.
M NewProjectPosition(Double, Double, Double, Double) ProjectPosition Creates a new project position object.
M NewProjectTemplateDocument(String) Document New project template document
M NewReferenceArray() ReferenceArray Creates a new instance of a reference array.
M NewReferencePointArray() ReferencePointArray Creates an empty array that can store ReferencePoint objects.
M NewSpaceSet() SpaceSet Creates a new instance of a space set.
M NewTypeBinding() TypeBinding Creates a new empty type binding object.
M NewTypeBinding(CategorySet) TypeBinding Creates a new type binding object containing the categories passed as a parameter.
M NewUV() UV Creates a UV object at the origin.
M NewUV(Double, Double) UV Creates a UV object representing coordinates in 2-space with supplied values.
M NewUV(UV) UV Creates a UV object by copying the supplied UV object.
M NewVertexIndexPairArray() VertexIndexPairArray Returns an array that can hold VertexIndexPair objects.
M NewVertexIndexPair(Int32, Int32) VertexIndexPair Creates a new VertexIndexPair object.
M NewViewSet() ViewSet Creates a new instance of a View set.
M NewXYZ() XYZ Creates a XYZ object at the origin.
M NewXYZ(Double, Double, Double) XYZ Creates a XYZ object representing coordinates in 3-space with supplied values.
M NewXYZ(XYZ) XYZ Creates a XYZ object by copying the supplied XYZ object.
M OpenBuildingComponentDocument(String) Document Opens a Building Component document from disk.
M OpenDocumentFile(ModelPath, OpenOptions) The opened document. Opens a document from disk or cloud.
M OpenDocumentFile(ModelPath, OpenOptions, IOpenFromCloudCallback) The opened document. Opens a document from disk or cloud.
M OpenDocumentFile(String) The opened document. Opens a document from disk.
M OpenIFCDocument(String) Document Opens an IFC document from disk using default options.
M OpenIFCDocument(String, IFCImportOptions) Document Opens an IFC document from disk using custom options.
M OpenSharedParameterFile() nullNothingnullptr Enables access to shared parameter groups and definitions that are maintained on disk.
M PurgeReleasedAPIObjects() None Explicitly purges all API objects that have been released but are still awaiting to be finalized
M RegisterFailuresProcessor(IFailuresProcessor) None Replaces Revit's default user interface (if present) with alternative handling for all warnings and errors (including those not generated by your application) for the rest of the Revit session; if your application is not prepared to respond to all warnings
M SetLibraryPaths(IDictionary<String, String>) None Sets path information identifying where Revit searches for content.
M SetSystemsAnalysisWorkflows(IDictionary<String, String>) None Sets name and path information identifying systems analysis workflow files.
M UpdateRenderAppearanceLibrary() None Updates the stored render appearance library, giving the Revit session access to any new RPC content.
M WriteJournalComment(String, Boolean) None Writes a comment to the Revit journal file.
Name Return Type Description
P ActiveAddInId AddInId Retrieves the Id of the currently running external application.
P AllowNavigationDuringRedraw bool Checks whether or not the navigation during redraw is enabled, and enable or disable it.
P AllUsersAddinsLocation string The folder location for .addin files for all users.
P AngleTolerance double Angle tolerance.
P BackgroundColor Color The background color to use for model views in this session.
P Cities CitySet Returns a set of all the known city locations within Revit.
P Create Application Provides an object that can be used to create new instances of Autodesk Revit API objects.
P CurrentRevitServerAccelerator string Current Revit Server accelerator.
P CurrentUserAddinsLocation string The folder location for .addin files for the current user.
P CurrentUsersAddinsDataFolderPath string Path to AddinsData folder for the current user.
P CurrentUsersDataFolderPath string Path to data folder for the current user.
P DefaultIFCProjectTemplate string Full path to the default template file for new IFC project documents. It may be empty, in which case the DefaultProjectTemplate should be used.
P DefaultProjectTemplate string Full path to the default template file for new project documents.
P DefaultViewDiscipline ViewDiscipline The view discipline that will be applied to new views by default.
P Documents DocumentSet Returns a set of documents within Revit.
P ExportIFCCategoryTable string Full path to the file that defines Revit category to IFC entity mappings for IFC export.
P FamilyTemplatePath string Default path for family template files.
P ImportIFCCategoryTable string Full path to the file that defines IFC entity to Revit category mappings for IFC import.
P IsArchitectureEnabled bool Checks whether or not the architecture discipline is enabled, and enable or disable it.
P IsElectricalAnalysisEnabled bool Checks whether or not electrical analysis is enabled, and enable or disable it.
P IsElectricalEnabled bool Checks whether or not the electrical discipline is enabled, and enable or disable it.
P IsEnergyAnalysisEnabled bool Checks whether or not energy analysis is enabled, and enable or disable it.
P IsInfrastructureEnabled bool Checks whether or not infrastructure discipline is enabled, and enable or disable it.
P IsLoggedIn bool Checks if the user is logged in from this session to their Autodesk account.
P IsMassingEnabled bool Checks whether or not the massing and site tools are enabled, and enable or disable them.
P IsMechanicalAnalysisEnabled bool Checks whether or not mechanical analysis is enabled, and enable or disable it.
P IsMechanicalEnabled bool Checks whether or not the mechanical discipline is enabled, and enable or disable it.
P IsPipingAnalysisEnabled bool Checks whether or not piping analysis is enabled, and enable or disable it.
P IsPipingEnabled bool Checks whether or not the piping discipline is enabled, and enable or disable it.
P IsRouteAnalysisEnabled bool Checks whether or not route analysis is enabled, and enable or disable it.
P IsStructuralAnalysisEnabled bool Checks whether or not the structural analysis is enabled, and enable or disable it.
P IsStructureEnabled bool Checks whether or not the structure discipline is enabled, and enable or disable it.
P IsSystemsEnabled bool Checks whether or not any systems disciplines (mechanical, electrical, or piping) are enabled.
P IsValidObject bool Specifies whether the .NET object represents a valid Revit entity.
P Language LanguageType The language used in the current session of Revit.
P LoginUserId string The user id of the user currently logged in. The user id will be empty if the user is not logged in.
P MinimumThickness double The minimum thickness allowed in Revit for a variety of geometric constructs. These include blends, extrusions, and wall layers.
P PointCloudsRootPath string Root path for point cloud files.
P Product ProductType The product type for the current session of Revit.
P RecordingJournalFilename string Retrieve the name of the journal file the Revit is currently recording to.
P SharedParametersFilename string Contains the fully qualified path to a shared parameters file.
P ShortCurveTolerance double The enforced minimum length for any curve created by Revit.
P ShowGraphicalOpenEndsAreaBasedLoadBoundaryDisconnects bool Whether or not to show the graphical open ends for Area Based Load Boundary disconnects.
P ShowGraphicalWarningCableTrayConduitDisconnects bool Whether or not to show the graphical warnings for CTC disconnects.
P ShowGraphicalWarningDuctDisconnects bool Whether or not to show the graphical warnings for duct disconnects.
P ShowGraphicalWarningElectricalDisconnects bool Whether or not to show the graphical warnings for Electrical disconnects.
P ShowGraphicalWarningHangerDisconnects bool Whether or not to show the graphical warnings for Fabrication Hanger disconnects.
P ShowGraphicalWarningPipeDisconnects bool Whether or not to show the graphical warnings for Pipe disconnects.
P SubVersionNumber string The minor version number of Revit
P SystemsAnalysisWorkfilesRootPath string Root path for systems analysis workfiles
P Username string Gets the user name for the current Revit session.
P VersionBuild string Returns the internal build number of the Autodesk Revit application.
P VersionName string Returns the name of the Revit application.
P VersionNumber string Return the primary version of the Revit application.
P VertexTolerance double Vertex tolerance.