External |
Inheritance Hierarchy Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntax The ExternalResourceBrowserData type exposes the following members.
Constructors | Name | Description | |
|---|---|---|
 | ExternalResourceBrowserData | Constructs a new ExternalResourceBrowserData using the given document(optional), server id, folder path and match options. |
Properties | Name | Description | |
|---|---|---|
 | FolderPath | The current folder path to which the new resources and subfolder belong. |
| | IsValidObject | Specifies whether the .NET object represents a valid Revit entity. |
| | ServerId | The Id of IExternalResourceServer which handles the external resource load. |
Methods | Name | Description | |
|---|---|---|
| | AddResource(String) | Adds an external resource to the folder path by supplying the resource name. |
| | AddResource(String, IDictionary String, String ) | Adds an external resource to the folder path by supplying the resource name and reference information. |
| | AddResource(String, String) | Adds an external resource to the folder path by supplying the resource name and version. |
| | AddResource(String, String, IDictionary String, String ) | Adds an external resource to the folder path by supplying the resource name, version and reference information. |
| | AddSubFolder(String) | Adds a subfolder to the folder path with the given name. |
| | AddSubFolder(String, String) | Adds a subfolder to the folder path with the given name and icon type. |
| | CallingDocumentHasModelPath | Indicates whether the document requesting the external resource browser data has a defined ModelPath. |
| | Dispose | Releases all resources used by the ExternalResourceBrowserData |
| | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object ) |
| | GetCallingDocumentModelPath | Returns a copy of the ModelPath of the document that is requesting the external resource browser data. |
| | GetHashCode | Serves as the default hash function. (Inherited from Object ) |
| | GetMatchOptions | Gets the match options used to filter external resources. |
| | GetResources | Gets the external resources under the folder path of the browser data. |
| | GetSubFoldersData | Gets the subfolders data under the folder path of the browser data. |
| | GetType | Gets the Type of the current instance. (Inherited from Object ) |
| | IsValidFolderName | Checks whether the folder name is valid. |
| | IsValidResourceName | Checks whether the resource name is valid. |
| | ToString | Returns a string that represents the current object. (Inherited from Object ) |
Remarks This data represents the contents to be shown to the user while they are browsing a specific folder in Revit.
The folder path can be obtained from the FolderPath property.
The external resource server is expected to populate all of the available resources and subfolders that should appear in the Revit file browser while the browser is open to this particular folder.
If the user navigates to another folder, a different ExternalResourceBrowserData object will be provided to allow the server to populate resources at that location.
When adding resource and subfolder, the resource and subfolder should not be added recursively.
When adding resource and subfolder, the name should be unique short name(without folder).
The name of resource and subfolder should not contain any invalid character of \/:*?"<>|.
The length of resource combined path(server name + folder path + resource name) should not exceed 259; The length of subfolder also has same restriction.
See Also