2024 Class
Changes 0
C

KeyBasedTreeEntriesLoadContent

Description:
This class is used by IExternalResourceServers to return KeyBasedTreeEntries data to Revit when their LoadResource method is invoked.
Remarks:

The class contains a KeyBasedTreeEntries object which should hold the KeyBasedTreeEntries data generated by the IExternalResourceServer.

An ExternalResourceServer can create the KeyBasedTreeEntries from an arbitrary data source by using AddEntry to add individual KeyBasedTreeEntries. Once all the desired entries have been added, BuildEntries can be called to construct the KeyBasedTreeEntries object from the individual entries that were added.

KeyBasedTreeEntriesLoadContent must have a built KeyBasedTreeEntries before its LoadStatus property can be set to ExternalResourceLoadStatus.Success.

Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.ExternalResourceLoadContent
    Autodesk.Revit.DB.KeyBasedTreeEntriesLoadContent
Name Return Type Description Inherited From
M AddEntry(KeyBasedTreeEntry) bool Adds one KeyBasedTreeEntry to this KeyBasedTreeEntriesLoadContent, which is used to build a KeyBasedTreeEntries object by BuildEntries function.
M BuildEntries() None Builds a KeyBasedTreeEntries object.
M CanAddEntry(KeyBasedTreeEntry) bool Verifies if the KeyBasedTreeEntry could be added in this KeyBasedTreeEntriesLoadContent.
M GetEntries() KeyBasedTreeEntries Gets a copy of KeyBasedTreeEntries object owned by this KeyBasedTreeEntriesLoadContent object.
M GetLoadResults() KeyBasedTreeEntriesLoadResults Returns a copy of the KeyBasedTreeEntriesLoadResults owned by this KeyBasedTreeEntriesLoadContent object.
M IsEntriesBuilt(KeyBasedTreeEntriesLoadContent) bool Verifies that the KeyBasedTreeEntries object owned by a KeyBasedTreeEntriesLoadContent object is built.
M Reset() None Clears KeyBasedTreeEntriesLoadContent object, including KeyBasedTreeEntries and KeyBasedTreeEntriesLoadResults, owned by this KeyBasedTreeEntriesLoadContent object.
M Dispose() None Releases all resources used by the ExternalResourceLoadContent
Name Return Type Description Inherited From
P IsValidObject bool Specifies whether the .NET object represents a valid Revit entity. ExternalResourceLoadContent
P LoadStatus ExternalResourceLoadStatus A value to indicate the status of an external resource load operation. IExternalResourceServers should set this in the LoadResource() method. ExternalResourceLoadContent
P Version string The version of the external data that the server is providing in this object. ExternalResourceLoadContent