Creates a new ImageType element and loads the image into it.
Namespace: Autodesk.Revit.DBAssembly: RevitAPI (in RevitAPI.dll) Version: 21.0.0.0 (21.1.1.109)
Since: 2015
Syntax
C# |
---|
[ObsoleteAttribute("This method is deprecated in Revit 2020 and will be removed in the next version of Revit. We suggest you instead use the Create method that takes ImageTypeOptions as input.")] public static ImageType Create( Document document, string imagePath ) |
Visual Basic |
---|
<ObsoleteAttribute("This method is deprecated in Revit 2020 and will be removed in the next version of Revit. We suggest you instead use the Create method that takes ImageTypeOptions as input.")> _ Public Shared Function Create ( _ document As Document, _ imagePath As String _ ) As ImageType |
Visual C++ |
---|
[ObsoleteAttribute(L"This method is deprecated in Revit 2020 and will be removed in the next version of Revit. We suggest you instead use the Create method that takes ImageTypeOptions as input.")] public: static ImageType^ Create( Document^ document, String^ imagePath ) |
Parameters
- document
- Type: Autodesk.Revit.DB..::..Document
The document.
- imagePath
- Type: System..::..String
A path to an image file to load.
Return Value
The new ImageType.
Remarks
The ImageType will be created but will not be placed into any view.
Exceptions
Exception | Condition |
---|---|
Autodesk.Revit.Exceptions..::..ArgumentException | The provided path is not a local path. -or- imagePath is an empty string. -or- The file represented by imagePath is not a supported image file type. -or- The image file represented by imagePath is a password protected PDF file. -or- The image file represented by imagePath could not be read and may be corrupt. |
Autodesk.Revit.Exceptions..::..ArgumentNullException | A non-optional argument was NULL |
Autodesk.Revit.Exceptions..::..FileArgumentNotFoundException | The file represented by imagePath does not exist. |
Autodesk.Revit.Exceptions..::..ModificationForbiddenException | The document is in failure mode: an operation has failed, and Revit requires the user to either cancel the operation or fix the problem (usually by deleting certain elements). -or- The document is being loaded, or is in the midst of another sensitive process. |
Autodesk.Revit.Exceptions..::..ModificationOutsideTransactionException | The document has no open transaction. |
Autodesk.Revit.Exceptions..::..OptionalFunctionalityNotAvailableException | The image file represented by imagePath is a PDF file but PDF import is not available in the installed Revit. |