Create a key schedule.
Namespace: Autodesk.Revit.DBAssembly: RevitAPI (in RevitAPI.dll) Version: 21.0.0.0 (21.1.1.109)
Since: 2013
Syntax
C# |
---|
public static ViewSchedule CreateKeySchedule( Document document, ElementId categoryId ) |
Visual Basic |
---|
Public Shared Function CreateKeySchedule ( _ document As Document, _ categoryId As ElementId _ ) As ViewSchedule |
Visual C++ |
---|
public: static ViewSchedule^ CreateKeySchedule( Document^ document, ElementId^ categoryId ) |
Parameters
- document
- Type: Autodesk.Revit.DB..::..Document
The document to which the new schedule will be added.
- categoryId
- Type: Autodesk.Revit.DB..::..ElementId
The ID of the category of elements that the schedule's keys will be associated with.
Return Value
The newly created schedule.
Remarks
A key schedule displays abstract "key" elements that can be used to
populate parameters of ordinary model elements.
Exceptions
Exception | Condition |
---|---|
Autodesk.Revit.Exceptions..::..ArgumentException | document is not a project document. -or- categoryId is not a valid category for a key schedule. |
Autodesk.Revit.Exceptions..::..ArgumentNullException | A non-optional argument was NULL |
Autodesk.Revit.Exceptions..::..ModificationForbiddenException | The document is in failure mode: an operation has failed, and Revit requires the user to either cancel the operation or fix the problem (usually by deleting certain elements). -or- The document is being loaded, or is in the midst of another sensitive process. |
Autodesk.Revit.Exceptions..::..ModificationOutsideTransactionException | The document has no open transaction. |