2025.3 Class
Changes 1
C

CustomExporter

Description:
A class that allows exporting 3D or 2D views via an export context.
Remarks:

The Export method of this class triggers standard rendering or exporting process in Revit, but instead of displaying the result on screen or printer, the output is channeled through the given custom context that handles processing of the geometric as well as non-geometric information.

Revit will process the exporting algorithm depending on the type of given context. If an instance of IPhotoRenderContext is used, then Revit will output the model as if executing the Render command, thus only such entities that would be visible in a rendered view will be sent to the context.

Alternatively, if an instance of IModelExportContext is used, Revit will output the model as if exporting it to a CAD format, a process which results outputting also objects that would not appear in a rendered image, such as model curves and text annotations.

For 2D views, an instance of IExportContext2D has to be used. Revit will output the contents of the 2D view as it is displayed on the screen. Export can be modified by setting properties pertaining to 2D views: Export2DGeometricObjectsIncludingPatternLines, Export2DIncludingAnnotationObjects. Export2DForceDisplayStyle. See notes for 2D export in IExportContext2D.

Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.CustomExporter
public class CustomExporter : IDisposable
Name Return Type Description Inherited From
C CustomExporter(Document, IExportContext) None Constructs a new instance of a CustomExporter for a given document using the input instance of IExportContext as the output device.
Name Return Type Description Inherited From
M Dispose() None Releases all resources used by the CustomExporter
M Equals None Determines whether the specified object is equal to the current object. (Inherited from Object ) Object
M Export(IList<ElementId>) None
M Export(View) None Exports one 3D or 2D view
M GetHashCode None Serves as the default hash function. (Inherited from Object ) Object
M GetType None Gets the Type of the current instance. (Inherited from Object ) Object
M IsRenderingSupported() Boolean Checks if view rendering is currently supported in the running instance of Revit.
M ToString None Returns a string that represents the current object. (Inherited from Object ) Object
Name Return Type Description Inherited From
P Export2DForceDisplayStyle DisplayStyle This value tells the exporter of 2D views to force the given display mode for the view.
P Export2DGeometricObjectsIncludingPatternLines bool This flag sets the exporter of 2D views to either include or exclude output of face pattern lines as part of geometric objects when the model is being processed by the export context.
P Export2DIncludingAnnotationObjects bool This flag sets the exporter of 2D views to either include or exclude output of annotation objects when the model is being processed by the export context.
P IncludeGeometricObjects bool This flag sets the exporter to either include or exclude output of geometric objects such as faces and curves when the model is being processed by the export context.
P IsValidObject Boolean Specifies whether the .NET object represents a valid Revit entity.
P ShouldStopOnError bool This flag instructs the exporting process to either stop or continue in case an error occurs during any of the exporting methods.