Autodesk Vault ProfessionalVault API

GetCustomPropertyDefinitions Method

Autodesk.DataManagement.Client.Framework.Vault.InterfacesIPropertyExtensionProvider

Gets a list of all custom property definitions. These are Property Definitions that are created on the client that represent computed values or values that are custom to a particular use case.

Syntax

System.Collections.Generic.IEnumerable<PropertyDefinition> GetCustomPropertyDefinitions(
   Connection vltConn,
   PropertyDefinitionDictionary existingPropDefs
)
Function GetCustomPropertyDefinitions( _
   ByVal vltConn As Connection, _
   ByVal existingPropDefs As PropertyDefinitionDictionary _
) As System.Collections.Generic.IEnumerable(Of PropertyDefinition)

Parameters

NameDescription
vltConnA connection to a vault server
existingPropDefsThe set of property definitions that have already been gathered by other extension providers

Return Value

A list of custom PropertyDefinitions, or null if there are none.

Remarks

The vault server does not know about these Property Definitions. You are responsible for implementing PreGetPropertyValues or PostGetPropertyValues to return the values for the custom prop defs that you define.

Custom property definitions should not have a valid Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.PropertyDefinition.Id. Use the constant InternalPropertyId for all custom property definitions.

See Also