M

ViewDisplayBackground.CreateImage

Description:
Creates an object that can be passed to View.SetBackground method to set the background of the Image type.

public static ViewDisplayBackground CreateImage(
	string imagePath,
	ViewDisplayBackgroundImageFlags flags,
	UV imageOffsets,
	UV imageScales
)

Public Shared Function CreateImage ( _
	imagePath As String, _
	flags As ViewDisplayBackgroundImageFlags, _
	imageOffsets As UV, _
	imageScales As UV _
) As ViewDisplayBackground

public:
static ViewDisplayBackground^ CreateImage(
	String^ imagePath, 
	ViewDisplayBackgroundImageFlags flags, 
	UV^ imageOffsets, 
	UV^ imageScales
)

System.String

imagePath

File path with the image to be used.
Autodesk.Revit.DB.ViewDisplayBackgroundImageFlags

flags

Combination of flags (binary) that control how image is displayed in relation to the view/crop boundary.
Autodesk.Revit.DB.UV

imageOffsets

Horizontal (u) and vertical (v) offsets of the image.
Autodesk.Revit.DB.UV

imageScales

Horizontal (u) and vertical (v) scales of the image (1 == no change).

Return Value View.SetBackground New background object to pass to View.SetBackground .

Autodesk.Revit.Exceptions.ArgumentException

The file specified by imagePath is not an image file. A valid image file should be in one of the following formats: bmp, jpg, jpeg, png, tif.
Autodesk.Revit.Exceptions.ArgumentNullException

A non-optional argument was NULL
Autodesk.Revit.Exceptions.ArgumentOutOfRangeException

A value passed for an enumeration argument is not a member of that enumeration
Autodesk.Revit.Exceptions.FileArgumentNotFoundException

The file specified by imagePath doesn't exist.

Share a snippet Help the community

Loading…

ViewDisplayBackground.CreateImage

Syntax

Parameters

Exceptions

Community Snippets

Discussion … comments