ViewSchedule.GetDefaultParameterNameForKeySchedule
Method
Description:
Gets the default parameter name that will be used when creating a key schedule.
Gets the default parameter name that will be used when creating a key schedule.
Remarks:
See ViewSchedule.KeyScheduleParameterName for details.
See ViewSchedule.KeyScheduleParameterName for details.
Syntax
public static string GetDefaultParameterNameForKeySchedule(
Document document,
ElementId categoryId
)
Parameters
Parameter | Type | Description |
---|---|---|
document | Document | The document to which the new schedule will be added. |
categoryId | ElementId | The ID of the category of elements that the schedule's keys will be associated with. |
Return Value
Type | Description |
---|---|
String | The default parameter name. |
Exceptions
Exception | Condition |
---|---|
ArgumentException | document is not a project document. -or- categoryId is not a valid category for a key schedule. |
ArgumentNullException | A non-optional argument was null |