DocumentPreviewSettings

Description:
Contains the settings related to the saving of preview images for a given document.

Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.DocumentPreviewSettings

public class DocumentPreviewSettings : IDisposable

Public Class DocumentPreviewSettings _
	Implements IDisposable

public ref class DocumentPreviewSettings : IDisposable

// Get the document's preview settings
DocumentPreviewSettings settings = document.GetDocumentPreviewSettings();

// Find a candidate 3D view
FilteredElementCollector collector = new FilteredElementCollector(document);
collector.OfClass(typeof(View3D));

Func<View3D, bool> isValidForPreview = v => settings.IsViewIdValidForPreview(v.Id);

View3D viewForPreview = collector.OfType<View3D>().First<View3D>(isValidForPreview);

// Set the preview settings
using (Transaction setTransaction = new Transaction(document, "Set preview view id"))
{
   setTransaction.Start();
   settings.PreviewViewId = viewForPreview.Id;
   setTransaction.Commit();
}

// Save the document
document.Save();

' Get the document's preview settings
Dim settings As DocumentPreviewSettings = document.GetDocumentPreviewSettings()

' Find a candidate 3D view
Dim collector As New FilteredElementCollector(document)
collector.OfClass(GetType(View3D))

Dim isValidForPreview As Func(Of View3D, Boolean) = Function(v) settings.IsViewIdValidForPreview(v.Id)

Dim viewForPreview As View3D = collector.OfType(Of View3D)().First(isValidForPreview)

' Set the preview settings
Using setTransaction As New Transaction(document, "Set preview view id")
    setTransaction.Start()
    settings.PreviewViewId = viewForPreview.Id
    setTransaction.Commit()
End Using

' Save the document
document.Save()

Name	Return Type	Description
M Dispose()	None	Releases all resources used by the
M ForceViewUpdate(Boolean)	None	Sets Revit to update the preview view if necessary.
M IsViewIdValidForPreview(ElementId)	bool	Identifies if the view id is valid as a preview view id.

Name	Return Type	Description
P IsValidObject	bool	Specifies whether the .NET object represents a valid Revit entity.
P IsViewUpdateForced	bool	Identifies if Revit will update the preview view if necessary.
P PreviewViewId	ElementId	The view id that will be used to generate the preview.