GetDefaultNameForKeySchedule Method


Gets the default view name that will be used when creating a key schedule.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 24.0.0.0 (24.0.0.0)
Since:  2013

Syntax

C#
public static string GetDefaultNameForKeySchedule(
	Document document,
	ElementId categoryId
)
Visual Basic
Public Shared Function GetDefaultNameForKeySchedule ( _
	document As Document, _
	categoryId As ElementId _
) As String
Visual C++
public:
static String^ GetDefaultNameForKeySchedule(
	Document^ document, 
	ElementId^ categoryId
)

Parameters

document
Type: Autodesk.Revit.DBDocument
The document to which the new schedule will be added.
categoryId
Type: Autodesk.Revit.DBElementId
The ID of the category of elements that the schedule's keys will be associated with.

Return Value

The default view name.

Exceptions

ExceptionCondition
Autodesk.Revit.ExceptionsArgumentException document is not a project document. -or- categoryId is not a valid category for a key schedule.
Autodesk.Revit.ExceptionsArgumentNullException A non-optional argument was null

See Also

ArchiLabs Desktop

Put AI to work inside Revit.

Give Desktop your instructions and project files to build Revit families, update model elements, and create views and schedules. Works directly in Revit and AutoCAD.

Explore Desktop →