Namespace: Autodesk.Revit.DB Class: ViewSchedule

ViewSchedule.GetDefaultNameForSchedule(Document, ElementId, ElementId)

Method

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

Syntax

public static string GetDefaultNameForSchedule(
	Document document,
	ElementId categoryId,
	ElementId areaSchemeId
)

Public Shared Function GetDefaultNameForSchedule ( 
	document As Document,
	categoryId As ElementId,
	areaSchemeId As ElementId
) As String

public:
static String^ GetDefaultNameForSchedule(
	Document^ document, 
	ElementId^ categoryId, 
	ElementId^ areaSchemeId
)

static member GetDefaultNameForSchedule : 
        document : Document * 
        categoryId : ElementId * 
        areaSchemeId : ElementId -> string

Parameters

Parameter	Type	Description
document	Document	The document to which the new schedule will be added.
categoryId	ElementId	The ID of the category whose elements will be included in the schedule, or InvalidElementId for a multi-category schedule.
areaSchemeId	ElementId	The ID of an area scheme in an area schedule, InvalidElementId otherwise.

Return Value

Type	Description
String	The default view name.

Exceptions

Exception	Condition
ArgumentException	document is not a project document. -or- categoryId is not a valid category for a regular schedule. -or- In a non-area schedule, areaSchemeId is not InvalidElementId. -or- In an area schedule, areaSchemeId is not the ID of an area scheme.
ArgumentNullException	A non-optional argument was null