Autodesk Vault ProfessionalVault API

FileRelationshipGatheringSettings Class

Autodesk.DataManagement.Client.Framework.VaultAutodesk.DataManagement.Client.Framework.Vault.Settings

Provides the settings that control how related files should be consumed relative to other files

Syntax

public class FileRelationshipGatheringSettings : IFileRelationshipGatheringSettingsReadOnly  
Public Class FileRelationshipGatheringSettings
   Implements IFileRelationshipGatheringSettingsReadOnly 

Constructors

NameDescription
FileRelationshipGatheringSettings

Properties

NameDescription
DateBiasedGets or sets whether we should use the "Date biased" approach of gathering dependencies.
IncludeAttachmentsGets or sets whether attachments of a source file should be consumed
IncludeChildrenGets whether children of a source file should be consumed. For example, an assembly depends on it's parts.
IncludeHiddenEntitiesGets or sets whether entities that are hidden should be included in the gathering results.
IncludeLibraryContentsGets or sets whether gathered entities that are a part of a Vault Library should be consumed.
IncludeParentsGets or sets whether parents of the source entity will be gathered. For example, the Assembly associated with a part.
IncludeRelatedDocumentationGets or sets whether related documentation that is associated with the entity will be gathered. For examplee, a DWG might be considered related documentation for an assembly. The DWG is not considered an attachment or a dependent.
RecurseChildrenGets or sets whether children should be included recursively, or if just the first level of children should be included
RecurseParentsGets or sets whether parents should be included recursively, or if just the first level parent should be included
ReleaseBiasedGets or sets that we should use the "Release biased" approach of gathering dependencies.
VersionGatheringOptionGets or sets an option which determines which versions of related files should be gathered.

Events

NameDescription
PropertyChangedEvent fired when one of the options in this object are changed

Returned By

Where you get a FileRelationshipGatheringSettings — members that return one.

Inheritance Hierarchy

  • System.Object
  • Autodesk.DataManagement.Client.Framework.Vault.Settings.FileRelationshipGatheringSettings

See Also