Share

ProfileLabelGroup.GetAvailableLabelGroups Method

Note: This API is now obsolete.

Returns the ObjectId collection of labels on the profile of a specified type.



Namespace: Autodesk.Civil.DatabaseServices
Assembly: AeccDbMgd (in AeccDbMgd.dll) Version: 13.8.0.280

Syntax

C#

[ObsoleteAttribute("Use Autodesk.Civil.DatabaseServices.ProfileLabelGroup.GetAvailableLabelGroupIds instead.", 
	false)]
public static ObjectIdCollection GetAvailableLabelGroups(
	RXClass runtimeClass,
	ObjectId profileViewId,
	ObjectId profileId,
	bool includeDerived
)

VB

<ObsoleteAttribute("Use Autodesk.Civil.DatabaseServices.ProfileLabelGroup.GetAvailableLabelGroupIds instead.", 
	false)>
Public Shared Function GetAvailableLabelGroups ( 
	runtimeClass As RXClass,
	profileViewId As ObjectId,
	profileId As ObjectId,
	includeDerived As Boolean
) As ObjectIdCollection

C++

public:
[ObsoleteAttribute(L"Use Autodesk.Civil.DatabaseServices.ProfileLabelGroup.GetAvailableLabelGroupIds instead.", 
	false)]
static ObjectIdCollection^ GetAvailableLabelGroups(
	RXClass^ runtimeClass, 
	ObjectId profileViewId, 
	ObjectId profileId, 
	bool includeDerived
)

Parameters

runtimeClass  RXClass
The type of the label group class.
profileViewId  ObjectId
The objectId of the profile view where the label groups are located.
profileId  ObjectId
The objectId of the profile where the label groups are located.
includeDerived  Boolean
Indicates whether to include the derived types of the specified type.

Return Value

ObjectIdCollection

Exceptions

ExceptionCondition
ArgumentException Thrown when:
  • The runtimeClass is not a kind of ProfileLabelGroup.
  • The profileId or profileViewId is invalid.

See Also

Reference

Was this information helpful?