Catalog Class |
Class for implementing a persistent collection of visual factory objects.
Inheritance HierarchySystemObject
System.CollectionsCollectionBase
Demo3D.VisualsCatalog
System.CollectionsCollectionBase
Demo3D.VisualsCatalog
Namespace: Demo3D.Visuals
Assembly: Demo3D.Core (in Demo3D.Core.dll) Version: 10.0.0.6737
SyntaxC#
public class Catalog : CollectionBase, IDisposable
The Catalog type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | App | Field ValueType:The application object that this catalog is attached to. |
| Author | Field ValueType:The name of the author that last edited in the catalog. |
| Description | Field ValueType:A description of the catalog. |
| HasChangedOnDisk | Field ValueType:Whether the original catalog file on disk has changed since the catalog was loaded. This may have happened if more than one instance of the application is running. |
| Image | Field ValueType:The icon image to use for the catalog in the catalog explorer. |
| Item |
Indexer declaration to get the nth VisualFactory from a catalog.
|
| LoadedHeader | Field ValueType:The state of the catalog when it was last loaded. |
| Name | Field ValueType:The name of the catalog. |
| NeedsSave | Field ValueType:Whether the catalog has been modified and needs saving to disk since it was last loaded. |
| Notes | |
| PathName |
The full path of the catalog on disk.
|
| ReadOnly | Field ValueType:Whether the catalog can be edited or not. This is read from the read-only state of the catalog file on disk initially. |
| Version | Field ValueType:The version number of the catalog. |
Methods| Name | Description | |
|---|---|---|
 | Add | |
| AddChildFolder | |
| AddVisualsAsComponent | |
 | ConvertToSingleVisual | |
| CreateFolderPath | |
| DeleteFolder | |
| Find | |
| FindLoadFactoryIndexes |
Return a list of int indexes of visual factories which represent loads.
|
| FolderExists | |
| GetChildFactories | |
| GetChildFactoriesDeep | |
| GetChildFolders | |
| GetFolder | |
| GetParentFolder | |
| GetVar | |
| IndexOf | |
| Load(String, Boolean) | |
| Load(IBuilder, String) | |
| LoadFromFile | |
| MakeVisualFactory | |
| Remove(String) | |
| Remove(VisualFactory) | |
| RenameFolder |
Rename the specified folder, remaining in same parent folder.
|
| SetVar |
Events| Name | Description | |
|---|---|---|
 | FactoryAdded |
Called when a visual factory has been added to the catalog.
|
| FactoryRemoved |
Called when a visual factory has been removed from the catalog.
|
Fields| Name | Description | |
|---|---|---|
 | FileExtension |
The file extension to be used for catalogs including the '.'/period.
|
| FileExtensionXml | The file extension to be used for catalogs in source control format including the '.'/period. |
See Also