Namespace: Autodesk.Revit.DB Class: TemporaryViewModes

TemporaryViewModes.GetCaption

Method

Description:
A text caption to use for the given mode.

Remarks:
The text appears in the UI on the temporary frame when the view is in the temporary mode.

Syntax

public string GetCaption(
	TemporaryViewMode mode
)

Public Function GetCaption ( 
	mode As TemporaryViewMode
) As String

public:
String^ GetCaption(
	TemporaryViewMode mode
)

member GetCaption : 
        mode : TemporaryViewMode -> string

Parameters

Parameter	Type	Description
mode	TemporaryViewMode	The mode to get a caption for.

Return Value

Type	Description
String	Text of the caption. The text is localized.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	A value passed for an enumeration argument is not a member of that enumeration