•  

PreviewViewId Property

The view id that will be used to generate the preview.

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

Syntax

C# 
public ElementId PreviewViewId { get; set; }
Visual Basic 
Public Property PreviewViewId As ElementId
	Get
	Set
Visual C++ 
public:
property ElementId^ PreviewViewId {
	ElementId^ get ();
	void set (ElementId^ value);
}

Field Value

InvalidElementId signals that there is no permanent preview view for the document. Where possible the document's active view will be used to generate the preview upon save; where there is no active view the document will not include a preview.

Remarks

This view will always be saved as the preview view for the document unless it is overridden by the value used in SaveOptions or SaveAsOptions.

Exceptions

Exception Condition
Autodesk.Revit.Exceptions ArgumentException When setting this property: The view id is not valid to use as a preview view.
Autodesk.Revit.Exceptions ArgumentNullException When setting this property: A non-optional argument was null

See Also