SetBackground Method


Sets the background for the view. Background can only be set for 3d views and for Sections/Elevations.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 22.0.0.0 (22.1.0.0)
Since: 2014

Syntax

C#
public void SetBackground(
	ViewDisplayBackground background
)
Visual Basic
Public Sub SetBackground ( _
	background As ViewDisplayBackground _
)
Visual C++
public:
void SetBackground(
	ViewDisplayBackground^ background
)

Parameters

background
Type: Autodesk.Revit.DB ViewDisplayBackground
Background to set. See 'ViewDisplayBackground' class and its 'create' methods.

Exceptions

Exception Condition
Autodesk.Revit.Exceptions ArgumentException The background object is invalid, or view has 'Rendering' style.
Autodesk.Revit.Exceptions ArgumentNullException A non-optional argument was null
Autodesk.Revit.Exceptions InvalidOperationException This view does not contain display-related properties.

See Also

ArchiLabs Desktop

Put AI to work inside Revit.

Give Desktop your instructions and project files to build Revit families, update model elements, and create views and schedules. Works directly in Revit and AutoCAD.

Explore Desktop →