ImageTypeReloadFrom Method |
Reloads the image in the ImageType from a new image file, and for a new
PageNumber.
Namespace: Autodesk.Revit.DBAssembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntaxpublic void ReloadFrom(
ImageTypeOptions options
)
Public Sub ReloadFrom (
options As ImageTypeOptions
)
public:
void ReloadFrom(
ImageTypeOptions^ options
)
member ReloadFrom :
options : ImageTypeOptions -> unit
Parameters
- options ImageTypeOptions
-
Options that specify what image to load.
ExceptionsException | Condition |
---|
ArgumentException |
options.Path is an empty string.
-or-
The file represented by options.Path is not a supported image file type.
-or-
The image file represented by options.Path is a password protected PDF file.
-or-
The image file represented by options.Path does not contain the page specified by options.PageNumber.
-or-
The image file represented by options.Path could not be read and may be corrupt.
-or-
An error occurred while handling the external resource corresponding to the image.
|
ArgumentNullException |
A non-optional argument was null
|
FileArgumentNotFoundException |
The file represented by options.Path does not exist.
|
InvalidOperationException |
This ImageType was not loaded from a file.
|
ModificationForbiddenException |
The document containing this ImageType 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 containing this ImageType is being loaded, or is in the midst of another
sensitive process.
|
ModificationOutsideTransactionException |
The document containing this ImageType has no open transaction.
|
Remarks
If reload fails (because the image file doesn't exist, cannot be read, or does not have the requested page number),
the currently loaded image will remain unchanged.
See Also