Autodesk Vault ProfessionalVault API

PropertyDefinition Class

Autodesk.DataManagement.Client.Framework.VaultAutodesk.DataManagement.Client.Framework.Vault.Currency.Properties

Represents the definition of Property. A PropertyValue represents a physical property value. For example, a file has an Author property value of "Michael". In this example, "Michael" is the property value and Author is the PropertyDefinition.

Syntax

public sealed class PropertyDefinition 
Public NotInheritable Class PropertyDefinition 

Constructors

NameDescription
PropertyDefinition

Properties

NameDescription
ActiveGets or sets whether this Property Definition is Active. Inactive PropertyDefinitions and the associated PropertyValues should not be displayed in any GUI
AssociatedEntityClassesGets the list of Entity Classes that use this PropertyDefinition
BasicSearchGets whether or not this Property Definition can take part in a Basic Search operation
ConstraintsGets or sets the constraints associated with this Property Definition.
DataTypeGets or sets the Data Type for this Property Definition
DefaultValueGets or sets the Default Value that will be applied to entities that do not have an existing value associated with this PropertyDefinition
DependenciesGets a list of PropertyDefinitions that this PropertyDefinition depends on to compute it's value. This can be used for internal PropertyDefinitions where the value for one property is computed based on the value of another
DisplayNameGets or sets the Display name for this Property Definition
HasListValuesGets whether or not this PropertyDefinition has a List Of Values associated with it
IdGets the unique identifier for a server-based property definition. This will have a value of InternalPropertyId if this PropertyDefinition is not associated with a server object.
IsCalculatedGets if this propdef represents properties that are calculated on the client (not based on any server entity, in which case the systemName is the point of uniqueness)
IsDynamicGets or sets whether or not this propdef is dynamic. A "dynamic propdef" is one whose value can change for any one iteration of an entity (regardless of tip or not). For example, the file compliance property is dynamic in that compliance can change within one iteration of a file.
IsSearchableGets or sets if this property is searchable via Advanced Search. The default value is that all non-internal properties are searchable.
IsSystemGets whether or not this is a System Property (as opposed to a UserDefined property)
ManagedDataTypeGets the .NET data type that will be returned from Autodesk.DataManagement.Client.Framework.Vault.Services.Connection.IPropertyManager.GetPropertyValues for properties associated with this PropertyDefinition
MappingsGets or sets the mappings for this Property Definition. The mappings determine the relationship between PropertyDefinitions and ContentSourcePropertyDefinition's
SystemNameGets the System Name for this Property Definition.
ValueListGets or sets an array of possible values for properties based on this property definition.

Methods

NameDescription
AddDependencyMakes this Property Definitions value dependent on the value of another Property Definition
EqualsTests if obj is equal to this PropertyDefinition object.
GetDoNotCacheGets whether the framework can cache property values associated with this Property Definition
GetRetrievalAlgorithmGets the Retrieval Algorithm for this PropertyDefinition, which is used to determine how property values for this definition should be retrieved.
SetDoNotCacheSets whether the framework can cache property values associated with this Property Definition
SetRetrievalAlgorithmGets the Retrieval Algorithm for this PropertyDefinition, which is used to determine how property values for this definition should be retrieved.
SupportsEntityClassGets whether or not this PropertyDefinition is associated with the specified entity class

Fields

NameDescription
InternalPropertyIdThe value of PropertyDefinitions that are not associated with a server object

Returned By

Where you get a PropertyDefinition — members that return one.

Inheritance Hierarchy

  • System.Object
  • Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.PropertyDefinition

See Also