ViewDisplayBackground

Public Class

Set of values that control how background is drawn in a view. Background can only be set for a 3d view or for a section or elevation view.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.ViewDisplayBackground

Namespace: Autodesk.Revit.DB

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

Syntax

public class ViewDisplayBackground : IDisposable

The ViewDisplayBackground type exposes the following members.

Properties

Name

Description

---

Public Property

BackgroundColor

The color of the horizon when the type is ‘Gradient’.

---

Public Property

GroundColor

The color of the ground when the type is ‘Gradient’ or ‘SunAndClouds’.

---

Public Property

HorizontalImageOffset

The distance between the left viewport boundary and the left edge of the background image.

---

Public Property

HorizontalImageScale

The horizontal scale of the background image; the scale of 1.0 puts the image pixel-to-pixel.

---

Public Property

ImageFlags

The image alignment indicators when the type is ‘Image’.

---

Public Property

ImagePath

The path to the image file when the type is ‘Image’.

---

Public Property
IsValidObject

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

---

Public Property

SkyColor

The color of the sky when the type is ‘Gradient’.

---

Public Property

Type

The type of the background.

---

Public Property

VerticalImageOffset

The distance between the bottom viewport boundary and the bottom edge of the background image.

---

Public Property

VerticalImageScale

The vertical scale of the background image; the scale of 1.0 puts the image pixel-to-pixel.

---

Methods

Name

Description

---

Public Method
Static Member

CreateGradient

Creates an object that can be passed to

View.SetBackground

method to set the background of the Gradient type.

---

Public Method
Static Member

CreateImage

Creates an object that can be passed to

View.SetBackground

method to set the background of the Image type.

---

Public Method
Static Member

CreateSky

Creates an object that can be passed to

View.SetBackground

method to set the background of the SunAndClouds type.

---

Public Method

Dispose

Releases all resources used by the ViewDisplayBackground

---

Public Method

Equals

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

---

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

ToString

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

---