Revit 2025 API
DocumentExport(String, String, ICollectionElement |
Exports a selection of views in DWG format.
Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntax
public bool Export( string folder, string name, ICollection<ElementId> views, DWGExportOptions options )
Public Function Export ( folder As String, name As String, views As ICollection(Of ElementId), options As DWGExportOptions ) As Boolean
public: bool Export( String^ folder, String^ name, ICollection<ElementId^>^ views, DWGExportOptions^ options )
member Export : folder : string * name : string * views : ICollection<ElementId> * options : DWGExportOptions -> bool
Parameters
- folder String
- Output folder, into which file(s) will be exported. The folder must exist.
- name String
- Either the name of a single file or a prefix for a set of files. If empty, automatic naming will be used. If , throw ArgumentException.
- views ICollectionElementId
- Selection of views to be exported. The set must contain at least one valid view.
- options DWGExportOptions
- Various options applicable to the DWG format. If , all options will be set to their respective default values.
Return Value
BooleanTrue if successful, otherwise False.
Exceptions| Exception | Condition |
|---|---|
| ArgumentException | NullOrEmpty -or- Contains invalid characters. -or- non empty list of views must be provided. -or- some of the views are not printable (exportable). -or- The modifiers set in layer info must be valid. -or- Thrown when the options in DWGExportOptions is invalid. |
| ArgumentNullException | A non-optional argument was null |
| DirectoryNotFoundException | Thrown when the directory does not exist. |
| InvalidOperationException | Export is temporarily disabled. -or- Exporting is not allowed in the current application mode. |
| InvalidPathArgumentException | The folder does not exist. |
| OptionalFunctionalityNotAvailableException | The DWG module is not available in the installed Revit. -or- The Graphics module is not available in the installed Revit. |
Remarks
All the views must be printable for the Export to succeed.
It can be assured by checking the CanBePrinted property of each view.
Examplepublic bool ExportDWG(Document document, View view, string setupName) { bool exported = false; // Get the predefined setups and use the one with the given name. IList<string> setupNames = BaseExportOptions.GetPredefinedSetupNames(document); foreach (string name in setupNames) { if (name.CompareTo(setupName) == 0) { // Export using the predefined options DWGExportOptions dwgOptions = DWGExportOptions.GetPredefinedOptions(document, name); // Export the active view ICollection<ElementId> views = new List<ElementId>(); views.Add(view.Id); // The document has to be saved already, therefore it has a valid PathName. exported = document.Export(Path.GetDirectoryName(document.PathName), Path.GetFileNameWithoutExtension(document.PathName), views, dwgOptions); break; } } return exported; }
Public Function ExportDWG(document As Document, view As View, setupName As String) As Boolean Dim exported As Boolean = False ' Get the predefined setups and use the one with the given name. Dim setupNames As IList(Of String) = BaseExportOptions.GetPredefinedSetupNames(document) For Each name As String In setupNames If name.CompareTo(setupName) = 0 Then ' Export using the predefined options Dim dwgOptions As DWGExportOptions = DWGExportOptions.GetPredefinedOptions(document, name) ' Export the active view Dim views As ICollection(Of ElementId) = New List(Of ElementId)() views.Add(view.Id) ' The document has to be saved already, therefore it has a valid PathName. exported = document.Export(Path.GetDirectoryName(document.PathName), Path.GetFileNameWithoutExtension(document.PathName), views, dwgOptions) Exit For End If Next Return exported End Function
No code example is currently available or this language may not be supported.
No code example is currently available or this language may not be supported.
See Also