2025.3 Class
Changes 0
C

ViewDisplayBackground

Description:
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
public class ViewDisplayBackground : IDisposable
Name Return Type Description Inherited From
M CreateGradient(Color, Color, Color) ViewDisplayBackground Creates an object that can be passed to View.SetBackground method to set the background of the Gradient type.
M CreateImage(String, ViewDisplayBackgroundImageFlags, UV, UV) ViewDisplayBackground Creates an object that can be passed to View.SetBackground method to set the background of the Image type.
M CreateSky() ViewDisplayBackground Creates an object that can be passed to View.SetBackground method to set the background of the SunAndClouds type.
M Dispose() None Releases all resources used by the ViewDisplayBackground
M Equals None Determines whether the specified object is equal to the current object. (Inherited from Object ) Object
M GetHashCode None Serves as the default hash function. (Inherited from Object ) Object
M GetType None Gets the Type of the current instance. (Inherited from Object ) Object
M ToString None Returns a string that represents the current object. (Inherited from Object ) Object
Name Return Type Description Inherited From
P BackgroundColor Color The color of the horizon when the type is 'Gradient'.
P GroundColor Color The color of the ground when the type is 'Gradient' or 'SunAndClouds'.
P HorizontalImageOffset double The distance between the left viewport boundary and the left edge of the background image.
P HorizontalImageScale double The horizontal scale of the background image; the scale of 1.0 puts the image pixel-to-pixel.
P ImageFlags ViewDisplayBackgroundImageFlags The image alignment indicators when the type is 'Image'.
P ImagePath string The path to the image file when the type is 'Image'.
P IsValidObject Boolean Specifies whether the .NET object represents a valid Revit entity.
P SkyColor Color The color of the sky when the type is 'Gradient'.
P Type ViewDisplayBackgroundType The type of the background.
P VerticalImageOffset double The distance between the bottom viewport boundary and the bottom edge of the background image.
P VerticalImageScale double The vertical scale of the background image; the scale of 1.0 puts the image pixel-to-pixel.