ImageExportOptions

Public Class

This class defines options for exporting views and sheets as an image.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.ImageExportOptions

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class ImageExportOptions : IDisposable

The ImageExportOptions type exposes the following members.

Constructors

Name

Description

Public Method
ImageExportOptions

Constructs a new instance of the options class used to produce images.

Properties

Name

Description

Public Property
ExportRange

The export range defining which view(s) will be exported.

Public Property
FilePath

The file name and path for the exported file.

Public Property
FitDirection

The fit direction. Used only if ZoomType is FitToPage.

Public Property
HLRandWFViewsFileType

File type for exported HLR and wireframe views.

Public Property
ImageResolution

The image resolution in dots per inch.

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.

Public Property
PixelSize

The pixel size of an image in one direction. Used only if ZoomType is FitToPage.

Public Property
ShadowViewsFileType

The file type for exported shadow views.

Public Property
ShouldCreateWebSite

Whether or not to create a web site with a page for each export. Used only when ExportRange is SetOfViews.

Public Property
ViewName

The name of the view to be created.

Public Property
Zoom

The value for Zoom (as a percentage). Used only when ZoomType is Zoom.

Public Property
ZoomType

The zoom type, which defines how the image size is determined.

Methods

Name

Description

Public Method

Dispose

Releases all resources used by the ImageExportOptions

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

Public Method
Static Member

GetFileName

Gets the file name that will be produced when exporting a view to an image.

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

Public Method

GetViewsAndSheets

Gets a list of views and sheets to be exported. Used only when ExportRange is SetOfViews.

Public Method
Static Member

IsValidFileName

Verify if File name is valid

Public Method
Static Member

IsValidForSaveToProjectAsImage

Verify if ImageExportOptions object is valid for calling saveToProjectAsImage

Public Method

SetViewsAndSheets

Sets a list of views and sheets to be exported. Used only when ExportRange is SetOfViews.

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)